czmq-ffi-gen 0.13.0 → 0.14.0

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

@@ -82,9 +82,9 @@ module CZMQ
         result
       end
 
-      # Return current system clock as milliseconds. Note that this clock can  
+      # Return current system clock as milliseconds. Note that this clock can
       # jump backwards (if the system clock is changed) so is unsafe to use for
-      # timers and time offsets. Use zclock_mono for that instead.             
+      # timers and time offsets. Use zclock_mono for that instead.
       #
       # @return [::FFI::Pointer]
       def self.time()
@@ -93,8 +93,8 @@ module CZMQ
       end
 
       # Return current monotonic clock in milliseconds. Use this when you compute
-      # time offsets. The monotonic clock is not affected by system changes and  
-      # so will never be reset backwards, unlike a system clock.                 
+      # time offsets. The monotonic clock is not affected by system changes and
+      # so will never be reset backwards, unlike a system clock.
       #
       # @return [::FFI::Pointer]
       def self.mono()
@@ -103,8 +103,8 @@ module CZMQ
       end
 
       # Return current monotonic clock in microseconds. Use this when you compute
-      # time offsets. The monotonic clock is not affected by system changes and  
-      # so will never be reset backwards, unlike a system clock.                 
+      # time offsets. The monotonic clock is not affected by system changes and
+      # so will never be reset backwards, unlike a system clock.
       #
       # @return [::FFI::Pointer]
       def self.usecs()

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

@@ -74,8 +74,8 @@ module CZMQ
       end
 
       # Create a new callback of the following type:
-      # 
-      #     typedef int (zconfig_fct) (                
+      #
+      #     typedef int (zconfig_fct) (
       #         zconfig_t *self, void *arg, int level);
       #
       # @note WARNING: If your Ruby code doesn't retain a reference to the
@@ -101,9 +101,9 @@ module CZMQ
         __new ptr
       end
 
-      # Load a config tree from a specified ZPL text file; returns a zconfig_t  
+      # 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.                                             
+      # if the file does not exist.
       # @param filename [String, #to_s, nil]
       # @return [CZMQ::Zconfig]
       def self.load(filename)
@@ -112,7 +112,7 @@ module CZMQ
       end
 
       # Equivalent to zconfig_load, taking a format string instead of a fixed
-      # filename.                                                            
+      # filename.
       # @param format [String, #to_s, nil]
       # @param args [Array<Object>]
       # @return [CZMQ::Zconfig]
@@ -164,7 +164,7 @@ module CZMQ
       end
 
       # Equivalent to zconfig_put, accepting a format specifier and variable
-      # argument list, instead of a single string value.                    
+      # argument list, instead of a single string value.
       #
       # @param path [String, #to_s, nil]
       # @param format [String, #to_s, nil]
@@ -178,7 +178,7 @@ module CZMQ
       end
 
       # Get value for config item into a string value; leading slash is optional
-      # and ignored.                                                            
+      # and ignored.
       #
       # @param path [String, #to_s, nil]
       # @param default_value [String, #to_s, nil]
@@ -201,10 +201,10 @@ module CZMQ
         result
       end
 
-      # Set new value for config item. The new value may be a string, a printf  
-      # format, or NULL. Note that if string may possibly contain '%', or if it 
+      # Set new value for config item. The new value may be a string, a printf
+      # format, or NULL. Note that if string may possibly contain '%', or if it
       # comes from an insecure source, you must use '%s' as the format, followed
-      # by the string.                                                          
+      # by the string.
       #
       # @param format [String, #to_s, nil]
       # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
@@ -264,7 +264,7 @@ module CZMQ
       end
 
       # Execute a callback for each config item in the tree; returns zero if
-      # successful, else -1.                                                
+      # successful, else -1.
       #
       # @param handler [::FFI::Pointer, #to_ptr]
       # @param arg [::FFI::Pointer, #to_ptr]
@@ -278,7 +278,7 @@ module CZMQ
 
       # Add comment to config item before saving to disk. You can add as many
       # comment lines as you like. If you use a null format, all comments are
-      # deleted.                                                             
+      # deleted.
       #
       # @param format [String, #to_s, nil]
       # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
@@ -302,7 +302,7 @@ module CZMQ
       end
 
       # Save a config tree to a specified ZPL text file, where a filename
