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

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

@@ -75,7 +75,7 @@ module CZMQ
 
       # Create a new callback of the following type:
       # Callback function for reactor socket activity
-      #     typedef int (zloop_reader_fn) (                
+      #     typedef int (zloop_reader_fn) (
       #         zloop_t *loop, zsock_t *reader, void *arg);
       #
       # @note WARNING: If your Ruby code doesn't retain a reference to the
@@ -94,7 +94,7 @@ module CZMQ
 
       # Create a new callback of the following type:
       # Callback function for reactor events (low-level)
-      #     typedef int (zloop_fn) (                            
+      #     typedef int (zloop_fn) (
       #         zloop_t *loop, zmq_pollitem_t *item, void *arg);
       #
       # @note WARNING: If your Ruby code doesn't retain a reference to the
@@ -112,7 +112,7 @@ module CZMQ
 
       # Create a new callback of the following type:
       # Callback for reactor timer events
-      #     typedef int (zloop_timer_fn) (              
+      #     typedef int (zloop_timer_fn) (
       #         zloop_t *loop, int timer_id, void *arg);
       #
       # @note WARNING: If your Ruby code doesn't retain a reference to the
@@ -145,10 +145,10 @@ module CZMQ
         result
       end
 
-      # Register socket reader with the reactor. When the reader has messages, 
+      # Register socket reader with the reactor. When the reader has messages,
       # the reactor will call the handler, passing the arg. Returns 0 if OK, -1
-      # if there was an error. If you register the same socket more than once, 
-      # each instance will invoke its corresponding handler.                   
+      # if there was an error. If you register the same socket more than once,
+      # each instance will invoke its corresponding handler.
       #
       # @param sock [Zsock, #__ptr]
       # @param handler [::FFI::Pointer, #to_ptr]
@@ -163,7 +163,7 @@ module CZMQ
       end
 
       # Cancel a socket reader from the reactor. If multiple readers exist for
-      # same socket, cancels ALL of them.                                     
+      # same socket, cancels ALL of them.
       #
       # @param sock [Zsock, #__ptr]
       # @return [void]
@@ -176,7 +176,7 @@ module CZMQ
       end
 
       # Configure a registered reader to ignore errors. If you do not set this,
-      # then readers that have errors are removed from the reactor silently.   
+      # then readers that have errors are removed from the reactor silently.
       #
       # @param sock [Zsock, #__ptr]
       # @return [void]
@@ -188,11 +188,11 @@ module CZMQ
         result
       end
 
-      # Register low-level libzmq pollitem with the reactor. When the pollitem  
-      # is ready, will call the handler, passing the arg. Returns 0 if OK, -1   
+      # Register low-level libzmq pollitem with the reactor. When the pollitem
+      # is ready, will call the handler, passing the arg. Returns 0 if OK, -1
       # if there was an error. If you register the pollitem more than once, each
-      # instance will invoke its corresponding handler. A pollitem with         
-      # socket=NULL and fd=0 means 'poll on FD zero'.                           
+      # instance will invoke its corresponding handler. A pollitem with
+      # socket=NULL and fd=0 means 'poll on FD zero'.
       #
       # @param item [::FFI::Pointer, #to_ptr]
       # @param handler [::FFI::Pointer, #to_ptr]
@@ -207,7 +207,7 @@ module CZMQ
 
       # Cancel a pollitem from the reactor, specified by socket or FD. If both
       # are specified, uses only socket. If multiple poll items exist for same
-      # socket/FD, cancels ALL of them.                                       
+      # socket/FD, cancels ALL of them.
       #
       # @param item [::FFI::Pointer, #to_ptr]
       # @return [void]
@@ -219,7 +219,7 @@ module CZMQ
       end
 
       # Configure a registered poller to ignore errors. If you do not set this,
-      # then poller that have errors are removed from the reactor silently.    
+      # then poller that have errors are removed from the reactor silently.
       #
       # @param item [::FFI::Pointer, #to_ptr]
       # @return [void]
