Module: ZMQ

Defined in:
lib/ffi-rzmq.rb,
lib/ffi-rzmq/poll.rb,
lib/ffi-rzmq/util.rb,
lib/ffi-rzmq/device.rb,
lib/ffi-rzmq/libzmq.rb,
lib/ffi-rzmq/socket.rb,
lib/ffi-rzmq/context.rb,
lib/ffi-rzmq/message.rb,
lib/ffi-rzmq/version.rb,
lib/ffi-rzmq/constants.rb,
lib/ffi-rzmq/constants.rb,
lib/ffi-rzmq/constants.rb,
lib/ffi-rzmq/poll_item.rb,
lib/ffi-rzmq/exceptions.rb,
lib/ffi-rzmq/poll_items.rb

Defined Under Namespace

Modules: CommonSocketBehavior, IdentitySupport, LibZMQ Classes: Context, ContextError, Device, ManagedMessage, Message, MessageError, PollItem, PollItems, Poller, Socket, Util, ZeroMQError

Constant Summary collapse

LIBPATH =

:stopdoc:

::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
PATH = 
::File.dirname(LIBPATH) + ::File::SEPARATOR
VERSION = 
"1.0.3"
PAIR =

Socket types

0
PUB = 
1
SUB = 
2
REQ = 
3
REP = 
4
XREQ = 
5
XREP = 
6
PULL = 
7
PUSH = 
8
SocketTypeNameMap = 
{
  PAIR => "PAIR",
  PUB => "PUB",
  SUB => "SUB",
  REQ => "REQ",
  REP => "REP",
  PULL => "PULL",
  PUSH => "PUSH",
  XREQ => "XREQ",
  XREP => "XREP"
}
AFFINITY =

Socket options

4
SUBSCRIBE = 
6
UNSUBSCRIBE = 
7
RATE = 
8
RECOVERY_IVL = 
9
SNDBUF = 
11
RCVBUF = 
12
RCVMORE = 
13
FD = 
14
EVENTS = 
15
TYPE = 
16
LINGER = 
17
RECONNECT_IVL = 
18
BACKLOG = 
19
RECONNECT_IVL_MAX = 
21
RCVTIMEO = 
27
SNDTIMEO = 
28
SNDMORE =

Send/recv options

2
POLL =

I/O multiplexing

1
POLLIN = 
1
POLLOUT = 
2
POLLERR = 
4
EAGAIN =

Socket errors

Errno::EAGAIN::Errno
EINVAL = 
Errno::EINVAL::Errno
ENOMEM = 
Errno::ENOMEM::Errno
ENODEV = 
Errno::ENODEV::Errno
EFAULT = 
Errno::EFAULT::Errno
EINTR = 
Errno::EINTR::Errno
HAUSNUMERO =

ZMQ errors

156384712
EFSM = 
(HAUSNUMERO + 51)
ENOCOMPATPROTO = 
(HAUSNUMERO + 52)
ETERM = 
(HAUSNUMERO + 53)
EMTHREAD = 
(HAUSNUMERO + 54)
ENOTSUP =

Rescue unknown constants and use the ZeroMQ defined values Usually only happens on Windows though some don’t resolve on OSX too (ENOTSUP)

Errno::ENOTSUP::Errno rescue (HAUSNUMERO + 1)
EPROTONOSUPPORT = 
Errno::EPROTONOSUPPORT::Errno rescue (HAUSNUMERO + 2)
ENOBUFS = 
Errno::ENOBUFS::Errno rescue (HAUSNUMERO + 3)
ENETDOWN = 
Errno::ENETDOWN::Errno rescue (HAUSNUMERO + 4)
EADDRINUSE = 
Errno::EADDRINUSE::Errno rescue (HAUSNUMERO + 5)
EADDRNOTAVAIL = 
Errno::EADDRNOTAVAIL::Errno rescue (HAUSNUMERO + 6)
ECONNREFUSED = 
Errno::ECONNREFUSED::Errno rescue (HAUSNUMERO + 7)
EINPROGRESS = 
Errno::EINPROGRESS::Errno rescue (HAUSNUMERO + 8)
ENOTSOCK = 
Errno::ENOTSOCK::Errno rescue (HAUSNUMERO + 9)
EMSGSIZE = 
Errno::EMSGSIZE::Errno rescue (HAUSNUMERO + 10)
EAFNOSUPPORT = 
Errno::EAFNOSUPPORT::Errno rescue (HAUSNUMERO + 11)
ENETUNREACH = 
Errno::ENETUNREACH::Errno rescue (HAUSNUMERO + 12)
ECONNABORTED = 
Errno::ECONNABORTED::Errno rescue (HAUSNUMERO + 13)
ECONNRESET = 
Errno::ECONNRESET::Errno rescue (HAUSNUMERO + 14)
ENOTCONN = 
Errno::ENOTCONN::Errno rescue (HAUSNUMERO + 15)
ETIMEDOUT = 
Errno::ETIMEDOUT::Errno rescue (HAUSNUMERO + 16)
EHOSTUNREACH = 
Errno::EHOSTUNREACH::Errno rescue (HAUSNUMERO + 17)
ENETRESET = 
Errno::ENETRESET::Errno rescue (HAUSNUMERO + 18)
STREAMER =

