ffi-rzmq 0.5.1 → 0.6.0

data/spec/context_spec.rb

@@ -13,6 +13,14 @@ module ZMQ
       it "should raise an error for negative io threads" do
         lambda { Context.new(-1) }.should raise_exception(ZMQ::ContextError)
       end
+      
+      it "should default to requesting 1 i/o thread when no argument is passed" do
+        ctx = mock('ctx')
+        ctx.stub!(:null? => false)
+        LibZMQ.should_receive(:zmq_init).with(1).and_return(ctx)
+        
+        Context.new
+      end
 
       it "should set the :pointer accessor to non-nil" do
         ctx = Context.new 1
@@ -43,7 +51,7 @@ module ZMQ
         ctx.terminate
       end
 
-      it "should raise an exception when it fails" do
+      it "should raise a ZMQ::ContextError exception when it fails" do
         ctx = Context.new 1
         LibZMQ.stub(:zmq_term => 1)
         lambda { ctx.terminate }.should raise_error(ZMQ::ContextError)
@@ -57,7 +65,7 @@ module ZMQ
         ctx.socket(ZMQ::REQ).should be_kind_of(ZMQ::Socket)
       end
 
-      it "should raise an exception when allocation fails" do
+      it "should raise a ZMQ::SocketError exception when allocation fails" do
         ctx = Context.new 1
         Socket.stub(:new => nil)
         lambda { ctx.socket(ZMQ::REQ) }.should raise_error(ZMQ::SocketError)

data/spec/message_spec.rb

@@ -0,0 +1,42 @@
+
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+module ZMQ
+
+
+  describe Message do
+
+    context "when initializing with an argument" do
+      
+      it "should *not* define a finalizer on this object" do
+        ObjectSpace.should_not_receive(:define_finalizer)
+        Message.new "text"
+      end
+    end # context initializing
+
+
+    context "when copying in data" do
+      it "should raise a MessageError when the Message is being reused" do
+        message = Message.new "text"
+        lambda { message.copy_in_string("new text") }.should raise_error(MessageError)
+      end
+    end
+
+  end # describe Message
+  
+  
+  describe ManagedMessage do
+
+    context "when initializing with an argument" do
+      
+      it "should define a finalizer on this object" do
+        ObjectSpace.should_receive(:define_finalizer)
+        ManagedMessage.new "text"
+      end
+    end # context initializing
+
+
+  end # describe ManagedMessage
+
+
+end # module ZMQ

data/spec/pushpull_spec.rb

@@ -0,0 +1,70 @@
+
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+module ZMQ
+  describe Context do
+    context "when running basic push pull" do
+      include APIHelper
+
+      let(:string) { "booga-booga" }
+
+      before(:each) do
+        $stdout.flush
+        @context = ZMQ::Context.new 1
+        @push = @context.socket ZMQ::PUSH
+        @pull = @context.socket ZMQ::PULL
+        @link = "tcp://127.0.0.1:#{random_port}"
+        @pull.connect @link
+        @push.bind    @link
+      end
+
+      it "should receive an exact copy of the sent message using Message objects directly on one pull socket" do
+        @push.send_string string
+        received = @pull.recv_string
+        received.should == string
+      end
+       
+      it "should receive an exact string copy of the message sent when receiving in non-blocking mode and using Message objects directly" do
+        sent_message = Message.new string
+        received_message = Message.new
+
+        @push.send sent_message
+        sleep 0.1 # give it time for delivery
+        @pull.recv received_message, ZMQ::NOBLOCK
+        received_message.copy_out_string.should == string
+      end
+
+      it "should receive an exact string copy of the message sent when sending in non-blocking mode and using Message objects directly" do
+        sent_message = Message.new string
+        received_message = Message.new
+
+        @push.send sent_message, ZMQ::NOBLOCK
+        sleep 0.1 # give it time for delivery
+        @pull.recv received_message, ZMQ::NOBLOCK
+        received_message.copy_out_string.should == string
+      end
+
+      it "should receive a single message for each message sent on each socket listening, when an equal number pulls to messages" do
+        received = []
+        threads  = []
+        count    = 4
+         
+        count.times {
+          threads << Thread.new {
+            pull = @context.socket ZMQ::PULL
+            pull.connect @link
+            received << pull.recv_string
+            pull.close
+          }
+        }
+        
+        count.times { @push.send_string(string); sleep 0.001 }
+        
+        threads.each {|t| t.join}
+        
+        received.find_all {|r| r == string}.length.should == count
+      end
+      
+    end # @context ping-pong
+  end # describe
+end # module ZMQ

