io.spine.server.bus

Class MulticastBus<M extends io.spine.core.Signal<?,?,?>,E extends SignalEnvelope<?,M,?>,C extends io.spine.type.MessageClass<? extends com.google.protobuf.Message>,D extends MessageDispatcher<C,E>>

java.lang.Object

io.spine.server.bus.Bus<M,E,C,D>

io.spine.server.bus.MulticastBus<M,E,C,D>

Type 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

All Implemented Interfaces:

io.spine.logging.Logging, Closeable, java.lang.AutoCloseable

public abstract class MulticastBus<M extends io.spine.core.Signal<?,?,?>,E extends SignalEnvelope<?,M,?>,C extends io.spine.type.MessageClass<? extends com.google.protobuf.Message>,D extends MessageDispatcher<C,E>>
extends Bus<M,E,C,D>

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MulticastBus(BusBuilder<?,M,E,C,D> builder)

Method Summary

Modifier and Type	Method and Description
protected int	callDispatchers(E messageEnvelope) Call the dispatchers for the messageEnvelope.
protected void	onDispatched(io.spine.core.SignalId signal) Called after the dispatching of the signal to all of the target dispatchers has been completed.
protected void	onDispatchingStarted(io.spine.core.SignalId signal) Called before the dispatching of the signal with the passed ID is started.

Methods inherited from class io.spine.server.bus.Bus

close, deadMessageHandler, dispatch, hasFilter, hasListener, isOpen, post, post, prepareObserver, register, registry, setupFilters, store, toEnvelope, unregister, validator

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.spine.server.Closeable

checkOpen

Methods inherited from interface io.spine.logging.Logging

_config, _debug, _error, _fine, _finer, _finest, _info, _severe, _trace, _warn, debugLevel, errorLevel, logger, loggerFor

Constructor Detail

MulticastBus

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

Method Detail

callDispatchers

protected int callDispatchers(E messageEnvelope)

Call the dispatchers for the messageEnvelope.

Parameters:

messageEnvelope - the message envelope to pass to the dispatchers

Returns:

the number of the dispatchers called or 0 if there weren't any

onDispatchingStarted

protected final void onDispatchingStarted(io.spine.core.SignalId signal)

Description copied from class: Bus

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

Descendants may override this method and define their own logic on handling the dispatching lifecycle.

Overrides:

onDispatchingStarted in class Bus<M extends io.spine.core.Signal<?,?,?>,E extends SignalEnvelope<?,M,?>,C extends io.spine.type.MessageClass<? extends com.google.protobuf.Message>,D extends MessageDispatcher<C,E>>

Parameters:

signal - the ID of the signal being dispatched

See Also:

Bus.onDispatched(SignalId)

onDispatched

protected final void onDispatched(io.spine.core.SignalId signal)

Description copied from class: Bus

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

This method is called even if the dispatching of the message has failed.

Descendants may override this method and define their own logic on handling the dispatching lifecycle.

Overrides:

onDispatched in class Bus<M extends io.spine.core.Signal<?,?,?>,E extends SignalEnvelope<?,M,?>,C extends io.spine.type.MessageClass<? extends com.google.protobuf.Message>,D extends MessageDispatcher<C,E>>

Parameters:

signal - the ID of the dispatched signal

See Also:

Bus.onDispatchingStarted(SignalId)