@@ -231,9 +231,9 @@ module CZMQ
       end
 
       # Register a timer that expires after some delay and repeats some number of
-      # times. At each expiry, will call the handler, passing the arg. To run a  
+      # times. At each expiry, will call the handler, passing the arg. To run a
       # timer forever, use 0 times. Returns a timer_id that is used to cancel the
-      # timer in the future. Returns -1 if there was an error.                   
+      # timer in the future. Returns -1 if there was an error.
       #
       # @param delay [Integer, #to_int, #to_i]
       # @param times [Integer, #to_int, #to_i]
@@ -250,7 +250,7 @@ module CZMQ
       end
 
       # Cancel a specific timer identified by a specific timer_id (as returned by
-      # zloop_timer).                                                            
+      # zloop_timer).
       #
       # @param timer_id [Integer, #to_int, #to_i]
       # @return [Integer]
@@ -262,15 +262,15 @@ module CZMQ
         result
       end
 
-      # Register a ticket timer. Ticket timers are very fast in the case where   
-      # you use a lot of timers (thousands), and frequently remove and add them. 
-      # The main use case is expiry timers for servers that handle many clients, 
+      # Register a ticket timer. Ticket timers are very fast in the case where
+      # you use a lot of timers (thousands), and frequently remove and add them.
+      # The main use case is expiry timers for servers that handle many clients,
       # and which reset the expiry timer for each message received from a client.
-      # Whereas normal timers perform poorly as the number of clients grows, the 
-      # cost of ticket timers is constant, no matter the number of clients. You  
-      # must set the ticket delay using zloop_set_ticket_delay before creating a 
-      # ticket. Returns a handle to the timer that you should use in             
-      # zloop_ticket_reset and zloop_ticket_delete.                              
+      # Whereas normal timers perform poorly as the number of clients grows, the
+      # cost of ticket timers is constant, no matter the number of clients. You
+      # must set the ticket delay using zloop_set_ticket_delay before creating a
+      # ticket. Returns a handle to the timer that you should use in
+      # zloop_ticket_reset and zloop_ticket_delete.
       #
       # @param handler [::FFI::Pointer, #to_ptr]
       # @param arg [::FFI::Pointer, #to_ptr]
@@ -283,7 +283,7 @@ module CZMQ
       end
 
       # Reset a ticket timer, which moves it to the end of the ticket list and
-      # resets its execution time. This is a very fast operation.             
+      # resets its execution time. This is a very fast operation.
       #
       # @param handle [::FFI::Pointer, #to_ptr]
       # @return [void]
@@ -294,9 +294,9 @@ module CZMQ
         result
       end
 
-      # Delete a ticket timer. We do not actually delete the ticket here, as    
+      # Delete a ticket timer. We do not actually delete the ticket here, as
       # other code may still refer to the ticket. We mark as deleted, and remove
-      # later and safely.                                                       
+      # later and safely.
       #
       # @param handle [::FFI::Pointer, #to_ptr]
       # @return [void]
@@ -307,7 +307,7 @@ module CZMQ
         result
       end
 
-      # Set the ticket delay, which applies to all tickets. If you lower the   
+      # Set the ticket delay, which applies to all tickets. If you lower the
       # delay and there are already tickets created, the results are undefined.
       #
       # @param ticket_delay [Integer, #to_int, #to_i]
@@ -320,11 +320,11 @@ module CZMQ
         result
       end
 
-      # Set hard limit on number of timers allowed. Setting more than a small  
+      # Set hard limit on number of timers allowed. Setting more than a small
       # number of timers (10-100) can have a dramatic impact on the performance
-      # of the reactor. For high-volume cases, use ticket timers. If the hard  
-      # limit is reached, the reactor stops creating new timers and logs an    
-      # error.                                                                 
+      # of the reactor. For high-volume cases, use ticket timers. If the hard
+      # limit is reached, the reactor stops creating new timers and logs an
+      # error.
       #
       # @param max_timers [Integer, #to_int, #to_i]
       # @return [void]
