Package com.couchbase.client.core.cnc

Interface EventBus

All Known Implementing Classes:

DefaultEventBus, SimpleEventBus

public interface EventBus

The EventBus is the main demarcation line between internal behavior and external visibility.

All events happening inside the system (and those fed from the outside as well) are visible through the EventBus.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	EventBus.PublishResult	Signals if a publish call was successful and if not why.

Method Summary

Modifier and Type	Method	Description
EventBus.PublishResult	publish(Event event)	Try to publish an event.
Mono<Void>	start()	Starts the event bus if it hasn't been started yet.
Mono<Void>	stop(Duration timeout)	Stops the event bus if it hasn't been stopped already.
EventSubscription	subscribe(Consumer<Event> consumer)	Subscribes a Consumer to receive Events.
void	unsubscribe(EventSubscription subscription)	Unsubscribes the Consumer from this EventBus.

Method Details

publish

EventBus.PublishResult publish(Event event)

Try to publish an event.

Parameters:

event - the event to publish.

Returns:

the EventBus.PublishResult of th event.

subscribe

EventSubscription subscribe(Consumer<Event> consumer)

Subscribes a Consumer to receive Events.

Parameters:

consumer - the consumer which will receive events.

Returns:

a EventSubscription that can be used to unsubscribe.

unsubscribe

void unsubscribe(EventSubscription subscription)

Unsubscribes the Consumer from this EventBus.

Parameters:

subscription - the subscription used.

start

Mono<Void> start()

Starts the event bus if it hasn't been started yet.

stop

Mono<Void> stop(Duration timeout)

Stops the event bus if it hasn't been stopped already.