czmq-ffi-gen 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d73add1339edd404b96de5b47ff0e7513dff7fe2
-  data.tar.gz: 3b973b9f975f49eadc315eab5c7ac0b24e25e3f9
+  metadata.gz: 739bb30054648efc602eaff62354c63633ed0099
+  data.tar.gz: 2a81080b5e56231ede1770090e3168172cd0004d
 SHA512:
-  metadata.gz: 3bfddad065f3a2359bffe941773e4d7c24a36faac3f212d8fa9ac0ef2054fa0ceb41acbc9bd01e87b865af954d999ad087188ac61253c6d74aa90ac5d8f05cd5
-  data.tar.gz: 724a03ba6f49474f9080ce6ccae8b8d6da4d6966d7b41758b6c93f2cdfbdfa2cb739fa39a13c496d8b78a6d5015e224f89c3d3dcd7d5c27e0dc98d343c968e35
+  metadata.gz: 0aeb9fded462ac3262657cf447d34ceeb227b5446ed26b3ea23848634600a7587e899234bb83272753a1f211a0c37010a85c8c5bf19762de204bbe0d33f663ce
+  data.tar.gz: b6fdf14d753658728786dbd3e4c440a7a6acac96c6f0608d8cb0950079995de5b8a151b474bd4536fdb617d9d5f9aea816e5aa91207922995c0d0510862c1d65

data/CHANGES.md

@@ -1,3 +1,8 @@
+0.2.1 (12/12/2015)
+-----
+* upgrade CZMQ low-level binding to
+  - allow passing a null pointer (nil) for an FFI :string parameter
+
 0.2.0 (12/10/2015)
 -----
 * using new CZMQ version which

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

@@ -60,11 +60,18 @@ module CZMQ
         raise DestroyedError unless @ptr
         ptr_ptr = ::FFI::MemoryPointer.new :pointer
         ptr_ptr.write_pointer @ptr
-        ObjectSpace.undefine_finalizer self if @finalizer
-        @finalizer = nil
+        __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 callback of the following type:
       # Actors get a pipe and arguments from caller

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

@@ -60,11 +60,18 @@ module CZMQ
         raise DestroyedError unless @ptr
         ptr_ptr = ::FFI::MemoryPointer.new :pointer
         ptr_ptr.write_pointer @ptr
-        ObjectSpace.undefine_finalizer self if @finalizer
-        @finalizer = nil
+        __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 zarmour.
       # @return [CZMQ::Zarmour]
@@ -111,13 +118,12 @@ module CZMQ
       # The decoded output is null-terminated, so it may be treated
       # as a string, if that's what it was prior to encoding.      
       #
-      # @param data [String, #to_str, #to_s]
+      # @param data [String, #to_s, nil]
       # @param decode_size [::FFI::Pointer, #to_ptr]
       # @return [::FFI::Pointer]
       def decode(data, decode_size)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        data = String(data)
         result = ::CZMQ::FFI.zarmour_decode(self_p, data, decode_size)
         result
       end

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

@@ -60,11 +60,18 @@ module CZMQ
         raise DestroyedError unless @ptr
         ptr_ptr = ::FFI::MemoryPointer.new :pointer
         ptr_ptr.write_pointer @ptr
-        ObjectSpace.undefine_finalizer self if @finalizer
-        @finalizer = nil
+        __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 and initialize a new certificate in memory
       # @return [CZMQ::Zcert]
@@ -83,10 +90,9 @@ module CZMQ
       end
 
       # Load certificate from file
-      # @param filename [String, #to_str, #to_s]
+      # @param filename [String, #to_s, nil]
       # @return [CZMQ::Zcert]
       def self.load(filename)
-        filename = String(filename)
         ptr = ::CZMQ::FFI.zcert_load(filename)
         __new ptr
       end
@@ -143,15 +149,13 @@ module CZMQ
 
       # Set certificate metadata from formatted string.
       #
-      # @param name [String, #to_str, #to_s]
-      # @param format [String, #to_str, #to_s]
+      # @param name [String, #to_s, nil]
+      # @param format [String, #to_s, nil]
       # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
       # @return [void]
       def set_meta(name, format, *args)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        name = String(name)
-        format = String(format)
         result = ::CZMQ::FFI.zcert_set_meta(self_p, name, format, *args)
         result
       end
@@ -159,12 +163,11 @@ module CZMQ
       # Get metadata value from certificate; if the metadata value doesn't
       # exist, returns NULL.                                              
       #
-      # @param name [String, #to_str, #to_s]
+      # @param name [String, #to_s, nil]
       # @return [::FFI::Pointer]
       def meta(name)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        name = String(name)
         result = ::CZMQ::FFI.zcert_meta(self_p, name)
         result
       end
@@ -184,36 +187,33 @@ module CZMQ
       # 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_str, #to_s]
+      # @param filename [String, #to_s, nil]
       # @return [Integer]
       def save(filename)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        filename = String(filename)
         result = ::CZMQ::FFI.zcert_save(self_p, filename)
         result
       end
 
       # Save public certificate only to file for persistent storage
       #
