czmq-ffi-gen 0.13.0-x86-mingw32 → 0.14.1-x86-mingw32

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]

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

@@ -76,7 +76,7 @@ module CZMQ
       # Create a new callback of the following type:
       # Callback function for zhash_freefn method
       #     typedef void (zhash_free_fn) (
-      #         void *data);              
+      #         void *data);
       #
       # @note WARNING: If your Ruby code doesn't retain a reference to the
       #   FFI::Function object after passing it to a C function call,
@@ -97,8 +97,8 @@ module CZMQ
       end
 
       # Unpack binary frame into a new hash table. Packed data must follow format
-      # defined by zhash_pack. Hash table is set to autofree. An empty frame     
-      # unpacks to an empty hash table.                                          
+      # defined by zhash_pack. Hash table is set to autofree. An empty frame
+      # unpacks to an empty hash table.
       # @param frame [Zframe, #__ptr]
       # @return [CZMQ::Zhash]
       def self.unpack(frame)
@@ -117,9 +117,9 @@ module CZMQ
         result
       end
 
-      # Insert item into hash table with specified key and item.               
+      # Insert item into hash table with specified key and item.
       # If key is already present returns -1 and leaves existing item unchanged
-      # Returns 0 on success.                                                  
+      # Returns 0 on success.
       #
       # @param key [String, #to_s, nil]
       # @param item [::FFI::Pointer, #to_ptr]
@@ -131,8 +131,8 @@ module CZMQ
         result
       end
 
-      # Update item into hash table with specified key and item.            
-      # If key is already present, destroys old item and inserts new one.   
+      # Update item into hash table with specified key and item.
+      # If key is already present, destroys old item and inserts new one.
       # Use free_fn method to ensure deallocator is properly called on item.
       #
       # @param key [String, #to_s, nil]
@@ -146,7 +146,7 @@ module CZMQ
       end
 
       # Remove an item specified by key from the hash table. If there was no such
-      # item, this function does nothing.                                        
+      # item, this function does nothing.
       #
       # @param key [String, #to_s, nil]
       # @return [void]
@@ -169,7 +169,7 @@ module CZMQ
       end
 
       # Reindexes an item from an old key to a new key. If there was no such
-      # item, does nothing. Returns 0 if successful, else -1.               
+      # item, does nothing. Returns 0 if successful, else -1.
       #
       # @param old_key [String, #to_s, nil]
       # @param new_key [String, #to_s, nil]
@@ -182,10 +182,10 @@ module CZMQ
       end
 
       # Set a free function for the specified hash table item. When the item is
-      # destroyed, the free function, if any, is called on that item.          
-      # Use this when hash items are dynamically allocated, to ensure that     
-      # you don't have memory leaks. You can pass 'free' or NULL as a free_fn. 
-      # Returns the item, or NULL if there is no such item.                    
+      # destroyed, the free function, if any, is called on that item.
+      # Use this when hash items are dynamically allocated, to ensure that
+      # you don't have memory leaks. You can pass 'free' or NULL as a free_fn.
+      # Returns the item, or NULL if there is no such item.
       #
       # @param key [String, #to_s, nil]
       # @param free_fn [::FFI::Pointer, #to_ptr]
@@ -207,10 +207,10 @@ module CZMQ
         result
       end
 
-      # Make copy of hash table; if supplied table is null, returns null.    
-      # Does not copy items themselves. Rebuilds new table so may be slow on 
+      # Make copy of hash table; if supplied table is null, returns null.
+      # Does not copy items themselves. Rebuilds new table so may be slow on
       # very large tables. NOTE: only works with item values that are strings
-      # since there's no other way to know how to duplicate the item value.  
+      # since there's no other way to know how to duplicate the item value.
       #
       # @return [Zhash]
       def dup()
@@ -232,10 +232,10 @@ module CZMQ
         result
       end
 
-      # Simple iterator; returns first item in hash table, in no given order, 
-      # or NULL if the table is empty. This method is simpler to use than the 
+      # Simple iterator; returns first item in hash table, in no given order,
+      # or NULL if the table is empty. This method is simpler to use than the
       # foreach() method, which is deprecated. To access the key for this item
-      # use zhash_cursor(). NOTE: do NOT modify the table while iterating.    
+      # use zhash_cursor(). NOTE: do NOT modify the table while iterating.
       #
       # @return [::FFI::Pointer]
       def first()