data/spec/socket_spec.rb

@@ -9,7 +9,7 @@ module ZMQ
     context "when initializing" do
 
       let(:ctx) { Context.new 1 }
-      
+
       it "should raise an error for a nil context" do
         lambda { Socket.new(FFI::Pointer::NULL, ZMQ::REQ) }.should raise_exception(ZMQ::ContextError)
       end
@@ -54,9 +54,13 @@ module ZMQ
         lambda { Socket.new(ctx.pointer, 80) }.should raise_exception(ZMQ::SocketError)
       end
 
-      it "should set the :socket accessor to non-nil" do
-        sock = Socket.new(Context.new(1).pointer, ZMQ::REQ)
-        sock.socket.should_not be_nil
+      it "should set the :socket accessor to the raw socket allocated by libzmq" do
+        socket = mock('socket')#.as_null_object
+        socket.stub!(:null? => false)
+        LibZMQ.should_receive(:zmq_socket).and_return(socket)
+
+        sock = Socket.new(ctx.pointer, ZMQ::REQ)
+        sock.socket.should == socket
       end
 
       it "should define a finalizer on this object" do
@@ -65,47 +69,222 @@ module ZMQ
         ctx = Context.new 1
       end
     end # context initializing
-    
-    
+
+
     context "identity=" do
       it "should raise an exception for identities in excess of 255 bytes" do
         ctx = Context.new 1
         sock = Socket.new ctx.pointer, ZMQ::REQ
-        
+
         lambda { sock.identity = ('a' * 256) }.should raise_exception(ZMQ::SocketError)
       end
 
       it "should raise an exception for identities of length 0" do
         ctx = Context.new 1
         sock = Socket.new ctx.pointer, ZMQ::REQ
-        
+
         lambda { sock.identity = '' }.should raise_exception(ZMQ::SocketError)
       end
 
       it "should NOT raise an exception for identities of 1 byte" do
         ctx = Context.new 1
         sock = Socket.new ctx.pointer, ZMQ::REQ
-        
+
         lambda { sock.identity = 'a' }.should_not raise_exception(ZMQ::SocketError)
       end
 
       it "should NOT raise an exception for identities of 255 bytes" do
         ctx = Context.new 1
         sock = Socket.new ctx.pointer, ZMQ::REQ
-        
+
         lambda { sock.identity = ('a' * 255) }.should_not raise_exception(ZMQ::SocketError)
       end
 
       it "should convert numeric identities to strings" do
         ctx = Context.new 1
         sock = Socket.new ctx.pointer, ZMQ::REQ
-        
+
         sock.identity = 7
         sock.identity.should == '7'
       end
     end # context identity=
