Module: CZTop::ZsockOptions

Included in:

Actor, Socket

Defined in:

lib/cztop/zsock_options.rb

Overview

Note:

Most socket options only take effect for subsequent bind/connects.

This module adds the ability to access options of a Socket or an Actor.

See Also:

• http://api.zeromq.org/4-1:zmq-setsockopt
• http://api.zeromq.org/4-1:zmq-getsockopt
• http://api.zeromq.org/czmq3-0:zsock-option

Defined Under Namespace

Classes: OptionsAccessor

Instance Method Summary

• #fd ⇒ Integer

  Useful for registration in an event-loop.

• #options ⇒ OptionsAccessor

  Access to the options of this socket.

• #readable? ⇒ Boolean

  Checks whether there’s a message that can be read from the socket without blocking.

• #writable? ⇒ Boolean

  Checks whether at least one message can be written to the socket without blocking.

Instance Method Details

#fd ⇒ Integer

Useful for registration in an event-loop.

Returns:

• (Integer)

See Also:

• CZTop::ZsockOptions::OptionsAccessor#fd

# File 'lib/cztop/zsock_options.rb', line 35

def fd
  options.fd
end

#options ⇒ OptionsAccessor

Access to the options of this socket.

Returns:

• (OptionsAccessor) —

  the memoized options accessor

# File 'lib/cztop/zsock_options.rb', line 14

def options
  @options ||= OptionsAccessor.new(self)
end

#readable? ⇒ Boolean

Checks whether there’s a message that can be read from the socket without blocking.

Returns:

• (Boolean) —

  whether the socket is readable

# File 'lib/cztop/zsock_options.rb', line 21

def readable?
  (options.events & Poller::ZMQ::POLLIN) > 0
end

#writable? ⇒ Boolean

Checks whether at least one message can be written to the socket without blocking.

Returns:

• (Boolean) —

  whether the socket is writable

# File 'lib/cztop/zsock_options.rb', line 28

def writable?
  (options.events & Poller::ZMQ::POLLOUT) > 0
end