@@ -245,12 +245,12 @@ module CZMQ
         result
       end
 
-      # Simple iterator; returns next item in hash table, in no given order, 
+      # Simple iterator; returns next item in hash table, in no given order,
       # or NULL if the last item was already returned. Use this together with
-      # zhash_first() to process all items in a hash table. If you need the  
-      # items in sorted order, use zhash_keys() and then zlist_sort(). To    
-      # access the key for this item use zhash_cursor(). NOTE: do NOT modify 
-      # the table while iterating.                                           
+      # zhash_first() to process all items in a hash table. If you need the
+      # items in sorted order, use zhash_keys() and then zlist_sort(). To
+      # access the key for this item use zhash_cursor(). NOTE: do NOT modify
+      # the table while iterating.
       #
       # @return [::FFI::Pointer]
       def next()
@@ -261,9 +261,9 @@ module CZMQ
       end
 
       # After a successful first/next method, returns the key for the item that
-      # was returned. This is a constant string that you may not modify or     
-      # deallocate, and which lasts as long as the item in the hash. After an  
-      # unsuccessful first/next, returns NULL.                                 
+      # was returned. This is a constant string that you may not modify or
+      # deallocate, and which lasts as long as the item in the hash. After an
+      # unsuccessful first/next, returns NULL.
       #
       # @return [String]
       def cursor()
@@ -273,9 +273,9 @@ module CZMQ
         result
       end
 
-      # Add a comment to hash table before saving to disk. You can add as many   
+      # Add a comment to hash table before saving to disk. You can add as many
       # comment lines as you like. These comment lines are discarded when loading
-      # the file. If you use a null format, all comments are deleted.            
+      # the file. If you use a null format, all comments are deleted.
       #
       # @param format [String, #to_s, nil]
       # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
@@ -289,24 +289,24 @@ module CZMQ
 
       # Serialize hash table to a binary frame that can be sent in a message.
       # The packed format is compatible with the 'dictionary' type defined in
-      # http://rfc.zeromq.org/spec:35/FILEMQ, and implemented by zproto:     
-      #                                                                      
-      #    ; A list of name/value pairs                                      
-      #    dictionary      = dict-count *( dict-name dict-value )            
-      #    dict-count      = number-4                                        
-      #    dict-value      = longstr                                         
-      #    dict-name       = string                                          
-      #                                                                      
-      #    ; Strings are always length + text contents                       
-      #    longstr         = number-4 *VCHAR                                 
-      #    string          = number-1 *VCHAR                                 
-      #                                                                      
-      #    ; Numbers are unsigned integers in network byte order             
-      #    number-1        = 1OCTET                                          
-      #    number-4        = 4OCTET                                          
-      #                                                                      
-      # Comments are not included in the packed data. Item values MUST be    
-      # strings.                                                             
+      # http://rfc.zeromq.org/spec:35/FILEMQ, and implemented by zproto:
+      #
+      #    ; A list of name/value pairs
+      #    dictionary      = dict-count *( dict-name dict-value )
+      #    dict-count      = number-4
+      #    dict-value      = longstr
+      #    dict-name       = string
+      #
+      #    ; Strings are always length + text contents
+      #    longstr         = number-4 *VCHAR
+      #    string          = number-1 *VCHAR
+      #
+      #    ; Numbers are unsigned integers in network byte order
+      #    number-1        = 1OCTET
+      #    number-4        = 4OCTET
+      #
+      # Comments are not included in the packed data. Item values MUST be
+      # strings.
       #
       # @return [Zframe]
       def pack()
@@ -318,8 +318,8 @@ module CZMQ
       end
 
       # Save hash table to a text file in name=value format. Hash values must be
-      # printable strings; keys may not contain '=' character. Returns 0 if OK, 
-      # else -1 if a file error occurred.                                       
+      # printable strings; keys may not contain '=' character. Returns 0 if OK,
+      # else -1 if a file error occurred.
       #
       # @param filename [String, #to_s, nil]
       # @return [Integer]
@@ -330,9 +330,9 @@ module CZMQ
         result
       end
 
-      # Load hash table from a text file in name=value format; hash table must 
+      # Load hash table from a text file in name=value format; hash table must
       # already exist. Hash values must printable strings; keys may not contain