Device Types

1
FORWARDER = 
2
QUEUE = 
3
UPSTREAM =

Socket types

PULL
DOWNSTREAM = 
PUSH
DEALER = 
XREQ
ROUTER = 
XREP
HWM =

Socket options

1
IDENTITY =

Socket options

5
MCAST_LOOP = 
10
SWAP = 
3
RECOVERY_IVL_MSEC = 
20
NOBLOCK =

Send/recv options

1
NonBlocking = 
DONTWAIT
XPUB =

Socket types

9
XSUB = 
10
IO_THREADS =

Context options

1
MAX_SOCKETS = 
2
IO_THREADS_DFLT = 
1
MAX_SOCKETS_DFLT = 
1024
MAXMSGSIZE = 
22
SNDHWM = 
23
RCVHWM = 
24
MULTICAST_HOPS = 
25
IPV4ONLY = 
31
LAST_ENDPOINT = 
32
ROUTER_BEHAVIOR = 
33
TCP_KEEPALIVE = 
34
TCP_KEEPALIVE_CNT = 
35
TCP_KEEPALIVE_IDLE = 
36
TCP_KEEPALIVE_INTVL = 
37
TCP_ACCEPT_FILTER = 
38
MORE =

Message options

1
DONTWAIT =

Send/recv options

1
SNDLABEL = 
4
EVENT_CONNECTED =

Socket events and monitoring

1
EVENT_CONNECT_DELAYED = 
2
EVENT_CONNECT_RETRIED = 
4
EVENT_LISTENING = 
8
EVENT_BIND_FAILED = 
16
EVENT_ACCEPTED = 
32
EVENT_ACCEPT_FAILED = 
64
EVENT_CLOSED = 
128
EVENT_CLOSE_FAILED = 
256
EVENT_DISCONNECTED = 
512
EVENT_ALL = 
EVENT_CONNECTED | EVENT_CONNECT_DELAYED | EVENT_CONNECT_RETRIED |
EVENT_LISTENING | EVENT_BIND_FAILED | EVENT_ACCEPTED |
EVENT_ACCEPT_FAILED | EVENT_CLOSED | EVENT_CLOSE_FAILED |
EVENT_DISCONNECTED
EMFILE =

Socket & other errors

Errno::EMFILE::Errno

Class Method Summary collapse

Class Method Details

.libpath(*args, &block) ⇒ Object

Returns the library path for the module. If any arguments are given, they will be joined to the end of the libray path using File.join.



18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/ffi-rzmq.rb', line 18

def self.libpath( *args, &block )
  rv =  args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
  if block
    begin
      $LOAD_PATH.unshift LIBPATH
      rv = block.call
    ensure
      $LOAD_PATH.shift
    end
  end
  return rv
end

.path(*args, &block) ⇒ Object

Returns the lpath for the module. If any arguments are given, they will be joined to the end of the path using File.join.



35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/ffi-rzmq.rb', line 35

def self.path( *args, &block )
  rv = args.empty? ? PATH : ::File.join(PATH, args.flatten)
  if block
    begin
      $LOAD_PATH.unshift PATH
      rv = block.call
    ensure
      $LOAD_PATH.shift
    end
  end
  return rv
end

.require_all_libs_relative_to(fname, dir = nil) ⇒ Object

Utility method used to require all files ending in .rb that lie in the directory below this file that has the same name as the filename passed in. Optionally, a specific directory name can be passed in such that the filename does not have to be equivalent to the directory.



53
54
55
56
57
58
59
 
# File 'lib/ffi-rzmq.rb', line 53

def self.require_all_libs_relative_to( fname, dir = nil )
  dir ||= ::File.basename(fname, '.*')
  search_me = ::File.expand_path(
  ::File.join(::File.dirname(fname), dir, '**', '*.rb'))

  Dir.glob(search_me).sort.each {|rb| require rb}
end

.version ⇒ Object

Returns the version string for the library.



10
11
12
 
# File 'lib/ffi-rzmq.rb', line 10

def self.version
  @version ||= ZMQ::VERSION
end