nn-core 0.1.6 → 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aec634c40b00d3f8dc8301ee40777c9943d069d6
+  data.tar.gz: 23b6f3ea3d5327711e0f1ba2ec971f9f904d4d2f
+SHA512:
+  metadata.gz: 171ba1be554febe2101e3253094c722e9124f1da03b870427a7e062b470ab1f9eb955f22e0387e1081bb9ef9ef7fed402321de1172b068213276455a40d753ea
+  data.tar.gz: 7e969d818f3044048f9721250cb15a9cc5c1682cefbea62e322f7e3f31b2f04bbc3192611a475aec0b0390c95c4bc7c67e3e21ac3117006fb7d3bc24dd62af77

data/History.txt

@@ -1,3 +1,12 @@
+20130327 / 0.2.0
+	* Support nn_symbol function for setting up all constants in the binding.
+	
+	* Remove support for nn_version function.
+	
+	* Change #attach_function calls to use options hash for :blocking => true.
+	  This is cleaner and less noisy than all of the "@blocking = true" lines
+		before the #attach_function call.
+
 20130220 / 0.1.6
 	* Several fixes for tcp string handling have made it to nanomsg trunk,
 		so I can now re-enable those specs.

data/lib/nn-core/constants.rb

@@ -1,88 +1,26 @@
 module NNCore
-  NN_HAUSNUMERO = 156384712
 
-  # SP address families
-  AF_SP = 1
-  AF_SP_RAW = 2
-
-  # Transport types
-  NN_INPROC = -1
-  NN_IPC = -2
-  NN_TCP = -3
-
-  # Protocols
-  NN_PAIR_ID = 1
-  NN_PAIR = (NN_PAIR_ID * 16 + 0)
-
-  NN_PUBSUB_ID = 2
-  NN_PUB = (NN_PUBSUB_ID * 16 + 0)
-  NN_SUB = (NN_PUBSUB_ID * 16 + 1)
-
-  NN_REQREP_ID = 3
-  NN_REQ = (NN_REQREP_ID * 16 + 0)
-  NN_REP = (NN_REQREP_ID * 16 + 1)
-
-  NN_FANIN_ID = 4
-  NN_SOURCE = (NN_FANIN_ID * 16 + 0)
-  NN_SINK = (NN_FANIN_ID * 16 + 1)
-  NN_FANOUT_ID = 5
-  NN_PUSH = (NN_FANOUT_ID * 16 + 0)
-  NN_PULL = (NN_FANOUT_ID * 16 + 1)
-
-  NN_SURVEY_ID = 6
-  NN_SURVEYOR = (NN_SURVEY_ID * 16 + 0)
-  NN_RESPONDENT = (NN_SURVEY_ID * 16 + 1)
+  # To simplify management of constants in language bindings that cannot
+  # parse or directly utilize a C header file, the library provides the
+  # nn_symbol function. This function returns a string and an integer 
+  # value so that bindings authors can easily setup all constants and 
+  # their values without worrying about copy/paste or transcription
+  # errors every time the underlying library is changed.
+  #
+  # For documentation on all possible constants, please refer to the
+  # man pages at nanomsg.org
+  #
+  index = 0
+  while true
+    value = FFI::MemoryPointer.new(:int)
+
+    constant_string = LibNanomsg.nn_symbol(index, value)
+    break if constant_string.nil?
+
+    const_set(constant_string, value.read_int)
+    index += 1
+  end
   
-  NN_BUS_ID = 7
-  NN_BUS = (NN_BUS_ID * 16 + 0)
-
-  # Socket Option Levels (SOL)
-  NN_SOL_SOCKET = 0
-
-  # Socket options
-  NN_LINGER = 1
-  NN_SNDBUF = 2
-  NN_RCVBUF = 3
-  NN_SNDTIMEO = 4
-  NN_RCVTIMEO = 5
-  NN_RECONNECT_IVL = 6
-  NN_RECONNECT_IVL_MAX = 7
-  NN_SNDPRIO = 8
-  #NN_SNDFD = 10
-  #NN_RCVFD = 11
-
-  # Send/recv options
-  NN_DONTWAIT = 1
+  # This constant is not exported by nn_symbol. It is also of type size_t.
   NN_MSG = -1