-      # '=' character. Returns 0 if OK, else -1 if a file was not readable.    
+      # '=' character. Returns 0 if OK, else -1 if a file was not readable.
       #
       # @param filename [String, #to_s, nil]
       # @return [Integer]
@@ -345,8 +345,8 @@ module CZMQ
 
       # When a hash table was loaded from a file by zhash_load, this method will
       # reload the file if it has been modified since, and is "stable", i.e. not
-      # still changing. Returns 0 if OK, -1 if there was an error reloading the 
-      # file.                                                                   
+      # still changing. Returns 0 if OK, -1 if there was an error reloading the
+      # file.
       #
       # @return [Integer]
       def refresh()
@@ -357,7 +357,7 @@ module CZMQ
       end
 
       # Set hash for automatic value destruction. Note that this assumes that
-      # values are NULL-terminated strings. Do not use with different types. 
+      # values are NULL-terminated strings. Do not use with different types.
       #
       # @return [void]
       def autofree()

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

@@ -76,7 +76,7 @@ module CZMQ
       # Create a new callback of the following type:
       # Destroy an item
       #     typedef void (zhashx_destructor_fn) (
-      #         void **item);                    
+      #         void **item);
       #
       # @note WARNING: If your Ruby code doesn't retain a reference to the
       #   FFI::Function object after passing it to a C function call,
@@ -92,7 +92,7 @@ module CZMQ
       # Create a new callback of the following type:
       # Duplicate an item
       #     typedef void * (zhashx_duplicator_fn) (
-      #         const void *item);                 
+      #         const void *item);
       #
       # @note WARNING: If your Ruby code doesn't retain a reference to the
       #   FFI::Function object after passing it to a C function call,
@@ -107,7 +107,7 @@ module CZMQ
 
       # Create a new callback of the following type:
       # Compare two items, for sorting
-      #     typedef int (zhashx_comparator_fn) (      
+      #     typedef int (zhashx_comparator_fn) (
       #         const void *item1, const void *item2);
       #
       # @note WARNING: If your Ruby code doesn't retain a reference to the
@@ -125,7 +125,7 @@ module CZMQ
       # Create a new callback of the following type:
       # Destroy an item.
       #     typedef void (zhashx_free_fn) (
-      #         void *data);               
+      #         void *data);
       #
       # @note WARNING: If your Ruby code doesn't retain a reference to the
       #   FFI::Function object after passing it to a C function call,
@@ -141,7 +141,7 @@ module CZMQ
       # Create a new callback of the following type:
       # Hash function for keys.
       #     typedef size_t (zhashx_hash_fn) (
-      #         const void *key);            
+      #         const void *key);
       #
       # @note WARNING: If your Ruby code doesn't retain a reference to the
       #   FFI::Function object after passing it to a C function call,
@@ -156,10 +156,10 @@ module CZMQ
       end
 
       # Create a new callback of the following type:
-      # Serializes an item to a longstr.                       
+      # Serializes an item to a longstr.
       # The caller takes ownership of the newly created object.
       #     typedef char * (zhashx_serializer_fn) (
-      #         const void *item);                 
+      #         const void *item);
       #
       # @note WARNING: If your Ruby code doesn't retain a reference to the
       #   FFI::Function object after passing it to a C function call,
@@ -173,10 +173,10 @@ module CZMQ
       end
 
       # Create a new callback of the following type:
-      # Deserializes a longstr into an item.                   
+      # Deserializes a longstr into an item.
       # The caller takes ownership of the newly created object.
       #     typedef void * (zhashx_deserializer_fn) (
-      #         const char *item_str);               
+      #         const char *item_str);
       #
       # @note WARNING: If your Ruby code doesn't retain a reference to the
       #   FFI::Function object after passing it to a C function call,
@@ -197,8 +197,8 @@ module CZMQ
       end
 
       # Unpack binary frame into a new hash table. Packed data must follow format
-      # defined by zhashx_pack. Hash table is set to autofree. An empty frame    
-      # unpacks to an empty hash table.                                          
+      # defined by zhashx_pack. Hash table is set to autofree. An empty frame
+      # unpacks to an empty hash table.
       # @param frame [Zframe, #__ptr]
       # @return [CZMQ::Zhashx]
       def self.unpack(frame)
@@ -208,7 +208,7 @@ module CZMQ
       end
 
       # Same as unpack but uses a user-defined deserializer function to convert
