czmq-ffi-gen 0.9.1-x86-mingw32

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

@@ -0,0 +1,194 @@
+################################################################################
+#  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 Zpoller
+      # Raised when one tries to use an instance of {Zpoller} 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.zpoller_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 new poller, specifying zero or more readers. The list of 
+      # readers ends in a NULL. Each reader can be a zsock_t instance, a
+      # zactor_t instance, a libzmq socket (void *), or a file handle.  
+      # @param reader [::FFI::Pointer, #to_ptr]
+      # @param args [Array<Object>]
+      # @return [CZMQ::Zpoller]
+      def self.new(reader, *args)
+        ptr = ::CZMQ::FFI.zpoller_new(reader, *args)
+        __new ptr
+      end
+
+      # Destroy a poller
+      #
+      # @return [void]
+      def destroy()
+        return unless @ptr
+        self_p = __ptr_give_ref
+        result = ::CZMQ::FFI.zpoller_destroy(self_p)
+        result
+      end
+
+      # Add a reader to be polled. Returns 0 if OK, -1 on failure. The reader may
+      # be a libzmq void * socket, a zsock_t instance, or a zactor_t instance.   
+      #
+      # @param reader [::FFI::Pointer, #to_ptr]
+      # @return [Integer]
+      def add(reader)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zpoller_add(self_p, reader)
+        result
+      end
+
+      # Remove a reader from the poller; returns 0 if OK, -1 on failure. The reader
+      # must have been passed during construction, or in an zpoller_add () call.   
+      #
+      # @param reader [::FFI::Pointer, #to_ptr]
+      # @return [Integer]
+      def remove(reader)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zpoller_remove(self_p, reader)
+        result
+      end
+
+      # By default the poller 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.zpoller_set_nonstop(self_p, nonstop)
+        result
+      end
+
+      # Poll the registered readers for I/O, return first reader that has input.  
+      # The reader will be a libzmq void * socket, or a zsock_t or zactor_t       
+      # instance as specified in zpoller_new/zpoller_add. The timeout should be   
+      # zero or greater, or -1 to wait indefinitely. Socket priority is defined   
+      # by their order in the poll list. If you need a balanced poll, use the low 
+      # level zmq_poll method directly. If the poll call was interrupted (SIGINT),
+      # or the ZMQ context was destroyed, or the timeout expired, returns NULL.   
+      # You can test the actual exit condition by calling zpoller_expired () and  
+      # zpoller_terminated (). The timeout is in msec.                            
+      #
+      # @param timeout [Integer, #to_int, #to_i]
+      # @return [::FFI::Pointer]
+      def wait(timeout)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        timeout = Integer(timeout)
+        result = ::CZMQ::FFI.zpoller_wait(self_p, timeout)
+        result
+      end
+
+      # Return true if the last zpoller_wait () call ended because the timeout
+      # expired, without any error.                                           
+      #
+      # @return [Boolean]
+      def expired()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zpoller_expired(self_p)
+        result
+      end
+
+      # Return true if the last zpoller_wait () call ended because the process
+      # was interrupted, or the parent context was destroyed.                 
+      #
+      # @return [Boolean]
+      def terminated()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zpoller_terminated(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.zpoller_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/zproc.rb

@@ -0,0 +1,294 @@
+################################################################################
+#  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
+
+    # process configuration and status
+    # @note This class is 100% generated using zproject.
+    class Zproc
+      # Raised when one tries to use an instance of {Zproc} 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
+
+      # Returns CZMQ version as a single 6-digit integer encoding the major
+      # version (x 10000), the minor version (x 100) and the patch.        
+      #
+      # @return [Integer]
+      def self.czmq_version()
+        result = ::CZMQ::FFI.zproc_czmq_version()
+        result
+      end
+
+      # Returns true if the process received a SIGINT or SIGTERM signal.
+      # It is good practice to use this method to exit any infinite loop
+      # processing messages.                                            
+      #
+      # @return [Boolean]
+      def self.interrupted()
+        result = ::CZMQ::FFI.zproc_interrupted()
+        result
+      end
+
+      # Returns true if the underlying libzmq supports CURVE security.
+      #
+      # @return [Boolean]
+      def self.has_curve()
+        result = ::CZMQ::FFI.zproc_has_curve()
+        result
+      end
+
+      # Return current host name, for use in public tcp:// endpoints.
+      # If the host name is not resolvable, returns NULL.            
+      #
+      # @return [::FFI::AutoPointer]
+      def self.hostname()
+        result = ::CZMQ::FFI.zproc_hostname()
+        result = ::FFI::AutoPointer.new(result, LibC.method(:free))
+        result
+      end
+
+      # Move the current process into the background. The precise effect     
+      # depends on the operating system. On POSIX boxes, moves to a specified
+      # working directory (if specified), closes all file handles, reopens   
+      # stdin, stdout, and stderr to the null device, and sets the process to
+      # ignore SIGHUP. On Windows, does nothing. Returns 0 if OK, -1 if there
+      # was an error.                                                        
+      #
+      # @param workdir [String, #to_s, nil]
+      # @return [void]
+      def self.daemonize(workdir)
+        result = ::CZMQ::FFI.zproc_daemonize(workdir)
+        result
+      end
+
+      # Drop the process ID into the lockfile, with exclusive lock, and   
+      # switch the process to the specified group and/or user. Any of the 
+      # arguments may be null, indicating a no-op. Returns 0 on success,  
+      # -1 on failure. Note if you combine this with zsys_daemonize, run  
+      # after, not before that method, or the lockfile will hold the wrong
+      # process ID.                                                       
+      #
+      # @param lockfile [String, #to_s, nil]
+      # @param group [String, #to_s, nil]
+      # @param user [String, #to_s, nil]
+      # @return [void]
+      def self.run_as(lockfile, group, user)
+        result = ::CZMQ::FFI.zproc_run_as(lockfile, group, user)
+        result
+      end
+
+      # Configure the number of I/O threads that ZeroMQ will use. A good  
+      # rule of thumb is one thread per gigabit of traffic in or out. The 
+      # default is 1, sufficient for most applications. If the environment
+      # variable ZSYS_IO_THREADS is defined, that provides the default.   
+      # Note that this method is valid only before any socket is created. 
+      #
+      # @param io_threads [Integer, #to_int, #to_i]
+      # @return [void]
+      def self.set_io_threads(io_threads)
+        io_threads = Integer(io_threads)
+        result = ::CZMQ::FFI.zproc_set_io_threads(io_threads)
+        result
+      end
+
+      # Configure the number of sockets that ZeroMQ will allow. The default  
+      # is 1024. The actual limit depends on the system, and you can query it
+      # by using zsys_socket_limit (). A value of zero means "maximum".      
+      # Note that this method is valid only before any socket is created.    
+      #
+      # @param max_sockets [Integer, #to_int, #to_i]
+      # @return [void]
+      def self.set_max_sockets(max_sockets)
+        max_sockets = Integer(max_sockets)
+        result = ::CZMQ::FFI.zproc_set_max_sockets(max_sockets)
+        result
+      end
+
+      # Set network interface name to use for broadcasts, particularly zbeacon.    
+      # This lets the interface be configured for test environments where required.
+      # For example, on Mac OS X, zbeacon cannot bind to 255.255.255.255 which is  
+      # the default when there is no specified interface. If the environment       
+      # variable ZSYS_INTERFACE is set, use that as the default interface name.    
+      # Setting the interface to "*" means "use all available interfaces".         
+      #
+      # @param value [String, #to_s, nil]
+      # @return [void]
+      def self.set_biface(value)
+        result = ::CZMQ::FFI.zproc_set_biface(value)
+        result
+      end
+
+      # Return network interface to use for broadcasts, or "" if none was set.
+      #
+      # @return [String]
+      def self.biface()
+        result = ::CZMQ::FFI.zproc_biface()
+        result
+      end
+
+      # Set log identity, which is a string that prefixes all log messages sent
+      # by this process. The log identity defaults to the environment variable 
+      # ZSYS_LOGIDENT, if that is set.                                         
+      #
+      # @param value [String, #to_s, nil]
+      # @return [void]
+      def self.set_log_ident(value)
+        result = ::CZMQ::FFI.zproc_set_log_ident(value)
+        result
+      end
+
+      # Sends log output to a PUB socket bound to the specified endpoint. To   
+      # collect such log output, create a SUB socket, subscribe to the traffic 
+      # you care about, and connect to the endpoint. Log traffic is sent as a  
+      # single string frame, in the same format as when sent to stdout. The    
+      # log system supports a single sender; multiple calls to this method will
+      # bind the same sender to multiple endpoints. To disable the sender, call
+      # this method with a null argument.                                      
+      #
+      # @param endpoint [String, #to_s, nil]
+      # @return [void]
+      def self.set_log_sender(endpoint)
+        result = ::CZMQ::FFI.zproc_set_log_sender(endpoint)
+        result
+      end
+
+      # Enable or disable logging to the system facility (syslog on POSIX boxes,
+      # event log on Windows). By default this is disabled.                     
+      #
+      # @param logsystem [Boolean]
+      # @return [void]
+      def self.set_log_system(logsystem)
+        logsystem = !(0==logsystem||!logsystem) # boolean
+        result = ::CZMQ::FFI.zproc_set_log_system(logsystem)
+        result
+      end
+
+      # Log error condition - highest priority
+      #
+      # @param format [String, #to_s, nil]
+      # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
+      # @return [void]
+      def self.log_error(format, *args)
+        result = ::CZMQ::FFI.zproc_log_error(format, *args)
+        result
+      end
+
+      # Log warning condition - high priority
+      #
+      # @param format [String, #to_s, nil]
+      # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
+      # @return [void]
+      def self.log_warning(format, *args)
+        result = ::CZMQ::FFI.zproc_log_warning(format, *args)
+        result
+      end
+
+      # Log normal, but significant, condition - normal priority
+      #
+      # @param format [String, #to_s, nil]
+      # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
+      # @return [void]
+      def self.log_notice(format, *args)
+        result = ::CZMQ::FFI.zproc_log_notice(format, *args)
+        result
+      end
+
+      # Log informational message - low priority
+      #
+      # @param format [String, #to_s, nil]
+      # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
+      # @return [void]
+      def self.log_info(format, *args)
+        result = ::CZMQ::FFI.zproc_log_info(format, *args)
+        result
+      end
+
+      # Log debug-level message - lowest priority
+      #
+      # @param format [String, #to_s, nil]
+      # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
+      # @return [void]
+      def self.log_debug(format, *args)
+        result = ::CZMQ::FFI.zproc_log_debug(format, *args)
+        result
+      end
+
+      # Self test of this class.
+      #
+      # @param verbose [Boolean]
+      # @return [void]
+      def self.test(verbose)
+        verbose = !(0==verbose||!verbose) # boolean
+        result = ::CZMQ::FFI.zproc_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. #
+################################################################################