ffi-rzmq-core 1.0.3 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: aaef58251b0eb71a09de2e6614a728051abc6c01
-  data.tar.gz: 7b77162ec56a6df2f7c0211d5473e2b1b437206f
+SHA256:
+  metadata.gz: dfb36c8fd3ba8ea7889a686282a1eea04fd42b6b418fb627a59136ebca5e9c60
+  data.tar.gz: 6351eccd6e2ca3e0c91a49e02672bbec65d4d33abd728e368a98abf3d975c9ca
 SHA512:
-  metadata.gz: b87258245ef93fd6d2d90391f42422aaea73dcae7712e24d06fb8042fe8b019fffa0db24c98d3335e59617c649cc2eaae3a913cd9c741d271f858cc8b09c0334
-  data.tar.gz: 6ee10101e4de2928aeb5804bb1a407537bf36fa0443446494d3786a3ee817adbfff716f512829f51cf5b489b520d77fd26a00984ece6f5bf573d3aa8ab510f56
+  metadata.gz: 61f7bd2e38fe8025d8dd37e81e9872770c8ae367ec03305a5b155c4397503996f696af1f33987329ad2019041ddf17a4a1979df2cb0cb64e5c8bbb3852b8255c
+  data.tar.gz: 48c45585ef08d5a03cf76b3eb0e47cace36aacb686626bee1e2a55173b52c56ae858d5356736253d45b70b0702f69dd18e643dd5fb637e190121e78dbe652b1d

data/.travis.yml

@@ -2,12 +2,10 @@ before_install: sudo apt-get install libzmq3-dev
 script: bundle exec rspec
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
+  - 2.6.0
   - ruby-head
-  - jruby-19mode
   - jruby-head
-  - rbx-2.1.1
+  - rbx
 
 matrix:
   allow_failures:

data/History.txt

@@ -0,0 +1,8 @@
+== 1.0.7
+  * Provide a wrapper function for calling context termination. Zeromq 3.x
+    uses zmq_ctx_destroy to terminate a context. While this function exists
+    in Zeromq 4.x, it is deprecated. For 4.x, we prefer to use zmq_ctx_term.
+    When loading the library, we define a `terminate_context` method on the
+    module which defaults to using the 3.x function call. If the 4.x support
+    loads, then this method is overwritten to use the 4.x function call.
+    

data/README.md

@@ -10,6 +10,9 @@ hoping this encourages other library writers to create their own. Rather than du
 wrapping code, they can just pull in this gem and build a more idiomatic library around the
 basic definitions.
 
+As of zeromq 4.2.x, this library does not yet support the `zmq_atomic_counter_*` functions or many
+of the other newly exposed functions. Pull requests encouraged!
+
 See [ffi-rzmq]
 
 ### Development

data/ffi-rzmq-core.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency "ffi", ["~> 1.9"]
-  s.add_development_dependency "rspec", ["~> 2.14"]
+  s.add_runtime_dependency "ffi"
+  s.add_development_dependency "rspec"
   s.add_development_dependency "rake"
 end

data/lib/ffi-rzmq-core/constants.rb

@@ -37,54 +37,72 @@ module ZMQ
   }
 
   #  Socket options
