ffi-rxs 1.0.0 → 1.0.1

data/lib/ffi-rxs/util.rb

@@ -1,39 +1,42 @@
+# 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
 
-    # Returns true when +rc+ is greater than or equal to 0, false otherwise.
+    # @return true when +rc+ is greater than or equal to 0
+    # @return false otherwise
     #
     # We use the >= test because xs_poll() returns the number of sockets
     # that had a read or write event triggered. So, a >= 0 result means
     # it succeeded.
-    #
     def self.resultcode_ok? rc
       rc >= 0
     end
 
-    # Returns the +errno+ as set by the libxs library.
+    # Returns error number
     #
+    # @return errno as set by the libxs library.
     def self.errno
       LibXS.xs_errno
     end
 
-    # Returns a string corresponding to the currently set #errno. These
-    # error strings are defined by libxs.
-    #
+    # Returns error string
+    # 
+    # @return string corresponding to the currently set #errno. These
+    #   error strings are defined by libxs.
     def self.error_string
       LibXS.xs_strerror(errno).read_string
     end
 
-    # Returns an array of the form [major, minor, patch] to represent the
-    # version of libxs.
+    # Returns libxs version number
     #
-    # Class method! Invoke as:  XS::Util.version
+    # @return array of the form [major, minor, patch] to represent the
+    #   version of libxs
     #
+    # Class method! Invoke as:  XS::Util.version
     def self.version
       major = FFI::MemoryPointer.new :int
       minor = FFI::MemoryPointer.new :int
@@ -43,8 +46,10 @@ module XS
     end
 
     # Attempts to bind to a random tcp port on +host+ up to +max_tries+
-    # times. Returns the port number upon success or nil upon failure.
+    # times. 
     #
+    # @return port number upon success
+    # @return nil upon failure
     def self.bind_to_random_tcp_port host = '127.0.0.1', max_tries = 500
       tries = 0
       rc = -1
@@ -61,18 +66,18 @@ module XS
 
     private
 
-    # generate a random port between 10_000 and 65534
+    # Generate a random port between 10_000 and 65534
+    #
+    # @return port number
     def self.random_port
       rand(55534) + 10_000
     end
 
-    # :doc:
     # Called by most library methods to verify there were no errors during
     # operation. If any are found, raise the appropriate #XSError.
     #
-    # When no error is found, this method returns +true+ which is behavior
-    # used internally by #send and #recv.
-    #
+    # @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
         raise_error source, result_code
@@ -82,6 +87,10 @@ module XS
       true
     end
 
+    # Raises error
+    #
+    # @param source
+    # @param result_code
     def raise_error source, result_code
       if 'xs_init' == source || 'xs_socket' == source
         raise ContextError.new source, result_code, XS::Util.errno, XS::Util.error_string

data/lib/ffi-rxs/version.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module XS
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/ffi-rxs.rb

@@ -1,21 +1,18 @@
+# encoding: utf-8
 
 module XS
 
-  # :stopdoc:
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
-  # :startdoc:
 
-  # Returns the version string for the library.
-  #
+  # Returns the version string for the library.  
   def self.version
     @version ||= File.read(path('version.txt')).strip
   end
 
   # Returns the library path for the module. If any arguments are given,
-  # they will be joined to the end of the libray path using
-  # <tt>File.join</tt>.
-  #
+  # they will be joined to the end of the library path using
+  # _File.join_.
   def self.libpath( *args, &block )
     rv =  args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
     if block
@@ -31,8 +28,7 @@ module XS
 
   # Returns the lpath for the module. If any arguments are given,
   # they will be joined to the end of the path using
-  # <tt>File.join</tt>.
-  #
+  # _File.join_. 
   def self.path( *args, &block )
     rv = args.empty? ? PATH : ::File.join(PATH, args.flatten)
     if block
@@ -50,7 +46,6 @@ module XS
   # directory below this file that has the same name as the filename passed
   # in. Optionally, a specific _directory_ name can be passed in such that
   # the _filename_ does not have to be equivalent to the directory.