-      # a longstr back into item format.                                       
+      # a longstr back into item format.
       # @param frame [Zframe, #__ptr]
       # @param deserializer [::FFI::Pointer, #to_ptr]
       # @return [CZMQ::Zhashx]
@@ -228,9 +228,9 @@ module CZMQ
         result
       end
 
-      # Insert item into hash table with specified key and item.               
+      # Insert item into hash table with specified key and item.
       # If key is already present returns -1 and leaves existing item unchanged
-      # Returns 0 on success.                                                  
+      # Returns 0 on success.
       #
       # @param key [::FFI::Pointer, #to_ptr]
       # @param item [::FFI::Pointer, #to_ptr]
@@ -244,9 +244,9 @@ module CZMQ
 
       # Update or insert item into hash table with specified key and item. If the
       # key is already present, destroys old item and inserts new one. If you set
-      # a container item destructor, this is called on the old value. If the key 
-      # was not already present, inserts a new item. Sets the hash cursor to the 
-      # new item.                                                                
+      # a container item destructor, this is called on the old value. If the key
+      # was not already present, inserts a new item. Sets the hash cursor to the
+      # new item.
       #
       # @param key [::FFI::Pointer, #to_ptr]
       # @param item [::FFI::Pointer, #to_ptr]
@@ -259,7 +259,7 @@ module CZMQ
       end
 
       # Remove an item specified by key from the hash table. If there was no such
-      # item, this function does nothing.                                        
+      # item, this function does nothing.
       #
       # @param key [::FFI::Pointer, #to_ptr]
       # @return [void]
@@ -270,9 +270,9 @@ module CZMQ
         result
       end
 
-      # Delete all items from the hash table. If the key destructor is  
+      # Delete all items from the hash table. If the key destructor is
       # set, calls it on every key. If the item destructor is set, calls
-      # it on every item.                                               
+      # it on every item.
       #
       # @return [void]
       def purge()
@@ -294,7 +294,7 @@ module CZMQ
       end
 
       # Reindexes an item from an old key to a new key. If there was no such
-      # item, does nothing. Returns 0 if successful, else -1.               
+      # item, does nothing. Returns 0 if successful, else -1.
       #
       # @param old_key [::FFI::Pointer, #to_ptr]
       # @param new_key [::FFI::Pointer, #to_ptr]
@@ -307,10 +307,10 @@ module CZMQ
       end
 
       # Set a free function for the specified hash table item. When the item is
-      # destroyed, the free function, if any, is called on that item.          
-      # Use this when hash items are dynamically allocated, to ensure that     
-      # you don't have memory leaks. You can pass 'free' or NULL as a free_fn. 
-      # Returns the item, or NULL if there is no such item.                    
+      # destroyed, the free function, if any, is called on that item.
+      # Use this when hash items are dynamically allocated, to ensure that
+      # you don't have memory leaks. You can pass 'free' or NULL as a free_fn.
+      # Returns the item, or NULL if there is no such item.
       #
       # @param key [::FFI::Pointer, #to_ptr]
       # @param free_fn [::FFI::Pointer, #to_ptr]
@@ -332,9 +332,9 @@ module CZMQ
         result
       end
 
-      # Return a zlistx_t containing the keys for the items in the       
+      # Return a zlistx_t containing the keys for the items in the
       # table. Uses the key_duplicator to duplicate all keys and sets the
-      # key_destructor as destructor for the list.                       
+      # key_destructor as destructor for the list.
       #
       # @return [Zlistx]
       def keys()
@@ -345,9 +345,9 @@ module CZMQ
         result
       end
 
-      # Return a zlistx_t containing the values for the items in the  
+      # Return a zlistx_t containing the values for the items in the
       # table. Uses the duplicator to duplicate all items and sets the
-      # destructor as destructor for the list.                        
+      # destructor as destructor for the list.
       #
       # @return [Zlistx]
       def values()
@@ -358,10 +358,10 @@ module CZMQ
         result
       end
 
-      # Simple iterator; returns first item in hash table, in no given order, 
-      # or NULL if the table is empty. This method is simpler to use than the 
+      # Simple iterator; returns first item in hash table, in no given order,
+      # or NULL if the table is empty. This method is simpler to use than the
       # foreach() method, which is deprecated. To access the key for this item
