czmq-ffi-gen 0.13.0 → 0.14.0

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

@@ -73,8 +73,8 @@ module CZMQ
       end
 
       # Receive C string from socket. Caller must free returned string using
-      # zstr_free(). Returns NULL if the context is being terminated or the 
-      # process was interrupted.                                            
+      # zstr_free(). Returns NULL if the context is being terminated or the
+      # process was interrupted.
       #
       # @param source [::FFI::Pointer, #to_ptr]
       # @return [::FFI::AutoPointer]
@@ -84,13 +84,13 @@ module CZMQ
         result
       end
 
-      # Receive a series of strings (until NULL) from multipart data.    
-      # Each string is allocated and filled with string data; if there   
-      # are not enough frames, unallocated strings are set to NULL.      
-      # Returns -1 if the message could not be read, else returns the    
+      # Receive a series of strings (until NULL) from multipart data.
+      # Each string is allocated and filled with string data; if there
+      # are not enough frames, unallocated strings are set to NULL.
+      # Returns -1 if the message could not be read, else returns the
       # number of strings filled, zero or more. Free each returned string
-      # using zstr_free(). If not enough strings are provided, remaining 
-      # multipart frames in the message are dropped.                     
+      # using zstr_free(). If not enough strings are provided, remaining
+      # multipart frames in the message are dropped.
       #
       # @param source [::FFI::Pointer, #to_ptr]
       # @param string_p [::FFI::Pointer, #to_ptr]
@@ -101,10 +101,23 @@ module CZMQ
         result
       end
 
-      # Send a C string to a socket, as a frame. The string is sent without 
+      # De-compress and receive C string from socket, received as a message
+      # with two frames: size of the uncompressed string, and the string itself.
+      # Caller must free returned string using zstr_free(). Returns NULL if the
+      # context is being terminated or the process was interrupted.
+      #
+      # @param source [::FFI::Pointer, #to_ptr]
+      # @return [::FFI::AutoPointer]
+      def self.recv_compress(source)
+        result = ::CZMQ::FFI.zstr_recv_compress(source)
+        result = ::FFI::AutoPointer.new(result, LibC.method(:free))
+        result
+      end
+
+      # Send a C string to a socket, as a frame. The string is sent without
       # trailing null byte; to read this you can use zstr_recv, or a similar
-      # method that adds a null terminator on the received string. String   
-      # may be NULL, which is sent as "".                                   
+      # method that adds a null terminator on the received string. String
+      # may be NULL, which is sent as "".
       #
       # @param dest [::FFI::Pointer, #to_ptr]
       # @param string [String, #to_s, nil]
@@ -115,7 +128,7 @@ module CZMQ
       end
 
       # Send a C string to a socket, as zstr_send(), with a MORE flag, so that
-      # you can send further strings in the same multi-part message.          
+      # you can send further strings in the same multi-part message.
       #
       # @param dest [::FFI::Pointer, #to_ptr]
       # @param string [String, #to_s, nil]
@@ -126,8 +139,8 @@ module CZMQ
       end
 
       # Send a formatted string to a socket. Note that you should NOT use
-      # user-supplied strings in the format (they may contain '%' which  
-      # will create security holes).                                     
+      # user-supplied strings in the format (they may contain '%' which
+      # will create security holes).
       #
       # @param dest [::FFI::Pointer, #to_ptr]
       # @param format [String, #to_s, nil]
@@ -138,9 +151,9 @@ module CZMQ
         result
       end
 
-      # Send a formatted string to a socket, as for zstr_sendf(), with a      
+      # Send a formatted string to a socket, as for zstr_sendf(), with a
       # MORE flag, so that you can send further strings in the same multi-part
-      # message.                                                              
+      # message.
       #
       # @param dest [::FFI::Pointer, #to_ptr]
       # @param format [String, #to_s, nil]
@@ -151,7 +164,7 @@ module CZMQ
         result
       end
 
-      # Send a series of strings (until NULL) as multipart data   
+      # Send a series of strings (until NULL) as multipart data
       # Returns 0 if the strings could be sent OK, or -1 on error.
       #
       # @param dest [::FFI::Pointer, #to_ptr]
@@ -163,8 +176,34 @@ module CZMQ
         result
       end
 
+      # Compress and send a C string to a socket, as a message with two frames:
+      # size of the uncompressed string, and the string itself. The string is
+      # sent without trailing null byte; to read this you can use
+      # zstr_recv_compress, or a similar method that de-compresses and adds a
+      # null terminator on the received string.
+      #
+      # @param dest [::FFI::Pointer, #to_ptr]
+      # @param string [String, #to_s, nil]
+      # @return [Integer]
+      def self.send_compress(dest, string)
+        result = ::CZMQ::FFI.zstr_send_compress(dest, string)
+        result
+      end
+
+      # Compress and send a C string to a socket, as zstr_send_compress(),
+      # with a MORE flag, so that you can send further strings in the same
+      # multi-part message.
+      #
+      # @param dest [::FFI::Pointer, #to_ptr]
+      # @param string [String, #to_s, nil]
+      # @return [Integer]
+      def self.sendm_compress(dest, string)
+        result = ::CZMQ::FFI.zstr_sendm_compress(dest, string)
+        result
+      end
+
       # Accepts a void pointer and returns a fresh character string. If source
-      # is null, returns an empty string.                                     
+      # is null, returns an empty string.
       #
       # @param source [::FFI::Pointer, #to_ptr]
       # @return [::FFI::AutoPointer]
@@ -175,7 +214,7 @@ module CZMQ
       end
 
       # Free a provided string, and nullify the parent pointer. Safe to call on
-      # a null pointer.                                                        
+      # a null pointer.
       #
       # @param string_p [::FFI::Pointer, #to_ptr]
       # @return [void]