@@ -337,7 +337,7 @@ module CZMQ
       end
 
       # Set verbose tracing of reactor on/off. The default verbose setting is
-      # off (false).                                                         
+      # off (false).
       #
       # @param verbose [Boolean]
       # @return [void]
@@ -349,10 +349,10 @@ module CZMQ
         result
       end
 
-      # By default the reactor stops if the process receives a SIGINT or SIGTERM 
+      # By default the reactor stops if the process receives a SIGINT or SIGTERM
       # signal. This makes it impossible to shut-down message based architectures
       # like zactors. This method lets you switch off break handling. The default
-      # nonstop setting is off (false).                                          
+      # nonstop setting is off (false).
       #
       # @param nonstop [Boolean]
       # @return [void]
@@ -364,10 +364,10 @@ module CZMQ
         result
       end
 
-      # Start the reactor. Takes control of the thread and returns when the 0MQ  
+      # Start the reactor. Takes control of the thread and returns when the 0MQ
       # context is terminated or the process is interrupted, or any event handler
-      # returns -1. Event handlers may register new sockets and timers, and      
-      # cancel sockets. Returns 0 if interrupted, -1 if canceled by a handler.   
+      # returns -1. Event handlers may register new sockets and timers, and
+      # cancel sockets. Returns 0 if interrupted, -1 if canceled by a handler.
       #
       # @return [Integer]
       def start()

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

@@ -80,10 +80,10 @@ module CZMQ
         __new ptr
       end
 
-      # Receive message from socket, returns zmsg_t object or NULL if the recv   
-      # was interrupted. Does a blocking recv. If you want to not block then use 
+      # Receive message from socket, returns zmsg_t object or NULL if the recv
+      # was interrupted. Does a blocking recv. If you want to not block then use
       # the zloop class or zmsg_recv_nowait or zmq_poll to check for socket input
-      # before receiving.                                                        
+      # before receiving.
       # @param source [::FFI::Pointer, #to_ptr]
       # @return [CZMQ::Zmsg]
       def self.recv(source)
@@ -92,7 +92,7 @@ module CZMQ
       end
 
       # Load/append an open file into new message, return the message.
-      # Returns NULL if the message could not be loaded.              
+      # Returns NULL if the message could not be loaded.
       # @param file [::FFI::Pointer, #to_ptr]
       # @return [CZMQ::Zmsg]
       def self.load(file)
@@ -101,8 +101,8 @@ module CZMQ
       end
 
       # Decodes a serialized message frame created by zmsg_encode () and returns
-      # a new zmsg_t object. Returns NULL if the frame was badly formatted or   
-      # there was insufficient memory to work.                                  
+      # a new zmsg_t object. Returns NULL if the frame was badly formatted or
+      # there was insufficient memory to work.
       # @param frame [Zframe, #__ptr]
       # @return [CZMQ::Zmsg]
       def self.decode(frame)
@@ -112,8 +112,8 @@ module CZMQ
       end
 
       # Generate a signal message encoding the given status. A signal is a short
-      # message carrying a 1-byte success/failure code (by convention, 0 means  
-      # OK). Signals are encoded to be distinguishable from "normal" messages.  
+      # message carrying a 1-byte success/failure code (by convention, 0 means
+      # OK). Signals are encoded to be distinguishable from "normal" messages.
       # @param status [Integer, #to_int, #to_i]
       # @return [CZMQ::Zmsg]
       def self.new_signal(status)
@@ -134,8 +134,8 @@ module CZMQ
 
       # Send message to destination socket, and destroy the message after sending
       # it successfully. If the message has no frames, sends nothing but destroys
-      # the message anyhow. Nullifies the caller's reference to the message (as  
-      # it is a destructor).                                                     
+      # the message anyhow. Nullifies the caller's reference to the message (as
+      # it is a destructor).
       #
       # @param self_p [#__ptr_give_ref]
       # @param dest [::FFI::Pointer, #to_ptr]
@@ -146,12 +146,12 @@ module CZMQ
         result
       end
 