-      # @param filename [String, #to_str, #to_s]
+      # @param filename [String, #to_s, nil]
       # @return [Integer]
       def save_public(filename)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        filename = String(filename)
         result = ::CZMQ::FFI.zcert_save_public(self_p, filename)
         result
       end
 
       # Save secret certificate only to file for persistent storage
       #
-      # @param filename [String, #to_str, #to_s]
+      # @param filename [String, #to_s, nil]
       # @return [Integer]
       def save_secret(filename)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        filename = String(filename)
         result = ::CZMQ::FFI.zcert_save_secret(self_p, filename)
         result
       end

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

@@ -60,11 +60,18 @@ module CZMQ
         raise DestroyedError unless @ptr
         ptr_ptr = ::FFI::MemoryPointer.new :pointer
         ptr_ptr.write_pointer @ptr
-        ObjectSpace.undefine_finalizer self if @finalizer
-        @finalizer = nil
+        __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 certificate store from a disk directory, loading and        
       # indexing all certificates in that location. The directory itself may be  
@@ -72,10 +79,9 @@ module CZMQ
       # 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_str, #to_s]
+      # @param location [String, #to_s, nil]
       # @return [CZMQ::Zcertstore]
       def self.new(location)
-        location = String(location)
         ptr = ::CZMQ::FFI.zcertstore_new(location)
         __new ptr
       end
@@ -94,12 +100,11 @@ module CZMQ
       # Look up certificate by public key, returns zcert_t object if found,
       # else returns NULL. The public key is provided in Z85 text format.  
       #
-      # @param public_key [String, #to_str, #to_s]
+      # @param public_key [String, #to_s, nil]
       # @return [Zcert]
       def lookup(public_key)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        public_key = String(public_key)
         result = ::CZMQ::FFI.zcertstore_lookup(self_p, public_key)
         result = Zcert.__new result, false
         result

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

@@ -60,11 +60,18 @@ module CZMQ
         raise DestroyedError unless @ptr
         ptr_ptr = ::FFI::MemoryPointer.new :pointer
         ptr_ptr.write_pointer @ptr
-        ObjectSpace.undefine_finalizer self if @finalizer
-        @finalizer = nil
+        __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 callback of the following type:
       # 
@@ -85,11 +92,10 @@ module CZMQ
       end
 
       # Create new config item
-      # @param name [String, #to_str, #to_s]
+      # @param name [String, #to_s, nil]
       # @param parent [Zconfig, #__ptr]
       # @return [CZMQ::Zconfig]
       def self.new(name, parent)
-        name = String(name)
         parent = parent.__ptr if parent
         ptr = ::CZMQ::FFI.zconfig_new(name, parent)
         __new ptr
@@ -98,21 +104,19 @@ module CZMQ
       # Load a config tree from a specified ZPL text file; returns a zconfig_t  
       # reference for the root, if the file exists and is readable. Returns NULL
       # if the file does not exist.                                             
-      # @param filename [String, #to_str, #to_s]
+      # @param filename [String, #to_s, nil]
       # @return [CZMQ::Zconfig]
       def self.load(filename)
-        filename = String(filename)
         ptr = ::CZMQ::FFI.zconfig_load(filename)
         __new ptr
       end
 
       # Equivalent to zconfig_load, taking a format string instead of a fixed
       # filename.                                                            
-      # @param format [String, #to_str, #to_s]
+      # @param format [String, #to_s, nil]
       # @param args [Array<Object>]
       # @return [CZMQ::Zconfig]
       def self.loadf(format, *args)
-        format = String(format)
         ptr = ::CZMQ::FFI.zconfig_loadf(format, *args)
         __new ptr
       end
@@ -149,14 +153,12 @@ module CZMQ
 
       # Insert or update configuration key with value
       #
-      # @param path [String, #to_str, #to_s]
-      # @param value [String, #to_str, #to_s]
+      # @param path [String, #to_s, nil]
+      # @param value [String, #to_s, nil]
       # @return [void]
       def put(path, value)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        path = String(path)
-        value = String(value)
         result = ::CZMQ::FFI.zconfig_put(self_p, path, value)
         result
       end
@@ -164,15 +166,13 @@ module CZMQ
       # Equivalent to zconfig_put, accepting a format specifier and variable
       # argument list, instead of a single string value.                    
       #
-      # @param path [String, #to_str, #to_s]
-      # @param format [String, #to_str, #to_s]
+      # @param path [String, #to_s, nil]
+      # @param format [String, #to_s, nil]
       # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
       # @return [void]
       def putf(path, format, *args)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        path = String(path)
-        format = String(format)
         result = ::CZMQ::FFI.zconfig_putf(self_p, path, format, *args)
         result
       end
@@ -180,26 +180,23 @@ module CZMQ
       # Get value for config item into a string value; leading slash is optional
       # and ignored.                                                            
       #
