czmq-ffi-gen 0.9.2-x64-mingw32

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

@@ -0,0 +1,396 @@
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Read the zproject/README.md for information about making permanent changes. #
+################################################################################
+
+module CZMQ
+  module FFI
+
+    # event-driven reactor
+    # @note This class is 100% generated using zproject.
+    class Zloop
+      # Raised when one tries to use an instance of {Zloop} after
+      # the internal pointer to the native object has been nullified.
+      class DestroyedError < RuntimeError; end
+
+      # Boilerplate for self pointer, initializer, and finalizer
+      class << self
+        alias :__new :new
+      end
+      # Attaches the pointer _ptr_ to this instance and defines a finalizer for
+      # it if necessary.
+      # @param ptr [::FFI::Pointer]
+      # @param finalize [Boolean]
+      def initialize(ptr, finalize = true)
+        @ptr = ptr
+        if @ptr.null?
+          @ptr = nil # Remove null pointers so we don't have to test for them.
+        elsif finalize
+          @finalizer = self.class.create_finalizer_for @ptr
+          ObjectSpace.define_finalizer self, @finalizer
+        end
+      end
+      # @param ptr [::FFI::Pointer]
+      # @return [Proc]
+      def self.create_finalizer_for(ptr)
+        Proc.new do
+          ptr_ptr = ::FFI::MemoryPointer.new :pointer
+          ptr_ptr.write_pointer ptr
+          ::CZMQ::FFI.zloop_destroy ptr_ptr
+        end
+      end
+      # @return [Boolean]
+      def null?
+        !@ptr or @ptr.null?
+      end
+      # Return internal pointer
+      # @return [::FFI::Pointer]
+      def __ptr
+        raise DestroyedError unless @ptr
+        @ptr
+      end
+      # So external Libraries can just pass the Object to a FFI function which expects a :pointer
+      alias_method :to_ptr, :__ptr
+      # Nullify internal pointer and return pointer pointer.
+      # @note This detaches the current instance from the native object
+      #   and thus makes it unusable.
+      # @return [::FFI::MemoryPointer] the pointer pointing to a pointer
+      #   pointing to the native object
+      def __ptr_give_ref
+        raise DestroyedError unless @ptr
+        ptr_ptr = ::FFI::MemoryPointer.new :pointer
+        ptr_ptr.write_pointer @ptr
+        __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:
+      # Callback function for reactor socket activity
+      #     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
+      #   FFI::Function object after passing it to a C function call,
+      #   it may be garbage collected while C still holds the pointer,
+      #   potentially resulting in a segmentation fault.
+      def self.reader_fn
+        ::FFI::Function.new :int, [:pointer, :pointer, :pointer], blocking: true do |loop, reader, arg|
+          loop = Zloop.__new loop, false
+          reader = Zsock.__new reader, false
+          result = yield loop, reader, arg
+          result = Integer(result)
+          result
+        end
+      end
+
+      # Create a new callback of the following type:
+      # Callback function for reactor events (low-level)
+      #     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
+      #   FFI::Function object after passing it to a C function call,
+      #   it may be garbage collected while C still holds the pointer,
+      #   potentially resulting in a segmentation fault.
+      def self.fn
+        ::FFI::Function.new :int, [:pointer, :pointer, :pointer], blocking: true do |loop, item, arg|
+          loop = Zloop.__new loop, false
+          result = yield loop, item, arg
+          result = Integer(result)
+          result
+        end
+      end
+
+      # Create a new callback of the following type:
+      # Callback for reactor timer events
+      #     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
+      #   FFI::Function object after passing it to a C function call,
+      #   it may be garbage collected while C still holds the pointer,
+      #   potentially resulting in a segmentation fault.
+      def self.timer_fn
+        ::FFI::Function.new :int, [:pointer, :int, :pointer], blocking: true do |loop, timer_id, arg|
+          loop = Zloop.__new loop, false
+          result = yield loop, timer_id, arg
+          result = Integer(result)
+          result
+        end
+      end
+
+      # Create a new zloop reactor
+      # @return [CZMQ::Zloop]
+      def self.new()
+        ptr = ::CZMQ::FFI.zloop_new()
+        __new ptr
+      end
+
+      # Destroy a reactor
+      #
+      # @return [void]
+      def destroy()
+        return unless @ptr
+        self_p = __ptr_give_ref
+        result = ::CZMQ::FFI.zloop_destroy(self_p)
+        result
+      end
+
+      # 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.                   
+      #
+      # @param sock [Zsock, #__ptr]
+      # @param handler [::FFI::Pointer, #to_ptr]
+      # @param arg [::FFI::Pointer, #to_ptr]
+      # @return [Integer]
+      def reader(sock, handler, arg)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        sock = sock.__ptr if sock
+        result = ::CZMQ::FFI.zloop_reader(self_p, sock, handler, arg)
+        result
+      end
+
+      # Cancel a socket reader from the reactor. If multiple readers exist for
+      # same socket, cancels ALL of them.                                     
+      #
+      # @param sock [Zsock, #__ptr]
+      # @return [void]
+      def reader_end(sock)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        sock = sock.__ptr if sock
+        result = ::CZMQ::FFI.zloop_reader_end(self_p, sock)
+        result
+      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.   
+      #
+      # @param sock [Zsock, #__ptr]
+      # @return [void]
+      def reader_set_tolerant(sock)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        sock = sock.__ptr if sock
+        result = ::CZMQ::FFI.zloop_reader_set_tolerant(self_p, sock)
+        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   
+      # 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'.                           
+      #
+      # @param item [::FFI::Pointer, #to_ptr]
+      # @param handler [::FFI::Pointer, #to_ptr]
+      # @param arg [::FFI::Pointer, #to_ptr]
+      # @return [Integer]
+      def poller(item, handler, arg)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zloop_poller(self_p, item, handler, arg)
+        result
+      end
+
+      # 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.                                       
+      #
+      # @param item [::FFI::Pointer, #to_ptr]
+      # @return [void]
+      def poller_end(item)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zloop_poller_end(self_p, item)
+        result
+      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.    
+      #
+      # @param item [::FFI::Pointer, #to_ptr]
+      # @return [void]
+      def poller_set_tolerant(item)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zloop_poller_set_tolerant(self_p, item)
+        result
+      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  
+      # 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.                   
+      #
+      # @param delay [Integer, #to_int, #to_i]
+      # @param times [Integer, #to_int, #to_i]
+      # @param handler [::FFI::Pointer, #to_ptr]
+      # @param arg [::FFI::Pointer, #to_ptr]
+      # @return [Integer]
+      def timer(delay, times, handler, arg)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        delay = Integer(delay)
+        times = Integer(times)
+        result = ::CZMQ::FFI.zloop_timer(self_p, delay, times, handler, arg)
+        result
+      end
+
+      # Cancel a specific timer identified by a specific timer_id (as returned by
+      # zloop_timer).                                                            
+      #
+      # @param timer_id [Integer, #to_int, #to_i]
+      # @return [Integer]
+      def timer_end(timer_id)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        timer_id = Integer(timer_id)
+        result = ::CZMQ::FFI.zloop_timer_end(self_p, timer_id)
+        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, 
+      # 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.                              
+      #
+      # @param handler [::FFI::Pointer, #to_ptr]
+      # @param arg [::FFI::Pointer, #to_ptr]
+      # @return [::FFI::Pointer]
+      def ticket(handler, arg)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zloop_ticket(self_p, handler, arg)
+        result
+      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.             
+      #
+      # @param handle [::FFI::Pointer, #to_ptr]
+      # @return [void]
+      def ticket_reset(handle)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zloop_ticket_reset(self_p, handle)
+        result
+      end
+
+      # 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.                                                       
+      #
+      # @param handle [::FFI::Pointer, #to_ptr]
+      # @return [void]
+      def ticket_delete(handle)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zloop_ticket_delete(self_p, handle)
+        result
+      end
+
+      # 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]
+      # @return [void]
+      def set_ticket_delay(ticket_delay)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        ticket_delay = Integer(ticket_delay)
+        result = ::CZMQ::FFI.zloop_set_ticket_delay(self_p, ticket_delay)
+        result
+      end
+
+      # 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.                                                                 
+      #
+      # @param max_timers [Integer, #to_int, #to_i]
+      # @return [void]
+      def set_max_timers(max_timers)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        max_timers = Integer(max_timers)
+        result = ::CZMQ::FFI.zloop_set_max_timers(self_p, max_timers)
+        result
+      end
+
+      # Set verbose tracing of reactor on/off. The default verbose setting is
+      # off (false).                                                         
+      #
+      # @param verbose [Boolean]
+      # @return [void]
+      def set_verbose(verbose)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        verbose = !(0==verbose||!verbose) # boolean
+        result = ::CZMQ::FFI.zloop_set_verbose(self_p, verbose)
+        result
+      end
+
+      # 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).                                          
+      #
+      # @param nonstop [Boolean]
+      # @return [void]
+      def set_nonstop(nonstop)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        nonstop = !(0==nonstop||!nonstop) # boolean
+        result = ::CZMQ::FFI.zloop_set_nonstop(self_p, nonstop)
+        result
+      end
+
+      # 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.   
+      #
+      # @return [Integer]
+      def start()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zloop_start(self_p)
+        result
+      end
+
+      # Self test of this class.
+      #
+      # @param verbose [Boolean]
+      # @return [void]
+      def self.test(verbose)
+        verbose = !(0==verbose||!verbose) # boolean
+        result = ::CZMQ::FFI.zloop_test(verbose)
+        result
+      end
+    end
+  end
+end
+
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Read the zproject/README.md for information about making permanent changes. #
+################################################################################

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

