czmq-ffi-gen 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba0ee8a4aee41a7656ec7a4891bd952a3942945a
-  data.tar.gz: 5d21b7bb354da3c19f1eb7323df14cbf1ba2a172
+  metadata.gz: 4753723af1305df12590a3f43a5cedc724d3d8af
+  data.tar.gz: 502e1643c0f83b02f414e4211bba56b91cef9817
 SHA512:
-  metadata.gz: f38147470bf967d450ee9f72626cf3cf6776922d45e32ea2467e24ce7b2fa93ed2e220636871ec815c75a3f7fca79b92e692119503c7796b378dd7e4d43a09fb
-  data.tar.gz: 294f60d99f21caaecd594f4e615de343c45198c0654a388abe42a5779ab14bb50ebce0a96c4f73c75a4988cd139c5e0d2ccac8ccad20ad95c391e0697d81fa64
+  metadata.gz: a309f48d12a153ab625476d187e635df2ec9e592da1442a4928557e329bb7e2be7123f58976926fb6f1a9b1b5023c5a690455e59873a2ee99591450cf7babf04
+  data.tar.gz: 969c75a924e8bf90f0b66de5f5cb3faad2d050a6e7e5d1e142cf371796bdb62771ca3a139529ce93bb7b6441b4233de8fe495faa6323032e41197a9a679d45e7

data/CHANGES.md

@@ -1,3 +1,9 @@
+0.4.0 (12/26/2015)
+-----
+* upgrade CZMQ low-level binding to
+  - add Zproc.has_curve
+* add basic specs for Zproc
+
 0.3.0 (12/15/2015)
 -----
 * upgrade CZMQ low-level binding to

data/README.md

@@ -56,11 +56,13 @@ Tested with these:
 
 This gem requires the presence of the CZMQ library, which in turn requires the
 ZMQ library. For **security mechanisms** like CURVE, you'll need