-      # use zhashx_cursor(). NOTE: do NOT modify the table while iterating.   
+      # use zhashx_cursor(). NOTE: do NOT modify the table while iterating.
       #
       # @return [::FFI::Pointer]
       def first()
@@ -371,12 +371,12 @@ module CZMQ
         result
       end
 
-      # Simple iterator; returns next item in hash table, in no given order, 
+      # Simple iterator; returns next item in hash table, in no given order,
       # or NULL if the last item was already returned. Use this together with
-      # zhashx_first() to process all items in a hash table. If you need the 
-      # items in sorted order, use zhashx_keys() and then zlistx_sort(). To  
+      # zhashx_first() to process all items in a hash table. If you need the
+      # items in sorted order, use zhashx_keys() and then zlistx_sort(). To
       # access the key for this item use zhashx_cursor(). NOTE: do NOT modify
-      # the table while iterating.                                           
+      # the table while iterating.
       #
       # @return [::FFI::Pointer]
       def next()
@@ -387,9 +387,9 @@ module CZMQ
       end
 
       # After a successful first/next method, returns the key for the item that
-      # was returned. This is a constant string that you may not modify or     
-      # deallocate, and which lasts as long as the item in the hash. After an  
-      # unsuccessful first/next, returns NULL.                                 
+      # was returned. This is a constant string that you may not modify or
+      # deallocate, and which lasts as long as the item in the hash. After an
+      # unsuccessful first/next, returns NULL.
       #
       # @return [::FFI::Pointer]
       def cursor()
@@ -399,9 +399,9 @@ module CZMQ
         result
       end
 
-      # Add a comment to hash table before saving to disk. You can add as many   
+      # Add a comment to hash table before saving to disk. You can add as many
       # comment lines as you like. These comment lines are discarded when loading
-      # the file. If you use a null format, all comments are deleted.            
+      # the file. If you use a null format, all comments are deleted.
       #
       # @param format [String, #to_s, nil]
       # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
@@ -414,8 +414,8 @@ module CZMQ
       end
 
       # Save hash table to a text file in name=value format. Hash values must be
-      # printable strings; keys may not contain '=' character. Returns 0 if OK, 
-      # else -1 if a file error occurred.                                       
+      # printable strings; keys may not contain '=' character. Returns 0 if OK,
+      # else -1 if a file error occurred.
       #
       # @param filename [String, #to_s, nil]
       # @return [Integer]
@@ -426,9 +426,9 @@ module CZMQ
         result
       end
 
-      # Load hash table from a text file in name=value format; hash table must 
+      # Load hash table from a text file in name=value format; hash table must
       # already exist. Hash values must printable strings; keys may not contain
-      # '=' character. Returns 0 if OK, else -1 if a file was not readable.    
+      # '=' character. Returns 0 if OK, else -1 if a file was not readable.
       #
       # @param filename [String, #to_s, nil]
       # @return [Integer]
@@ -440,9 +440,9 @@ module CZMQ
       end
 
       # When a hash table was loaded from a file by zhashx_load, this method will
-      # reload the file if it has been modified since, and is "stable", i.e. not 
-      # still changing. Returns 0 if OK, -1 if there was an error reloading the  
-      # file.                                                                    
+      # reload the file if it has been modified since, and is "stable", i.e. not
+      # still changing. Returns 0 if OK, -1 if there was an error reloading the
+      # file.
       #
       # @return [Integer]
       def refresh()
@@ -454,24 +454,24 @@ module CZMQ
 
       # Serialize hash table to a binary frame that can be sent in a message.
       # The packed format is compatible with the 'dictionary' type defined in
