class CZMQ::FFI::Zpoller

event-driven reactor @note This class is 100% generated using zproject.

Public Class Methods

__new(reader, *args)
Alias for: new
create_finalizer_for(ptr) click to toggle source

@param ptr [::FFI::Pointer] @return [Proc]

# File lib/czmq-ffi-gen/czmq/ffi/zpoller.rb, line 35
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
new(ptr, finalize = true) click to toggle source

Attaches the pointer ptr to this instance and defines a finalizer for it if necessary. @param ptr [::FFI::Pointer] @param finalize [Boolean]

# File lib/czmq-ffi-gen/czmq/ffi/zpoller.rb, line 24
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
new(reader, *args) click to toggle source

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]

# File lib/czmq-ffi-gen/czmq/ffi/zpoller.rb, line 82
def self.new(reader, *args)
  ptr = ::CZMQ::FFI.zpoller_new(reader, *args)
  __new ptr
end
Also aliased as: __new
test(verbose) click to toggle source

Self test of this class.

@param verbose [Boolean] @return [void]

# File lib/czmq-ffi-gen/czmq/ffi/zpoller.rb, line 184
def self.test(verbose)
  verbose = !(0==verbose||!verbose) # boolean
  result = ::CZMQ::FFI.zpoller_test(verbose)
  result
end

Public Instance Methods

__ptr() click to toggle source

Return internal pointer @return [::FFI::Pointer]

# File lib/czmq-ffi-gen/czmq/ffi/zpoller.rb, line 48
def __ptr
  raise DestroyedError unless @ptr
  @ptr
end
Also aliased as: to_ptr
__ptr_give_ref() click to toggle source

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
# File lib/czmq-ffi-gen/czmq/ffi/zpoller.rb, line 59
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
__undef_finalizer() click to toggle source

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]

# File lib/czmq-ffi-gen/czmq/ffi/zpoller.rb, line 71
def __undef_finalizer
  ObjectSpace.undefine_finalizer self
  @finalizer = nil
end
add(reader) click to toggle source

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, a zactor_t instance or a file handle.

@param reader [::FFI::Pointer, to_ptr] @return [Integer]

# File lib/czmq-ffi-gen/czmq/ffi/zpoller.rb, line 103
def add(reader)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zpoller_add(self_p, reader)
  result
end
destroy() click to toggle source

Destroy a poller

@return [void]

# File lib/czmq-ffi-gen/czmq/ffi/zpoller.rb, line 90
def destroy()
  return unless @ptr
  self_p = __ptr_give_ref
  result = ::CZMQ::FFI.zpoller_destroy(self_p)
  result
end
expired() click to toggle source

Return true if the last zpoller_wait () call ended because the timeout expired, without any error.

@return [Boolean]

# File lib/czmq-ffi-gen/czmq/ffi/zpoller.rb, line 162
def expired()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zpoller_expired(self_p)
  result
end
null?() click to toggle source

@return [Boolean]

# File lib/czmq-ffi-gen/czmq/ffi/zpoller.rb, line 43
def null?
  !@ptr or @ptr.null?
end
remove(reader) click to toggle source

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]

# File lib/czmq-ffi-gen/czmq/ffi/zpoller.rb, line 115
def remove(reader)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zpoller_remove(self_p, reader)
  result
end
set_nonstop(nonstop) click to toggle source

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]

# File lib/czmq-ffi-gen/czmq/ffi/zpoller.rb, line 129
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
terminated() click to toggle source

Return true if the last zpoller_wait () call ended because the process was interrupted, or the parent context was destroyed.

@return [Boolean]

# File lib/czmq-ffi-gen/czmq/ffi/zpoller.rb, line 173
def terminated()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zpoller_terminated(self_p)
  result
end
to_ptr()

So external Libraries can just pass the Object to a FFI function which expects a :pointer

Alias for: __ptr
wait(timeout) click to toggle source

Poll the registered readers for I/O, return first reader that has input. The reader will be a libzmq void * socket, a zsock_t, a zactor_t instance or a file handle 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]

# File lib/czmq-ffi-gen/czmq/ffi/zpoller.rb, line 150
def wait(timeout)
  raise DestroyedError unless @ptr
  self_p = @ptr
  timeout = Integer(timeout)
  result = ::CZMQ::FFI.zpoller_wait(self_p, timeout)
  result
end