akka.event.japi
Interface EventBus<E,S,C>

All Known Implementing Classes:

ActorEventBus, LookupEventBus, ScanningEventBus, SubchannelEventBus

public interface EventBus<E,S,C>

Java API: See documentation for EventBus E is the Event type S is the Subscriber type C is the Classifier type

Method Summary

void	publish(E event) Publishes the specified Event to this bus
boolean	subscribe(S subscriber, C to) Attempts to register the subscriber to the specified Classifier
void	unsubscribe(S subscriber) Attempts to deregister the subscriber from all Classifiers it may be subscribed to
boolean	unsubscribe(S subscriber, C from) Attempts to deregister the subscriber from the specified Classifier

Method Detail

subscribe

boolean subscribe(S subscriber,
                  C to)

Attempts to register the subscriber to the specified Classifier

Parameters:

subscriber - (undocumented)

to - (undocumented)

Returns:

true if successful and false if not (because it was already subscribed to that Classifier, or otherwise)

unsubscribe

boolean unsubscribe(S subscriber,
                    C from)

Attempts to deregister the subscriber from the specified Classifier

Parameters:

subscriber - (undocumented)

from - (undocumented)

Returns:

true if successful and false if not (because it wasn't subscribed to that Classifier, or otherwise)

unsubscribe

void unsubscribe(S subscriber)

Attempts to deregister the subscriber from all Classifiers it may be subscribed to

Parameters:

subscriber - (undocumented)

publish

void publish(E event)

Publishes the specified Event to this bus

Parameters:

event - (undocumented)