ffi-rxs 1.1.0 → 1.2.0

data/.gitignore

@@ -7,3 +7,4 @@ doc/*
 
 *.rbc
 .redcar/
+*~

data/CHANGELOG

@@ -1,3 +1,13 @@
+= Version 1.2.0
+
+  * Add new surveyor socket types
+  * Add new xs_shutdown function and Socket#shutdown method
+  * Add UTF-8 encoding string to spec files
+  * Amend description to refer to Crossroads I/O as a messaging library
+  * XS::Util is now a singleton class
+  * Util.error_check method is now public
+  * Handle return codes from xs_connect and xs_bind that are > 0 or < -1
+  
 = Version 1.1.0
 
   * Version number bumped to reflect addition of new features in v1.0.1

data/README.textile

@@ -1,8 +1,10 @@
 h1. About ffi-rxs
 
-This gem wraps the "Crossroads I/O":http://crossroads.io 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. That's all of them: MRI 1.9.x, Rubinius and JRuby.
+"!https://secure.travis-ci.org/celldee/ffi-rxs.png!":http://travis-ci.org/celldee/ffi-rxs
 
-Crossroads I/O is a fork of ZeroMQ. This gem is a re-working of the ffi-rzmq gem created by Chuck Remes to provide bindings for the Crossroads I/O libxs C library instead of the ZeroMQ libzmq library. The gem auto-configures itself to expose the API conforming to the loaded C library. 
+This gem wraps the "Crossroads I/O":http://crossroads.io messaging library (libxs) 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. That's all of them: MRI 1.9.x, Rubinius and JRuby.
+
+Crossroads I/O is a fork of ZeroMQ. This gem is a re-working of the "ffi-rzmq":http://github.com/chuckremes/ffi-rzmq gem created by Chuck Remes to provide bindings for the libxs library instead of the ZeroMQ libzmq library. 
 
 h2. Features/Problems
 
@@ -15,10 +17,15 @@ h2. Requirements
 * Crossroads I/O version 1.0.0 or later.
 * ffi (>= 1.0.0)
   
-The Crossroads I/O library must be installed on your system in a well-known location like /usr/local/lib. This is the default for new Crossroads I/O installs. Future releases may include the library as a C extension built at time of installation.
-  
-Do *not* run this gem under MRI with an old 'ffi' gem. It will crash randomly and you will be sad.
+The libxs library must be installed on your system in a well-known location like '/usr/local/lib'.
+
+Do *not* run this gem under MRI with an old 'ffi' gem. It will not work as expected.
 
+*NOTE*
+The master GitHub repository contains a copy of the libxs library in the 'ext' directory. This is so that the "Travis CI":http://travis-ci.org continuous integration build platform can be used. The .gemspec file excludes the 'ext' directory from the gem build.
+
+If you want to build a gem using a version of libxs other than your current system version, then you can include the library in the 'ext' directory. *Do not forget* to change the .gemspec file so that it does not exclude the library from the gem build.
+  
 h2. Installation
 
 A full gem has been released to Rubygems.org as of release 1.0.0. Make sure the Crossroads I/O library is already installed on your system.
@@ -48,7 +55,7 @@ ctx = XS::Context.create()
 socket = ctx.socket(XS::REQ)
 socket.connect("tcp://127.0.0.1:5000")
  
-for i in 1..10
+(1..10).each do |i|
   msg = "msg #{i.to_s}"
   socket.send_string(msg)
   puts "Sending: " + msg

data/examples/request.rb

@@ -15,7 +15,7 @@ ctx = XS::Context.create()
 socket = ctx.socket(XS::REQ)
 socket.connect("tcp://127.0.0.1:5000")
  
-for i in 1..10
+(1..10).each do |i|
   msg = "msg #{i.to_s}"
   socket.send_string(msg)
   puts "Sending: " + msg

data/ffi-rxs.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Chris Duncan"]
   s.email       = ["celldee@gmail.com"]
   s.homepage    = "http://github.com/celldee/ffi-rxs"
-  s.summary     = %q{Ruby FFI bindings for Crossroads I/O networking library.}
-  s.description = %q{Ruby FFI bindings for Crossroads I/O networking library.}
+  s.summary     = %q{Ruby FFI bindings for Crossroads I/O messaging library.}
+  s.description = %q{Ruby FFI bindings for Crossroads I/O messaging library.}
 
   s.files         = `git ls-files`.split("\n")
   s.files         = s.files.reject{ |f| f.include?('ext/libxs.so') }

data/lib/ffi-rxs/constants.rb

@@ -19,6 +19,11 @@ module XS
   PUSH = 8
   XPUB = 9
   XSUB = 10
+  SURVEYOR = 11
+  RESPONDENT = 12
+  XSURVEYOR = 13
+  XRESPONDENT = 14
+  
   DEALER = XREQ
   ROUTER = XREP
 
@@ -35,7 +40,11 @@ module XS
     ROUTER => "ROUTER",
     DEALER => "DEALER",
     XPUB => "XPUB",
-    XSUB => "XSUB"
+    XSUB => "XSUB",
+    SURVEYOR => "SURVEYOR",
+    RESPONDENT => "RESPONDENT",
+    XSURVEYOR => "XSURVEYOR",
+    XRESPONDENT => "XRESPONDENT"
   }
 
   # Socket options
@@ -63,6 +72,8 @@ module XS
   SNDTIMEO = 28
   IPV4ONLY = 31
   KEEPALIVE = 32
+  PROTOCOL = 33
+  SURVEY_TIMEOUT = 34
   
   # Message options
   MORE = 1

data/lib/ffi-rxs/context.rb

@@ -29,7 +29,6 @@ module XS
   #     STDERR.puts "Context allocation failed"
   #   end
   class Context
-    include XS::Util
 
     attr_reader :context, :pointer
 
@@ -43,7 +42,7 @@ module XS
       @sockets = []
       @context = LibXS.xs_init()
       @pointer = @context
-      error_check 'xs_init', (@context.nil? || @context.null?) ? -1 : 0
+      XS::Util.error_check 'xs_init', (@context.nil? || @context.null?) ? -1 : 0
 
       define_finalizer
     end

data/lib/ffi-rxs/libxs.rb

@@ -45,6 +45,8 @@ module XS
     @blocking = true
     attach_function :xs_setctxopt, [:pointer, :int, :pointer, :int], :int
     @blocking = true
+    attach_function :xs_shutdown, [:pointer, :int], :int
+    @blocking = true
     attach_function :xs_socket, [:pointer, :int], :pointer
     @blocking = true
     attach_function :xs_strerror, [:int], :pointer

data/lib/ffi-rxs/message.rb

@@ -84,7 +84,6 @@ module XS
   #   puts "value1 is #{message.value1}"
   #
   class Message
-    include XS::Util
     
     # Recommended way to create a standard message.
     #

data/lib/ffi-rxs/poll.rb

@@ -3,7 +3,6 @@
 module XS
 
   class Poller
-    include XS::Util
 
     attr_reader :readables, :writables
 

data/lib/ffi-rxs/socket.rb

@@ -3,7 +3,6 @@
 module XS
 
   module CommonSocketBehavior
-    include XS::Util
 
     attr_reader :socket, :name
 
@@ -184,6 +183,9 @@ module XS
     #   socket.bind("tcp://127.0.0.1:5555")
     #
     # @param address
+    #
+    # @return 0 or greater if successful
+    # @return < 0 if unsuccessful
     def bind address
       LibXS.xs_bind @socket, address
     end
@@ -195,10 +197,10 @@ module XS
     #
     # @param address
     #
-    # @return 0 if successful
-    # @return -1 if unsuccessful
+    # @return 0 or greater if successful
+    # @return < 0 if unsuccessful
     def connect address
-      rc = LibXS.xs_connect @socket, address
+      LibXS.xs_connect @socket, address
     end
 
     # Closes the socket. Any unprocessed messages in queue are sent or dropped
@@ -333,6 +335,19 @@ module XS
       message.close
       rc
     end
+    
+    # Unbinds/disconnects the socket from an endpoint.
+    #
+    # @example
+    #   socket.shutdown(endpoint_id)
+    #
+    # @param endpoint_id (endpoint id returned from socket.bind/socket.connect)
+    #
+    # @return 0 if successful
+    # @return -1 if unsuccessful
+    def shutdown endpoint_id
+      LibXS.xs_shutdown @socket, endpoint_id
+    end
 
     # Dequeues a message from the underlying queue. By default, this is a blocking operation.
     #

data/lib/ffi-rxs/util.rb

@@ -1,10 +1,9 @@
 # encoding: utf-8
 
 module XS
-
-  # These methods don't belong to any specific class. They get included
-  # in the #Context, #Socket and #Poller classes.
-  module Util
+  
+  # Provides general utility methods
+  class Util
 
     # @return true when +rc+ is greater than or equal to 0
     # @return false otherwise
@@ -63,23 +62,13 @@ module XS
       resultcode_ok?(rc) ? random : nil
     end
 
-
-    private
-
-    # Generate a random port between 10_000 and 65534
-    #
-    # @return port number
-    def self.random_port
-      rand(55534) + 10_000
-    end
-
-    # Called by most library methods to verify there were no errors during
-    # operation. If any are found, raise the appropriate #XSError.
+    # Called to verify there were no errors during operation. If any are found,
+    # raise the appropriate XSError.
     #
     # @return true when no error is found which is behavior used internally
     #   by #send and #recv.
-    def error_check source, result_code
-      if -1 == result_code
+    def self.error_check source, result_code
+      if result_code < 0
         raise_error source, result_code
       end
 
@@ -87,25 +76,31 @@ module XS
       true
     end
 
+    private
+
+    # Generate a random port between 10_000 and 65534
+    #
+    # @return port number
+    def self.random_port
+      rand(55534) + 10_000
+    end
+    
     # Raises error
     #
     # @param source
     # @param result_code
-    def raise_error source, result_code
-      if 'xs_init' == source || 'xs_socket' == source
+    def self.raise_error source, result_code
+      case source
+      when 'xs_init', 'xs_socket'
         raise ContextError.new source, result_code, XS::Util.errno, XS::Util.error_string
-
-      elsif ['xs_msg_init', 'xs_msg_init_data', 'xs_msg_copy', 'xs_msg_move'].include?(source)
+      when 'xs_msg_init', 'xs_msg_init_data', 'xs_msg_copy', 'xs_msg_move'
         raise MessageError.new source, result_code, XS::Util.errno, XS::Util.error_string
-
       else
-        puts "else"
-        raise XSError.new source, result_code, -1,
-        "Source [#{source}] does not match any xs_* strings, rc [#{result_code}], errno [#{XS::Util.errno}], error_string [#{XS::Util.error_string}]"
+        raise XSError.new source, result_code, XS::Util.errno, XS::Util.error_string
       end
     end
 
-    def eagain?
+    def self.eagain?
       EAGAIN == XS::Util.errno
     end
 

data/lib/ffi-rxs/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module XS
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/spec/context_spec.rb

@@ -1,4 +1,4 @@
-$: << "." # added for ruby 1.9.2 compatibilty; it doesn't include the current directory on the load path anymore
+# encoding: utf-8
 
 require File.join(File.dirname(__FILE__), %w[spec_helper])
 
@@ -59,11 +59,10 @@ module XS
     context "when setting context options" do
       include APIHelper
       
-      it "gets EINVAL when option name is not recognized" do
+      it "should return unsuccessful code when option name is not recognized" do
         ctx = Context.new
         rc = ctx.setctxopt(XS::IDENTITY, 10)
         Util.resultcode_ok?(rc).should be_false
-        XS::Util.errno.should == XS::EINVAL
       end
     end
     
@@ -74,14 +73,12 @@ module XS
         ctx = Context.new
         rc = ctx.setctxopt(XS::IO_THREADS, 0)
         Util.resultcode_ok?(rc).should be_false
-        XS::Util.errno.should == XS::EINVAL
       end
       
       it "should return unsuccessful code for negative io threads" do
         ctx = Context.new
         rc = ctx.setctxopt(XS::IO_THREADS, -1)
         Util.resultcode_ok?(rc).should be_false
-        XS::Util.errno.should == XS::EINVAL
       end
       
       it "should return successful code for positive io threads" do
@@ -105,7 +102,6 @@ module XS
         ctx = Context.new
         rc = ctx.setctxopt(XS::MAX_SOCKETS, -1)
         Util.resultcode_ok?(rc).should be_false
-        XS::Util.errno.should == XS::EINVAL
       end
       
       it "should return successful code for positive max sockets" do

data/spec/message_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 
 require File.join(File.dirname(__FILE__), %w[spec_helper])
 

data/spec/multipart_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require File.join(File.dirname(__FILE__), %w[spec_helper])
 
 module XS

data/spec/nonblocking_recv_spec.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 
 require File.join(File.dirname(__FILE__), %w[spec_helper])
 

data/spec/poll_spec.rb

@@ -1,4 +1,4 @@
-$: << "." # added for ruby 1.9.2 compatibilty; it doesn't include the current directory on the load path anymore
+# encoding: utf-8
 
 require File.join(File.dirname(__FILE__), %w[spec_helper])
 

data/spec/pushpull_spec.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 
 require File.join(File.dirname(__FILE__), %w[spec_helper])
 
@@ -61,7 +62,7 @@ module XS
             pull = @context.socket XS::PULL
             rc = pull.setsockopt XS::LINGER, 0
             rc = pull.connect @link
-            rc.should == 0
+            rc.should_not be < 0
             buffer = ''
             rc = pull.recv_string buffer
             rc.should == 11
@@ -86,7 +87,7 @@ module XS
         pull = @context.socket XS::PULL
         rc = pull.setsockopt XS::LINGER, 0
         rc = pull.connect @link
-        rc.should == 0
+        rc.should_not be < 0
         mutex = Mutex.new
 
         count.times do |i|

data/spec/reqrep_spec.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 
 require File.join(File.dirname(__FILE__), %w[spec_helper])
 

data/spec/socket_spec.rb

@@ -1,12 +1,12 @@
+# encoding: utf-8
 
 require File.join(File.dirname(__FILE__), %w[spec_helper])
 
 module XS
 
-
   describe Socket do
 
-    socket_types = [XS::REQ, XS::REP, XS::DEALER, XS::ROUTER, XS::PUB, XS::SUB, XS::PUSH, XS::PULL, XS::PAIR, XS::XPUB, XS::XSUB]
+    socket_types = [XS::REQ, XS::REP, XS::DEALER, XS::ROUTER, XS::PUB, XS::SUB, XS::PUSH, XS::PULL, XS::PAIR, XS::XPUB, XS::XSUB, XS::SURVEYOR, XS::XSURVEYOR, XS::RESPONDENT, XS::XRESPONDENT]
 
     context "when initializing" do
       before(:all) { @ctx = Context.new }
@@ -418,7 +418,7 @@ module XS
           socket.close
         end
 
-        if RUBY_PLATFORM =~ /linux|darwin/
+        if RUBY_PLATFORM =~ /linux|darwin|java/
           # this spec doesn't work on Windows; hints welcome
 
           context "using option XS::FD" do
@@ -467,12 +467,14 @@ module XS
 
         end # posix platform
 
-        context "using option XS::EVENTS" do
-          it "should return a mask of events as a Fixnum" do
-            array = []
-            rc = socket.getsockopt(XS::EVENTS, array)
-            rc.should == 0
-            array[0].should be_a(Fixnum)
+        unless XS::SocketTypeNameMap[socket_type] == 'SURVEYOR' # Feature not implemented yet
+          context "using option XS::EVENTS" do
+            it "should return a mask of events as a Fixnum" do
+              array = []
+              rc = socket.getsockopt(XS::EVENTS, array)
+              rc.should == 0
+              array[0].should be_a(Fixnum)
+            end
           end
         end
 
@@ -552,6 +554,41 @@ module XS
       end
 
     end # describe 'events mapping to pollin and pollout'
+    
+    socket_types.each do |socket_type|
+    
+      context "calling shutdown" do
+        before(:each) do
+          @ctx = Context.new
+          @socket = @ctx.socket socket_type
+        end
+
+        after(:each) do
+          @socket.close
+          @ctx.terminate
+        end
+        
+        it "unbinds #{XS::SocketTypeNameMap[socket_type]} socket" do
+          rc = @socket.bind("tcp://127.0.0.1:5555")
+          sleep 0.2
+          rc.should be > -1
+          rc = @socket.shutdown(rc)
+          sleep 0.2
+          rc.should == 0
+        end
+        
+        it "disconnects #{XS::SocketTypeNameMap[socket_type]} socket" do
+          rc = @socket.connect("tcp://127.0.0.1:5555")
+          sleep 0.2
+          rc.should be > -1
+          rc = @socket.shutdown(rc)
+          sleep 0.2
+          rc.should == 0
+        end
+    
+      end # context calling shutdown
+      
+    end
 
   end # describe Socket
 

data/spec/spec_helper.rb

@@ -1,7 +1,8 @@
+# encoding: utf-8
+
 # Execute 'rake spec' from the main directory to run all specs.
 
-require File.expand_path(
-File.join(File.dirname(__FILE__), %w[.. lib ffi-rxs]))
+require File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib ffi-rxs]))
 
 Thread.abort_on_exception = true
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ffi-rxs
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-30 00:00:00.000000000 Z
+date: 2012-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
-  requirement: &71177540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *71177540
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &71177190 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,15 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *71177190
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &71176920 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,8 +53,13 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *71176920
-description: Ruby FFI bindings for Crossroads I/O networking library.
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby FFI bindings for Crossroads I/O messaging library.
 email:
 - celldee@gmail.com
 executables: []
@@ -79,28 +94,16 @@ files:
 - ffi-rxs.gemspec
 - lib/ffi-rxs.rb
 - lib/ffi-rxs/constants.rb
-- lib/ffi-rxs/constants.rb~
 - lib/ffi-rxs/context.rb
-- lib/ffi-rxs/context.rb~
-- lib/ffi-rxs/device.rb~
 - lib/ffi-rxs/exceptions.rb
-- lib/ffi-rxs/exceptions.rb~
 - lib/ffi-rxs/libc.rb
-- lib/ffi-rxs/libc.rb~
 - lib/ffi-rxs/libxs.rb
-- lib/ffi-rxs/libxs.rb~
 - lib/ffi-rxs/message.rb
-- lib/ffi-rxs/message.rb~
 - lib/ffi-rxs/poll.rb
-- lib/ffi-rxs/poll.rb~
 - lib/ffi-rxs/poll_items.rb
-- lib/ffi-rxs/poll_items.rb~
 - lib/ffi-rxs/socket.rb
-- lib/ffi-rxs/socket.rb~
 - lib/ffi-rxs/util.rb
-- lib/ffi-rxs/util.rb~
 - lib/ffi-rxs/version.rb
-- lib/ffi-rxs/version.rb~
 - spec/context_spec.rb
 - spec/message_spec.rb
 - spec/multipart_spec.rb
@@ -130,9 +133,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Ruby FFI bindings for Crossroads I/O networking library.
+summary: Ruby FFI bindings for Crossroads I/O messaging library.
 test_files: []
-has_rdoc: