server/io.spine.server.bus/MulticastBus

MulticastBus

public abstract class MulticastBus<M extends Signal<?, ?, ?>, E extends SignalEnvelope<? extends Object, M, ? extends Object>, C extends MessageClass<? extends Message>, D extends MessageDispatcher<C, E>> extends Bus<T, E, C, D>

A Bus, which delivers a single message to multiple dispatchers.

Parameters

<M>

the type of outer objects (containing messages of interest) that are posted to the bus

<E>

the type of envelopes for outer objects used by this bus

<C>

the type of message class

<D>

the type of dispatches used by this bus

Inheritors

EventBus

Constructors

MulticastBus

protected void MulticastBus(BusBuilder<? extends Object, M, E, C, D> builder)

Functions

callDispatchers

protected int callDispatchers(E messageEnvelope)

Call the dispatchers for the messageEnvelope.

onDispatched

protected final void onDispatched(SignalId signal)

Called after the dispatching of the signal to all of the target dispatchers has been completed.

onDispatchingStarted

protected final void onDispatchingStarted(SignalId signal)

Called before the dispatching of the signal with the passed ID is started.

Inherited functions

checkOpen

public void checkOpen()

Ensures that the object is open.

public void close()

Closes the filters of this bus and unregisters all the dispatchers.

public abstract void close()

deadMessageHandler

protected abstract DeadMessageHandler<E> deadMessageHandler()

Obtains the instance of DeadMessageHandler for this bus.

dispatch

protected abstract void dispatch(E envelope)

Passes the given envelope for dispatching.

hasFilter

public boolean hasFilter(BusFilter<E> filter)

hasListener

public boolean hasListener(Listener<E> listener)

isOpen

public final boolean isOpen()

Tells if this bus can accept messages for posting.

post

public final void post(T message, StreamObserver<Ack> observer)

Posts the message to the bus.

public final void post(Iterable<T> messages, StreamObserver<Ack> observer)

Posts the given messages to the bus.

prepareObserver

protected StreamObserver<Ack> prepareObserver(Iterable<T> messages, StreamObserver<Ack> source)

Prepares the given StreamObserver to post messages into this bus.

public void register(D dispatcher)

Registers the passed dispatcher.

registry

protected DispatcherRegistry<C, E, D> registry()

Obtains the dispatcher registry.

setupFilters

protected Iterable<BusFilter<E>> setupFilters(Iterable<BusFilter<E>> filters)

A callback for derived classes to modify the order of filters used by the bus.

store

protected abstract void store(Iterable<T> messages)

Stores the given messages into the underlying storage.

toEnvelope

protected abstract E toEnvelope(T message)

Packs the given message of type T into an envelope of type E.

unregister

public void unregister(D dispatcher)

Unregisters dispatching for message classes of the passed dispatcher.

validator

protected abstract EnvelopeValidator<E> validator()

Obtains the instance of EnvelopeValidator for this bus.