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.


27
28
29
30
31
32
# File 'activesupport/lib/active_support/notifications/fanout.rb', line 27

def initialize
  @string_subscribers = Hash.new { |h, k| h[k] = [] }
  @other_subscribers = []
  @listeners_for = Concurrent::Map.new
  super
end

Instance Method Details

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


80
81
82
# File 'activesupport/lib/active_support/notifications/fanout.rb', line 80

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

#inspectObject

:nodoc:


71
72
73
74
# File 'activesupport/lib/active_support/notifications/fanout.rb', line 71

def inspect # :nodoc:
  total_patterns = @string_subscribers.size + @other_subscribers.size
  "#<#{self.class} (#{total_patterns} patterns)>"
end

#iterate_guarding_exceptions(listeners) ⇒ Object


92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'activesupport/lib/active_support/notifications/fanout.rb', line 92

def iterate_guarding_exceptions(listeners)
  exceptions = nil

  listeners.each do |s|
    yield s
  rescue Exception => e
    exceptions ||= []
    exceptions << e
  end

  if exceptions
    if exceptions.size == 1
      raise exceptions.first
    else
      raise InstrumentationSubscriberError.new(exceptions), cause: exceptions.first
    end
  end

  listeners
end

#listeners_for(name) ⇒ Object


113
114
115
116
117
118
119
120
# File 'activesupport/lib/active_support/notifications/fanout.rb', line 113

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] ||=
      @string_subscribers[name] + @other_subscribers.select { |s| s.subscribed_to?(name) }
  end
end

#listening?(name) ⇒ Boolean

Returns:

  • (Boolean)

122
123
124
# File 'activesupport/lib/active_support/notifications/fanout.rb', line 122

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

#publish(name, *args) ⇒ Object


84
85
86
# File 'activesupport/lib/active_support/notifications/fanout.rb', line 84

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

#publish_event(event) ⇒ Object


88
89
90
# File 'activesupport/lib/active_support/notifications/fanout.rb', line 88

def publish_event(event)
  iterate_guarding_exceptions(listeners_for(event.name)) { |s| s.publish_event(event) }
end

#start(name, id, payload) ⇒ Object


76
77
78
# File 'activesupport/lib/active_support/notifications/fanout.rb', line 76

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

#subscribe(pattern = nil, callable = nil, monotonic: false, &block) ⇒ Object


34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
# File 'activesupport/lib/active_support/notifications/fanout.rb', line 34

def subscribe(pattern = nil, callable = nil, monotonic: false, &block)
  subscriber = Subscribers.new(pattern, callable || block, monotonic)
  synchronize do
    case pattern
    when String
      @string_subscribers[pattern] << subscriber
      @listeners_for.delete(pattern)
    when NilClass, Regexp
      @other_subscribers << subscriber
      @listeners_for.clear
    else
      raise ArgumentError,  "pattern must be specified as a String, Regexp or empty"
    end
  end
  subscriber
end

#unsubscribe(subscriber_or_name) ⇒ Object


51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# File 'activesupport/lib/active_support/notifications/fanout.rb', line 51

def unsubscribe(subscriber_or_name)
  synchronize do
    case subscriber_or_name
    when String
      @string_subscribers[subscriber_or_name].clear
      @listeners_for.delete(subscriber_or_name)
      @other_subscribers.each { |sub| sub.unsubscribe!(subscriber_or_name) }
    else
      pattern = subscriber_or_name.try(:pattern)
      if String === pattern
        @string_subscribers[pattern].delete(subscriber_or_name)
        @listeners_for.delete(pattern)
      else
        @other_subscribers.delete(subscriber_or_name)
        @listeners_for.clear
      end
    end
  end
end

#waitObject

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


127
128
# File 'activesupport/lib/active_support/notifications/fanout.rb', line 127

def wait
end