-    
-    
+
+
+    [ZMQ::REQ, ZMQ::REP, ZMQ::XREQ, ZMQ::XREP, ZMQ::PUB, ZMQ::SUB, ZMQ::PUSH, ZMQ::PULL, ZMQ::PAIR].each do |socket_type|
+
+      context "#setsockopt for a #{ZMQ::SocketTypeNameMap[socket_type]} socket" do
+        let(:socket) do
+          ctx = Context.new
+          Socket.new ctx.pointer, socket_type
+        end
+
+
+        context "using option ZMQ::SUBSCRIBE" do
+          if ZMQ::SUB == socket_type
+            it "should *not* raise a ZMQ::SocketError" do
+              lambda { socket.setsockopt(ZMQ::SUBSCRIBE, "topic.string") }.should_not raise_error(SocketError)
+            end
+          else
+            it "should raise a ZMQ::SocketError" do
+              lambda { socket.setsockopt(ZMQ::SUBSCRIBE, "topic.string") }.should raise_error(SocketError)
+            end
+          end
+        end # context using option ZMQ::SUBSCRIBE
+
+
+        context "using option ZMQ::UNSUBSCRIBE" do
+          if ZMQ::SUB == socket_type
+            it "should *not* raise a ZMQ::SocketError given a topic string that was previously subscribed" do
+              socket.setsockopt ZMQ::SUBSCRIBE, "topic.string"
+              lambda { socket.setsockopt(ZMQ::UNSUBSCRIBE, "topic.string") }.should_not raise_error(SocketError)
+            end
+
+            it "should raise a ZMQ::SocketError given a topic string that was never subscribed" do
+              socket.setsockopt ZMQ::SUBSCRIBE, "topic.string"
+              lambda { socket.setsockopt(ZMQ::UNSUBSCRIBE, "unknown") }.should raise_error(SocketError)
+            end
+          else
+            it "should raise a ZMQ::SocketError" do
+              lambda { socket.setsockopt(ZMQ::UNSUBSCRIBE, "topic.string") }.should raise_error(SocketError)
+            end
+          end
+        end # context using option ZMQ::UNSUBSCRIBE
+
+
+        context "using option ZMQ::HWM" do
+          it "should set the high water mark given a positive value" do
+            hwm = 4
+            socket.setsockopt ZMQ::HWM, hwm
+            socket.getsockopt(ZMQ::HWM).should == hwm
+          end
+
+          it "should convert a negative value to a positive value" do
+            hwm = -4
+            socket.setsockopt ZMQ::HWM, hwm
+            socket.getsockopt(ZMQ::HWM).should == hwm.abs
+          end
+        end # context using option ZMQ::HWM
+
+
+#        context "using option ZMQ::SWAP" do
+#          it "should set the swap value given a positive value" do
+#            swap = 10_000
+#            socket.setsockopt ZMQ::SWAP, swap
+#            socket.getsockopt(ZMQ::SWAP).should == swap
+#          end
+#
+#          it "should raise a SocketError given a negative value" do
+#            swap = -10_000
+#            lambda { socket.setsockopt(ZMQ::SWAP, swap) }.should raise_error(SocketError)
+#          end
+#        end # context using option ZMQ::SWP
+
+
+        context "using option ZMQ::AFFINITY" do
+          it "should set the affinity value given a positive value" do
+            affinity = 3
+            socket.setsockopt ZMQ::AFFINITY, affinity
+            socket.getsockopt(ZMQ::AFFINITY).should == affinity
+          end
+
+          it "should set the affinity value as a positive value given a negative value" do
+            affinity = -3
+            socket.setsockopt ZMQ::AFFINITY, affinity
+            socket.getsockopt(ZMQ::AFFINITY).should == affinity.abs
+          end
+        end # context using option ZMQ::AFFINITY
+        
+        
+        context "using option ZMQ::IDENTITY" do
+          it "should set the identity given any string under 255 characters" do
+            (1..255).each do |length|
+              identity = 'a' * length
+              socket.setsockopt ZMQ::IDENTITY, identity
+              socket.getsockopt(ZMQ::IDENTITY).should == identity
+            end
+          end
+          
+          it "should raise a SocketError given a string 256 characters or longer" do
+            identity = 'a' * 256
+            lambda { socket.setsockopt(ZMQ::IDENTITY, identity) }.should raise_error(SocketError)
+          end
+        end # context using option ZMQ::IDENTITY
+        
+        
+#        context "using option ZMQ::RATE" do
+#          it "should set the multicast send rate given a positive value" do
+#            rate = 200
+#            socket.setsockopt ZMQ::RATE, rate
+#            socket.getsockopt(ZMQ::RATE).should == rate
+#          end
+#
+#          it "should raise a SocketError given a negative value" do
+#            rate = -200
+#            lambda { socket.setsockopt ZMQ::RATE, rate }.should raise_error(SocketError)
+#          end
+#        end # context using option ZMQ::RATE
+#        
+#        
+#        context "using option ZMQ::RECOVERY_IVL" do
+#          it "should set the multicast recovery buffer measured in seconds given a positive value" do
+#            rate = 200
+#            socket.setsockopt ZMQ::RECOVERY_IVL, rate
+#            socket.getsockopt(ZMQ::RECOVERY_IVL).should == rate
+#          end
+#
+#          it "should raise a SocketError given a negative value" do
+#            rate = -200
+#            lambda { socket.setsockopt ZMQ::RECOVERY_IVL, rate }.should raise_error(SocketError)
+#          end
+#        end # context using option ZMQ::RECOVERY_IVL
+        
+        
+        context "using option ZMQ::MCAST_LOOP" do
+          it "should enable the multicast loopback given a true value" do
+            socket.setsockopt ZMQ::MCAST_LOOP, true
+            socket.getsockopt(ZMQ::MCAST_LOOP).should be_true
+          end
+
+          it "should disable the multicast loopback given a false value" do
+            socket.setsockopt ZMQ::MCAST_LOOP, false
+            socket.getsockopt(ZMQ::MCAST_LOOP).should be_false
+          end
+        end # context using option ZMQ::MCAST_LOOP
+        
+        
+        context "using option ZMQ::SNDBUF" do
+          it "should set the OS send buffer given a positive value" do
+            size = 100
+            socket.setsockopt ZMQ::SNDBUF, size
+            socket.getsockopt(ZMQ::SNDBUF).should == size
+          end
+
+          it "should set the OS send buffer to a positive value given a false value" do
+            size = -100
+            socket.setsockopt ZMQ::SNDBUF, size
+            socket.getsockopt(ZMQ::SNDBUF).should == size.abs
+          end
+        end # context using option ZMQ::SNDBUF
+        
+        
+        context "using option ZMQ::RCVBUF" do
+          it "should set the OS receive buffer given a positive value" do
+            size = 100
+            socket.setsockopt ZMQ::RCVBUF, size
+            socket.getsockopt(ZMQ::RCVBUF).should == size
+          end
+
+          it "should set the OS receive buffer to a positive value given a false value" do
+            size = -100
+            socket.setsockopt ZMQ::RCVBUF, size
+            socket.getsockopt(ZMQ::RCVBUF).should == size.abs
+          end
+        end # context using option ZMQ::RCVBUF
+      end # context #setsockopt
+
+    end # each socket_type
+
+
   end # describe Socket
 
 