-
-  # Socket errors
-  ENOTSUP = Errno::ENOTSUP::Errno rescue NN_HAUSNUMERO + 1
-  EPROTONOSUPPORT = Errno::EPROTONOSUPPORT::Errno rescue NN_HAUSNUMERO + 2
-  ENOBUFS = Errno::ENOBUFS::Errno rescue NN_HAUSNUMERO + 3
-  ENETDOWN = Errno::ENETDOWN::Errnow rescue NN_HAUSNUMERO + 4
-  EADDRINUSE = Errno::EADDRINUSE::Errno rescue NN_HAUSNUMERO + 5
-  EADDRNOTAVAIL = Errno::EADDRNOTAVAIL::Errno rescue NN_HAUSNUMERO + 6
-  ECONNREFUSED = Errno::ECONNREFUSED::Errno rescue NN_HAUSNUMERO + 7
-  EINPROGRESS = Errno::EINPROGRESS::Errno rescue NN_HAUSNUMERO + 8
-  ENOTSOCK = Errno::ENOTSOCK::Errno rescue NN_HAUSNUMERO + 9
-  EAFNOSUPPORT = Errno::EAFNOSUPPORT::Errno rescue NN_HAUSNUMERO + 10
-  EPROTO = Errno::EPROTO::Errno rescue NN_HAUSNUMERO + 11
-  
-  ETIMEDOUT = Errno::ETIMEDOUT::Errno
-  EAGAIN = Errno::EAGAIN::Errno
-  EINVAL = Errno::EINVAL::Errno
-  ENOMEM = Errno::ENOMEM::Errno
-  ENODEV = Errno::ENODEV::Errno
-  EFAULT = Errno::EFAULT::Errno
-  #  EINTR  = Errno::EINTR::Errno
-  EBADF = Errno::EBADF::Errno
-  ENOPROTOOPT = Errno::ENOPROTOOPT::Errno
-  ENAMETOOLONG = Errno::ENAMETOOLONG::Errno
-
-  # Library errors
-  ETERM = Errno::ETERM::Errno rescue NN_HAUSNUMERO + 53
-  EFSM = Errno::EFSM::Errno rescue NN_HAUSNUMERO + 54
-
-  # Miscellaneous
-  NN_SOCKADDR_MAX = 128
 end

data/lib/nn-core/libnanomsg.rb

@@ -33,41 +33,26 @@ module NNCore
     # Size_t not working properly on Windows
     find_type(:size_t) rescue typedef(:ulong, :size_t)
 
-    @blocking = true
-    attach_function :nn_version, [:pointer, :pointer, :pointer], :int
+    attach_function :nn_symbol, [:int, :pointer], :string, :blocking => true
     
-    @blocking = true
-    attach_function :nn_errno, [], :int
-    @blocking = true
-    attach_function :nn_strerror, [:int], :string
-    @blocking = true
-    attach_function :nn_socket, [:int, :int], :int
-    @blocking = true
-    attach_function :nn_close, [:int], :int
+    attach_function :nn_errno, [], :int, :blocking => true
+    attach_function :nn_strerror, [:int], :string, :blocking => true
+    attach_function :nn_socket, [:int, :int], :int, :blocking => true
+    attach_function :nn_close, [:int], :int, :blocking => true
     
-    @blocking = true
-    attach_function :nn_getsockopt, [:int, :int, :int, :pointer, :pointer], :int
-    @blocking = true
-    attach_function :nn_setsockopt, [:int, :int, :int, :pointer, :size_t], :int
-    @blocking = true
-    attach_function :nn_bind, [:int, :string], :int
-    @blocking = true
-    attach_function :nn_connect, [:int, :string], :int
-    @blocking = true
-    attach_function :nn_shutdown, [:int, :int], :int
-    @blocking = true
-    attach_function :nn_send, [:int, :pointer, :size_t, :int], :int
-    @blocking = true
-    attach_function :nn_recv, [:int, :pointer, :size_t, :int], :int
+    attach_function :nn_getsockopt, [:int, :int, :int, :pointer, :pointer], :int, :blocking => true
+    attach_function :nn_setsockopt, [:int, :int, :int, :pointer, :size_t], :int, :blocking => true
+    attach_function :nn_bind, [:int, :string], :int, :blocking => true
+    attach_function :nn_connect, [:int, :string], :int, :blocking => true
+    attach_function :nn_shutdown, [:int, :int], :int, :blocking => true
+    attach_function :nn_send, [:int, :pointer, :size_t, :int], :int, :blocking => true
+    attach_function :nn_recv, [:int, :pointer, :size_t, :int], :int, :blocking => true
+    attach_function :nn_term, [], :void, :blocking => true
 
     # functions for working with raw buffers
-    @blocking = true
-    attach_function :nn_sendmsg, [:int, :pointer, :int], :int
-    @blocking = true
-    attach_function :nn_recvmsg, [:int, :pointer, :int], :int
-    @blocking = true
-    attach_function :nn_allocmsg, [:size_t, :int], :pointer
-    @blocking = true
-    attach_function :nn_freemsg, [:pointer], :int        
+    attach_function :nn_sendmsg, [:int, :pointer, :int], :int, :blocking => true
+    attach_function :nn_recvmsg, [:int, :pointer, :int], :int, :blocking => true
+    attach_function :nn_allocmsg, [:size_t, :int], :pointer, :blocking => true
+    attach_function :nn_freemsg, [:pointer], :int, :blocking => true
   end
 end

