czmq-ffi-gen 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6513e81d88e575dca1b7746d5e1a9bf22ac47426
-  data.tar.gz: 10a74a54e3db24ba434d0b0cfd0b559fd554714b
+  metadata.gz: b634e62bd8c72143a970934c9725f5a9067e3952
+  data.tar.gz: fbdaeaab8b805c156b252795cf03c6e65302fafd
 SHA512:
-  metadata.gz: ecb3895cc443b32b04e37f2d66649c35c601416cf33c467b3034ddc4c002b43ffda221a14e991ef0106acd96b0560067b953b150f81e5100b48ef65f3a8d8408
-  data.tar.gz: f62d6bf5f1a1b47ba4b049a7339a69edd9dd402c3f1f41d44aa0ed38616ba2c1e57f7ea1413b715022c2a08082636bc2b3c0490a5645bec51c1a55805babb588
+  metadata.gz: f152c3f1db2a4a823e42eebe5dbe3f2695a9efdb13b460e04d11a504fed55a4fb25ab36f5bdc17beb1f529cfedc93e9d7e9d29b0b6e317da95d59864d056ff35
+  data.tar.gz: a6d4854e57cbb1c266be6b3e4069ef6b32b806b6d13c372d294e4394ca94f8493122193a6281ac3a33c5490ea0ad936632692527c54915500efb650554c56bb3

data/CHANGES.md