-      # Send message to destination socket as part of a multipart sequence, and 
-      # destroy the message after sending it successfully. Note that after a    
+      # Send message to destination socket as part of a multipart sequence, and
+      # destroy the message after sending it successfully. Note that after a
       # zmsg_sendm, you must call zmsg_send or another method that sends a final
-      # message part. If the message has no frames, sends nothing but destroys  
-      # the message anyhow. Nullifies the caller's reference to the message (as 
-      # it is a destructor).                                                    
+      # message part. If the message has no frames, sends nothing but destroys
+      # the message anyhow. Nullifies the caller's reference to the message (as
+      # it is a destructor).
       #
       # @param self_p [#__ptr_give_ref]
       # @param dest [::FFI::Pointer, #to_ptr]
@@ -183,7 +183,7 @@ module CZMQ
       end
 
       # Return message routing ID, if the message came from a ZMQ_SERVER socket.
-      # Else returns zero.                                                      
+      # Else returns zero.
       #
       # @return [Integer]
       def routing_id()
@@ -194,7 +194,7 @@ module CZMQ
       end
 
       # Set routing ID on message. This is used if/when the message is sent to a
-      # ZMQ_SERVER socket.                                                      
+      # ZMQ_SERVER socket.
       #
       # @param routing_id [Integer, #to_int, #to_i]
       # @return [void]
@@ -206,10 +206,10 @@ module CZMQ
         result
       end
 
-      # Push frame to the front of the message, i.e. before all other frames.  
+      # Push frame to the front of the message, i.e. before all other frames.
       # Message takes ownership of frame, will destroy it when message is sent.
-      # Returns 0 on success, -1 on error. Deprecates zmsg_push, which did not 
-      # nullify the caller's frame reference.                                  
+      # Returns 0 on success, -1 on error. Deprecates zmsg_push, which did not
+      # nullify the caller's frame reference.
       #
       # @param frame_p [#__ptr_give_ref]
       # @return [Integer]
@@ -221,10 +221,10 @@ module CZMQ
         result
       end
 
-      # Add frame to the end of the message, i.e. after all other frames.      
+      # Add frame to the end of the message, i.e. after all other frames.
       # Message takes ownership of frame, will destroy it when message is sent.
-      # Returns 0 on success. Deprecates zmsg_add, which did not nullify the   
-      # caller's frame reference.                                              
+      # Returns 0 on success. Deprecates zmsg_add, which did not nullify the
+      # caller's frame reference.
       #
       # @param frame_p [#__ptr_give_ref]
       # @return [Integer]
@@ -248,7 +248,7 @@ module CZMQ
       end
 
       # Push block of memory to front of message, as a new frame.
-      # Returns 0 on success, -1 on error.                       
+      # Returns 0 on success, -1 on error.
       #
       # @param data [::FFI::Pointer, #to_ptr]
       # @param size [Integer, #to_int, #to_i]
@@ -262,7 +262,7 @@ module CZMQ
       end
 
       # Add block of memory to the end of the message, as a new frame.
-      # Returns 0 on success, -1 on error.                            
+      # Returns 0 on success, -1 on error.
       #
       # @param data [::FFI::Pointer, #to_ptr]
       # @param size [Integer, #to_int, #to_i]
@@ -276,7 +276,7 @@ module CZMQ
       end
 
       # Push string as new frame to front of message.
-      # Returns 0 on success, -1 on error.           
+      # Returns 0 on success, -1 on error.
       #
       # @param string [String, #to_s, nil]
       # @return [Integer]
@@ -288,7 +288,7 @@ module CZMQ
       end
 
       # Push string as new frame to end of message.
-      # Returns 0 on success, -1 on error.         
+      # Returns 0 on success, -1 on error.
       #
       # @param string [String, #to_s, nil]
       # @return [Integer]
@@ -300,7 +300,7 @@ module CZMQ
       end
 
       # Push formatted string as new frame to front of message.
-      # Returns 0 on success, -1 on error.                     
+      # Returns 0 on success, -1 on error.
       #
       # @param format [String, #to_s, nil]
       # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
