Module: EvilEvents::Core::Events::EventExtensions::Dispatchable::ClassMethods Private

Defined in:
lib/evil_events/core/events/event_extensions/dispatchable.rb

Overview

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

Since:

  • 0.4.0

Instance Method Summary collapse

Instance Method Details

#adapter(identifier = nil) ⇒ EvilEvents::Core::Broadcasting::Dispatcher::Dispatchable

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • identifier (Symbol, String, NilClass) (defaults to: nil)

Returns:

  • (EvilEvents::Core::Broadcasting::Dispatcher::Dispatchable)

Since:

  • 0.4.0



46
47
48
49
# File 'lib/evil_events/core/events/event_extensions/dispatchable.rb', line 46

def adapter(identifier = nil)
  @adapter_identifier = identifier if identifier
  EvilEvents::Core::Bootstrap[:event_system].resolve_adapter(adapter_name)
end

#adapter_nameSymbol, String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Symbol, String)

Since:

  • 0.4.0



54
55
56
# File 'lib/evil_events/core/events/event_extensions/dispatchable.rb', line 54

def adapter_name
  @adapter_identifier || EvilEvents::Core::Bootstrap[:config].settings.adapter.default
end

#emit!(id: nil, payload: {}, metadata: {}, adapter: nil) ⇒ void

This method returns an undefined value.

Parameters:

  • id (Hash) (defaults to: nil)

    a customizable set of options

  • payload (Hash) (defaults to: {})

    a customizable set of options

  • metadata (Hash) (defaults to: {})

    a customizable set of options

  • adapter (Hash) (defaults to: nil)

    a customizable set of options

Options Hash (id:):

  • (NilClass, Object)

Options Hash (payload:):

  • (Hash)

Options Hash (metadata:):

  • (Hash)

Options Hash (adapter:):

  • (Symbol, NilClass)

See Also:

Since:

  • 0.4.0



69
70
71
# File 'lib/evil_events/core/events/event_extensions/dispatchable.rb', line 69

def emit!(id: nil, payload: {}, metadata: {}, adapter: nil)
  new(id: id, payload: payload, metadata: ).emit!(adapter: adapter)
end