-  AFFINITY                = 4
-  IDENTITY                = 5
-  SUBSCRIBE               = 6
-  UNSUBSCRIBE             = 7
-  RATE                    = 8
-  RECOVERY_IVL            = 9
-  SNDBUF                  = 11
-  RCVBUF                  = 12
-  RCVMORE                 = 13
-  FD                      = 14
-  EVENTS                  = 15
-  TYPE                    = 16
-  LINGER                  = 17
-  RECONNECT_IVL           = 18
-  BACKLOG                 = 19
-  RECONNECT_IVL_MAX       = 21
-  MAXMSGSIZE              = 22
-  SNDHWM                  = 23
-  RCVHWM                  = 24
-  MULTICAST_HOPS          = 25
-  RCVTIMEO                = 27
-  SNDTIMEO                = 28
-  IPV4ONLY                = 31
-  LAST_ENDPOINT           = 32
-  ROUTER_MANDATORY        = 33
-  TCP_KEEPALIVE           = 34
-  TCP_KEEPALIVE_CNT       = 35
-  TCP_KEEPALIVE_IDLE      = 36
-  TCP_KEEPALIVE_INTVL     = 37
-  TCP_ACCEPT_FILTER       = 38
-  DELAY_ATTACH_ON_CONNECT = 39
-  XPUB_VERBOSE            = 40
-  ROUTER_RAW              = 41
-  IPV6                    = 42
-  MECHANISM               = 43
-  PLAIN_SERVER            = 44
-  PLAIN_USERNAME          = 45
-  PLAIN_PASSWORD          = 46
-  CURVE_SERVER            = 47
-  CURVE_PUBLICKEY         = 48
-  CURVE_SECRETKEY         = 49
-  CURVE_SERVERKEY         = 50
-  PROBE_ROUTER            = 51
-  REQ_CORRELATE           = 52
-  REQ_RELAXED             = 53
-  CONFLATE                = 54
-  ZAP_DOMAIN              = 55
-  ROUTER_HANDOVER         = 56
+  AFFINITY                 = 4
+  IDENTITY                 = 5
+  SUBSCRIBE                = 6
+  UNSUBSCRIBE              = 7
+  RATE                     = 8
+  RECOVERY_IVL             = 9
+  SNDBUF                   = 11
+  RCVBUF                   = 12
+  RCVMORE                  = 13
+  FD                       = 14
+  EVENTS                   = 15
+  TYPE                     = 16
+  LINGER                   = 17
+  RECONNECT_IVL            = 18
+  BACKLOG                  = 19
+  RECONNECT_IVL_MAX        = 21
+  MAXMSGSIZE               = 22
+  SNDHWM                   = 23
+  RCVHWM                   = 24
+  MULTICAST_HOPS           = 25
+  RCVTIMEO                 = 27
+  SNDTIMEO                 = 28
+  IPV4ONLY                 = 31
+  LAST_ENDPOINT            = 32
+  ROUTER_MANDATORY         = 33
+  TCP_KEEPALIVE            = 34
+  TCP_KEEPALIVE_CNT        = 35
+  TCP_KEEPALIVE_IDLE       = 36
+  TCP_KEEPALIVE_INTVL      = 37
+  TCP_ACCEPT_FILTER        = 38
+  DELAY_ATTACH_ON_CONNECT  = 39
+  XPUB_VERBOSE             = 40
+  ROUTER_RAW               = 41
+  IPV6                     = 42
+  MECHANISM                = 43
+  PLAIN_SERVER             = 44
+  PLAIN_USERNAME           = 45
+  PLAIN_PASSWORD           = 46
+  CURVE_SERVER             = 47
+  CURVE_PUBLICKEY          = 48
+  CURVE_SECRETKEY          = 49
+  CURVE_SERVERKEY          = 50
+  PROBE_ROUTER             = 51
+  REQ_CORRELATE            = 52
+  REQ_RELAXED              = 53
+  CONFLATE                 = 54
+  ZAP_DOMAIN               = 55
+  ROUTER_HANDOVER          = 56
+  TOS                      = 57
+  CONNECT_RID              = 61
+  GSSAPI_SERVER            = 62
+  GSSAPI_PRINCIPAL         = 63
+  GSSAPI_SERVICE_PRINCIPAL = 64
+  GSSAPI_PLAINTEXT         = 65
+  HANDSHAKE_IVL            = 66
+  SOCKS_PROXY              = 68
+  XPUB_NODROP              = 69
+  BLOCKY                   = 70
+  XPUB_MANUAL              = 71
+  XPUB_WELCOME_MSG         = 72
+  STREAM_NOTIFY            = 73
+  INVERT_MATCHING          = 74
+  HEARTBEAT_IVL            = 75
+  HEARTBEAT_TTL            = 76
+  HEARTBEAT_TIMEOUT        = 77
+  XPUB_VERBOSE_UNSUBSCRIBE = 78
 
   IMMEDIATE       = DELAY_ATTACH_ON_CONNECT
   FAIL_UNROUTABLE = ROUTER_MANDATORY

data/lib/ffi-rzmq-core/libzmq.rb

@@ -1,4 +1,5 @@
 require 'open3'
+require 'rbconfig'
 
 # Wraps the libzmq library and attaches to the functions that are
 # common across the 3.2.x+ and 4.x APIs.
@@ -11,6 +12,8 @@ module LibZMQ
     # to the usual system paths
     inside_gem = File.join(File.dirname(__FILE__), '..', '..', 'ext')
     local_path = FFI::Platform::IS_WINDOWS ? ENV['PATH'].split(';') : ENV['PATH'].split(':')
+    env_path = [ ENV['ZMQ_LIB_PATH'] ].compact
+    rbconfig_path = RbConfig::CONFIG["libdir"]
     homebrew_path = nil
 
     # RUBYOPT set by RVM breaks 'brew' so we need to unset it.
@@ -31,18 +34,28 @@ module LibZMQ
     ENV['RUBYOPT'] = rubyopt
 
     # Search for libzmq in the following order...