@@ -313,7 +313,7 @@ module CZMQ
       end
 
       # Push formatted string as new frame to end of message.
-      # Returns 0 on success, -1 on error.                   
+      # Returns 0 on success, -1 on error.
       #
       # @param format [String, #to_s, nil]
       # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
@@ -326,7 +326,7 @@ module CZMQ
       end
 
       # Pop frame off front of message, return as fresh string. If there were
-      # no more frames in the message, returns NULL.                         
+      # no more frames in the message, returns NULL.
       #
       # @return [::FFI::AutoPointer]
       def popstr()
@@ -337,9 +337,9 @@ module CZMQ
         result
       end
 
-      # Push encoded message as a new frame. Message takes ownership of    
+      # Push encoded message as a new frame. Message takes ownership of
       # submessage, so the original is destroyed in this call. Returns 0 on
-      # success, -1 on error.                                              
+      # success, -1 on error.
       #
       # @param msg_p [#__ptr_give_ref]
       # @return [Integer]
@@ -352,7 +352,7 @@ module CZMQ
       end
 
       # Remove first submessage from message, if any. Returns zmsg_t, or NULL if
-      # decoding was not successful.                                            
+      # decoding was not successful.
       #
       # @return [Zmsg]
       def popmsg()
@@ -376,7 +376,7 @@ module CZMQ
       end
 
       # Set cursor to first frame in message. Returns frame, or NULL, if the
-      # message is empty. Use this to navigate the frames as a list.        
+      # message is empty. Use this to navigate the frames as a list.
       #
       # @return [Zframe]
       def first()
@@ -388,7 +388,7 @@ module CZMQ
       end
 
       # Return the next frame. If there are no more frames, returns NULL. To move
-      # to the first frame call zmsg_first(). Advances the cursor.               
+      # to the first frame call zmsg_first(). Advances the cursor.
       #
       # @return [Zframe]
       def next()
@@ -410,11 +410,11 @@ module CZMQ
         result
       end
 
-      # Save message to an open file, return 0 if OK, else -1. The message is  
-      # saved as a series of frames, each with length and data. Note that the  
-      # file is NOT guaranteed to be portable between operating systems, not   
+      # Save message to an open file, return 0 if OK, else -1. The message is
+      # saved as a series of frames, each with length and data. Note that the
+      # file is NOT guaranteed to be portable between operating systems, not
       # versions of CZMQ. The file format is at present undocumented and liable
-      # to arbitrary change.                                                   
+      # to arbitrary change.
       #
       # @param file [::FFI::Pointer, #to_ptr]
       # @return [Integer]
@@ -426,10 +426,10 @@ module CZMQ
       end
 
       # Serialize multipart message to a single message frame. Use this method
-      # to send structured messages across transports that do not support     
-      # multipart data. Allocates and returns a new frame containing the      
-      # serialized message. To decode a serialized message frame, use         
-      # zmsg_decode ().                                                       
+      # to send structured messages across transports that do not support
+      # multipart data. Allocates and returns a new frame containing the
+      # serialized message. To decode a serialized message frame, use
+      # zmsg_decode ().
       #
       # @return [Zframe]
       def encode()
@@ -441,7 +441,7 @@ module CZMQ
       end
 
       # Create copy of message, as new message object. Returns a fresh zmsg_t
-      # object. If message is null, or memory was exhausted, returns null.   
+      # object. If message is null, or memory was exhausted, returns null.
       #
       # @return [Zmsg]
       def dup()
@@ -453,7 +453,7 @@ module CZMQ
       end
 
       # Send message to zsys log sink (may be stdout, or system facility as
-      # configured by zsys_set_logstream).                                 
+      # configured by zsys_set_logstream).
       #
       # @return [void]
       def print()
@@ -463,7 +463,7 @@ module CZMQ
         result
       end
 
-      # Return true if the two messages have the same number of frames and each  
+      # Return true if the two messages have the same number of frames and each
       # frame in the first message is identical to the corresponding frame in the
       # other message. As with zframe_eq, return false if either message is NULL.
       #