class ActiveSupport::Notifications::Fanout

Experimental RBS support (using type sampling data from the type_fusion project).

# sig/active_support/notifications/fanout.rbs

class ActiveSupport::Notifications::Fanout
  def finish: (String name, String id, Hash payload, ?Array[ActiveSupport::Notifications::Fanout::Subscribers::Evented] listeners) -> untyped
  def iterate_guarding_exceptions: ((Array[ActiveSupport::Notifications::Fanout::Subscribers::Evented] | Array[ActiveSupport::Notifications::Fanout::Subscribers::EventObject]) listeners) -> untyped
  def listeners_for: (String name) -> untyped
  def listening?: (String name) -> true
  def start: (String name, String id, Hash payload) -> untyped
end

This class is thread safe. All methods are reentrant.
It just pushes events to all registered log subscribers.
This is a default queue implementation that ships with Notifications.

def finish(name, id, payload, listeners = listeners_for(name))

Experimental RBS support (using type sampling data from the type_fusion project).

def finish: (String name, String id, (identifier | String | layout | NilClass | cache_hit | NilClass | controller | String | action | String | request | ActionDispatch::Request | params | _method | String | authenticity_token | String | api_token | String | commit | String | controller | String | action | String | id | String | headers | ActionDispatch::Http::Headers | format | Symbol | method | String | path | String | sql | String | name | String | binds | ActiveRecord::Relation::QueryAttribute | ActiveRecord::Relation::QueryAttribute | type_casted_binds | Integer | String | statement_name | String | async | FalseClass | connection | ActiveRecord::ConnectionAdapters::PostgreSQLAdapter) payload, ?(ActiveSupport::Notifications::Fanout::Subscribers::EventObject | ActiveSupport::Notifications::Fanout::Subscribers::Timed | ActiveSupport::Notifications::Fanout::Subscribers::EventObject | ActiveSupport::Notifications::Fanout::Subscribers::Evented | ActiveSupport::Notifications::Fanout::Subscribers::Timed | ActiveSupport::Notifications::Fanout::Subscribers::EventObject) listeners) -> untyped

This signature was generated using 3 samples from 1 application.

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

def initialize

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

def iterate_guarding_exceptions(listeners)

Experimental RBS support (using type sampling data from the type_fusion project).

def iterate_guarding_exceptions: ((ActiveSupport::Notifications::Fanout::Subscribers::EventObject |  | ActiveSupport::Notifications::Fanout::Subscribers::Evented | ActiveSupport::Notifications::Fanout::Subscribers::Timed | ActiveSupport::Notifications::Fanout::Subscribers::EventObject) listeners) -> untyped

This signature was generated using 8 samples from 1 application.

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

def listeners_for(name)

Experimental RBS support (using type sampling data from the type_fusion project).

def listeners_for: (String name) -> untyped

This signature was generated using 10 samples from 1 application.

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

def listening?(name)

Experimental RBS support (using type sampling data from the type_fusion project).

def listening?: (String name) -> true

This signature was generated using 2 samples from 1 application.

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

def publish(name, *args)

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

def publish_event(event)

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

def start(name, id, payload)

Experimental RBS support (using type sampling data from the type_fusion project).

type ActiveSupport__Notifications__Fanout_start_payload = identifier | String | layout | NilClass | record_count | Integer | class_name | String | sql | String | name | String | binds | ActiveModel::Attribute::WithCastValue | type_casted_binds | Integer | statement_name | String | async | FalseClass | connection | ActiveRecord::ConnectionAdapters::PostgreSQLAdapter | sql | String | name | String | binds | ActiveRecord::Relation::QueryAttribute | ActiveRecord::Relation::QueryAttribute | type_casted_binds | TrueClass | Integer | statement_name | String | async | FalseClass | connection | ActiveRecord::ConnectionAdapters::PostgreSQLAdapter

def start: (String name, String id, ActiveSupport__Notifications__Fanout_start_payload payload) -> untyped

This signature was generated using 6 samples from 1 application.

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

def subscribe(pattern = nil, callable = nil, monotonic: false, &block)

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

def unsubscribe(subscriber_or_name)

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

def wait

This is a sync queue, so there is no waiting.
def wait
end