@@ -0,0 +1,515 @@
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Read the zproject/README.md for information about making permanent changes. #
+################################################################################
+
+module CZMQ
+  module FFI
+
+    # working with multipart messages
+    # @note This class is 100% generated using zproject.
+    class Zmsg
+      # Raised when one tries to use an instance of {Zmsg} after
+      # the internal pointer to the native object has been nullified.
+      class DestroyedError < RuntimeError; end
+
+      # Boilerplate for self pointer, initializer, and finalizer
+      class << self
+        alias :__new :new
+      end
+      # Attaches the pointer _ptr_ to this instance and defines a finalizer for
+      # it if necessary.
+      # @param ptr [::FFI::Pointer]
+      # @param finalize [Boolean]
+      def initialize(ptr, finalize = true)
+        @ptr = ptr
+        if @ptr.null?
+          @ptr = nil # Remove null pointers so we don't have to test for them.
+        elsif finalize
+          @finalizer = self.class.create_finalizer_for @ptr
+          ObjectSpace.define_finalizer self, @finalizer
+        end
+      end
+      # @param ptr [::FFI::Pointer]
+      # @return [Proc]
+      def self.create_finalizer_for(ptr)
+        Proc.new do
+          ptr_ptr = ::FFI::MemoryPointer.new :pointer
+          ptr_ptr.write_pointer ptr
+          ::CZMQ::FFI.zmsg_destroy ptr_ptr
+        end
+      end
+      # @return [Boolean]
+      def null?
+        !@ptr or @ptr.null?
+      end
+      # Return internal pointer
+      # @return [::FFI::Pointer]
+      def __ptr
+        raise DestroyedError unless @ptr
+        @ptr
+      end
+      # So external Libraries can just pass the Object to a FFI function which expects a :pointer
+      alias_method :to_ptr, :__ptr
+      # Nullify internal pointer and return pointer pointer.
+      # @note This detaches the current instance from the native object
+      #   and thus makes it unusable.
+      # @return [::FFI::MemoryPointer] the pointer pointing to a pointer
+      #   pointing to the native object
+      def __ptr_give_ref
+        raise DestroyedError unless @ptr
+        ptr_ptr = ::FFI::MemoryPointer.new :pointer
+        ptr_ptr.write_pointer @ptr
+        __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 empty message object
+      # @return [CZMQ::Zmsg]
+      def self.new()
+        ptr = ::CZMQ::FFI.zmsg_new()
+        __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 
+      # the zloop class or zmsg_recv_nowait or zmq_poll to check for socket input
+      # before receiving.                                                        
+      # @param source [::FFI::Pointer, #to_ptr]
+      # @return [CZMQ::Zmsg]
+      def self.recv(source)
+        ptr = ::CZMQ::FFI.zmsg_recv(source)
+        __new ptr
+      end
+
+      # Load/append an open file into new message, return the message.
+      # Returns NULL if the message could not be loaded.              
+      # @param file [::FFI::Pointer, #to_ptr]
+      # @return [CZMQ::Zmsg]
+      def self.load(file)
+        ptr = ::CZMQ::FFI.zmsg_load(file)
+        __new ptr
+      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.                                  
+      # @param frame [Zframe, #__ptr]
+      # @return [CZMQ::Zmsg]
+      def self.decode(frame)
+        frame = frame.__ptr if frame
+        ptr = ::CZMQ::FFI.zmsg_decode(frame)
+        __new ptr
+      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.  
+      # @param status [Integer, #to_int, #to_i]
+      # @return [CZMQ::Zmsg]
+      def self.new_signal(status)
+        status = Integer(status)
+        ptr = ::CZMQ::FFI.zmsg_new_signal(status)
+        __new ptr
+      end
+
+      # Destroy a message object and all frames it contains
+      #
+      # @return [void]
+      def destroy()
+        return unless @ptr
+        self_p = __ptr_give_ref
+        result = ::CZMQ::FFI.zmsg_destroy(self_p)
+        result
+      end
+
+      # 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).                                                     
+      #
+      # @param self_p [#__ptr_give_ref]
+      # @param dest [::FFI::Pointer, #to_ptr]
+      # @return [Integer]
+      def self.send(self_p, dest)
+        self_p = self_p.__ptr_give_ref
+        result = ::CZMQ::FFI.zmsg_send(self_p, dest)
+        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    
+      # 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).                                                    
+      #
+      # @param self_p [#__ptr_give_ref]
+      # @param dest [::FFI::Pointer, #to_ptr]
+      # @return [Integer]
+      def self.sendm(self_p, dest)
+        self_p = self_p.__ptr_give_ref
+        result = ::CZMQ::FFI.zmsg_sendm(self_p, dest)
+        result
+      end
+
+      # Return size of message, i.e. number of frames (0 or more).
+      #
+      # @return [Integer]
+      def size()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zmsg_size(self_p)
+        result
+      end
+
+      # Return total size of all frames in message.
+      #
+      # @return [Integer]
+      def content_size()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zmsg_content_size(self_p)
+        result
+      end
+
+      # Return message routing ID, if the message came from a ZMQ_SERVER socket.
+      # Else returns zero.                                                      
+      #
+      # @return [Integer]
+      def routing_id()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zmsg_routing_id(self_p)
+        result
+      end
+
+      # Set routing ID on message. This is used if/when the message is sent to a
+      # ZMQ_SERVER socket.                                                      
+      #
+      # @param routing_id [Integer, #to_int, #to_i]
+      # @return [void]
+      def set_routing_id(routing_id)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        routing_id = Integer(routing_id)
+        result = ::CZMQ::FFI.zmsg_set_routing_id(self_p, routing_id)
+        result
+      end
+
+      # 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.                                  
+      #
+      # @param frame_p [#__ptr_give_ref]
+      # @return [Integer]
+      def prepend(frame_p)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        frame_p = frame_p.__ptr_give_ref
+        result = ::CZMQ::FFI.zmsg_prepend(self_p, frame_p)
+        result
+      end
+
+      # 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.                                              
+      #
+      # @param frame_p [#__ptr_give_ref]
+      # @return [Integer]
+      def append(frame_p)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        frame_p = frame_p.__ptr_give_ref
+        result = ::CZMQ::FFI.zmsg_append(self_p, frame_p)
+        result
+      end
+
+      # Remove first frame from message, if any. Returns frame, or NULL.
+      #
+      # @return [Zframe]
+      def pop()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zmsg_pop(self_p)
+        result = Zframe.__new result, true
+        result
+      end
+
+      # Push block of memory to front of message, as a new frame.
+      # Returns 0 on success, -1 on error.                       
+      #
+      # @param data [::FFI::Pointer, #to_ptr]
+      # @param size [Integer, #to_int, #to_i]
+      # @return [Integer]
+      def pushmem(data, size)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        size = Integer(size)
+        result = ::CZMQ::FFI.zmsg_pushmem(self_p, data, size)
+        result
+      end
+
+      # Add block of memory to the end of the message, as a new frame.
+      # Returns 0 on success, -1 on error.                            
+      #
+      # @param data [::FFI::Pointer, #to_ptr]
+      # @param size [Integer, #to_int, #to_i]
+      # @return [Integer]
+      def addmem(data, size)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        size = Integer(size)
+        result = ::CZMQ::FFI.zmsg_addmem(self_p, data, size)
+        result
+      end
+
+      # Push string as new frame to front of message.
+      # Returns 0 on success, -1 on error.           
+      #
+      # @param string [String, #to_s, nil]
+      # @return [Integer]
+      def pushstr(string)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zmsg_pushstr(self_p, string)
+        result
+      end
+
+      # Push string as new frame to end of message.
+      # Returns 0 on success, -1 on error.         
+      #
+      # @param string [String, #to_s, nil]
+      # @return [Integer]
+      def addstr(string)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zmsg_addstr(self_p, string)
+        result
+      end
+
+      # Push formatted string as new frame to front of message.
+      # 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
+      # @return [Integer]
+      def pushstrf(format, *args)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zmsg_pushstrf(self_p, format, *args)
+        result
+      end
+
+      # Push formatted string as new frame to end of message.
+      # 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
+      # @return [Integer]
+      def addstrf(format, *args)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zmsg_addstrf(self_p, format, *args)
+        result
+      end
+
+      # Pop frame off front of message, return as fresh string. If there were
+      # no more frames in the message, returns NULL.                         
+      #
+      # @return [::FFI::AutoPointer]
+      def popstr()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zmsg_popstr(self_p)
+        result = ::FFI::AutoPointer.new(result, LibC.method(:free))
+        result
+      end
+
+      # 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.                                              
+      #
+      # @param msg_p [#__ptr_give_ref]
+      # @return [Integer]
+      def addmsg(msg_p)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        msg_p = msg_p.__ptr_give_ref
+        result = ::CZMQ::FFI.zmsg_addmsg(self_p, msg_p)
+        result
+      end
+
+      # Remove first submessage from message, if any. Returns zmsg_t, or NULL if
+      # decoding was not successful.                                            
+      #
+      # @return [Zmsg]
+      def popmsg()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zmsg_popmsg(self_p)
+        result = Zmsg.__new result, true
+        result
+      end
+
+      # Remove specified frame from list, if present. Does not destroy frame.
+      #
+      # @param frame [Zframe, #__ptr]
+      # @return [void]
+      def remove(frame)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        frame = frame.__ptr if frame
+        result = ::CZMQ::FFI.zmsg_remove(self_p, frame)
+        result
+      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.        
+      #
+      # @return [Zframe]
+      def first()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zmsg_first(self_p)
+        result = Zframe.__new result, false
+        result
+      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.               
+      #
+      # @return [Zframe]
+      def next()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zmsg_next(self_p)
+        result = Zframe.__new result, false
+        result
+      end
+
+      # Return the last frame. If there are no frames, returns NULL.
+      #
+      # @return [Zframe]
+      def last()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zmsg_last(self_p)
+        result = Zframe.__new result, false
+        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   
+      # versions of CZMQ. The file format is at present undocumented and liable
+      # to arbitrary change.                                                   
+      #
+      # @param file [::FFI::Pointer, #to_ptr]
+      # @return [Integer]
+      def save(file)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zmsg_save(self_p, file)
+        result
+      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 ().                                                       
+      #
+      # @return [Zframe]
+      def encode()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zmsg_encode(self_p)
+        result = Zframe.__new result, true
+        result
+      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.   
+      #
+      # @return [Zmsg]
+      def dup()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zmsg_dup(self_p)
+        result = Zmsg.__new result, true
+        result
+      end
+
+      # Send message to zsys log sink (may be stdout, or system facility as
+      # configured by zsys_set_logstream).                                 
+      #
+      # @return [void]
+      def print()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zmsg_print(self_p)
+        result
+      end
+
+      # 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.
+      #
+      # @param other [Zmsg, #__ptr]
+      # @return [Boolean]
+      def eq(other)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        other = other.__ptr if other
+        result = ::CZMQ::FFI.zmsg_eq(self_p, other)
+        result
+      end
+
+      # Return signal value, 0 or greater, if message is a signal, -1 if not.
+      #
+      # @return [Integer]
+      def signal()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zmsg_signal(self_p)
+        result
+      end
+
+      # Probe the supplied object, and report if it looks like a zmsg_t.
+      #
+      # @param self_ [::FFI::Pointer, #to_ptr]
+      # @return [Boolean]
+      def self.is(self_)
+        result = ::CZMQ::FFI.zmsg_is(self_)
+        result
+      end
+
+      # Self test of this class.
+      #
+      # @param verbose [Boolean]
+      # @return [void]
+      def self.test(verbose)
+        verbose = !(0==verbose||!verbose) # boolean
+        result = ::CZMQ::FFI.zmsg_test(verbose)
+        result
+      end
+    end
+  end
+end
+
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Read the zproject/README.md for information about making permanent changes. #
+################################################################################