-      # "-" means dump to standard output.                               
+      # "-" means dump to standard output.
       #
       # @param filename [String, #to_s, nil]
       # @return [Integer]
@@ -314,7 +314,7 @@ module CZMQ
       end
 
       # Equivalent to zconfig_save, taking a format string instead of a fixed
-      # filename.                                                            
+      # filename.
       #
       # @param format [String, #to_s, nil]
       # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
@@ -337,8 +337,8 @@ module CZMQ
       end
 
       # Reload config tree from same file that it was previously loaded from.
-      # Returns 0 if OK, -1 if there was an error (and then does not change  
-      # existing data).                                                      
+      # Returns 0 if OK, -1 if there was an error (and then does not change
+      # existing data).
       #
       # @param self_p [#__ptr_give_ref]
       # @return [Integer]
@@ -392,7 +392,7 @@ module CZMQ
       end
 
       # Return true if a configuration tree was loaded from a file and that
-      # file has changed in since the tree was loaded.                     
+      # file has changed in since the tree was loaded.
       #
       # @return [Boolean]
       def has_changed()
@@ -402,6 +402,16 @@ module CZMQ
         result
       end
 
+      # Destroy subtree (child)
+      #
+      # @return [void]
+      def remove()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zconfig_remove(self_p)
+        result
+      end
+
       # Print the config file to open stream
       #
       # @param file [::FFI::Pointer, #to_ptr]

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

@@ -74,7 +74,7 @@ module CZMQ
       end
 
       # Constructor - creates new digest object, which you use to build up a
-      # digest by repeatedly calling zdigest_update() on chunks of data.    
+      # digest by repeatedly calling zdigest_update() on chunks of data.
       # @return [CZMQ::Zdigest]
       def self.new()
         ptr = ::CZMQ::FFI.zdigest_new()
@@ -105,7 +105,7 @@ module CZMQ
       end
 
       # Return final digest hash data. If built without crypto support,
-      # returns NULL.                                                  
+      # returns NULL.
       #
       # @return [::FFI::Pointer]
       def data()
@@ -125,9 +125,9 @@ module CZMQ
         result
       end
 
-      # Return digest as printable hex string; caller should not modify nor   
+      # Return digest as printable hex string; caller should not modify nor
       # free this string. After calling this, you may not use zdigest_update()
-      # on the same digest. If built without crypto support, returns NULL.    
+      # on the same digest. If built without crypto support, returns NULL.
       #
       # @return [::FFI::Pointer]
       def string()

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

@@ -74,8 +74,8 @@ module CZMQ
       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.  
+      # 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_s, nil]
       # @param parent [String, #to_s, nil]
       # @return [CZMQ::Zdir]
@@ -115,7 +115,7 @@ module CZMQ
       end
 
       # Return total hierarchy size, in bytes of data contained in all files
-      # in the directory tree.                                              
+      # in the directory tree.
       #
       # @return [::FFI::Pointer]
       def cursize()
@@ -136,8 +136,8 @@ module CZMQ
       end
 
       # Returns a sorted list of zfile objects; Each entry in the list is a pointer
-      # to a zfile_t item already allocated in the zdir tree. Do not destroy the   
-      # original zdir tree until you are done with this list.                      
+      # to a zfile_t item already allocated in the zdir tree. Do not destroy the
+      # original zdir tree until you are done with this list.
       #
       # @return [Zlist]
       def list()
@@ -148,9 +148,9 @@ module CZMQ
         result
       end
 
-      # Remove directory, optionally including all files that it contains, at  
+      # Remove directory, optionally including all files that it contains, at
       # all levels. If force is false, will only remove the directory if empty.
-      # If force is true, will remove all files and all subdirectories.        
+      # If force is true, will remove all files and all subdirectories.
       #
       # @param force [Boolean]
       # @return [void]
@@ -162,10 +162,10 @@ module CZMQ
         result
       end
 
-      # Calculate differences between two versions of a directory tree.    
-      # Returns a list of zdir_patch_t patches. Either older or newer may  
+      # Calculate differences between two versions of a directory tree.
+      # Returns a list of zdir_patch_t patches. Either older or newer may
       # be null, indicating the directory is empty/absent. If alias is set,
-      # generates virtual filename (minus path, plus alias).               
+      # generates virtual filename (minus path, plus alias).
       #
       # @param older [Zdir, #__ptr]
       # @param newer [Zdir, #__ptr]
