Module: Mongo::Event::Subscriber

Included in:

Cluster

Defined in:

lib/mongo/event/subscriber.rb

Overview

Adds convenience methods for adding listeners to event publishers.

Since:

• 2.0.0

Instance Attribute Summary

• #event_listeners ⇒ Event::Listeners readonly

  Event_listeners The listeners.

Instance Method Summary

• #subscribe_to(event, listener) ⇒ Object

  Subscribe to the provided event.

Instance Attribute Details

#event_listeners ⇒ Event::Listeners (readonly)

Returns event_listeners The listeners.

Returns:

• (Event::Listeners) —

  event_listeners The listeners.

Since:

• 2.0.0

# File 'lib/mongo/event/subscriber.rb', line 27

def event_listeners
  @event_listeners
end

Instance Method Details

#subscribe_to(event, listener) ⇒ Object

Subscribe to the provided event.

Examples:

Subscribe to the event.

subscriber.subscribe_to('test', listener)

Parameters:

• event (String) —

  The event.

• listener (Object) —

  The event listener.

Since:

• 2.0.0

# File 'lib/mongo/event/subscriber.rb', line 38

def subscribe_to(event, listener)
  event_listeners.add_listener(event, listener)
end