@@ -1,3 +1,11 @@
+0.14.0 (11/27/2017)
+-----
+* on Windows with RubyInstaller2: fix loading libczmq
+  (thanks to Christian Boos)
+* update CZMQ low-level binding to include the improvements on robustness
+  (zeromq/zproject#1010)
+* CI: use recent rubies, but don't test MRI 2.1 anymore
+
 0.13.0 (01/01/2017)
 -----
 * update CZMQ low-level binding to v4.0.2 to fix #7

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

@@ -75,7 +75,7 @@ module CZMQ
 
       # Create a new callback of the following type:
       # Actors get a pipe and arguments from caller
-      #     typedef void (zactor_fn) (     
+      #     typedef void (zactor_fn) (
       #         zsock_t *pipe, void *args);
       #
       # @note WARNING: If your Ruby code doesn't retain a reference to the
@@ -90,6 +90,28 @@ module CZMQ
         end
       end
 
+      # Create a new callback of the following type:
+      # Function to be called on zactor_destroy. Default behavior is to send zmsg_t with string "$TERM" in a first frame.
+      #
+      # An example - to send $KTHXBAI string
+      #
+      #     if (zstr_send (self->pipe, "$KTHXBAI") == 0)
+      #         zsock_wait (self->pipe);
+      #     typedef void (zactor_destructor_fn) (
+      #         zactor_t *self);
+      #
+      # @note WARNING: If your Ruby code doesn't retain a reference to the
+      #   FFI::Function object after passing it to a C function call,
+      #   it may be garbage collected while C still holds the pointer,
+      #   potentially resulting in a segmentation fault.
+      def self.destructor_fn
+        ::FFI::Function.new :void, [:pointer], blocking: true do |self_|
+          self_ = Zactor.__new self_, false
+          result = yield self_
+          result
+        end
+      end
+
       # Create a new actor passing arbitrary arguments reference.
       # @param task [::FFI::Pointer, #to_ptr]
       # @param args [::FFI::Pointer, #to_ptr]
@@ -110,7 +132,7 @@ module CZMQ
       end
 
       # Send a zmsg message to the actor, take ownership of the message
-      # and destroy when it has been sent.                             
+      # and destroy when it has been sent.
       #
       # @param msg_p [#__ptr_give_ref]
       # @return [Integer]
@@ -122,9 +144,9 @@ module CZMQ
         result
       end
 
-      # Receive a zmsg message from the actor. Returns NULL if the actor 
+      # Receive a zmsg message from the actor. Returns NULL if the actor
       # was interrupted before the message could be received, or if there
-      # was a timeout on the actor.                                      
+      # was a timeout on the actor.
       #
       # @return [Zmsg]
       def recv()
@@ -145,8 +167,8 @@ module CZMQ
       end
 
       # Probe the supplied reference. If it looks like a zactor_t instance,
-      # return the underlying libzmq actor handle; else if it looks like   
-      # a libzmq actor handle, return the supplied value.                  
+      # return the underlying libzmq actor handle; else if it looks like
+      # a libzmq actor handle, return the supplied value.
       #
       # @param self_ [::FFI::Pointer, #to_ptr]
       # @return [::FFI::Pointer]
@@ -156,7 +178,7 @@ module CZMQ
       end
 
       # Return the actor's zsock handle. Use this when you absolutely need
-      # to work with the zsock instance rather than the actor.            
+      # to work with the zsock instance rather than the actor.
       #
       # @return [Zsock]
       def sock()
@@ -167,6 +189,17 @@ module CZMQ
         result
       end
 
+      # Change default destructor by custom function. Actor MUST be able to handle new message instead of default $TERM.
+      #
+      # @param destructor [::FFI::Pointer, #to_ptr]
+      # @return [void]
+      def set_destructor(destructor)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zactor_set_destructor(self_p, destructor)
+        result
+      end
+
       # Self test of this class.
       #
       # @param verbose [Boolean]

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

@@ -0,0 +1,259 @@
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Read the zproject/README.md for information about making permanent changes. #
+################################################################################
+
+module CZMQ
+  module FFI
+
+    # Platform independent command line argument parsing helpers
+    #
+    # There are two kind of elements provided by this class
+    # foo --named-parameter --parameter with_value positional arguments -a gain-parameter
+    # zargs keeps poision only for arguments, parameters are to be accessed like hash.
+    #
+    # It DOES:
+    # * provide easy to use CLASS compatible API for accessing argv
+    # * is platform independent
+    # * provide getopt_long style -- argument, which delimits parameters from arguments
+    # * makes parameters positon independent
+    #
+    # It does NOT
+    # * change argv
+    # * provide a "declarative" way to define command line interface
+    #
+    # In future it SHALL
+    # * hide several formats of command line to one (-Idir, --include=dir,
+    #   --include dir are the same from API pov)
+    # @note This class is 100% generated using zproject.
+    class Zargs
+      # Raised when one tries to use an instance of {Zargs} 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
+      # @param ptr [::FFI::Pointer]
+      # @return [Proc]
+      def self.create_finalizer_for(ptr)
+        Proc.new do
+          ptr_ptr = ::FFI::MemoryPointer.new :pointer
+          ptr_ptr.write_pointer ptr
+          ::CZMQ::FFI.zargs_destroy ptr_ptr
+        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
+
+      # Create a new zargs from command line arguments.
+      # @param argc [Integer, #to_int, #to_i]
+      # @param argv [::FFI::Pointer, #to_ptr]
+      # @return [CZMQ::Zargs]
+      def self.new(argc, argv)
+        argc = Integer(argc)
+        ptr = ::CZMQ::FFI.zargs_new(argc, argv)
+        __new ptr
+      end
+
+      # Destroy zargs instance.
+      #
+      # @return [void]
+      def destroy()
+        return unless @ptr
+        self_p = __ptr_give_ref
+        result = ::CZMQ::FFI.zargs_destroy(self_p)
+        result
+      end
+
+      # Return program name (argv[0])
+      #
+      # @return [String]
+      def progname()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zargs_progname(self_p)
+        result
+      end
+
+      # Return number of positional arguments
+      #
+      # @return [Integer]
+      def arguments()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zargs_arguments(self_p)
+        result
+      end
+
+      # Return first positional argument or NULL
+      #
+      # @return [String]
+      def first()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zargs_first(self_p)
+        result
+      end
+
+      # Return next positional argument or NULL
+      #
+      # @return [String]
+      def next()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zargs_next(self_p)
+        result
+      end
+
+      # Return first named parameter value, or NULL if there are no named
+      # parameters, or value for which zargs_param_empty (arg) returns true.
+      #
+      # @return [String]
+      def param_first()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zargs_param_first(self_p)
+        result
+      end
+
+      # Return next named parameter value, or NULL if there are no named
+      # parameters, or value for which zargs_param_empty (arg) returns true.
+      #
+      # @return [String]
+      def param_next()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zargs_param_next(self_p)
+        result
+      end
+
+      # Return current parameter name, or NULL if there are no named
+      # parameters.
+      #
+      # @return [String]
+      def param_name()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zargs_param_name(self_p)
+        result
+      end
+
+      # Return value of named parameter, NULL if no given parameter has
+      # been specified, or special value for wich zargs_param_empty ()
+      # returns true.
+      #
+      # @param keys [String, #to_s, nil]
+      # @return [String]
+      def param_lookup(keys)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zargs_param_lookup(self_p, keys)
+        result
+      end
+
+      # Return value of named parameter(s), NULL if no given parameter has
+      # been specified, or special value for wich zargs_param_empty ()
+      # returns true.
+      #
+      # @param keys [String, #to_s, nil]
+      # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
+      # @return [String]
+      def param_lookupx(keys, *args)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zargs_param_lookupx(self_p, keys, *args)
+        result
+      end
+
+      # Returns true if there are --help -h arguments
+      #
+      # @return [Boolean]
+      def has_help()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zargs_has_help(self_p)
+        result
+      end
+
+      # Returns true if parameter did not have a value
+      #
+      # @param arg [String, #to_s, nil]
+      # @return [Boolean]
+      def self.param_empty(arg)
+        result = ::CZMQ::FFI.zargs_param_empty(arg)
+        result
+      end
+
+      # Print an instance of zargs.
+      #
+      # @return [void]
+      def print()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zargs_print(self_p)
+        result
+      end
+
+      # Self test of this class.
+      #
+      # @param verbose [Boolean]
+      # @return [void]
+      def self.test(verbose)
+        verbose = !(0==verbose||!verbose) # boolean
+        result = ::CZMQ::FFI.zargs_test(verbose)
+        result
+      end
+    end
+  end
+end
+
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Read the zproject/README.md for information about making permanent changes. #
+################################################################################

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

@@ -110,7 +110,7 @@ module CZMQ
 
       # Encode a stream of bytes into an armoured string. Returns the armoured
       # string, or NULL if there was insufficient memory available to allocate
-      # a new string.                                                         
+      # a new string.
       #
       # @param data [::FFI::Pointer, #to_ptr]
       # @param size [Integer, #to_int, #to_i]
@@ -124,9 +124,9 @@ module CZMQ
         result
       end
 
-      # Decode an armoured string into a chunk. The decoded output is    
+      # Decode an armoured string into a chunk. The decoded output is
       # null-terminated, so it may be treated as a string, if that's what
-      # it was prior to encoding.                                        
+      # it was prior to encoding.
       #
       # @param data [String, #to_s, nil]
       # @return [Zchunk]

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

@@ -89,6 +89,15 @@ module CZMQ
         __new ptr
       end
 
+      # Accepts public/secret key text pair from caller
+      # @param public_txt [String, #to_s, nil]
+      # @param secret_txt [String, #to_s, nil]
+      # @return [CZMQ::Zcert]
+      def self.new_from_txt(public_txt, secret_txt)
+        ptr = ::CZMQ::FFI.zcert_new_from_txt(public_txt, secret_txt)
+        __new ptr
+      end
+
       # Load certificate from file
       # @param filename [String, #to_s, nil]
       # @return [CZMQ::Zcert]
@@ -172,7 +181,7 @@ module CZMQ
       end
 
       # Get metadata value from certificate; if the metadata value doesn't
-      # exist, returns NULL.                                              
+      # exist, returns NULL.
       #
       # @param name [String, #to_s, nil]
       # @return [String]
@@ -184,7 +193,7 @@ module CZMQ
       end
 
       # Get list of metadata fields from certificate. Caller is responsible for
-      # destroying list. Caller should not modify the values of list items.    
+      # destroying list. Caller should not modify the values of list items.
       #
       # @return [Zlist]
       def meta_keys()
@@ -195,7 +204,7 @@ module CZMQ
         result
       end
 
-      # Save full certificate (public + secret) to file for persistent storage  
+      # Save full certificate (public + secret) to file for persistent storage
       # This creates one public file and one secret file (filename + "_secret").
       #
       # @param filename [String, #to_s, nil]
@@ -230,8 +239,8 @@ module CZMQ
       end
 
       # Apply certificate to socket, i.e. use for CURVE security on socket.
-      # If certificate was loaded from public file, the secret key will be 
-      # undefined, and this certificate will not work successfully.        
+      # If certificate was loaded from public file, the secret key will be
+      # undefined, and this certificate will not work successfully.
       #
       # @param socket [::FFI::Pointer, #to_ptr]
       # @return [void]
@@ -243,7 +252,7 @@ module CZMQ
       end
 
       # Return copy of certificate; if certificate is NULL or we exhausted
-      # heap memory, returns NULL.                                        
+      # heap memory, returns NULL.
       #
       # @return [Zcert]
       def dup()

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

@@ -76,7 +76,7 @@ module CZMQ
       # Create a new callback of the following type:
       # Loaders retrieve certificates from an arbitrary source.
       #     typedef void (zcertstore_loader) (
-      #         zcertstore_t *self);          
+      #         zcertstore_t *self);
       #
       # @note WARNING: If your Ruby code doesn't retain a reference to the
       #   FFI::Function object after passing it to a C function call,
@@ -93,7 +93,7 @@ module CZMQ
       # Create a new callback of the following type:
       # Destructor for loader state.
       #     typedef void (zcertstore_destructor) (
-      #         void **self_p);                   
+      #         void **self_p);
       #
       # @note WARNING: If your Ruby code doesn't retain a reference to the
       #   FFI::Function object after passing it to a C function call,
@@ -106,12 +106,12 @@ module CZMQ
         end
       end
 
-      # Create a new certificate store from a disk directory, loading and        
-      # indexing all certificates in that location. The directory itself may be  
+      # Create a new certificate store from a disk directory, loading and
+      # indexing all certificates in that location. The directory itself may be
       # absent, and created later, or modified at any time. The certificate store
-      # is automatically refreshed on any zcertstore_lookup() call. If the       
-      # location is specified as NULL, creates a pure-memory store, which you    
-      # can work with by inserting certificates at runtime.                      
+      # is automatically refreshed on any zcertstore_lookup() call. If the
+      # location is specified as NULL, creates a pure-memory store, which you
+      # can work with by inserting certificates at runtime.
       # @param location [String, #to_s, nil]
       # @return [CZMQ::Zcertstore]
       def self.new(location)
@@ -120,7 +120,7 @@ module CZMQ
       end
 
       # Destroy a certificate store object in memory. Does not affect anything
-      # stored on disk.                                                       
+      # stored on disk.
       #
       # @return [void]
       def destroy()
@@ -144,7 +144,7 @@ module CZMQ
       end
 
       # Look up certificate by public key, returns zcert_t object if found,
-      # else returns NULL. The public key is provided in Z85 text format.  
+      # else returns NULL. The public key is provided in Z85 text format.
       #
       # @param public_key [String, #to_s, nil]
       # @return [Zcert]
@@ -158,7 +158,7 @@ module CZMQ
 
       # Insert certificate into certificate store in memory. Note that this
       # does not save the certificate to disk. To do that, use zcert_save()
-      # directly on the certificate. Takes ownership of zcert_t object.    
+      # directly on the certificate. Takes ownership of zcert_t object.
       #
       # @param cert_p [#__ptr_give_ref]
       # @return [void]
@@ -171,7 +171,7 @@ module CZMQ
       end
 
       # Empty certificate hashtable. This wrapper exists to be friendly to bindings,
-      # which don't usually have access to struct internals.                        
+      # which don't usually have access to struct internals.
       #
       # @return [void]
       def empty()
@@ -191,6 +191,20 @@ module CZMQ
         result
       end
 
+      # Return a list of all the certificates in the store.
+      # The caller takes ownership of the zlistx_t object and is responsible
+      # for destroying it.  The caller does not take ownership of the zcert_t
+      # objects.
+      #
+      # @return [Zlistx]
+      def certs()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zcertstore_certs(self_p)
+        result = Zlistx.__new result, true
+        result
+      end
+
       # Self test of this class
       #
       # @param verbose [Boolean]

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

@@ -73,8 +73,8 @@ module CZMQ
         @finalizer = nil
       end
 
-      # Create a new chunk of the specified size. If you specify the data, it   
-      # is copied into the chunk. If you do not specify the data, the chunk is  
+      # Create a new chunk of the specified size. If you specify the data, it
+      # is copied into the chunk. If you do not specify the data, the chunk is
       # allocated and left empty, and you can then add data using zchunk_append.
       # @param data [::FFI::Pointer, #to_ptr]
       # @param size [Integer, #to_int, #to_i]
@@ -138,7 +138,7 @@ module CZMQ
       end
 
       # Set chunk data from user-supplied data; truncate if too large. Data may
-      # be null. Returns actual size of chunk                                  
+      # be null. Returns actual size of chunk
       #
       # @param data [::FFI::Pointer, #to_ptr]
       # @param size [Integer, #to_int, #to_i]
@@ -165,9 +165,9 @@ module CZMQ
         result
       end
 
-      # Append user-supplied data to chunk, return resulting chunk size. If the 
+      # Append user-supplied data to chunk, return resulting chunk size. If the
       # data would exceeded the available space, it is truncated. If you want to
-      # grow the chunk to accommodate new data, use the zchunk_extend method.   
+      # grow the chunk to accommodate new data, use the zchunk_extend method.
       #
       # @param data [::FFI::Pointer, #to_ptr]
       # @param size [Integer, #to_int, #to_i]
@@ -181,7 +181,7 @@ module CZMQ
       end
 
       # Append user-supplied data to chunk, return resulting chunk size. If the
-      # data would exceeded the available space, the chunk grows in size.      
+      # data would exceeded the available space, the chunk grows in size.
       #
       # @param data [::FFI::Pointer, #to_ptr]
       # @param size [Integer, #to_int, #to_i]
@@ -194,10 +194,10 @@ module CZMQ
         result
       end
 
-      # Copy as much data from 'source' into the chunk as possible; returns the  
-      # new size of chunk. If all data from 'source' is used, returns exhausted  
+      # Copy as much data from 'source' into the chunk as possible; returns the
+      # new size of chunk. If all data from 'source' is used, returns exhausted
       # on the source chunk. Source can be consumed as many times as needed until
-      # it is exhausted. If source was already exhausted, does not change chunk. 
+      # it is exhausted. If source was already exhausted, does not change chunk.
       #
       # @param source [Zchunk, #__ptr]
       # @return [Integer]
@@ -210,7 +210,7 @@ module CZMQ
       end
 
       # Returns true if the chunk was exhausted by consume methods, or if the
-      # chunk has a size of zero.                                            
+      # chunk has a size of zero.
       #
       # @return [Boolean]
       def exhausted()
@@ -243,9 +243,9 @@ module CZMQ
         result
       end
 
-      # Try to slurp an entire file into a chunk. Will read up to maxsize of  
-      # the file. If maxsize is 0, will attempt to read the entire file and   
-      # fail with an assertion if that cannot fit into memory. Returns a new  
+      # Try to slurp an entire file into a chunk. Will read up to maxsize of
+      # the file. If maxsize is 0, will attempt to read the entire file and
+      # fail with an assertion if that cannot fit into memory. Returns a new
       # chunk containing the file data, or NULL if the file could not be read.
       #
       # @param filename [String, #to_s, nil]
@@ -258,9 +258,9 @@ module CZMQ
         result
       end
 
-      # Create copy of chunk, as new chunk object. Returns a fresh zchunk_t   
+      # Create copy of chunk, as new chunk object. Returns a fresh zchunk_t
       # object, or null if there was not enough heap memory. If chunk is null,
-      # returns null.                                                         
+      # returns null.
       #
       # @return [Zchunk]
       def dup()
@@ -272,7 +272,7 @@ module CZMQ
       end
 
       # Return chunk data encoded as printable hex string. Caller must free
-      # string when finished with it.                                      
+      # string when finished with it.
       #
       # @return [::FFI::AutoPointer]
       def strhex()
@@ -284,7 +284,7 @@ module CZMQ
       end
 
       # Return chunk data copied into freshly allocated string
-      # Caller must free string when finished with it.        
+      # Caller must free string when finished with it.
       #
       # @return [::FFI::AutoPointer]
       def strdup()
@@ -350,7 +350,7 @@ module CZMQ
       end
 
       # Dump message to stderr, for debugging and tracing.
-      # See zchunk_fprint for details                     
+      # See zchunk_fprint for details
       #
       # @return [void]
       def print()