-[libsodium](https://github.com/jedisct1/libsodium).
+[libsodium](https://github.com/jedisct1/libsodium) and at least ZMQ 4.0.
 
 On OSX using homebrew, run:
 
-    $ brew install libsodium czmq
+    $ brew install libsodium
+    $ brew install zmq --with-libsodium
+    $ brew install czmq
 
 If you're running Linux, go check [this page](http://zeromq.org/distro:_start)
 to get more help. Make sure to install CZMQ, not only ZMQ.

data/lib/czmq-ffi-gen.rb

@@ -1,4 +1,5 @@
 require_relative "czmq-ffi-gen/czmq/ffi"
 require_relative "czmq-ffi-gen/gem_version"
 require_relative "czmq-ffi-gen/library_version"
+require_relative "czmq-ffi-gen/signals"
 CZMQ::FFI.available? or raise LoadError, "libczmq is not available"

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

@@ -404,6 +404,28 @@ module CZMQ
 
       require_relative 'ffi/zpoller'
 
+      attach_function :zproc_czmq_version, [], :int, **opts
+      attach_function :zproc_interrupted, [], :bool, **opts
+      attach_function :zproc_has_curve, [], :bool, **opts
+      attach_function :zproc_hostname, [], :pointer, **opts
+      attach_function :zproc_daemonize, [:string], :void, **opts
+      attach_function :zproc_run_as, [:string, :string, :string], :void, **opts
+      attach_function :zproc_set_io_threads, [:size_t], :void, **opts
+      attach_function :zproc_set_max_sockets, [:size_t], :void, **opts
+      attach_function :zproc_set_biface, [:string], :void, **opts
+      attach_function :zproc_biface, [], :string, **opts
+      attach_function :zproc_set_log_ident, [:string], :void, **opts
+      attach_function :zproc_set_log_sender, [:string], :void, **opts
+      attach_function :zproc_set_log_system, [:bool], :void, **opts
+      attach_function :zproc_log_error, [:string, :varargs], :void, **opts
+      attach_function :zproc_log_warning, [:string, :varargs], :void, **opts
+      attach_function :zproc_log_notice, [:string, :varargs], :void, **opts
+      attach_function :zproc_log_info, [:string, :varargs], :void, **opts
+      attach_function :zproc_log_debug, [:string, :varargs], :void, **opts
+      attach_function :zproc_test, [:bool], :void, **opts
+
+      require_relative 'ffi/zproc'
+
       attach_function :zsock_new, [:int], :pointer, **opts
       attach_function :zsock_new_pub, [:string], :pointer, **opts
       attach_function :zsock_new_sub, [:string, :string], :pointer, **opts

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

@@ -0,0 +1,294 @@
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Please refer to the README for information about making permanent changes.  #
+################################################################################
+
+module CZMQ
+  module FFI
+
+    # process configuration and status
+    # @note This class is 100% generated using zproject.
+    class Zproc
+      # Raised when one tries to use an instance of {Zproc} after
+      # the internal pointer to the native object has been nullified.
+      class DestroyedError < RuntimeError; end
+
+      # Boilerplate for self pointer, initializer, and finalizer
+      class << self
+        alias :__new :new
+      end
+      # Attaches the pointer _ptr_ to this instance and defines a finalizer for
+      # it if necessary.
+      # @param ptr [::FFI::Pointer]
+      # @param finalize [Boolean]
+      def initialize(ptr, finalize = true)
+        @ptr = ptr
+        if @ptr.null?
+          @ptr = nil # Remove null pointers so we don't have to test for them.
+        elsif finalize
+          @finalizer = self.class.create_finalizer_for @ptr
+          ObjectSpace.define_finalizer self, @finalizer
+        end
+      end
+      # @return [Proc]
+      def self.create_finalizer_for(ptr)
+        Proc.new do
+          "WARNING: "\
+          "Objects of type #{self} cannot be destroyed implicitly. "\
+          "Please call the correct destroy method with the relevant arguments."
+        end
+      end
+      # @return [Boolean]
+      def null?
+        !@ptr or @ptr.null?
+      end
+      # Return internal pointer
+      # @return [::FFI::Pointer]
+      def __ptr
+        raise DestroyedError unless @ptr
+        @ptr
+      end
+      # So external Libraries can just pass the Object to a FFI function which expects a :pointer
+      alias_method :to_ptr, :__ptr
+      # Nullify internal pointer and return pointer pointer.
+      # @note This detaches the current instance from the native object
+      #   and thus makes it unusable.
+      # @return [::FFI::MemoryPointer] the pointer pointing to a pointer
+      #   pointing to the native object
+      def __ptr_give_ref
+        raise DestroyedError unless @ptr
+        ptr_ptr = ::FFI::MemoryPointer.new :pointer
+        ptr_ptr.write_pointer @ptr
+        __undef_finalizer if @finalizer
+        @ptr = nil
+        ptr_ptr
+      end
+      # Undefines the finalizer for this object.
+      # @note Only use this if you need to and can guarantee that the native
+      #   object will be freed by other means.
+      # @return [void]
+      def __undef_finalizer
+        ObjectSpace.undefine_finalizer self
+        @finalizer = nil
+      end
+
+      # Returns CZMQ version as a single 6-digit integer encoding the major
+      # version (x 10000), the minor version (x 100) and the patch.        
+      #
+      # @return [Integer]
+      def self.czmq_version()
+        result = ::CZMQ::FFI.zproc_czmq_version()
+        result
+      end
+
+      # Returns true if the process received a SIGINT or SIGTERM signal.
+      # It is good practice to use this method to exit any infinite loop
+      # processing messages.                                            
+      #
+      # @return [Boolean]
+      def self.interrupted()
+        result = ::CZMQ::FFI.zproc_interrupted()
+        result
+      end
+
+      # Returns true if the underlying libzmq supports CURVE security.
+      #
+      # @return [Boolean]
+      def self.has_curve()
+        result = ::CZMQ::FFI.zproc_has_curve()
+        result
+      end
+
+      # Return current host name, for use in public tcp:// endpoints.
+      # If the host name is not resolvable, returns NULL.            
+      #
+      # @return [::FFI::AutoPointer]
+      def self.hostname()
+        result = ::CZMQ::FFI.zproc_hostname()
+        result = ::FFI::AutoPointer.new(result, LibC.method(:free))
+        result
+      end
+
+      # Move the current process into the background. The precise effect     
+      # depends on the operating system. On POSIX boxes, moves to a specified
+      # working directory (if specified), closes all file handles, reopens   
+      # stdin, stdout, and stderr to the null device, and sets the process to
+      # ignore SIGHUP. On Windows, does nothing. Returns 0 if OK, -1 if there
+      # was an error.                                                        
+      #
+      # @param workdir [String, #to_s, nil]
+      # @return [void]
+      def self.daemonize(workdir)
+        result = ::CZMQ::FFI.zproc_daemonize(workdir)
+        result
+      end
+
+      # Drop the process ID into the lockfile, with exclusive lock, and   
+      # switch the process to the specified group and/or user. Any of the 
+      # arguments may be null, indicating a no-op. Returns 0 on success,  
+      # -1 on failure. Note if you combine this with zsys_daemonize, run  
+      # after, not before that method, or the lockfile will hold the wrong
+      # process ID.                                                       
+      #
+      # @param lockfile [String, #to_s, nil]
+      # @param group [String, #to_s, nil]
+      # @param user [String, #to_s, nil]
+      # @return [void]
+      def self.run_as(lockfile, group, user)
+        result = ::CZMQ::FFI.zproc_run_as(lockfile, group, user)
+        result
+      end
+
+      # Configure the number of I/O threads that ZeroMQ will use. A good  
+      # rule of thumb is one thread per gigabit of traffic in or out. The 
+      # default is 1, sufficient for most applications. If the environment
+      # variable ZSYS_IO_THREADS is defined, that provides the default.   
+      # Note that this method is valid only before any socket is created. 
+      #
+      # @param io_threads [Integer, #to_int, #to_i]
+      # @return [void]
+      def self.set_io_threads(io_threads)
+        io_threads = Integer(io_threads)
+        result = ::CZMQ::FFI.zproc_set_io_threads(io_threads)
+        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".      
+      # Note that this method is valid only before any socket is created.    
+      #
+      # @param max_sockets [Integer, #to_int, #to_i]
+      # @return [void]
+      def self.set_max_sockets(max_sockets)
+        max_sockets = Integer(max_sockets)
+        result = ::CZMQ::FFI.zproc_set_max_sockets(max_sockets)
+        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  
+      # the default when there is no specified interface. If the environment       
+      # variable ZSYS_INTERFACE is set, use that as the default interface name.    
+      # Setting the interface to "*" means "use all available interfaces".         
+      #
+      # @param value [String, #to_s, nil]
+      # @return [void]
+      def self.set_biface(value)
+        result = ::CZMQ::FFI.zproc_set_biface(value)
+        result
+      end
+
+      # Return network interface to use for broadcasts, or "" if none was set.
+      #
+      # @return [String]
+      def self.biface()
+        result = ::CZMQ::FFI.zproc_biface()
+        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.                                         
+      #
+      # @param value [String, #to_s, nil]
+      # @return [void]
+      def self.set_log_ident(value)
+        result = ::CZMQ::FFI.zproc_set_log_ident(value)
+        result
+      end
+
+      # Sends log output to a PUB socket bound to the specified endpoint. To   
+      # collect such log output, create a SUB socket, subscribe to the traffic 
+      # you care about, and connect to the endpoint. Log traffic is sent as a  
+      # single string frame, in the same format as when sent to stdout. The    
+      # log system supports a single sender; multiple calls to this method will
+      # bind the same sender to multiple endpoints. To disable the sender, call
+      # this method with a null argument.                                      
+      #
+      # @param endpoint [String, #to_s, nil]
+      # @return [void]
+      def self.set_log_sender(endpoint)
+        result = ::CZMQ::FFI.zproc_set_log_sender(endpoint)
+        result
+      end
+
+      # Enable or disable logging to the system facility (syslog on POSIX boxes,
+      # event log on Windows). By default this is disabled.                     
+      #
+      # @param logsystem [Boolean]
+      # @return [void]
+      def self.set_log_system(logsystem)
+        logsystem = !(0==logsystem||!logsystem) # boolean
+        result = ::CZMQ::FFI.zproc_set_log_system(logsystem)
+        result
+      end
+
+      # Log error condition - highest priority
+      #
+      # @param format [String, #to_s, nil]
+      # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
+      # @return [void]
+      def self.log_error(format, *args)
+        result = ::CZMQ::FFI.zproc_log_error(format, *args)
+        result
+      end
+
+      # Log warning condition - high priority
+      #
+      # @param format [String, #to_s, nil]
+      # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
+      # @return [void]
+      def self.log_warning(format, *args)
+        result = ::CZMQ::FFI.zproc_log_warning(format, *args)
+        result
+      end
+
+      # Log normal, but significant, condition - normal priority
+      #
+      # @param format [String, #to_s, nil]
+      # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
+      # @return [void]
+      def self.log_notice(format, *args)
+        result = ::CZMQ::FFI.zproc_log_notice(format, *args)
+        result
+      end
+
+      # Log informational message - low priority
+      #
+      # @param format [String, #to_s, nil]
+      # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
+      # @return [void]
+      def self.log_info(format, *args)
+        result = ::CZMQ::FFI.zproc_log_info(format, *args)
+        result
+      end
+
+      # Log debug-level message - lowest priority
+      #
+      # @param format [String, #to_s, nil]
+      # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
+      # @return [void]
+      def self.log_debug(format, *args)
+        result = ::CZMQ::FFI.zproc_log_debug(format, *args)
+        result
+      end
+
+      # Self test of this class.
+      #
+      # @param verbose [Boolean]
+      # @return [void]
+      def self.test(verbose)
+        verbose = !(0==verbose||!verbose) # boolean
+        result = ::CZMQ::FFI.zproc_test(verbose)
+        result
+      end
+    end
+  end
+end
+
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Please refer to the README for information about making permanent changes.  #
+################################################################################

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

@@ -1,5 +1,5 @@
 module CZMQ
   module FFI
-    GEM_VERSION = "0.3.0"
+    GEM_VERSION = "0.4.0"
   end
 end

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

@@ -0,0 +1,27 @@
+module CZMQ
+  module FFI
+
+    attach_function :zsys_handler_set, [:pointer], :void, blocking: true
+
+    # This is used to disable CZMQ's signal handling so blocking calls can be
+    # interrupted using Ctrl-C.
+    module Signals
+      module_function
+
+      @default_handling_disabled = false
+
+      # Disables default SIGINT/SIGTERM handling in CZMQ.
+      # @return [void]
+      def disable_default_handling
+        FFI.zsys_handler_set(nil)
+        @default_handling_disabled = true
+      end
+
+      # @return [Boolean] whether the CZMQ's default signal handling has been
+      #   disabled
+      def default_handling_disabled?
+        @default_handling_disabled
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: czmq-ffi-gen
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Patrik Wenger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-15 00:00:00.000000000 Z
+date: 2015-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -111,12 +111,14 @@ files:
 - lib/czmq-ffi-gen/czmq/ffi/zloop.rb
 - lib/czmq-ffi-gen/czmq/ffi/zmsg.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
 - lib/czmq-ffi-gen/czmq/ffi/zstr.rb
 - lib/czmq-ffi-gen/czmq/ffi/ztrie.rb
 - lib/czmq-ffi-gen/czmq/ffi/zuuid.rb
 - lib/czmq-ffi-gen/gem_version.rb
 - lib/czmq-ffi-gen/library_version.rb
+- lib/czmq-ffi-gen/signals.rb
 homepage: https://github.com/paddor/czmq-ffi-gen
 licenses:
 - ISC