Package discord4j.core.event

Class ReplayingEventDispatcher.Builder

java.lang.Object

discord4j.core.event.DefaultEventDispatcher.Builder

discord4j.core.event.ReplayingEventDispatcher.Builder

All Implemented Interfaces:

EventDispatcher.Builder

Enclosing class:

ReplayingEventDispatcher

public static class ReplayingEventDispatcher.Builder
extends DefaultEventDispatcher.Builder

A builder to create EventDispatcher instances.

Field Summary

Fields

Modifier and Type	Field	Description
protected Predicate<Event>	replayEventFilter
protected FluxSink.OverflowStrategy	replayEventOverflowStrategy
protected ReplayProcessor<Event>	replayEventProcessor
protected Publisher<?>	stopReplayingTrigger
protected Scheduler	timedTaskScheduler

Fields inherited from class discord4j.core.event.DefaultEventDispatcher.Builder

eventProcessor, eventScheduler, overflowStrategy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()

Method Summary

Modifier and Type	Method	Description
EventDispatcher	build()	Create the EventDispatcher
ReplayingEventDispatcher.Builder	eventProcessor(FluxProcessor<Event,Event> eventProcessor)	Set the underlying FluxProcessor the dispatcher will use to queue and distribute events.
ReplayingEventDispatcher.Builder	eventScheduler(Scheduler eventScheduler)	Set the Scheduler this dispatcher should use to publish events to its subscribers.
ReplayingEventDispatcher.Builder	overflowStrategy(FluxSink.OverflowStrategy overflowStrategy)	Set the FluxSink.OverflowStrategy for dealing with overflow scenarios where too many events are being published.
ReplayingEventDispatcher.Builder	replayEventFilter(Predicate<Event> replayEventFilter)	Set a filter used to determine whether an incoming Event should be stored for replay.
ReplayingEventDispatcher.Builder	replayEventOverflowStrategy(FluxSink.OverflowStrategy replayEventOverflowStrategy)	Set an overflow strategy while pushing events to the replay processor.
ReplayingEventDispatcher.Builder	replayEventProcessor(ReplayProcessor<Event> replayEventProcessor)	Set a processor used to store events while no subscribers are connected and will be forwarded to all late subscribers.
ReplayingEventDispatcher.Builder	stopReplayingTrigger(Publisher<?> stopReplayingTrigger)	Set a trigger Publisher that is subscribed upon the first subscriber connects to this dispatcher.
ReplayingEventDispatcher.Builder	timedTaskScheduler(Scheduler timedTaskScheduler)	Set a time-capable Scheduler used to detect whether all events have replayed to a subscriber.

Methods inherited from class discord4j.core.event.DefaultEventDispatcher.Builder

eventSink

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

replayEventFilter

protected Predicate<Event> replayEventFilter

timedTaskScheduler

protected Scheduler timedTaskScheduler

replayEventProcessor

protected ReplayProcessor<Event> replayEventProcessor

replayEventOverflowStrategy

protected FluxSink.OverflowStrategy replayEventOverflowStrategy

stopReplayingTrigger

protected Publisher<?> stopReplayingTrigger

Constructor Detail

Builder

protected Builder()

Method Detail

eventProcessor

public ReplayingEventDispatcher.Builder eventProcessor(FluxProcessor<Event,Event> eventProcessor)

Description copied from interface: EventDispatcher.Builder

Set the underlying FluxProcessor the dispatcher will use to queue and distribute events. Defaults to using an EmitterProcessor.

Using EmitterProcessor only emits events since a subscriber has subscribed to the processor (except for the first one which receives all queued signals until that point), and it allows you to configure the backing queue size while allowing you to use operators like Flux.repeat() and Flux.retry() to drop the triggering signal.

Specified by:

eventProcessor in interface EventDispatcher.Builder

Overrides:

eventProcessor in class DefaultEventDispatcher.Builder

Parameters:

eventProcessor - the custom processor for events

Returns:

this builder

overflowStrategy

public ReplayingEventDispatcher.Builder overflowStrategy(FluxSink.OverflowStrategy overflowStrategy)

Description copied from interface: EventDispatcher.Builder

Set the FluxSink.OverflowStrategy for dealing with overflow scenarios where too many events are being published. Defaults to using FluxSink.OverflowStrategy.BUFFER to ensure all events are delivered at the cost of higher memory footprint and potential OutOfMemoryError scenarios.

To only keep the earliest events you can use FluxSink.OverflowStrategy.DROP, and to only keep the most recent events, use FluxSink.OverflowStrategy.LATEST. The number of events that can be queued until this strategy is applied depends on the underlying processor implementation.

Specified by:

overflowStrategy in interface EventDispatcher.Builder

Overrides:

overflowStrategy in class DefaultEventDispatcher.Builder

Parameters:

overflowStrategy - the custom backpressure strategy

Returns:

this builder

eventScheduler

public ReplayingEventDispatcher.Builder eventScheduler(Scheduler eventScheduler)

Description copied from interface: EventDispatcher.Builder

Set the Scheduler this dispatcher should use to publish events to its subscribers. Using a bounded elastic/blocking-capable one is recommended for general workloads that may have blocking sequences.

Specified by:

eventScheduler in interface EventDispatcher.Builder

Overrides:

eventScheduler in class DefaultEventDispatcher.Builder

Parameters:

eventScheduler - a custom Scheduler to publish events

Returns:

this builder

replayEventProcessor

public ReplayingEventDispatcher.Builder replayEventProcessor(ReplayProcessor<Event> replayEventProcessor)

Set a processor used to store events while no subscribers are connected and will be forwarded to all late subscribers.

Parameters:

replayEventProcessor - the replay processor to use as backend

Returns:

this builder

replayEventOverflowStrategy

public ReplayingEventDispatcher.Builder replayEventOverflowStrategy(FluxSink.OverflowStrategy replayEventOverflowStrategy)

Set an overflow strategy while pushing events to the replay processor.

Parameters:

replayEventOverflowStrategy - the strategy to use when pushing values to the replay processor

Returns:

this builder

replayEventFilter

public ReplayingEventDispatcher.Builder replayEventFilter(Predicate<Event> replayEventFilter)

Set a filter used to determine whether an incoming Event should be stored for replay.

Parameters:

replayEventFilter - the filter for events that can be replayed

Returns:

this builder

timedTaskScheduler

public ReplayingEventDispatcher.Builder timedTaskScheduler(Scheduler timedTaskScheduler)

Set a time-capable Scheduler used to detect whether all events have replayed to a subscriber.

Parameters:

timedTaskScheduler - the scheduler to detect no more events can be replayed

Returns:

this builder

stopReplayingTrigger

public ReplayingEventDispatcher.Builder stopReplayingTrigger(Publisher<?> stopReplayingTrigger)

Set a trigger Publisher that is subscribed upon the first subscriber connects to this dispatcher. Upon completion, error or cancellation, the replaying window will be closed until all subscribers have disconnected.

Parameters:

stopReplayingTrigger - the sequence to signal that no more events should be replayed. Can be subscribed to multiple times as subscribers disconnect.

Returns:

this builder

build

public EventDispatcher build()

Description copied from interface: EventDispatcher.Builder

Create the EventDispatcher

Specified by:

build in interface EventDispatcher.Builder

Overrides:

build in class DefaultEventDispatcher.Builder

Returns:

an EventDispatcher with the configured parameters.