czmq-ffi-gen 0.14.0 → 1.0.0

data/lib/czmq-ffi-gen/czmq/ffi/zsys.rb

@@ -188,7 +188,7 @@ module CZMQ
 
       # Set default interrupt handler, so Ctrl-C or SIGTERM will set
       # zsys_interrupted. Idempotent; safe to call multiple times.
-      # Can be supressed by ZSYS_SIGHANDLER=false
+      # Can be suppressed by ZSYS_SIGHANDLER=false
       # *** This is for CZMQ internal use only and may change arbitrarily ***
       #
       # @return [void]
@@ -197,6 +197,26 @@ module CZMQ
         result
       end
 
+      # Check if default interrupt handler of Ctrl-C or SIGTERM was called.
+      # Does not work if ZSYS_SIGHANDLER is false and code does not call
+      # set interrupted on signal.
+      #
+      # @return [Boolean]
+      def self.is_interrupted()
+        result = ::CZMQ::FFI.zsys_is_interrupted()
+        result
+      end
+
+      # Set interrupted flag. This is done by default signal handler, however
+      # this can be handy for language bindings or cases without default
+      # signal handler.
+      #
+      # @return [void]
+      def self.set_interrupted()
+        result = ::CZMQ::FFI.zsys_set_interrupted()
+        result
+      end
+
       # Return 1 if file exists, else zero
       #
       # @param filename [String, #to_s, nil]
@@ -304,6 +324,22 @@ module CZMQ
         result
       end
 
+      # Format a string using printf formatting, returning a freshly allocated
+      # buffer. If there was insufficient memory, returns NULL. Free the returned
+      # string using zstr_free(). The hinted version allows to optimize by using
+      # a larger starting buffer size (known to/assumed by the developer) and so
+      # avoid reallocations.
+      #
+      # @param hint [Integer, #to_int, #to_i]
+      # @param format [String, #to_s, nil]
+      # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
+      # @return [::FFI::Pointer]
+      def self.sprintf_hint(hint, format, *args)
+        hint = Integer(hint)
+        result = ::CZMQ::FFI.zsys_sprintf_hint(hint, format, *args)
+        result
+      end
+
       # Format a string using printf formatting, returning a freshly allocated
       # buffer. If there was insufficient memory, returns NULL. Free the returned
       # string using zstr_free().
@@ -483,6 +519,52 @@ module CZMQ
         result
       end
 
+      # Configure the numeric prefix to each thread created for the internal
+      # context's thread pool. This option is only supported on Linux.
+      # If the environment variable ZSYS_THREAD_NAME_PREFIX is defined, that
+      # provides the default.
+      # Note that this method is valid only before any socket is created.
+      #
+      # @param prefix [Integer, #to_int, #to_i]
+      # @return [void]
+      def self.set_thread_name_prefix(prefix)
+        prefix = Integer(prefix)
+        result = ::CZMQ::FFI.zsys_set_thread_name_prefix(prefix)
+        result
+      end
+
+      # Return thread name prefix.
+      #
+      # @return [Integer]
+      def self.thread_name_prefix()
+        result = ::CZMQ::FFI.zsys_thread_name_prefix()
+        result
+      end
+
+      # Adds a specific CPU to the affinity list of the ZMQ context thread pool.
+      # This option is only supported on Linux.
+      # Note that this method is valid only before any socket is created.
+      #
+      # @param cpu [Integer, #to_int, #to_i]
+      # @return [void]
+      def self.thread_affinity_cpu_add(cpu)
+        cpu = Integer(cpu)
+        result = ::CZMQ::FFI.zsys_thread_affinity_cpu_add(cpu)
+        result
+      end
+
+      # Removes a specific CPU to the affinity list of the ZMQ context thread pool.
+      # This option is only supported on Linux.
+      # Note that this method is valid only before any socket is created.
+      #
+      # @param cpu [Integer, #to_int, #to_i]
+      # @return [void]
+      def self.thread_affinity_cpu_remove(cpu)
+        cpu = Integer(cpu)
+        result = ::CZMQ::FFI.zsys_thread_affinity_cpu_remove(cpu)
+        result
+      end
+
       # Configure the number of sockets that ZeroMQ will allow. The default
       # is 1024. The actual limit depends on the system, and you can query it
       # by using zsys_socket_limit (). A value of zero means "maximum".
