czmq-ffi-gen 0.9.1-x86-mingw32

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

@@ -0,0 +1,203 @@
+################################################################################
+#  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
+
+    # sending and receiving strings
+    # @note This class is 100% generated using zproject.
+    class Zstr
+      # Raised when one tries to use an instance of {Zstr} 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
+      # @return [Proc]
+      def self.create_finalizer_for(ptr)
+        Proc.new do
+          "WARNING: "\
+          "Objects of type #{self} cannot be destroyed implicitly. "\
+          "Please call the correct destroy method with the relevant arguments."
+        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
+
+      # 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.                                            
+      #
+      # @param source [::FFI::Pointer, #to_ptr]
+      # @return [::FFI::AutoPointer]
+      def self.recv(source)
+        result = ::CZMQ::FFI.zstr_recv(source)
+        result = ::FFI::AutoPointer.new(result, LibC.method(:free))
+        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    
+      # 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.                     
+      #
+      # @param source [::FFI::Pointer, #to_ptr]
+      # @param string_p [::FFI::Pointer, #to_ptr]
+      # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
+      # @return [Integer]
+      def self.recvx(source, string_p, *args)
+        result = ::CZMQ::FFI.zstr_recvx(source, string_p, *args)
+        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 "".                                   
+      #
+      # @param dest [::FFI::Pointer, #to_ptr]
+      # @param string [String, #to_s, nil]
+      # @return [Integer]
+      def self.send(dest, string)
+        result = ::CZMQ::FFI.zstr_send(dest, string)
+        result
+      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.          
+      #
+      # @param dest [::FFI::Pointer, #to_ptr]
+      # @param string [String, #to_s, nil]
+      # @return [Integer]
+      def self.sendm(dest, string)
+        result = ::CZMQ::FFI.zstr_sendm(dest, string)
+        result
+      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).                                     
+      #
+      # @param dest [::FFI::Pointer, #to_ptr]
+      # @param format [String, #to_s, nil]
+      # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
+      # @return [Integer]
+      def self.sendf(dest, format, *args)
+        result = ::CZMQ::FFI.zstr_sendf(dest, format, *args)
+        result
+      end
+
+      # 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.                                                              
+      #
+      # @param dest [::FFI::Pointer, #to_ptr]
+      # @param format [String, #to_s, nil]
+      # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
+      # @return [Integer]
+      def self.sendfm(dest, format, *args)
+        result = ::CZMQ::FFI.zstr_sendfm(dest, format, *args)
+        result
+      end
+
+      # 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]
+      # @param string [String, #to_s, nil]
+      # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
+      # @return [Integer]
+      def self.sendx(dest, string, *args)
+        result = ::CZMQ::FFI.zstr_sendx(dest, string, *args)
+        result
+      end
+
+      # Accepts a void pointer and returns a fresh character string. If source
+      # is null, returns an empty string.                                     
+      #
+      # @param source [::FFI::Pointer, #to_ptr]
+      # @return [::FFI::AutoPointer]
+      def self.str(source)
+        result = ::CZMQ::FFI.zstr_str(source)
+        result = ::FFI::AutoPointer.new(result, LibC.method(:free))
+        result
+      end
+
+      # Free a provided string, and nullify the parent pointer. Safe to call on
+      # a null pointer.                                                        
+      #
+      # @param string_p [::FFI::Pointer, #to_ptr]
+      # @return [void]
+      def self.free(string_p)
+        result = ::CZMQ::FFI.zstr_free(string_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.zstr_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/ztimerset.rb

@@ -0,0 +1,203 @@
+################################################################################
+#  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
+
+    # timer set
+    # @note This class is 100% generated using zproject.
+    class Ztimerset
+      # Raised when one tries to use an instance of {Ztimerset} 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.ztimerset_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 timer event.
+      #     typedef void (ztimerset_fn) (
+      #         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.fn
+        ::FFI::Function.new :void, [:int, :pointer], blocking: true do |timer_id, arg|
+          result = yield timer_id, arg
+          result
+        end
+      end
+
+      # Create new timer set.
+      # @return [CZMQ::Ztimerset]
+      def self.new()
+        ptr = ::CZMQ::FFI.ztimerset_new()
+        __new ptr
+      end
+
+      # Destroy a timer set
+      #
+      # @return [void]
+      def destroy()
+        return unless @ptr
+        self_p = __ptr_give_ref
+        result = ::CZMQ::FFI.ztimerset_destroy(self_p)
+        result
+      end
+
+      # Add a timer to the set. Returns timer id if OK, -1 on failure.
+      #
+      # @param interval [Integer, #to_int, #to_i]
+      # @param handler [::FFI::Pointer, #to_ptr]
+      # @param arg [::FFI::Pointer, #to_ptr]
+      # @return [Integer]
+      def add(interval, handler, arg)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        interval = Integer(interval)
+        result = ::CZMQ::FFI.ztimerset_add(self_p, interval, handler, arg)
+        result
+      end
+
+      # Cancel a timer. Returns 0 if OK, -1 on failure.
+      #
+      # @param timer_id [Integer, #to_int, #to_i]
+      # @return [Integer]
+      def cancel(timer_id)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        timer_id = Integer(timer_id)
+        result = ::CZMQ::FFI.ztimerset_cancel(self_p, timer_id)
+        result
+      end
+
+      # Set timer interval. Returns 0 if OK, -1 on failure.                                    
+      # This method is slow, canceling the timer and adding a new one yield better performance.
+      #
+      # @param timer_id [Integer, #to_int, #to_i]
+      # @param interval [Integer, #to_int, #to_i]
+      # @return [Integer]
+      def set_interval(timer_id, interval)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        timer_id = Integer(timer_id)
+        interval = Integer(interval)
+        result = ::CZMQ::FFI.ztimerset_set_interval(self_p, timer_id, interval)
+        result
+      end
+
+      # Reset timer to start interval counting from current time. Returns 0 if OK, -1 on failure.
+      # This method is slow, canceling the timer and adding a new one yield better performance.  
+      #
+      # @param timer_id [Integer, #to_int, #to_i]
+      # @return [Integer]
+      def reset(timer_id)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        timer_id = Integer(timer_id)
+        result = ::CZMQ::FFI.ztimerset_reset(self_p, timer_id)
+        result
+      end
+
+      # Return the time until the next interval.                        
+      # Should be used as timeout parameter for the zpoller wait method.
+      # The timeout is in msec.                                         
+      #
+      # @return [Integer]
+      def timeout()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.ztimerset_timeout(self_p)
+        result
+      end
+
+      # Invoke callback function of all timers which their interval has elapsed.
+      # Should be call after zpoller wait method.                               
+      # Returns 0 if OK, -1 on failure.                                         
+      #
+      # @return [Integer]
+      def execute()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.ztimerset_execute(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.ztimerset_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/ztrie.rb

@@ -0,0 +1,221 @@
+################################################################################
+#  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
+
+    # simple trie for tokenizable strings
+    # @note This class is 100% generated using zproject.
+    class Ztrie
+      # Raised when one tries to use an instance of {Ztrie} 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.ztrie_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 ztrie_node to destroy node data.
+      #     typedef void (ztrie_destroy_data_fn) (
+      #         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,
+      #   it may be garbage collected while C still holds the pointer,
+      #   potentially resulting in a segmentation fault.
+      def self.destroy_data_fn
+        ::FFI::Function.new :void, [:pointer], blocking: true do |data|
+          result = yield data
+          result
+        end
+      end
+
+      # Creates a new ztrie.
+      # @param delimiter [::FFI::Pointer, #to_ptr]
+      # @return [CZMQ::Ztrie]
+      def self.new(delimiter)
+        ptr = ::CZMQ::FFI.ztrie_new(delimiter)
+        __new ptr
+      end
+
+      # Destroy the ztrie.
+      #
+      # @return [void]
+      def destroy()
+        return unless @ptr
+        self_p = __ptr_give_ref
+        result = ::CZMQ::FFI.ztrie_destroy(self_p)
+        result
+      end
+
+      # Inserts a new route into the tree and attaches the data. Returns -1     
+      # if the route already exists, otherwise 0. This method takes ownership of
+      # the provided data if a destroy_data_fn is provided.                     
+      #
+      # @param path [String, #to_s, nil]
+      # @param data [::FFI::Pointer, #to_ptr]
+      # @param destroy_data_fn [::FFI::Pointer, #to_ptr]
+      # @return [Integer]
+      def insert_route(path, data, destroy_data_fn)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.ztrie_insert_route(self_p, path, data, destroy_data_fn)
+        result
+      end
+
+      # Removes a route from the trie and destroys its data. Returns -1 if the
+      # route does not exists, otherwise 0.                                   
+      # the start of the list call zlist_first (). Advances the cursor.       
+      #
+      # @param path [String, #to_s, nil]
+      # @return [Integer]
+      def remove_route(path)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.ztrie_remove_route(self_p, path)
+        result
+      end
+
+      # Returns true if the path matches a route in the tree, otherwise false.
+      #
+      # @param path [String, #to_s, nil]
+      # @return [Boolean]
+      def matches(path)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.ztrie_matches(self_p, path)
+        result
+      end
+
+      # Returns the data of a matched route from last ztrie_matches. If the path
+      # did not match, returns NULL. Do not delete the data as it's owned by    
+      # ztrie.                                                                  
+      #
+      # @return [::FFI::Pointer]
+      def hit_data()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.ztrie_hit_data(self_p)
+        result
+      end
+
+      # Returns the count of parameters that a matched route has.
+      #
+      # @return [Integer]
+      def hit_parameter_count()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.ztrie_hit_parameter_count(self_p)
+        result
+      end
+
+      # Returns the parameters of a matched route with named regexes from last   
+      # ztrie_matches. If the path did not match or the route did not contain any
+      # named regexes, returns NULL.                                             
+      #
+      # @return [Zhashx]
+      def hit_parameters()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.ztrie_hit_parameters(self_p)
+        result = Zhashx.__new result, false
+        result
+      end
+
+      # Returns the asterisk matched part of a route, if there has been no match
+      # or no asterisk match, returns NULL.                                     
+      #
+      # @return [String]
+      def hit_asterisk_match()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.ztrie_hit_asterisk_match(self_p)
+        result
+      end
+
+      # Print the trie
+      #
+      # @return [void]
+      def print()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.ztrie_print(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.ztrie_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. #
+################################################################################