data/lib/nn-core/version.rb

@@ -1,3 +1,3 @@
 module NNCore
-  VERSION = "0.1.6"
+  VERSION = "0.2.1"
 end

data/spec/nn_symbol_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+module NNCore
+  describe "nn_symbol" do
+
+    context "given an initialized library" do
+
+      it "returns a string constant given an index of 0" do
+        value = FFI::MemoryPointer.new(:int)
+
+        constant_string = LibNanomsg.nn_symbol(0, value)
+        constant_string.should be_a(String)
+      end
+
+      it "returns an integer value in the second parameter given an index of 0" do
+        value = FFI::MemoryPointer.new(:int)
+
+        constant_string = LibNanomsg.nn_symbol(0, value)
+        value.read_int.should >= 0
+      end
+
+    end
+  end
+end

data/spec/nn_term_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+module NNCore
+  describe "nn_term" do
+
+    context "given an initialized library and" do
+
+      context "given a valid socket" do
+        before(:each) do
+          @socket = LibNanomsg.nn_socket(AF_SP, NN_PUB)
+        end
+
+        after(:each) do
+          LibNanomsg.nn_close(@socket)
+        end
+
+        it "makes subsequent calls to nn_send fail with ETERM" do
+          LibNanomsg.nn_term
+          rc = LibNanomsg.nn_send(0, "ABC", 3, 0)
+          rc.should == -1
+          LibNanomsg.nn_errno.should == ETERM
+        end
+
+#        it "makes subsequent calls to nn_recv fail with ETERM" do
+#          LibNanomsg.nn_term
+#          buffer = FFI::MemoryPointer.new(:pointer)
+#          rc = LibNanomsg.nn_recv(@socket, buffer, NN_MSG, 0)
+#          rc.should == -1
+#          LibNanomsg.nn_errno.should == ETERM
+#        end
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -20,8 +20,6 @@ module NNCore
     :NN_PAIR => NN_PAIR,
     :NN_REQ => NN_REQ,
     :NN_REP => NN_REP,
-    :NN_SOURCE => NN_SOURCE,
-    :NN_SINK => NN_SINK,
     :NN_PUSH => NN_PUSH,
     :NN_PULL => NN_PULL,
     :NN_SURVEYOR => NN_SURVEYOR,
@@ -35,5 +33,5 @@ module NNCore
   
   # Some protocols support the AF_SP_RAW address family, so we need to skip those
   # tests that are expecting a failure.
-  RAW_UNSUPPORTED = [:NN_PUB, :NN_SUB]
+  RAW_UNSUPPORTED = []
 end

metadata

@@ -1,170 +1,126 @@
 --- !ruby/object:Gem::Specification
 name: nn-core
 version: !ruby/object:Gem::Version
-  version: 0.1.6
-  prerelease: 
+  version: 0.2.1
 platform: ruby
 authors:
 - Chuck Remes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-20 00:00:00.000000000 Z
+date: 2014-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
   type: :runtime
-  name: ffi
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
-    none: false
   type: :development
-  name: rspec
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
   type: :development
-  name: rake
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-description: ! 'Wraps the nanomsg networking library using the ruby FFI (foreign
-
-  function interface). It only exposes the native C API to Ruby. Other gems should
-  use this gem
-
-  to build an API using Ruby idioms.'
+description: |-
+  Wraps the nanomsg networking library using the ruby FFI (foreign
+  function interface). It only exposes the native C API to Ruby. Other gems should use this gem
+  to build an API using Ruby idioms.
 email:
 - git@chuckremes.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- !binary |-
