Class: OMQ::Routing::Pull

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

Overview

PULL socket routing: fair-queue receive from PUSH peers.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(engine) ⇒ Pull

Returns a new instance of Pull.

Parameters:



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

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

Instance Attribute Details

#recv_queue ⇒ Async::LimitedQueue (readonly)

Returns:

  • (Async::LimitedQueue) 


18
19
20
 
# File 'lib/omq/routing/pull.rb', line 18

def recv_queue
  @recv_queue
end

Instance Method Details

#connection_added(connection) ⇒ Object

Parameters:

  • connection (Connection) 


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

def connection_added(connection)
  @engine.start_recv_pump(connection, @recv_queue)
end

#connection_removed(connection) ⇒ Object

Parameters:

  • connection (Connection) 


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

def connection_removed(connection)
  # recv pump stops on EOFError via its connection barrier
end

#dequeue_recv ⇒ Array<String>?

Dequeues the next received message. Blocks until one is available. Engine-facing contract — Engine must not touch @recv_queue directly.

Returns:

  • (Array<String>, nil) 


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

def dequeue_recv
  @recv_queue.dequeue
end

#enqueue(_parts) ⇒ Object

PULL is read-only.



57
58
59
 
# File 'lib/omq/routing/pull.rb', line 57

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

#unblock_recv ⇒ void

This method returns an undefined value.

Wakes a blocked #dequeue_recv with a nil sentinel. Called by Engine on close or fatal-error propagation.



36
37
38
 
# File 'lib/omq/routing/pull.rb', line 36

def unblock_recv
  @recv_queue.enqueue(nil)
end