data/spec/spec_helper.rb

@@ -5,6 +5,8 @@
 require File.expand_path(
 File.join(File.dirname(__FILE__), %w[.. lib ffi-rzmq]))
 
+Thread.abort_on_exception = true
+
 # turns off all warnings; added so I don't have to see the warnings
 # for included libraries like FFI.
 $VERBOSE = false

data/version.txt

@@ -1 +1 @@
-0.5.1
+0.6.0

metadata

@@ -3,39 +3,40 @@ name: ffi-rzmq
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
-    - 0
-    - 5
-    - 1
-  version: 0.5.1
+  - 0
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
 authors: 
-  - Chuck Remes
+- Chuck Remes
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-08-30 00:00:00 -05:00
+date: 2010-09-21 00:00:00 -05:00
 default_executable: 
 dependencies: 
-  - !ruby/object:Gem::Dependency 
-    name: bones
-    prerelease: false
-    requirement: &id001 !ruby/object:Gem::Requirement 
-      requirements: 
-        - - ">="
-          - !ruby/object:Gem::Version 
-            segments: 
-              - 3
-              - 4
-              - 7
-            version: 3.4.7
-    type: :development
-    version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bones
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 4
+        - 7
+        version: 3.4.7
+  type: :development
+  version_requirements: *id001
 description: |-
   This gem wraps the ZeroMQ networking library using the ruby FFI (foreign
   function interface). It's a pure ruby wrapper so this gem can be loaded