-  #
   def self.require_all_libs_relative_to( fname, dir = nil )
     dir ||= ::File.basename(fname, '.*')
     search_me = ::File.expand_path(
@@ -61,14 +56,13 @@ module XS
 
 end  # module XS
 
-# some code is conditionalized based upon what ruby engine we are
-# executing
-
+# Conditional code execution depending upon which ruby engine we are
+# using
 RBX = defined?(RUBY_ENGINE) && RUBY_ENGINE =~ /rbx/ ? true : false
 
 require 'ffi' unless RBX
 
-# the order of files is important
+# The order that files are required in is important
 %w(libc libxs constants util exceptions context message socket poll_items poll).each do |file|
   require XS.libpath(['ffi-rxs', file])
 end

data/spec/socket_spec.rb

@@ -340,6 +340,69 @@ module XS
             array[0].should == value
           end
         end # context using option XS::BACKLOG
+        
+        
+        context "using option XS::KEEPALIVE" do
+          it "should enable use of protocol keepalives if set to 1" do
+            value = 1
+            socket.setsockopt XS::KEEPALIVE, value
+            array = []
+            rc = socket.getsockopt(XS::KEEPALIVE, array)
+            rc.should == 0
+            array[0].should == value
+          end
+
+          it "should default to a value of 0" do
+            value = 0
+            array = []
+            rc = socket.getsockopt(XS::KEEPALIVE, array)
+            rc.should == 0
+            array[0].should == value
+          end
+          
+          it "returns -1 given a negative value" do
+            value = -1
+            rc = socket.setsockopt XS::KEEPALIVE, value
+            rc.should == -1
+          end
+          
+          it "returns -1 given a value > 1" do
+            value = 2
+            rc = socket.setsockopt XS::KEEPALIVE, value
+            rc.should == -1
+          end
+        end # context using option XS::KEEPALIVE
+        
+        context "using option XS::IPV4ONLY" do
+          it "should enable use of IPV6 sockets when set to 0" do
+            value = 0
+            socket.setsockopt XS::IPV4ONLY, value
+            array = []
+            rc = socket.getsockopt(XS::IPV4ONLY, array)
+            rc.should == 0
+            array[0].should == value
+          end
+
+          it "should default to a value of 1" do
+            value = 1
+            array = []
+            rc = socket.getsockopt(XS::IPV4ONLY, array)
+            rc.should == 0
+            array[0].should == value
+          end
+          
+          it "returns -1 given a negative value" do
+            value = -1
+            rc = socket.setsockopt XS::IPV4ONLY, value
+            rc.should == -1
+          end
+          
+          it "returns -1 given a value > 1" do
+            value = 2
+            rc = socket.setsockopt XS::IPV4ONLY, value
+            rc.should == -1
+          end
+        end # context using option XS::IPV4ONLY
       end # context #setsockopt
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ffi-rxs
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-27 00:00:00.000000000 Z
+date: 2012-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
-  requirement: &83395810 !ruby/object:Gem::Requirement
+  requirement: &73901550 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *83395810
+  version_requirements: *73901550
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &83413290 !ruby/object:Gem::Requirement
+  requirement: &73901000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *83413290
+  version_requirements: *73901000
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &83412730 !ruby/object:Gem::Requirement
+  requirement: &73900740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,15 +43,8 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *83412730
-description: ! 'This gem wraps the Crossroads I/O 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.'
+  version_requirements: *73900740
+description: Ruby FFI bindings for Crossroads I/O networking library.
 email:
 - celldee@gmail.com
 executables: []
@@ -59,10 +52,29 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
+- .yardopts
 - AUTHORS.txt
+- CHANGELOG
 - Gemfile
-- README.rdoc
+- LICENSE
+- README.textile
 - Rakefile
+- examples/LICENSE
+- examples/README
+- examples/durable_pub.rb
+- examples/durable_sub.rb
+- examples/latency_measurement.rb
+- examples/reply.rb
+- examples/req_rep_poll.rb
+- examples/request.rb
+- examples/task_sink.rb
+- examples/task_vent.rb
+- examples/task_worker.rb
+- examples/throughput_measurement.rb
+- examples/weather_upd_client.rb
+- examples/weather_upd_server.rb
+- examples/xreq_xrep_poll.rb
 - ext/README
 - ffi-rxs.gemspec
 - lib/ffi-rxs.rb
@@ -121,6 +133,6 @@ rubyforge_project:
 rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
-summary: This gem wraps the Crossroads I/O networking library using Ruby FFI (foreign
-  function interface).
+summary: Ruby FFI bindings for Crossroads I/O networking library.
 test_files: []
+has_rdoc: 

data/README.rdoc

@@ -1,86 +0,0 @@
-ffi-rxs
-    by Chris Duncan
-
-== DESCRIPTION:
-
-This gem wraps the Crossroads I/O 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.
-
-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. 
-
-== FEATURES/PROBLEMS:
-
-This gem needs to be tested in the wild. Please kick its tyres and give it a
-good thrashing. It is inevitable that bugs will be discovered, so please open 
-issues for them here or fork this project, fix them, and send me a pull
-request.
-
-The 'ffi' gem has dropped support for MRI 1.8.x. Since this project relies
-on that gem to load and run this code, then this project does not support
-MRI 1.8.x. I recommend JRuby for the best performance and stability.
-
-== REQUIREMENTS:
-
-  * Crossroads I/O version 1.0.0 or later.
-  
-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.
-
-  * ffi (>= 1.0.0)
-  
-Do *not* run this gem under MRI with an old 'ffi' gem. It will crash randomly and
-you will be sad.
-
-== INSTALL:
-
-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.
-
- % gem install ffi-rxs # should grab the latest release
-
-
-To build from git master:
-
- % git clone git://github.com/celldee/ffi-rxs
- % cd ffi-rxs
- % gem build ffi-rxs.gemspec
- % gem install ffi-rxs-*.gem
- 
-
-NOTE for Windows users!
-In order for this gem to find the libxs.dll, it *must* be on the Windows PATH. Google
-for "modify windows path" for instructions on how to do that if you are unfamiliar with
-that activity.
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2011 - 2012 Chuck Remes, Chris Duncan and contributors
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.