Module: ZMQ

Defined in:
lib/ffi-rzmq.rb,
lib/ffi-rzmq/zmq.rb,
lib/ffi-rzmq/poll.rb,
lib/ffi-rzmq/device.rb,
lib/ffi-rzmq/socket.rb,
lib/ffi-rzmq/context.rb,
lib/ffi-rzmq/message.rb,
lib/ffi-rzmq/exceptions.rb,
lib/ffi-rzmq/poll_items.rb

Defined Under Namespace

Modules: Util Classes: Context, ContextError, Device, ManagedMessage, Message, MessageError, PollError, PollItems, Poller, Socket, SocketError, ZeroMQError

Constant Summary collapse

LIBPATH =

:stopdoc:

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

Socket types

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

Socket options

1
SWAP = 
3
AFFINITY = 
4
IDENTITY = 
5
SUBSCRIBE = 
6
UNSUBSCRIBE = 
7
RATE = 
8
RECOVERY_IVL = 
9
MCAST_LOOP = 
10
SNDBUF = 
11
RCVBUF = 
12
RCVMORE = 
13
FD = 
14
EVENTS = 
15
TYPE = 
16
LINGER = 
17
RECONNECT_IVL = 
18
BACKLOG = 
19
RECOVERY_IVL_MSEC = 
20
NOBLOCK =

Send/recv options

1
SNDMORE = 
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
STREAMER =

Device Types

1
FORWARDER = 
2
QUEUE = 
3
HAUSNUMERO =

ZMQ errors

156384712
EMTHREAD = 
(HAUSNUMERO + 50)
EFSM = 
(HAUSNUMERO + 51)
ENOCOMPATPROTO = 
(HAUSNUMERO + 52)
ETERM = 
(HAUSNUMERO + 53)
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)
ZMQ_POLL_STR = 
'zmq_poll'.freeze
ZMQ_SOCKET_STR = 
'zmq_socket'.freeze
ZMQ_SETSOCKOPT_STR = 
'zmq_setsockopt'.freeze
ZMQ_GETSOCKOPT_STR = 
'zmq_getsockopt'.freeze
ZMQ_BIND_STR = 
'zmq_bind'.freeze
ZMQ_CONNECT_STR = 
'zmq_connect'.freeze
ZMQ_CLOSE_STR = 
'zmq_close'.freeze
ZMQ_SEND_STR = 
'zmq_send'.freeze
ZMQ_RECV_STR = 
'zmq_recv'.freeze
ZMQ_INIT_STR = 
'zmq_init'.freeze
ZMQ_TERM_STR = 
'zmq_term'.freeze
ZMQ_MSG_INIT_SIZE_STR = 
'zmq_msg_init_size'.freeze
ZMQ_MSG_INIT_DATA_STR = 
'zmq_msg_init_data'.freeze
ZMQ_MSG_INIT_STR = 
'zmq_msg_init'.freeze
ZMQ_MSG_CLOSE_STR = 
'zmq_msg_close'.freeze
ZMQ_MSG_COPY_STR = 
'zmq_msg_copy'.freeze
ZMQ_MSG_MOVE_STR = 
'zmq_msg_move'.freeze
ZMQ_MSG_SIZE_STR = 
'zmq_msg_size'.freeze

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.



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

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.



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

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.



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

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.



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

def self.version
  @version ||= File.read(path('version.txt')).strip
end