-    ZMQ_LIB_PATHS = ([inside_gem] + local_path + [
+    ZMQ_LIB_PATHS = ([inside_gem] + env_path + local_path + [rbconfig_path] + [
                        '/usr/local/lib', '/opt/local/lib', homebrew_path, '/usr/lib64'
     ]).compact.map{|path| "#{path}/libzmq.#{FFI::Platform::LIBSUFFIX}"}
+
+    # Recent versions of libzmq do not put all symbols into the global namespace so
+    # lazy linking can fail at runtime. Force all symbols to global namespace.
+    ffi_lib_flags :now, :global
     ffi_lib(ZMQ_LIB_PATHS + %w{libzmq})
 
   rescue LoadError
-    if ZMQ_LIB_PATHS.any? {|path|
-      File.file? File.join(path, "libzmq.#{FFI::Platform::LIBSUFFIX}")}
+    # Failed to load the zmq library
+
+    found_libs = ZMQ_LIB_PATHS.find_all {|path| File.file? path }
+    if found_libs.any?
       warn "Unable to load this gem. The libzmq library exists, but cannot be loaded."
-      warn "If this is Windows:"
-      warn "-  Check that you have MSVC runtime installed or statically linked"
-      warn "-  Check that your DLL is compiled for #{FFI::Platform::ADDRESS_SIZE} bit"
+      warn "libzmq library was found at:"
+      warn found_libs.inspect
+      if FFI::Platform::IS_WINDOWS
+        warn "On Windows:"
+        warn "-  Check that you have MSVC runtime installed or statically linked"
+        warn "-  Check that your DLL is compiled for #{FFI::Platform::ADDRESS_SIZE} bit"
+      end
     else
       warn "Unable to load this gem. The libzmq library (or DLL) could not be found."
       warn "If this is a Windows platform, make sure libzmq.dll is on the PATH."
@@ -116,4 +129,8 @@ module LibZMQ
   # Monitoring API
   attach_function :zmq_socket_monitor, [:pointer, :pointer, :int], :int, :blocking => true
 
+  # Wrapper function for context termination
+  def self.terminate_context(context)
+    zmq_ctx_destroy(context)
+  end
 end

data/lib/ffi-rzmq-core/libzmq4.rb

@@ -14,4 +14,9 @@ module LibZMQ
   # Will return -1 with errno set to ENOSUP otherwise
   attach_function :zmq_curve_keypair, [:pointer, :pointer], :int, :blocking => true
 
+  # Wrapper function for context termination
+  def self.terminate_context(context)
+    zmq_ctx_term(context)
+  end
+
 end

data/lib/ffi-rzmq-core/structures.rb

@@ -1,14 +1,51 @@
 module LibZMQ
 
-  # Used for casting pointers back to the msg_t struct
-  #
-  class Message < FFI::Struct
-    layout :content,  :pointer,
-      :flags,    :uint8,
-      :vsm_size, :uint8,
-      :vsm_data, [:uint8, 30]
+  def self.version_number
+    10000 * version[:major] + 100 * version[:minor] + version[:patch]
+  end
+
+  def self.version_string
+    "%d.%d.%d" % version.values_at(:major, :minor, :patch)
   end
 
+  raise "zmq library version not supported: #{version_string}" if version_number < 030200
+
+  # here are the typedefs for zmsg_msg_t for all known releases of libzmq
+  # grep 'typedef struct zmq_msg_t'  */include/zmq.h
+  # zeromq-3.2.2/include/zmq.h:typedef struct zmq_msg_t {unsigned char _ [32];} zmq_msg_t;
+  # zeromq-3.2.3/include/zmq.h:typedef struct zmq_msg_t {unsigned char _ [32];} zmq_msg_t;
+  # zeromq-3.2.4/include/zmq.h:typedef struct zmq_msg_t {unsigned char _ [32];} zmq_msg_t;
+  # zeromq-3.2.5/include/zmq.h:typedef struct zmq_msg_t {unsigned char _ [32];} zmq_msg_t;
+  # zeromq-4.0.0/include/zmq.h:typedef struct zmq_msg_t {unsigned char _ [32];} zmq_msg_t;
+  # zeromq-4.0.1/include/zmq.h:typedef struct zmq_msg_t {unsigned char _ [32];} zmq_msg_t;
+  # zeromq-4.0.2/include/zmq.h:typedef struct zmq_msg_t {unsigned char _ [32];} zmq_msg_t;
+  # zeromq-4.0.3/include/zmq.h:typedef struct zmq_msg_t {unsigned char _ [32];} zmq_msg_t;
+  # zeromq-4.0.4/include/zmq.h:typedef struct zmq_msg_t {unsigned char _ [32];} zmq_msg_t;
+  # zeromq-4.0.5/include/zmq.h:typedef struct zmq_msg_t {unsigned char _ [32];} zmq_msg_t;
+  # zeromq-4.0.6/include/zmq.h:typedef struct zmq_msg_t {unsigned char _ [32];} zmq_msg_t;
+  # zeromq-4.0.7/include/zmq.h:typedef struct zmq_msg_t {unsigned char _ [32];} zmq_msg_t;
+  # zeromq-4.1.0/include/zmq.h:typedef struct zmq_msg_t {unsigned char _ [48];} zmq_msg_t;
+  # zeromq-4.1.1/include/zmq.h:typedef struct zmq_msg_t {unsigned char _ [64];} zmq_msg_t;
+  # zeromq-4.1.2/include/zmq.h:typedef struct zmq_msg_t {unsigned char _ [64];} zmq_msg_t;
+  # zeromq-4.1.3/include/zmq.h:typedef struct zmq_msg_t {unsigned char _ [64];} zmq_msg_t;
+  # zeromq-4.1.4/include/zmq.h:typedef struct zmq_msg_t {unsigned char _ [64];} zmq_msg_t;
+  # libzmq/include/zmq.h: typedef union zmq_msg_t {unsigned char _ [64]; void *p; } zmq_msg_t;
+
+  def self.size_of_zmq_msg_t
+    if version_number < 040100
+      32
+    elsif version_number < 040101
+      48
+    else
+      64
+    end
+  end
+
+  # Declare Message with correct size and alignment
+  class Message < FFI::Union
+    layout :'_', [:uint8, LibZMQ.size_of_zmq_msg_t],
+       :p, :pointer
+  end
 
   # Create the basic mapping for the poll_item_t structure so we can
   # access those fields via Ruby.

data/lib/ffi-rzmq-core/version.rb

@@ -1,3 +1,3 @@
 module LibZMQ
-  VERSION = "1.0.3"
+  VERSION = "1.0.7"
 end

data/lib/ffi-rzmq-core.rb

@@ -1,8 +1,8 @@
 require 'ffi'
 require 'ffi-rzmq-core/libc'
 require 'ffi-rzmq-core/libzmq'
-require 'ffi-rzmq-core/structures'
 require 'ffi-rzmq-core/utilities'
+require 'ffi-rzmq-core/structures'
 require 'ffi-rzmq-core/constants'
 
 if LibZMQ.version4?

data/spec/libzmq_spec.rb

@@ -45,4 +45,27 @@ describe LibZMQ do
     expect(LibZMQ).to respond_to(:zmq_socket_monitor)
   end
 
+  if LibZMQ.version3?
+
+    describe '.terminate_context' do
+      it 'calls the 3.x zmq_ctx_destroy function' do
+        context_dbl = double('context')
+
+        expect(LibZMQ).to receive(:zmq_ctx_destroy).with(context_dbl)
+        LibZMQ.terminate_context(context_dbl)
+      end
+    end
+
+  elsif LibZMQ.version4?
+
+    describe '.terminate_context' do
+      it 'calls the 4.x zmq_ctx_destroy function' do
+        context_dbl = double('context')
+
+        expect(LibZMQ).to receive(:zmq_ctx_term).with(context_dbl)
+        LibZMQ.terminate_context(context_dbl)
+      end
+    end
+
+  end
 end

data/spec/spec_helper.rb

@@ -2,7 +2,6 @@ require File.expand_path(
 File.join(File.dirname(__FILE__), %w[.. lib ffi-rzmq-core]))
 
 require 'rspec'
-require 'rspec/autorun'
 
 Dir[File.join(File.dirname(__FILE__), "support", "*.rb")].each do |support|
   require support

data/spec/structures_spec.rb

@@ -2,13 +2,24 @@ require 'spec_helper'
 
 describe LibZMQ do
 
-  it "wraps the msg_t struct as Message" do
-    message = LibZMQ::Message.new
+  if LibZMQ.version_number >= 040101
+
+    it "the msg_t struct wrapped in Message is 64 bytes" do
+      LibZMQ::Message.size == 64
+    end
+
+  elsif LibZMQ.version_number < 040100
+
+    it "the msg_t struct wrapped in Message is 32 bytes" do
+      LibZMQ::Message.size == 32
+    end
+
+  elsif LibZMQ.version_number == 040100
+
+    it "the msg_t struct wrapped in Message is 48 bytes" do
+      LibZMQ::Message.size == 32
+    end
 
-    expect(message[:content]).to_not be_nil
-    expect(message[:flags]).to_not be_nil
-    expect(message[:vsm_size]).to_not be_nil
-    expect(message[:vsm_data]).to_not be_nil
   end
 
   it "wraps poll_item_t in a PollItem" do

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: ffi-rzmq-core
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.7
 platform: ruby
 authors:
 - Chuck Remes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-12 00:00:00.000000000 Z
+date: 2019-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -64,6 +64,7 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
+- History.txt
 - LICENSE
 - README.md
 - Rakefile
@@ -102,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: This gem provides only the FFI wrapper for the ZeroMQ (0mq) networking library.