Parent

EventMachine::Channel

Provides a simple interface to push items to a number of subscribers. The channel will schedule all operations on the main reactor thread for thread safe reactor operations.

This provides a convenient way for connections to consume messages from long running code in defer, without threading issues.

channel = EM::Channel.new
sid = channel.subscribe{ |msg| p [:got, msg] }
channel.push('hello world')
channel.unsubscribe(sid)

See examples/ex_channel.rb for a detailed example.

Public Class Methods

new() click to toggle source

Create a new channel

# File lib/em/channel.rb, line 17
def initialize
  @subs = {}
  @uid = 0
end

Public Instance Methods

<<(*items) click to toggle source
Alias for: push
pop(*a, &b) click to toggle source

Receive exactly one message from the channel.

# File lib/em/channel.rb, line 43
def pop(*a, &b)
  EM.schedule {
    name = subscribe do |*args|
      unsubscribe(name)
      EM::Callback(*a, &b).call(*args)
    end
  }
end
push(*items) click to toggle source

Add items to the channel, which are pushed out to all subscribers.

# File lib/em/channel.rb, line 36
def push(*items)
  items = items.dup
  EM.schedule { @subs.values.each { |s| items.each { |i| s.call i } } }
end
Also aliased as: <<
subscribe(*a, &b) click to toggle source

Takes any arguments suitable for EM::Callback() and returns a subscriber id for use when unsubscribing.

# File lib/em/channel.rb, line 24
def subscribe(*a, &b)
  name = gen_id
  EM.schedule { @subs[name] = EM::Callback(*a, &b) }
  name
end
unsubscribe(name) click to toggle source

Removes this subscriber from the list.

# File lib/em/channel.rb, line 31
def unsubscribe(name)
  EM.schedule { @subs.delete name }
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.