@@ -192,7 +192,7 @@ module CZMQ
       end
 
       # Load directory cache; returns a hash table containing the SHA-1 digests
-      # of every file in the tree. The cache is saved between runs in .cache.  
+      # of every file in the tree. The cache is saved between runs in .cache.
       #
       # @return [Zhash]
       def cache()
@@ -228,32 +228,32 @@ module CZMQ
         result
       end
 
-      # Create a new zdir_watch actor instance:                       
-      #                                                               
-      #     zactor_t *watch = zactor_new (zdir_watch, NULL);          
-      #                                                               
-      # Destroy zdir_watch instance:                                  
-      #                                                               
-      #     zactor_destroy (&watch);                                  
-      #                                                               
-      # Enable verbose logging of commands and activity:              
-      #                                                               
-      #     zstr_send (watch, "VERBOSE");                             
-      #                                                               
-      # Subscribe to changes to a directory path:                     
-      #                                                               
-      #     zsock_send (watch, "ss", "SUBSCRIBE", "directory_path");  
-      #                                                               
-      # Unsubscribe from changes to a directory path:                 
-      #                                                               
+      # Create a new zdir_watch actor instance:
+      #
+      #     zactor_t *watch = zactor_new (zdir_watch, NULL);
+      #
+      # Destroy zdir_watch instance:
+      #
+      #     zactor_destroy (&watch);
+      #
+      # Enable verbose logging of commands and activity:
+      #
+      #     zstr_send (watch, "VERBOSE");
+      #
+      # Subscribe to changes to a directory path:
+      #
+      #     zsock_send (watch, "ss", "SUBSCRIBE", "directory_path");
+      #
+      # Unsubscribe from changes to a directory path:
+      #
       #     zsock_send (watch, "ss", "UNSUBSCRIBE", "directory_path");
-      #                                                               
-      # Receive directory changes:                                    
-      #     zsock_recv (watch, "sp", &path, &patches);                
-      #                                                               
-      #     // Delete the received data.                              
-      #     free (path);                                              
-      #     zlist_destroy (&patches);                                 
+      #
+      # Receive directory changes:
+      #     zsock_recv (watch, "sp", &path, &patches);
+      #
+      #     // Delete the received data.
+      #     free (path);
+      #     zlist_destroy (&patches);
       #
       # @param pipe [Zsock, #__ptr]
       # @param unused [::FFI::Pointer, #to_ptr]

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

@@ -103,7 +103,7 @@ module CZMQ
       end
 
       # Create copy of a patch. If the patch is null, or memory was exhausted,
-      # returns null.                                                         
+      # returns null.
       #
       # @return [ZdirPatch]
       def dup()

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

@@ -77,7 +77,7 @@ module CZMQ
       # links, which are files with the extension ".ln". A symbolic link is a
       # text file containing one line, the filename of a target file. Reading
       # data from the symbolic link actually reads from the target file. Path
-      # may be NULL, in which case it is not used.                           
+      # may be NULL, in which case it is not used.
       # @param path [String, #to_s, nil]
       # @param name [String, #to_s, nil]
       # @return [CZMQ::Zfile]
@@ -86,6 +86,14 @@ module CZMQ
         __new ptr
       end
 
+      # Create new temporary file for writing via tmpfile. File is automaticaly
+      # deleted on destroy
+      # @return [CZMQ::Zfile]
+      def self.tmp()
+        ptr = ::CZMQ::FFI.zfile_tmp()
+        __new ptr
+      end
+
       # Destroy a file item
       #
       # @return [void]
@@ -97,7 +105,7 @@ module CZMQ
       end
 
       # Duplicate a file item, returns a newly constructed item. If the file
-      # is null, or memory was exhausted, returns null.                     
+      # is null, or memory was exhausted, returns null.
       #
       # @return [Zfile]
       def dup()
@@ -119,9 +127,9 @@ module CZMQ
         result
       end
 
-      # Refresh file properties from disk; this is not done automatically   
+      # Refresh file properties from disk; this is not done automatically
       # on access methods, otherwise it is not possible to compare directory
-      # snapshots.                                                          
+      # snapshots.
       #
       # @return [void]
       def restat()
@@ -132,7 +140,7 @@ module CZMQ
       end
 
       # Return when the file was last modified. If you want this to reflect the