-  and run by any ruby runtime that supports FFI. Right now that means
-  MRI 1.9.x and JRuby.
+  and run by any ruby runtime that supports FFI. That's all of them:
+  MRI 1.8.7+, 1.9.x, Rubinius and JRuby.
   
   The impetus behind this library was to provide support for ZeroMQ in
   JRuby which has native threads. Unlike MRI, MacRuby, IronRuby and
@@ -49,67 +50,73 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-  - History.txt
-  - README.rdoc
-  - version.txt
+- History.txt
+- README.rdoc
+- examples/README.rdoc
+- version.txt
 files: 
-  - .bnsignore
-  - History.txt
-  - README.rdoc
-  - Rakefile
-  - examples/async_req_rep.rb
-  - examples/local_lat.rb
-  - examples/local_lat_zerocopy.rb
-  - examples/publish_subscribe.rb
-  - examples/remote_lat.rb
-  - examples/remote_lat_zerocopy.rb
-  - examples/reqrep_poll.rb
-  - examples/request_response.rb
-  - examples/t
-  - examples/xreqxrep_poll.rb
-  - ffi-rzmq.gemspec
-  - lib/ffi-rzmq.rb
-  - lib/ffi-rzmq/context.rb
-  - lib/ffi-rzmq/exceptions.rb
-  - lib/ffi-rzmq/message.rb
-  - lib/ffi-rzmq/poll.rb
-  - lib/ffi-rzmq/poll_items.rb
-  - lib/ffi-rzmq/socket.rb
-  - lib/ffi-rzmq/wrapper.rb
-  - lib/ffi-rzmq/zmq.rb
-  - spec/context_spec.rb
-  - spec/reqrep_spec.rb
-  - spec/socket_spec.rb
-  - spec/spec_helper.rb
-  - version.txt
+- .gitignore
+- History.txt
+- README.rdoc
+- Rakefile
+- examples/README.rdoc
+- examples/local_lat.rb
+- examples/local_lat_zerocopy.rb
+- examples/local_throughput.rb
+- examples/publish_subscribe.rb
+- examples/remote_lat.rb
+- examples/remote_lat_zerocopy.rb
+- examples/remote_throughput.rb
+- examples/reqrep_poll.rb
+- examples/request_response.rb
+- examples/xreqxrep_poll.rb
+- ffi-rzmq.gemspec
+- lib/ffi-rzmq.rb
+- lib/ffi-rzmq/context.rb
+- lib/ffi-rzmq/exceptions.rb
+- lib/ffi-rzmq/message.rb
+- lib/ffi-rzmq/poll.rb
+- lib/ffi-rzmq/poll_items.rb
+- lib/ffi-rzmq/socket.rb
+- lib/ffi-rzmq/wrapper.rb
+- lib/ffi-rzmq/zmq.rb
+- spec/context_spec.rb
+- spec/message_spec.rb
+- spec/pushpull_spec.rb
+- spec/reqrep_spec.rb
+- spec/socket_spec.rb
+- spec/spec_helper.rb
+- version.txt
 has_rdoc: true
 homepage: http://github.com/chuckremes/ffi-rzmq
 licenses: []
 
 post_install_message: 
 rdoc_options: 
-  - --main
-  - README.rdoc
+- --main
+- README.rdoc
 require_paths: 
-  - lib
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-          - 0
-        version: "0"
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-          - 0
-        version: "0"
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: ffi-rzmq
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: This gem wraps the ZeroMQ networking library using the ruby FFI (foreign function interface)