io.lettuce.core.event

Interface EventBus

All Known Implementing Classes:

DefaultEventBus

public interface EventBus

Interface for an EventBus. Events can be published over the bus that are delivered to the subscribers.

Since:

3.4

Author:

Mark Paluch

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Flux<Event>	get() Deprecated. since 7.8, use subscribe(Consumer) or subscribe(Class, Consumer) instead; scheduled for removal in Lettuce 8.0. To obtain a Flux from the callback API, bridge it yourself: Flux.create(sink -> { Subscription s = eventBus.subscribe(sink::next); sink.onDispose(s::close); }, FluxSink.OverflowStrategy.DROP);
void	publish(Event event) Publish a Event to the bus.
default <T extends Event> Subscription	subscribe(Class<T> type, Consumer<T> listener) Subscribes to Events of a given type published to the bus.
default Subscription	subscribe(Consumer<Event> listener) Subscribes to all Events published to the bus.

Method Detail

get

@Deprecated
reactor.core.publisher.Flux<Event> get()

Deprecated. since 7.8, use subscribe(Consumer) or subscribe(Class, Consumer) instead; scheduled for removal in Lettuce 8.0. To obtain a Flux from the callback API, bridge it yourself:

             Flux.create(sink -> {
                 Subscription s = eventBus.subscribe(sink::next);
                 sink.onDispose(s::close);
             }, FluxSink.OverflowStrategy.DROP);
             

Subscribes to the event bus and its Events. The Flux drops events on backpressure to avoid contention.

Returns:

the observable to obtain events.

publish

void publish(Event event)

Publish a Event to the bus.

Parameters:

event - the event to publish

subscribe

default Subscription subscribe(Consumer<Event> listener)

Subscribes to all Events published to the bus. The listener is invoked for every event until the returned Subscription is closed. Events are dropped on backpressure to avoid contention. Exceptions thrown by the listener are caught and logged so that a single failing invocation does not cancel the subscription or affect delivery to other subscribers.

Parameters:

listener - callback invoked with each published event, must not be null.

Returns:

a Subscription that stops delivery when closed.

Since:

7.8

subscribe

default <T extends Event> Subscription subscribe(Class<T> type,
                                                 Consumer<T> listener)

Subscribes to Events of a given type published to the bus. The listener is invoked for every event assignable to type until the returned Subscription is closed.

Type Parameters:

T - the event type.

Parameters:

type - the event type to receive, must not be null.

listener - callback invoked with each matching event, must not be null.

Returns:

a Subscription that stops delivery when closed.

Since:

7.8