-      # @param path [String, #to_str, #to_s]
-      # @param default_value [String, #to_str, #to_s]
+      # @param path [String, #to_s, nil]
+      # @param default_value [String, #to_s, nil]
       # @return [::FFI::Pointer]
       def get(path, default_value)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        path = String(path)
-        default_value = String(default_value)
         result = ::CZMQ::FFI.zconfig_get(self_p, path, default_value)
         result
       end
 
       # Set config item name, name may be NULL
       #
-      # @param name [String, #to_str, #to_s]
+      # @param name [String, #to_s, nil]
       # @return [void]
       def set_name(name)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        name = String(name)
         result = ::CZMQ::FFI.zconfig_set_name(self_p, name)
         result
       end
@@ -209,13 +206,12 @@ module CZMQ
       # comes from an insecure source, you must use '%s' as the format, followed
       # by the string.                                                          
       #
-      # @param format [String, #to_str, #to_s]
+      # @param format [String, #to_s, nil]
       # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
       # @return [void]
       def set_value(format, *args)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        format = String(format)
         result = ::CZMQ::FFI.zconfig_set_value(self_p, format, *args)
         result
       end
@@ -244,12 +240,11 @@ module CZMQ
 
       # Find a config item along a path; leading slash is optional and ignored.
       #
-      # @param path [String, #to_str, #to_s]
+      # @param path [String, #to_s, nil]
       # @return [Zconfig]
       def locate(path)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        path = String(path)
         result = ::CZMQ::FFI.zconfig_locate(self_p, path)
         result = Zconfig.__new result, false
         result
@@ -285,13 +280,12 @@ module CZMQ
       # comment lines as you like. If you use a null format, all comments are
       # deleted.                                                             
       #
-      # @param format [String, #to_str, #to_s]
+      # @param format [String, #to_s, nil]
       # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
       # @return [void]
       def set_comment(format, *args)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        format = String(format)
         result = ::CZMQ::FFI.zconfig_set_comment(self_p, format, *args)
         result
       end
@@ -310,12 +304,11 @@ module CZMQ
       # Save a config tree to a specified ZPL text file, where a filename
       # "-" means dump to standard output.                               
       #
-      # @param filename [String, #to_str, #to_s]
+      # @param filename [String, #to_s, nil]
       # @return [Integer]
       def save(filename)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        filename = String(filename)
         result = ::CZMQ::FFI.zconfig_save(self_p, filename)
         result
       end
@@ -323,13 +316,12 @@ module CZMQ
       # Equivalent to zconfig_save, taking a format string instead of a fixed
       # filename.                                                            
       #
-      # @param format [String, #to_str, #to_s]
+      # @param format [String, #to_s, nil]
       # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
       # @return [Integer]
       def savef(format, *args)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        format = String(format)
         result = ::CZMQ::FFI.zconfig_savef(self_p, format, *args)
         result
       end
@@ -378,10 +370,9 @@ module CZMQ
 
       # Load a config tree from a null-terminated string
       #
-      # @param string [String, #to_str, #to_s]
+      # @param string [String, #to_s, nil]
       # @return [Zconfig]
       def self.str_load(string)
-        string = String(string)
         result = ::CZMQ::FFI.zconfig_str_load(string)
         result = Zconfig.__new result, true
         result

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

@@ -60,21 +60,26 @@ module CZMQ
         raise DestroyedError unless @ptr
         ptr_ptr = ::FFI::MemoryPointer.new :pointer
         ptr_ptr.write_pointer @ptr
-        ObjectSpace.undefine_finalizer self if @finalizer
-        @finalizer = nil
+        __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 directory item that loads in the full tree of the specified
       # path, optionally located under some parent path. If parent is "-", then 
       # loads only the top-level directory, and does not use parent as a path.  
-      # @param path [String, #to_str, #to_s]
-      # @param parent [String, #to_str, #to_s]
+      # @param path [String, #to_s, nil]
+      # @param parent [String, #to_s, nil]
       # @return [CZMQ::Zdir]
       def self.new(path, parent)
-        path = String(path)
-        parent = String(parent)
         ptr = ::CZMQ::FFI.zdir_new(path, parent)
         __new ptr
       end
@@ -164,12 +169,11 @@ module CZMQ
       #
       # @param older [Zdir, #__ptr]
       # @param newer [Zdir, #__ptr]
-      # @param alias_ [String, #to_str, #to_s]
+      # @param alias_ [String, #to_s, nil]
       # @return [Zlist]
       def self.diff(older, newer, alias_)
         older = older.__ptr if older
         newer = newer.__ptr if newer
-        alias_ = String(alias_)
         result = ::CZMQ::FFI.zdir_diff(older, newer, alias_)
         result = Zlist.__new result, true
         result
@@ -177,12 +181,11 @@ module CZMQ
 
       # Return full contents of directory as a zdir_patch list.
       #
-      # @param alias_ [String, #to_str, #to_s]
+      # @param alias_ [String, #to_s, nil]
       # @return [Zlist]
       def resync(alias_)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        alias_ = String(alias_)
         result = ::CZMQ::FFI.zdir_resync(self_p, alias_)
         result = Zlist.__new result, true
         result