-  LmdpdGlnbm9yZQ==
-- !binary |-
-  LnJzcGVj
-- !binary |-
-  QXV0aG9ycy50eHQ=
-- !binary |-
-  R2VtZmlsZQ==
-- !binary |-
-  SGlzdG9yeS50eHQ=
-- !binary |-
-  UkVBRE1FLm1k
-- !binary |-
-  UmFrZWZpbGU=
-- !binary |-
-  ZXhhbXBsZXMvcm91bmR0cmlwX2xhdGVuY3kucmI=
-- !binary |-
-  bGliL25uLWNvcmUucmI=
-- !binary |-
-  bGliL25uLWNvcmUvY29uc3RhbnRzLnJi
-- !binary |-
-  bGliL25uLWNvcmUvbGlibmFub21zZy5yYg==
-- !binary |-
-  bGliL25uLWNvcmUvc3RydWN0cy5yYg==
-- !binary |-
-  bGliL25uLWNvcmUvdmVyc2lvbi5yYg==
-- !binary |-
-  bm4tY29yZS5nZW1zcGVj
-- !binary |-
-  c3BlYy9ubl9iaW5kX3NwZWMucmI=
-- !binary |-
-  c3BlYy9ubl9jbG9zZV9zcGVjLnJi
-- !binary |-
-  c3BlYy9ubl9jb25uZWN0X3NwZWMucmI=
-- !binary |-
-  c3BlYy9ubl9nZXRzb2Nrb3B0X3NwZWMucmI=
-- !binary |-
-  c3BlYy9ubl9yZWN2X3NwZWMucmI=
-- !binary |-
-  c3BlYy9ubl9zZW5kX3NwZWMucmI=
-- !binary |-
-  c3BlYy9ubl9zZXRzb2Nrb3B0X3NwZWMucmI=
-- !binary |-
-  c3BlYy9ubl9zaHV0ZG93bl9zcGVjLnJi
-- !binary |-
-  c3BlYy9ubl9zb2NrZXRfc3BlYy5yYg==
-- !binary |-
-  c3BlYy9ubl92ZXJzaW9uX3NwZWMucmI=
-- !binary |-
-  c3BlYy9zcGVjX2hlbHBlci5yYg==
+- ".gitignore"
+- ".rspec"
+- Authors.txt
+- Gemfile
+- History.txt
+- README.md
+- Rakefile
+- examples/roundtrip_latency.rb
+- lib/nn-core.rb
+- lib/nn-core/constants.rb
+- lib/nn-core/libnanomsg.rb
+- lib/nn-core/structs.rb
+- lib/nn-core/version.rb
+- nn-core.gemspec
+- spec/nn_bind_spec.rb
+- spec/nn_close_spec.rb
+- spec/nn_connect_spec.rb
+- spec/nn_getsockopt_spec.rb
+- spec/nn_recv_spec.rb
+- spec/nn_send_spec.rb
+- spec/nn_setsockopt_spec.rb
+- spec/nn_shutdown_spec.rb
+- spec/nn_socket_spec.rb
+- spec/nn_symbol_spec.rb
+- spec/nn_term_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/chuckremes/nn-core
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 requirements: []
 rubyforge_project: nn-core
-rubygems_version: 1.8.24
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Wraps the nanomsg networking library using Ruby FFI (foreign function interface).
 test_files:
-- !binary |-
-  c3BlYy9ubl9iaW5kX3NwZWMucmI=
-- !binary |-
-  c3BlYy9ubl9jbG9zZV9zcGVjLnJi
-- !binary |-
-  c3BlYy9ubl9jb25uZWN0X3NwZWMucmI=
-- !binary |-
-  c3BlYy9ubl9nZXRzb2Nrb3B0X3NwZWMucmI=
-- !binary |-
-  c3BlYy9ubl9yZWN2X3NwZWMucmI=
-- !binary |-
-  c3BlYy9ubl9zZW5kX3NwZWMucmI=
-- !binary |-
-  c3BlYy9ubl9zZXRzb2Nrb3B0X3NwZWMucmI=
-- !binary |-
-  c3BlYy9ubl9zaHV0ZG93bl9zcGVjLnJi
-- !binary |-
-  c3BlYy9ubl9zb2NrZXRfc3BlYy5yYg==
-- !binary |-
-  c3BlYy9ubl92ZXJzaW9uX3NwZWMucmI=
-- !binary |-
-  c3BlYy9zcGVjX2hlbHBlci5yYg==
+- spec/nn_bind_spec.rb
+- spec/nn_close_spec.rb
+- spec/nn_connect_spec.rb
+- spec/nn_getsockopt_spec.rb
+- spec/nn_recv_spec.rb
+- spec/nn_send_spec.rb
+- spec/nn_setsockopt_spec.rb
+- spec/nn_shutdown_spec.rb
+- spec/nn_socket_spec.rb
+- spec/nn_symbol_spec.rb
+- spec/nn_term_spec.rb
+- spec/spec_helper.rb

data/spec/nn_version_spec.rb

@@ -1,23 +0,0 @@
-require 'spec_helper'
-
-module NNCore
-  describe "nn_version" do
-
-    context "given an initialized library" do
-
-      it "returns 0 and populates the pointers with the major, minor and patch version numbers" do
-        major = FFI::MemoryPointer.new(:int)
-        minor = FFI::MemoryPointer.new(:int)
-        patch = FFI::MemoryPointer.new(:int)
-
-        # there is no return value for this function
-        LibNanomsg.nn_version(major, minor, patch)
-        
-        major.read_int.should >= 0
-        minor.read_int.should >= 0
-        patch.read_int.should >= 0
-      end
-
-    end
-  end
-end