@@ -523,6 +605,26 @@ module CZMQ
         result
       end
 
+      # Configure whether to use zero copy strategy in libzmq. If the environment
+      # variable ZSYS_ZERO_COPY_RECV is defined, that provides the default.
+      # Otherwise the default is 1.
+      #
+      # @param zero_copy [Integer, #to_int, #to_i]
+      # @return [void]
+      def self.set_zero_copy_recv(zero_copy)
+        zero_copy = Integer(zero_copy)
+        result = ::CZMQ::FFI.zsys_set_zero_copy_recv(zero_copy)
+        result
+      end
+
+      # Return ZMQ_ZERO_COPY_RECV option.
+      #
+      # @return [Integer]
+      def self.zero_copy_recv()
+        result = ::CZMQ::FFI.zsys_zero_copy_recv()
+        result
+      end
+
       # Configure the threshold value of filesystem object age per st_mtime
       # that should elapse until we consider that object "stable" at the
       # current zclock_time() moment.
@@ -633,6 +735,16 @@ module CZMQ
         result
       end
 
+      # Test if ipv6 is available on the system. Return true if available.
+      # The only way to reliably check is to actually open a socket and
+      # try to bind it. (ported from libzmq)
+      #
+      # @return [Boolean]
+      def self.ipv6_available()
+        result = ::CZMQ::FFI.zsys_ipv6_available()
+        result
+      end
+
       # Set network interface name to use for broadcasts, particularly zbeacon.
       # This lets the interface be configured for test environments where required.
       # For example, on Mac OS X, zbeacon cannot bind to 255.255.255.255 which is
@@ -696,6 +808,46 @@ module CZMQ
         result
       end
 
+      # Set IPv4 multicast address to use for sending zbeacon messages. By default
+      # IPv4 multicast is NOT used. If the environment variable
+      # ZSYS_IPV4_MCAST_ADDRESS is set, use that as the default IPv4 multicast
+      # address. Calling this function or setting ZSYS_IPV4_MCAST_ADDRESS
+      # will enable IPv4 zbeacon messages.
+      #
+      # @param value [String, #to_s, nil]
+      # @return [void]
+      def self.set_ipv4_mcast_address(value)
+        result = ::CZMQ::FFI.zsys_set_ipv4_mcast_address(value)
+        result
+      end
+
+      # Return IPv4 multicast address to use for sending zbeacon, or NULL if none was
+      # set.
+      #
+      # @return [String]
+      def self.ipv4_mcast_address()
+        result = ::CZMQ::FFI.zsys_ipv4_mcast_address()
+        result
+      end
+
+      # Set multicast TTL default is 1
+      #
+      # @param value [Integer, #to_int, #to_i]
+      # @return [void]
+      def self.set_mcast_ttl(value)
+        value = Integer(value)
+        result = ::CZMQ::FFI.zsys_set_mcast_ttl(value)
+        result
+      end
+
+      # Get multicast TTL
+      #
+      # @return [Integer]
+      def self.mcast_ttl()
+        result = ::CZMQ::FFI.zsys_mcast_ttl()
+        result
+      end
+
       # Configure the automatic use of pre-allocated FDs when creating new sockets.
       # If 0 (default), nothing will happen. Else, when a new socket is bound, the
       # system API will be used to check if an existing pre-allocated FD with a
@@ -719,6 +871,70 @@ module CZMQ
         result
       end
 
