Class: OMQ::SUB

Inherits:
Socket show all
Includes:
Readable
Defined in:
lib/omq/pub_sub.rb

Overview

SUB socket.

Constant Summary collapse

EVERYTHING =

Returns subscription prefix to subscribe to everything.

Returns:

  • (String) —

    subscription prefix to subscribe to everything

''

Instance Attribute Summary

Attributes inherited from Socket

#engine, #last_tcp_port, #options

Instance Method Summary collapse

Methods included from Readable

#receive, #wait_readable

Methods included from QueueReadable

#dequeue, #each, #wait

Methods inherited from Socket

#all_peers_gone, #attach_endpoints, bind, #bind, #close, #close_read, connect, #connect, #connection_count, #disconnect, #init_engine, #inspect, #last_endpoint, #monitor, #peer_connected, #reconnect_enabled=, #set_unbounded, #stop, #subscriber_joined, #unbind

Constructor Details

#initialize(endpoints = nil, linger: 0, subscribe: nil, on_mute: :block, backend: nil) ⇒ SUB

Returns a new instance of SUB.

Parameters:

  • endpoints (String, nil) (defaults to: nil)
  • linger (Integer) (defaults to: 0)
  • subscribe (String, nil) (defaults to: nil) —

    subscription prefix; nil (default) means no subscription — call #subscribe explicitly.

  • on_mute (Symbol) (defaults to: :block) —

    :block (default), :drop_newest, or :drop_oldest



38
39
40
41
42
 
# File 'lib/omq/pub_sub.rb', line 38

def initialize(endpoints = nil, linger: 0, subscribe: nil, on_mute: :block, backend: nil)
  init_engine(:SUB, linger: linger, on_mute: on_mute, backend: backend)
  attach_endpoints(endpoints, default: :connect)
  self.subscribe(subscribe) unless subscribe.nil?
end

Instance Method Details

#subscribe(prefix = EVERYTHING) ⇒ void

This method returns an undefined value.

Subscribes to a topic prefix.

Parameters:

  • prefix (String) (defaults to: EVERYTHING) 


50
51
52
 
# File 'lib/omq/pub_sub.rb', line 50

def subscribe(prefix = EVERYTHING)
  @engine.routing.subscribe(prefix)
end

#unsubscribe(prefix) ⇒ void

This method returns an undefined value.

Unsubscribes from a topic prefix.

Parameters:

  • prefix (String) 


60
61
62
 
# File 'lib/omq/pub_sub.rb', line 60

def unsubscribe(prefix)
  @engine.routing.unsubscribe(prefix)
end