Class: ActiveSupport::Notifications::Fanout

Inherits:
Object
  • Object
show all
Includes:
Mutex_m
Defined in:
activesupport/lib/active_support/notifications/fanout.rb

Overview

This is a default queue implementation that ships with Notifications. It just pushes events to all registered log subscribers.

This class is thread safe. All methods are reentrant.

Defined Under Namespace

Modules: Subscribers

Instance Method Summary collapse

Constructor Details

#initializeFanout

Returns a new instance of Fanout.


13
14
15
16
17
# File 'activesupport/lib/active_support/notifications/fanout.rb', line 13

def initialize
  @subscribers = []
  @listeners_for = Concurrent::Map.new
  super
end

Instance Method Details

#finish(name, id, payload, listeners = listeners_for(name)) ⇒ Object


45
46
47
# File 'activesupport/lib/active_support/notifications/fanout.rb', line 45

def finish(name, id, payload, listeners = listeners_for(name))
  listeners.each { |s| s.finish(name, id, payload) }
end

#listeners_for(name) ⇒ Object


53
54
55
56
57
58
59
# File 'activesupport/lib/active_support/notifications/fanout.rb', line 53

def listeners_for(name)
  # this is correctly done double-checked locking (Concurrent::Map's lookups have volatile semantics)
  @listeners_for[name] || synchronize do
    # use synchronisation when accessing @subscribers
    @listeners_for[name] ||= @subscribers.select { |s| s.subscribed_to?(name) }
  end
end

#listening?(name) ⇒ Boolean

Returns:

  • (Boolean)

61
62
63
# File 'activesupport/lib/active_support/notifications/fanout.rb', line 61

def listening?(name)
  listeners_for(name).any?
end

#publish(name, *args) ⇒ Object


49
50
51
# File 'activesupport/lib/active_support/notifications/fanout.rb', line 49

def publish(name, *args)
  listeners_for(name).each { |s| s.publish(name, *args) }
end

#start(name, id, payload) ⇒ Object


41
42
43
# File 'activesupport/lib/active_support/notifications/fanout.rb', line 41

def start(name, id, payload)
  listeners_for(name).each { |s| s.start(name, id, payload) }
end

#subscribe(pattern = nil, block = Proc.new) ⇒ Object


19
20
21
22
23
24
25
26
# File 'activesupport/lib/active_support/notifications/fanout.rb', line 19

def subscribe(pattern = nil, block = Proc.new)
  subscriber = Subscribers.new pattern, block
  synchronize do
    @subscribers << subscriber
    @listeners_for.clear
  end
  subscriber
end

#unsubscribe(subscriber_or_name) ⇒ Object


28
29
30
31
32
33
34
35
36
37
38
39
# File 'activesupport/lib/active_support/notifications/fanout.rb', line 28

def unsubscribe(subscriber_or_name)
  synchronize do
    case subscriber_or_name
    when String
      @subscribers.reject! { |s| s.matches?(subscriber_or_name) }
    else
      @subscribers.delete(subscriber_or_name)
    end

    @listeners_for.clear
  end
end

#waitObject

This is a sync queue, so there is no waiting.


66
67
# File 'activesupport/lib/active_support/notifications/fanout.rb', line 66

def wait
end