Class: OMQ::Routing::Gather

Inherits:
Object
  • Object
show all
Defined in:
lib/omq/routing/gather.rb

Overview

GATHER socket routing: fair-queue receive from SCATTER peers.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(engine) ⇒ Gather

Returns a new instance of Gather.

Parameters:

  • engine (Engine) 


10
11
12
13
14
 
# File 'lib/omq/routing/gather.rb', line 10

def initialize(engine)
  @engine     = engine
  @recv_queue = Routing.build_queue(engine.options.recv_hwm, :block)
  @tasks      = []
end

Instance Attribute Details

#recv_queue ⇒ Async::LimitedQueue (readonly)

Returns:

  • (Async::LimitedQueue) 


19
20
21
 
# File 'lib/omq/routing/gather.rb', line 19

def recv_queue
  @recv_queue
end

Instance Method Details

#connection_added(connection) ⇒ Object

Parameters:

  • connection (Connection) 


42
43
44
45
 
# File 'lib/omq/routing/gather.rb', line 42

def connection_added(connection)
  task = @engine.start_recv_pump(connection, @recv_queue)
  @tasks << task if task
end

#connection_removed(connection) ⇒ Object

Parameters:

  • connection (Connection) 


50
51
 
# File 'lib/omq/routing/gather.rb', line 50

def connection_removed(connection)
end

#dequeue_recv ⇒ Array<String>?

Dequeues the next received message. Blocks until one is available.

Returns:

  • (Array<String>, nil) 


26
27
28
 
# File 'lib/omq/routing/gather.rb', line 26

def dequeue_recv
  @recv_queue.dequeue
end

#enqueue(_parts) ⇒ Object

GATHER is read-only.



56
57
58
 
# File 'lib/omq/routing/gather.rb', line 56

def enqueue(_parts)
  raise "GATHER sockets cannot send"
end

#stop ⇒ Object

Stops all background tasks.



62
63
64
65
 
# File 'lib/omq/routing/gather.rb', line 62

def stop
  @tasks.each(&:stop)
  @tasks.clear
end

#unblock_recv ⇒ void

This method returns an undefined value.

Wakes a blocked #dequeue_recv with a nil sentinel.



35
36
37
 
# File 'lib/omq/routing/gather.rb', line 35

def unblock_recv
  @recv_queue.enqueue(nil)
end