Class: OMQ::Routing::Channel

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

Overview

CHANNEL socket routing: exclusive 1-to-1 bidirectional.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(engine) ⇒ Channel

Returns a new instance of Channel.

Parameters:



15
16
17
18
19
20
21
 
# File 'lib/omq/routing/channel.rb', line 15

def initialize(engine)
  @engine        = engine
  @connection    = nil
  @recv_queue    = Routing.build_queue(engine.options.recv_hwm, :block)
  @send_queue    = nil
  @staging_queue = Routing.build_queue(engine.options.send_hwm, :block)
end

Instance Attribute Details

#recv_queue ⇒ Async::LimitedQueue (readonly)

Returns:

  • (Async::LimitedQueue) 


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

def recv_queue
  @recv_queue
end

Instance Method Details

#connection_added(connection) ⇒ Object

Parameters:

  • connection (Protocol::ZMTP::Connection)

Raises:

  • (RuntimeError) —

    if a connection already exists



45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/omq/routing/channel.rb', line 45

def connection_added(connection)
  raise "CHANNEL allows only one peer" if @connection
  @connection = connection

  @engine.start_recv_pump(connection, @recv_queue)

  unless connection.is_a?(Transport::Inproc::Pipe)
    @send_queue = Routing.build_queue(@engine.options.send_hwm, :block)
    while (msg = @staging_queue.dequeue(timeout: 0))
      @send_queue.enqueue(msg)
    end
    start_send_pump(connection)
  end
end

#connection_removed(connection) ⇒ Object

Parameters:

  • connection (Protocol::ZMTP::Connection) 


63
64
65
66
67
68
 
# File 'lib/omq/routing/channel.rb', line 63

def connection_removed(connection)
  if @connection == connection
    @connection = nil
    @send_queue = nil
  end
end

#dequeue_recv ⇒ Array<String>?

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

Returns:

  • (Array<String>, nil) 


28
29
30
 
# File 'lib/omq/routing/channel.rb', line 28

def dequeue_recv
  @recv_queue.dequeue
end

#enqueue(parts) ⇒ Object

Parameters:

  • parts (Array<String>) 


73
74
75
76
77
78
79
80
81
82
 
# File 'lib/omq/routing/channel.rb', line 73

def enqueue(parts)
  conn = @connection
  if conn.is_a?(Transport::Inproc::Pipe) && conn.direct_recv_queue
    conn.send_message(parts)
  elsif @send_queue
    @send_queue.enqueue(parts)
  else
    @staging_queue.enqueue(parts)
  end
end

#send_queues_drained? ⇒ Boolean

True when the staging and send queues are empty.

Returns:

  • (Boolean) 


87
88
89
 
# File 'lib/omq/routing/channel.rb', line 87

def send_queues_drained?
  @staging_queue.empty? && (@send_queue.nil? || @send_queue.empty?)
end

#unblock_recv ⇒ void

This method returns an undefined value.

Wakes a blocked #dequeue_recv with a nil sentinel.



37
38
39
 
# File 'lib/omq/routing/channel.rb', line 37

def unblock_recv
  @recv_queue.enqueue(nil)
end