-      # current situation, call zfile_restat before checking this property.    
+      # current situation, call zfile_restat before checking this property.
       #
       # @return [::FFI::Pointer]
       def modified()
@@ -143,7 +151,7 @@ module CZMQ
       end
 
       # Return the last-known size of the file. If you want this to reflect the
-      # current situation, call zfile_restat before checking this property.    
+      # current situation, call zfile_restat before checking this property.
       #
       # @return [::FFI::Pointer]
       def cursize()
@@ -153,7 +161,7 @@ module CZMQ
         result
       end
 
-      # Return true if the file is a directory. If you want this to reflect   
+      # Return true if the file is a directory. If you want this to reflect
       # any external changes, call zfile_restat before checking this property.
       #
       # @return [Boolean]
@@ -176,8 +184,8 @@ module CZMQ
       end
 
       # Return true if the file is readable by this process. If you want this to
-      # reflect any external changes, call zfile_restat before checking this    
-      # property.                                                               
+      # reflect any external changes, call zfile_restat before checking this
+      # property.
       #
       # @return [Boolean]
       def is_readable()
@@ -187,9 +195,9 @@ module CZMQ
         result
       end
 
-      # Return true if the file is writeable by this process. If you want this 
+      # Return true if the file is writeable by this process. If you want this
       # to reflect any external changes, call zfile_restat before checking this
-      # property.                                                              
+      # property.
       #
       # @return [Boolean]
       def is_writeable()
@@ -200,7 +208,7 @@ module CZMQ
       end
 
       # Check if file has stopped changing and can be safely processed.
-      # Updates the file statistics from disk at every call.           
+      # Updates the file statistics from disk at every call.
       #
       # @return [Boolean]
       def is_stable()
@@ -211,7 +219,7 @@ module CZMQ
       end
 
       # Return true if the file was changed on disk since the zfile_t object
-      # was created, or the last zfile_restat() call made on it.            
+      # was created, or the last zfile_restat() call made on it.
       #
       # @return [Boolean]
       def has_changed()
@@ -231,7 +239,7 @@ module CZMQ
         result
       end
 
-      # Open file for reading                             
+      # Open file for reading
       # Returns 0 if OK, -1 if not found or not accessible
       #
       # @return [Integer]
@@ -242,9 +250,9 @@ module CZMQ
         result
       end
 
-      # Open file for writing, creating directory if needed               
+      # Open file for writing, creating directory if needed
       # File is created if necessary; chunks can be written to file at any
-      # location. Returns 0 if OK, -1 if error.                           
+      # location. Returns 0 if OK, -1 if error.
       #
       # @return [Integer]
       def output()
@@ -255,7 +263,7 @@ module CZMQ
       end
 
       # Read chunk from file at specified position. If this was the last chunk,
-      # sets the eof property. Returns a null chunk in case of error.          
+      # sets the eof property. Returns a null chunk in case of error.
       #
       # @param bytes [Integer, #to_int, #to_i]
       # @param offset [::FFI::Pointer, #to_ptr]
@@ -280,7 +288,7 @@ module CZMQ
       end
 
       # Write chunk to file at specified position
-      # Return 0 if OK, else -1                  
+      # Return 0 if OK, else -1
       #
       # @param chunk [Zchunk, #__ptr]
       # @param offset [::FFI::Pointer, #to_ptr]
@@ -294,7 +302,7 @@ module CZMQ
       end
 
       # Read next line of text from file. Returns a pointer to the text line,
-      # or NULL if there was nothing more to read from the file.             
+      # or NULL if there was nothing more to read from the file.
       #
       # @return [String]
       def readln()

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

@@ -9,13 +9,13 @@ module CZMQ
     # working with single message frames
     # @note This class is 100% generated using zproject.
     class Zframe
-      # 
+      #
       MORE = 1
 
-      # 
+      #
       REUSE = 2
 
-      # 
+      #
       DONTWAIT = 4
 
       # Raised when one tries to use an instance of {Zframe} after
@@ -83,8 +83,8 @@ module CZMQ
       end
 
       # Create a new frame. If size is not null, allocates the frame data
