Class: EZMQ::Socket

Inherits:
Object
  • Object
show all
Defined in:
lib/ezmq/socket.rb

Overview

Wrapper class to simplify 0MQ sockets.

Direct Known Subclasses

Client, Publisher, Puller, Pusher, Server, Subscriber

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Socket) initialize(mode, type, **options)

Note:

port is ignored unless protocol is either 'tcp' or 'udp'.

Creates a 0MQ socket.

Parameters:

  • mode (:bind, :connect) —

    the mode of the socket.

  • type (Object) —

    the type of socket to use.

  • options (Hash) —

    optional parameters.

Options Hash (**options):

  • context (ZMQ::Context) —

    a context to use for this socket (one will be created if not provided).

  • encode (lambda) —

    how to encode messages.

  • decode (lambda) —

    how to decode messages.

  • protocol (String) — default: 'tcp' —

    protocol for transport.

  • address (String) — default: '127.0.0.1' —

    address for endpoint.

  • port (Fixnum) — default: 5555 —

    port for endpoint.



24
25
26
27
28
29
30
31
32
 
# File 'lib/ezmq/socket.rb', line 24

def initialize(mode, type, **options)
  fail ArgumentError unless [:bind, :connect].include? mode
  @context = options[:context] || ZMQ::Context.new
  @socket = @context.socket type
  @encode = options[:encode] || -> m { m }
  @decode = options[:decode] || -> m { m }
  endpoint = options.select { |k, _| [:protocol, :address, :port].include? k }
  method(mode).call endpoint
end

Instance Attribute Details

- (Object) context

Returns the value of attribute context



5
6
7
 
# File 'lib/ezmq/socket.rb', line 5

def context
  @context
end

- (Object) decode

Returns the value of attribute decode



5
6
7
 
# File 'lib/ezmq/socket.rb', line 5

def decode
  @decode
end

- (Object) encode

Returns the value of attribute encode



5
6
7
 
# File 'lib/ezmq/socket.rb', line 5

def encode
  @encode
end

- (Object) socket

Returns the value of attribute socket



5
6
7
 
# File 'lib/ezmq/socket.rb', line 5

def socket
  @socket
end

Instance Method Details

- (Boolean) bind(protocol: 'tcp', address: '127.0.0.1', port: 5555)

Note:

An address of 'localhost' is not reliable on all platforms. Prefer '127.0.0.1' instead.

Note:

port is ignored unless protocol is either 'tcp' or 'udp'.

Binds the socket to the given address.

Parameters:

  • protocol (String) —

    ('tcp') protocol for transport.

  • address (String) —

    ('127.0.0.1') address for endpoint.

  • port (Fixnum) —

    (5555) port for endpoint.

Returns:

  • (Boolean) —

    was binding successful?



83
84
85
86
87
 
# File 'lib/ezmq/socket.rb', line 83

def bind(protocol: 'tcp', address: '127.0.0.1', port: 5555)
  endpoint = "#{ protocol }://#{ address }"
  endpoint = "#{ endpoint }:#{ port }" if %w(tcp udp).include? protocol
  @socket.bind(endpoint) == 0
end

- (Boolean) connect(protocol: 'tcp', address: '127.0.0.1', port: 5555)

Note:

port is ignored unless protocol is either 'tcp' or 'udp'.

Connects the socket to the given address.

Parameters:

  • protocol (String) —

    ('tcp') protocol for transport.

  • address (String) —

    ('127.0.0.1') address for endpoint.

  • port (Fixnum) —

    (5555) port for endpoint.

Returns:

  • (Boolean) —

    was connection successful?



98
99
100
101
102
 
# File 'lib/ezmq/socket.rb', line 98

def connect(protocol: 'tcp', address: '127.0.0.1', port: 5555)
  endpoint = "#{ protocol }://#{ address }"
  endpoint = "#{ endpoint }:#{ port }" if %w(tcp udp).include? protocol
  @socket.connect(endpoint) == 0
end

- (void) listen {|message| ... }

This method returns an undefined value.

By default, waits for a message and prints it to STDOUT.

Yields:

  • message passes the message received to the block.

Yield Parameters:

  • message (String) —

    the message received.



111
112
113
114
115
116
117
118
119
 
# File 'lib/ezmq/socket.rb', line 111

def listen
  loop do
    if block_given?
      yield receive
    else
      puts receive
    end
  end
end

- (Object) receive(**options) {|message| ... }

Note:

This method blocks until a message arrives.

Receive a message from the socket.

Parameters:

  • options (Hash) —

    optional parameters.

Options Hash (**options):

  • decode (lambda) —

    how to decode the message.

Yields:

  • message passes the message received to the block.

Yield Parameters:

  • message (Object) —

    the message received (decoded).

Returns:

  • (Object) —

    the message received (decoded).



61
62
63
64
65
66
67
68
69
70
 
# File 'lib/ezmq/socket.rb', line 61

def receive(**options)
  message = ''
  @socket.recv_string message
  decoded = (options[:decode] || @decode).call message
  if block_given?
    yield decoded
  else
    decoded
  end
end

- (Fixnum) send(message = '', **options)

Note:

If message is not a String, #encode must convert it to one.

Sends a message to the socket.

Parameters:

  • message (String) (defaults to: '') —

    the message to send.

  • options (Hash) —

    optional parameters.

Options Hash (**options):

  • encode (lambda) —

    how to encode the message.

Returns:

  • (Fixnum) —

    the size of the message.



44
45
46
47
 
# File 'lib/ezmq/socket.rb', line 44

def send(message = '', **options)
  encoded = (options[:encode] || @encode).call message
  @socket.send_string encoded
end