+      # Print formatted string. Format is specified by variable names
+      # in Python-like format style
+      #
+      # "%(KEY)s=%(VALUE)s", KEY=key, VALUE=value
+      # become
+      # "key=value"
+      #
+      # Returns freshly allocated string or NULL in a case of error.
+      # Not enough memory, invalid format specifier, name not in args
+      #
+      # @param format [String, #to_s, nil]
+      # @param args [Zhash, #__ptr]
+      # @return [::FFI::AutoPointer]
+      def self.zprintf(format, args)
+        args = args.__ptr if args
+        result = ::CZMQ::FFI.zsys_zprintf(format, args)
+        result = ::FFI::AutoPointer.new(result, LibC.method(:free))
+        result
+      end
+
+      # Return error string for given format/args combination.
+      #
+      # @param format [String, #to_s, nil]
+      # @param args [Zhash, #__ptr]
+      # @return [::FFI::AutoPointer]
+      def self.zprintf_error(format, args)
+        args = args.__ptr if args
+        result = ::CZMQ::FFI.zsys_zprintf_error(format, args)
+        result = ::FFI::AutoPointer.new(result, LibC.method(:free))
+        result
+      end
+
+      # Print formatted string. Format is specified by variable names
+      # in Python-like format style
+      #
+      # "%(KEY)s=%(VALUE)s", KEY=key, VALUE=value
+      # become
+      # "key=value"
+      #
+      # Returns freshly allocated string or NULL in a case of error.
+      # Not enough memory, invalid format specifier, name not in args
+      #
+      # @param format [String, #to_s, nil]
+      # @param args [Zconfig, #__ptr]
+      # @return [::FFI::AutoPointer]
+      def self.zplprintf(format, args)
+        args = args.__ptr if args
+        result = ::CZMQ::FFI.zsys_zplprintf(format, args)
+        result = ::FFI::AutoPointer.new(result, LibC.method(:free))
+        result
+      end
+
+      # Return error string for given format/args combination.
+      #
+      # @param format [String, #to_s, nil]
+      # @param args [Zconfig, #__ptr]
+      # @return [::FFI::AutoPointer]
+      def self.zplprintf_error(format, args)
+        args = args.__ptr if args
+        result = ::CZMQ::FFI.zsys_zplprintf_error(format, args)
+        result = ::FFI::AutoPointer.new(result, LibC.method(:free))
+        result
+      end
+
       # Set log identity, which is a string that prefixes all log messages sent
       # by this process. The log identity defaults to the environment variable
       # ZSYS_LOGIDENT, if that is set.

data/lib/czmq-ffi-gen/czmq_ffi_extensions.rb

@@ -0,0 +1,16 @@
+module CZMQ
+  module FFI
+
+    # @return [Boolean] whether the CZMQ DRAFT API is available
+    #
+    def self.has_draft?
+      # NOTE: We use some function that is currently declared DRAFT. Another one
+      # might be needed in future versions.
+      zsock_new_server(nil)
+      true
+    rescue NotImplementedError, NoMethodError
+      false
+    end
+
+  end
+end

data/lib/czmq-ffi-gen/gem_version.rb

@@ -1,5 +1,5 @@
 module CZMQ
   module FFI
-    GEM_VERSION = "0.14.0"
+    GEM_VERSION = "1.0.0"
   end
 end

data/lib/czmq-ffi-gen/libzmq.rb

@@ -5,8 +5,7 @@ module CZMQ::FFI::LibZMQ
 
   lib_name = 'libzmq'
   lib_dirs = ['/usr/local/lib', '/opt/local/lib', '/usr/lib64']
-  env_path = ENV['LIBZMQ_PATH']
-  lib_dirs = [*env_path.split(':'), *lib_dirs] if env_path
+  lib_dirs = [*ENV['LIBZMQ_PATH'].split(':'), *lib_dirs] if ENV['LIBZMQ_PATH']
   lib_paths = lib_dirs.map { |path| "#{path}/#{lib_name}.#{::FFI::Platform::LIBSUFFIX}" }
   ffi_lib lib_paths + [lib_name]
 
@@ -17,4 +16,32 @@ module CZMQ::FFI::LibZMQ
   attach_function :zmq_strerror, [:int], :string, **opts
   attach_function :zmq_errno, [], :int, **opts
   attach_function :zmq_version, [:pointer, :pointer, :pointer], :void, **opts
+  attach_function :zmq_has, [:pointer], :int, **opts
+
+
+  # get ZMQ version
+  ptrs = Array.new(3) { ::FFI::MemoryPointer.new(:int) }
+  zmq_version(*ptrs)
+  VERSION = ptrs.map { |n| n.get_int(0) }.join(".").freeze
+
+
+  # @param capability [Symbol, String] the name of the capability
+  # @return [Boolean] whether the capability is supported
+  #
+  def self.has?(capability)
+    ptr = FFI::MemoryPointer.from_string(capability.to_s.downcase)
+    zmq_has(ptr) == 1
+  end
+
+
+  # @return [Boolean] whether the DRAFT API is supported
+  def self.has_draft?
+    has? :draft
+  end
+
+
+  # @return [Boolean] whether CURVE is supported
+  def self.has_curve?
+    has? :curve
+  end
 end