-      # to the specified size. If additionally, data is not null, copies 
-      # size octets from the specified data into the frame body.         
+      # to the specified size. If additionally, data is not null, copies
+      # size octets from the specified data into the frame body.
       # @param data [::FFI::Pointer, #to_ptr]
       # @param size [Integer, #to_int, #to_i]
       # @return [CZMQ::Zframe]
@@ -109,9 +109,9 @@ module CZMQ
         __new ptr
       end
 
-      # Receive frame from socket, returns zframe_t object or NULL if the recv  
+      # Receive frame from socket, returns zframe_t object or NULL if the recv
       # was interrupted. Does a blocking recv, if you want to not block then use
-      # zpoller or zloop.                                                       
+      # zpoller or zloop.
       # @param source [::FFI::Pointer, #to_ptr]
       # @return [CZMQ::Zframe]
       def self.recv(source)
@@ -130,7 +130,7 @@ module CZMQ
       end
 
       # Send a frame to a socket, destroy frame after sending.
-      # Return -1 on error, 0 on success.                     
+      # Return -1 on error, 0 on success.
       #
       # @param self_p [#__ptr_give_ref]
       # @param dest [::FFI::Pointer, #to_ptr]
@@ -163,8 +163,9 @@ module CZMQ
         result
       end
 
-      # Return meta data property for frame           
-      # Caller must free string when finished with it.
+      # Return meta data property for frame
+      # The caller shall not modify or free the returned value, which shall be
+      # owned by the message.
       #
       # @param property [String, #to_s, nil]
       # @return [String]
@@ -176,7 +177,7 @@ module CZMQ
       end
 
       # Create a new frame that duplicates an existing frame. If frame is null,
-      # or memory was exhausted, returns null.                                 
+      # or memory was exhausted, returns null.
       #
       # @return [Zframe]
       def dup()
@@ -188,7 +189,7 @@ module CZMQ
       end
 
       # Return frame data encoded as printable hex string, useful for 0MQ UUIDs.
-      # Caller must free string when finished with it.                          
+      # Caller must free string when finished with it.
       #
       # @return [::FFI::AutoPointer]
       def strhex()
@@ -200,7 +201,7 @@ module CZMQ
       end
 
       # Return frame 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()
@@ -223,7 +224,7 @@ module CZMQ
       end
 
       # Return frame MORE indicator (1 or 0), set when reading frame from socket
-      # or by the zframe_set_more() method                                      
+      # or by the zframe_set_more() method
       #
       # @return [Integer]
       def more()
@@ -234,7 +235,7 @@ module CZMQ
       end
 
       # Set frame MORE indicator (1 or 0). Note this is NOT used when sending
-      # frame to socket, you have to specify flag explicitly.                
+      # frame to socket, you have to specify flag explicitly.
       #
       # @param more [Integer, #to_int, #to_i]
       # @return [void]
@@ -247,7 +248,7 @@ module CZMQ
       end
 
       # Return frame routing ID, if the frame came from a ZMQ_SERVER socket.
-      # Else returns zero.                                                  
+      # Else returns zero.
       #
       # @return [Integer]
       def routing_id()
@@ -258,7 +259,7 @@ module CZMQ
       end
 
       # Set routing ID on frame. This is used if/when the frame is sent to a
-      # ZMQ_SERVER socket.                                                  
+      # ZMQ_SERVER socket.
       #
       # @param routing_id [Integer, #to_int, #to_i]
       # @return [void]
@@ -281,8 +282,8 @@ module CZMQ
       end
 
       # Set group on frame. This is used if/when the frame is sent to a
-      # ZMQ_RADIO socket.                                              
-      # Return -1 on error, 0 on success.                              
+      # ZMQ_RADIO socket.
+      # Return -1 on error, 0 on success.
       #
       # @param group [String, #to_s, nil]
       # @return [Integer]
@@ -294,7 +295,7 @@ module CZMQ
       end
 
       # Return TRUE if two frames have identical size and data
-      # If either frame is NULL, equality is always false.    
+      # If either frame is NULL, equality is always false.
       #
       # @param other [Zframe, #__ptr]
       # @return [Boolean]
@@ -319,7 +320,7 @@ module CZMQ
         result
       end
 
-      # Send message to zsys log sink (may be stdout, or system facility as       
+      # Send message to zsys log sink (may be stdout, or system facility as
       # configured by zsys_set_logstream). Prefix shows before frame, if not null.
       #
       # @param prefix [String, #to_s, nil]