-      # http://rfc.zeromq.org/spec:35/FILEMQ, and implemented by zproto:     
-      #                                                                      
-      #    ; A list of name/value pairs                                      
-      #    dictionary      = dict-count *( dict-name dict-value )            
-      #    dict-count      = number-4                                        
-      #    dict-value      = longstr                                         
-      #    dict-name       = string                                          
-      #                                                                      
-      #    ; Strings are always length + text contents                       
-      #    longstr         = number-4 *VCHAR                                 
-      #    string          = number-1 *VCHAR                                 
-      #                                                                      
-      #    ; Numbers are unsigned integers in network byte order             
-      #    number-1        = 1OCTET                                          
-      #    number-4        = 4OCTET                                          
-      #                                                                      
-      # Comments are not included in the packed data. Item values MUST be    
-      # strings.                                                             
+      # http://rfc.zeromq.org/spec:35/FILEMQ, and implemented by zproto:
+      #
+      #    ; A list of name/value pairs
+      #    dictionary      = dict-count *( dict-name dict-value )
+      #    dict-count      = number-4
+      #    dict-value      = longstr
+      #    dict-name       = string
+      #
+      #    ; Strings are always length + text contents
+      #    longstr         = number-4 *VCHAR
+      #    string          = number-1 *VCHAR
+      #
+      #    ; Numbers are unsigned integers in network byte order
+      #    number-1        = 1OCTET
+      #    number-4        = 4OCTET
+      #
+      # Comments are not included in the packed data. Item values MUST be
+      # strings.
       #
       # @return [Zframe]
       def pack()
@@ -483,7 +483,7 @@ module CZMQ
       end
 
       # Same as pack but uses a user-defined serializer function to convert items
-      # into longstr.                                                            
+      # into longstr.
       #
       # @param serializer [::FFI::Pointer, #to_ptr]
       # @return [Zframe]
@@ -495,9 +495,9 @@ module CZMQ
         result
       end
 
-      # Make a copy of the list; items are duplicated if you set a duplicator 
-      # for the list, otherwise not. Copying a null reference returns a null  
-      # reference. Note that this method's behavior changed slightly for CZMQ 
+      # Make a copy of the list; items are duplicated if you set a duplicator
+      # for the list, otherwise not. Copying a null reference returns a null
+      # reference. Note that this method's behavior changed slightly for CZMQ
       # v3.x, as it does not set nor respect autofree. It does however let you
       # duplicate any hash table safely. The old behavior is in zhashx_dup_v2.
       #
@@ -511,7 +511,7 @@ module CZMQ
       end
 
       # Set a user-defined deallocator for hash items; by default items are not
-      # freed when the hash is destroyed.                                      
+      # freed when the hash is destroyed.
       #
       # @param destructor [::FFI::Pointer, #to_ptr]
       # @return [void]
@@ -523,7 +523,7 @@ module CZMQ
       end
 
       # Set a user-defined duplicator for hash items; by default items are not
-      # copied when the hash is duplicated.                                   
+      # copied when the hash is duplicated.
       #
       # @param duplicator [::FFI::Pointer, #to_ptr]
       # @return [void]
@@ -535,7 +535,7 @@ module CZMQ
       end
 
       # Set a user-defined deallocator for keys; by default keys are freed
-      # when the hash is destroyed using free().                          
+      # when the hash is destroyed using free().
       #
       # @param destructor [::FFI::Pointer, #to_ptr]
       # @return [void]
@@ -547,7 +547,7 @@ module CZMQ
       end
 
       # Set a user-defined duplicator for keys; by default keys are duplicated
-      # using strdup.                                                         
+      # using strdup.
       #
       # @param duplicator [::FFI::Pointer, #to_ptr]
       # @return [void]
@@ -559,7 +559,9 @@ module CZMQ
       end
 
       # Set a user-defined comparator for keys; by default keys are
-      # compared using strcmp.                                     
+      # compared using strcmp.
+      # The callback function should return zero (0) on matching
+      # items.
       #
       # @param comparator [::FFI::Pointer, #to_ptr]
       # @return [void]
@@ -570,8 +572,8 @@ module CZMQ
         result
       end
 
-      # Set a user-defined comparator for keys; by default keys are
-      # compared using strcmp.                                     
+      # Set a user-defined hash function for keys; by default keys are
+      # hashed by a modified Bernstein hashing function.
       #
       # @param hasher [::FFI::Pointer, #to_ptr]
       # @return [void]
@@ -582,10 +584,10 @@ module CZMQ
         result
       end
 
-      # Make copy of hash table; if supplied table is null, returns null.    
-      # Does not copy items themselves. Rebuilds new table so may be slow on 
+      # Make copy of hash table; if supplied table is null, returns null.
+      # Does not copy items themselves. Rebuilds new table so may be slow on
       # very large tables. NOTE: only works with item values that are strings
-      # since there's no other way to know how to duplicate the item value.  
+      # since there's no other way to know how to duplicate the item value.
       #
       # @return [Zhashx]
       def dup_v2()