data/lib/czmq-ffi-gen/versions.rb

@@ -1,19 +1,9 @@
-require_relative "gem_version"
-require_relative "libzmq"
-
 module CZMQ
   module FFI
     # CZMQ library version
     CZMQ_VERSION = VERSION
 
-    # @deprecated Use {CZMQ_VERSION} instead.
-    LIBRARY_VERSION = CZMQ_VERSION
-
     # ZMQ library version
-    ZMQ_VERSION = begin
-      version = Array.new(3) { ::FFI::MemoryPointer.new(:int) }
-      LibZMQ.zmq_version(*version)
-      version.map { |n| n.get_int(0) }.join(".")
-    end
+    ZMQ_VERSION = LibZMQ::VERSION
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: czmq-ffi-gen
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Patrik Wenger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-27 00:00:00.000000000 Z
+date: 2021-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -16,56 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.10
+        version: '1.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.10
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -110,11 +96,18 @@ files:
 - lib/czmq-ffi-gen/czmq/ffi/zframe.rb
 - lib/czmq-ffi-gen/czmq/ffi/zhash.rb
 - lib/czmq-ffi-gen/czmq/ffi/zhashx.rb
+- lib/czmq-ffi-gen/czmq/ffi/zhttp_client.rb
+- lib/czmq-ffi-gen/czmq/ffi/zhttp_request.rb
+- lib/czmq-ffi-gen/czmq/ffi/zhttp_response.rb
+- lib/czmq-ffi-gen/czmq/ffi/zhttp_server.rb
+- lib/czmq-ffi-gen/czmq/ffi/zhttp_server_connection.rb
+- lib/czmq-ffi-gen/czmq/ffi/zhttp_server_options.rb
 - lib/czmq-ffi-gen/czmq/ffi/ziflist.rb
 - lib/czmq-ffi-gen/czmq/ffi/zlist.rb
 - lib/czmq-ffi-gen/czmq/ffi/zlistx.rb
 - lib/czmq-ffi-gen/czmq/ffi/zloop.rb
 - lib/czmq-ffi-gen/czmq/ffi/zmsg.rb
+- lib/czmq-ffi-gen/czmq/ffi/zosc.rb
 - lib/czmq-ffi-gen/czmq/ffi/zpoller.rb
 - lib/czmq-ffi-gen/czmq/ffi/zproc.rb
 - lib/czmq-ffi-gen/czmq/ffi/zsock.rb
@@ -123,17 +116,20 @@ files:
 - lib/czmq-ffi-gen/czmq/ffi/ztimerset.rb
 - lib/czmq-ffi-gen/czmq/ffi/ztrie.rb
 - lib/czmq-ffi-gen/czmq/ffi/zuuid.rb
+- lib/czmq-ffi-gen/czmq_ffi_extensions.rb
 - lib/czmq-ffi-gen/errors.rb
 - lib/czmq-ffi-gen/gem_version.rb
-- lib/czmq-ffi-gen/legacy.rb
 - lib/czmq-ffi-gen/libzmq.rb
 - lib/czmq-ffi-gen/signals.rb
 - lib/czmq-ffi-gen/vendor.rb
 - lib/czmq-ffi-gen/versions.rb
-homepage: https://github.com/paddor/czmq-ffi-gen
+homepage: https://rubygems.org/gems/czmq-ffi-gen
 licenses:
 - ISC
-metadata: {}
+metadata:
+  homepage_uri: https://rubygems.org/gems/czmq-ffi-gen
+  source_code_uri: https://github.com/paddor/czmq-ffi-gen
+  changelog_uri: https://github.com/paddor/czmq-ffi-gen/blob/master/CHANGES.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -142,16 +138,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.2.4
 signing_key: 
 specification_version: 4
-summary: The low-level Ruby binding for CZMQ (generated using zproject)
+summary: Generated low-level Ruby binding for CZMQ
 test_files: []