celluloid-zmq 0.9.0 → 0.10.0

data/CHANGES.md

@@ -1,3 +1,8 @@
+0.10.0
+------
+* Factor celluloid-zmq into its own gem
+* #linger= support
+
 0.9.0
 -----
 * New 0MQ APIs which wrap ffi-rzmq's

data/Gemfile

@@ -1,7 +1,7 @@
 source 'http://rubygems.org'
 
-gem 'celluloid',    :git => 'git://github.com/tarcieri/celluloid'
-gem 'celluloid-io', :git => 'git://github.com/tarcieri/celluloid-io'
+gem 'celluloid',    :git => 'git://github.com/celluloid/celluloid'
+gem 'celluloid-io', :git => 'git://github.com/celluloid/celluloid-io'
 
 # Specify your gem's dependencies in celluloid-zmq.gemspec
 gemspec

data/README.md

@@ -1,56 +1,102 @@
-Celluloid::ZMQ
-==============
+![Celluloid::ZMQ](https://github.com/celluloid/celluloid-zmq/raw/master/logo.png)
+=================
+[![Build Status](https://secure.travis-ci.org/celluloid/celluloid-zmq.png?branch=master)](http://travis-ci.org/celluloid/celluloid-zmq)
 
-This gem uses the ffi-rzmq library to provide Celluloid actors that can
-interact with 0MQ sockets.
+Celluloid::ZMQ provides Celluloid actors that can interact with [0MQ sockets][0mq].
+Underneath, it's built on the [ffi-rzmq][ffi-rzmq] library. Celluloid::ZMQ was
+primarily created for the purpose of writing [DCell][dcell], distributed Celluloid
+over 0MQ, so before you go building your own distributed Celluloid systems with
+Celluloid::ZMQ, be sure to give DCell a look and decide if it fits your purposes.
 
-Celluloid::ZMQ provides two methods for multiplexing 0MQ sockets with
-receiving messages over Celluloid's actor protocol:
+[0mq]: http://www.zeromq.org/
+[ffi-rzmq]: https://github.com/chuckremes/ffi-rzmq
+[dcell]: https://github.com/celluloid/dcell
 
-* Celluloid::ZMQ#wait_readable(socket): wait until a message is available to
-  read from the given 0MQ socket
-* Celluloid::ZMQ#wait_writeable(socket): waits until there's space in the
-  given socket's message buffer to send another message
+It provides different `Celluloid::ZMQ::Socket` classes which can be initialized
+then sent `bind` or `connect`. Once bound or connected, the socket can
+`read` or `send` depending on whether it's readable or writable.
 
-Example Usage:
+## Supported Platforms
 
-    require 'celluloid-zmq'
+Celluloid::IO requires Ruby 1.9 support on all Ruby VMs. You will also need
+the ZeroMQ library installed as it's accessed via FFI.
 
-	ZMQ_CONTEXT = ZMQ::Context.new(1)
+Supported VMs are Ruby 1.9.3, JRuby 1.6, and Rubinius 2.0.
 
-    class MyZmqCell
-      include Celluloid::ZMQ
+To use JRuby in 1.9 mode, you'll need to pass the "--1.9" command line option
+to the JRuby executable, or set the "JRUBY_OPTS=--1.9" environment variable.
 
-      def initialize(addr)
-        @socket = ZMQ_CONTEXT.socket(ZMQ::PUSH)
+## 0MQ Socket Types
 
-        unless ZMQ::Util.resultcode_ok? @socket.connect addr
-	      @socket.close
-	      raise "error connecting to #{addr}: #{ZMQ::Util.error_string}"
-        end
-      end
+The following 0MQ socket types are supported (see [sockets.rb][socketsrb] for more info)
 
-      def write(message)
-        wait_writeable @socket
-        unless ZMQ::Util.resultcode_ok? @socket.send_string message
-          raise "error sending 0MQ message: #{ZMQ::Util.error_string}"
-        end
-      end
+[socketsrb]: https://github.com/celluloid/celluloid-zmq/blob/master/lib/celluloid/zmq/sockets.rb
 
-      def read
-        wait_readable @socket
-        message = ''
+* ReqSocket / RepSocket
+* PushSocket / PullSocket
+* PubSocket / SubSocket
 
-	    rc = @socket.recv_string message
-	    if ZMQ::Util.resultcode_ok? rc
-	      handle_message message
-	    else
-	      raise "error receiving ZMQ string: #{ZMQ::Util.error_string}"
-	    end
-      end
+## Usage
+
+```ruby
+require 'celluloid/zmq'
+
+Celluloid::ZMQ.init
+
+class Server
+  include Celluloid::ZMQ
+
+  def initialize(address)
+    @socket = PullSocket.new
+
+    begin
+      @socket.bind(address)
+    rescue IOError
+      @socket.close
+      raise
+    end
+  end
+
+  def run
+    while true; handle_message! @socket.read; end
+  end
+
+  def handle_message(message)
+    puts "got message: #{message}"
+  end
+end
+
+class Client
+  include Celluloid::ZMQ
+
+  def initialize(address)
+    @socket = PushSocket.new
+
+    begin
+      @socket.connect(address)
+    rescue IOError
+      @socket.close
+      raise
     end
+  end
+
+  def write(message)
+    @socket.send(message)
+
+    nil
+  end
+end
+
+addr = 'tcp://127.0.0.1:3435'
+
+server = Server.new(addr)
+client = Client.new(addr)
+
+server.run!
+client.write('hi')
+```
 
 Copyright
 ---------
 
-Copyright (c) 2011 Tony Arcieri. See LICENSE.txt for further details.
+Copyright (c) 2012 Tony Arcieri. See LICENSE.txt for further details.

data/celluloid-zmq.gemspec

@@ -6,13 +6,13 @@ Gem::Specification.new do |gem|
   gem.email         = ["tony.arcieri@gmail.com"]
   gem.description   = "Celluloid bindings to the ffi-rzmq library"
   gem.summary       = "Celluloid::ZMQ provides concurrent Celluloid actors that can listen for 0MQ events"
-  gem.homepage      = "http://github.com/tarcieri/dcell"
+  gem.homepage      = "http://github.com/celluloid/celluloid-zmq"
 
   gem.name          = "celluloid-zmq"
   gem.version       = Celluloid::ZMQ::VERSION
 
-  gem.add_dependency "celluloid",    "~> 0.9.0"
-  gem.add_dependency "celluloid-io", "~> 0.9.0"
+  gem.add_dependency "celluloid",    "~> 0.10.0"
+  gem.add_dependency "celluloid-io", "~> 0.10.0"
   gem.add_dependency "ffi"
   gem.add_dependency "ffi-rzmq"
 

data/lib/celluloid/zmq/sockets.rb

@@ -1,29 +1,34 @@
 module Celluloid
   module ZMQ
+    attr_reader :linger
+
     class Socket
       # Create a new socket
       def initialize(type)
         @socket = Celluloid::ZMQ.context.socket ::ZMQ.const_get(type.to_s.upcase)
+        @linger = 0
       end
 
       # Connect to the given 0MQ address
       # Address should be in the form: tcp://1.2.3.4:5678/
       def connect(addr)
-        puts "zomg connecting"
         unless ::ZMQ::Util.resultcode_ok? @socket.connect addr
           raise IOError, "error connecting to #{addr}: #{::ZMQ::Util.error_string}"
         end
         true
       end
 
+      def linger=(value)
+        @linger = value || -1
+
+        unless ::ZMQ::Util.resultcode_ok? @socket.setsockopt(::ZMQ::LINGER, value)
+          raise IOError, "couldn't set linger: #{::ZMQ::Util.error_string}"
+        end
+      end
+
       # Bind to the given 0MQ address
       # Address should be in the form: tcp://1.2.3.4:5678/
       def bind(addr)
-        unless ::ZMQ::Util.resultcode_ok? @socket.setsockopt(::ZMQ::LINGER, 0)
-          @socket.close
-          raise IOError, "couldn't set ZMQ::LINGER: #{::ZMQ::Util.error_string}"
-        end
-
         unless ::ZMQ::Util.resultcode_ok? @socket.bind(addr)
           raise IOError, "couldn't bind to #{addr}: #{::ZMQ::Util.error_string}"
         end
@@ -49,6 +54,17 @@ module Celluloid
 
     # Readable 0MQ sockets have a read method
     module ReadableSocket
+      # always set LINGER on readable sockets
+      def bind(addr)
+        self.linger = @linger
+        super(addr)
+      end
+
+      def connect(addr)
+        self.linger = @linger
+        super(addr)
+      end
+
       # Read a message from the socket
       def read(buffer = '')
         Celluloid.current_actor.wait_readable(@socket) if evented?

data/lib/celluloid/zmq/version.rb

@@ -1,5 +1,5 @@
 module Celluloid
   module ZMQ
-    VERSION = "0.9.0"
+    VERSION = "0.10.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: celluloid-zmq
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,33 +9,33 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-21 00:00:00.000000000 Z
+date: 2012-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid
-  requirement: &70214687519820 !ruby/object:Gem::Requirement
+  requirement: &70300524096260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.10.0
   type: :runtime
   prerelease: false
-  version_requirements: *70214687519820
+  version_requirements: *70300524096260
 - !ruby/object:Gem::Dependency
   name: celluloid-io
-  requirement: &70214687517520 !ruby/object:Gem::Requirement
+  requirement: &70300524095640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.10.0
   type: :runtime
   prerelease: false
-  version_requirements: *70214687517520
+  version_requirements: *70300524095640
 - !ruby/object:Gem::Dependency
   name: ffi
-  requirement: &70214687516960 !ruby/object:Gem::Requirement
+  requirement: &70300524095260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70214687516960
+  version_requirements: *70300524095260
 - !ruby/object:Gem::Dependency
   name: ffi-rzmq
-  requirement: &70214687516180 !ruby/object:Gem::Requirement
+  requirement: &70300524094760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70214687516180
+  version_requirements: *70300524094760
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70214687515760 !ruby/object:Gem::Requirement
+  requirement: &70300551724880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70214687515760
+  version_requirements: *70300551724880
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70214687551620 !ruby/object:Gem::Requirement
+  requirement: &70300551724460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70214687551620
+  version_requirements: *70300551724460
 description: Celluloid bindings to the ffi-rzmq library
 email:
 - tony.arcieri@gmail.com
@@ -92,15 +92,13 @@ files:
 - lib/celluloid/zmq/version.rb
 - lib/celluloid/zmq/waker.rb
 - lib/celluloid/zmq.rb
-- pkg/celluloid-zmq-0.0.4.gem
-- pkg/celluloid-zmq-0.7.0.gem
-- pkg/celluloid-zmq-0.8.0.gem
+- logo.png
 - Rakefile
 - README.md
 - spec/celluloid/zmq/actor_spec.rb
 - spec/spec_helper.rb
 - .gitignore
-homepage: http://github.com/tarcieri/dcell
+homepage: http://github.com/celluloid/celluloid-zmq
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -120,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Celluloid::ZMQ provides concurrent Celluloid actors that can listen for 0MQ
@@ -129,4 +127,3 @@ test_files:
 - spec/celluloid/zmq/actor_spec.rb
 - spec/spec_helper.rb
 - .gitignore
-has_rdoc: