server/io.spine.server.delivery

Package-level declarations

This package is devoted to message delivery mechanism.

Types

public abstract class AbstractMessageEndpoint<I, M extends SignalEnvelope<? extends Object, ? extends Object, ? extends Object>> implements MessageEndpoint<I, M>

An abstract base for messages endpoints.

AbstractWorkRegistry

public abstract class AbstractWorkRegistry implements ShardedWorkRegistry

An implementation base for ShardedWorkRegistries based on a specific persistence mechanism.

AlreadyPickedUp

public final class AlreadyPickedUp extends FailedPickUp

Represents a scenario when shard could not be picked as it's already picked by another worker.

BatchDeliveryListener

public interface BatchDeliveryListener

Listens to start and end of the Inbox batch delivery.

CatchUpAlreadyStartedException

public final class CatchUpAlreadyStartedException extends IllegalStateException

An exception telling that the projection catch-up cannot be started, since some of the requested entities are already catching up.

CatchUpProcess

public final class CatchUpProcess extends AbstractStatefulReactor<I, S, B>

A process that performs a projection catch-up.

CatchUpProcessBuilder

public final class CatchUpProcessBuilder

A builder for CatchUpProcess.

CatchUpReadRequest

public final class CatchUpReadRequest implements ReadRequest

A request to read the state of CatchUp from the storage.

CatchUpSignal

public interface CatchUpSignal

A marker interface for the signals controlling the execution of catch-up processes.

CatchUpStorage

public interface CatchUpStorage implements Storage<I, M, R>

A storage for the state of the ongoing catch-up processes.

CommandEndpoint

public interface CommandEndpoint implements MessageEndpoint<I, M>

An endpoint which accepts commands.

Delivery

public final class Delivery

Delivers the messages to the entities.

DeliveryBuilder

public final class DeliveryBuilder

A builder for Delivery instances.

DeliveryMonitor

public class DeliveryMonitor

A controlling monitor of a Inbox Delivery process.

DeliveryStats

public final class DeliveryStats

The statistics on delivering the messages from a certain shard.

DeliveryStrategy

public abstract class DeliveryStrategy

Determines the index of a shard for the given identifier of an entity.

EventEndpoint

public interface EventEndpoint implements MessageEndpoint<I, M>

An endpoint which accepts events.

FailedPickUp

public abstract class FailedPickUp

An abstract base for shard pick-up-related failures.

FailedReception

public final class FailedReception

The evidence of an InboxMessage which has failed to be handled by its receptor, such as an event or a command handler method.

Inbox

public final class Inbox

A container for the messages dispatched to a certain consumer, such as an event subscriber or a command handler.

InboxMessageComparator

public final class InboxMessageComparator implements Comparator<T>, Serializable

A comparator comparing the InboxMessages so that they appear in a chronological order of their appearance in the corresponding Inbox.

InboxMessageMixin

public interface InboxMessageMixin implements ShardedRecord

A mixin for InboxMessage.

InboxReadRequest

public final class InboxReadRequest implements ReadRequest

A request to read a certain InboxMessage by its ID.

InboxStorage

public interface InboxStorage implements Storage<I, M, R>

A contract for storages of Inbox messages.

LabelNotFoundException

public class LabelNotFoundException extends RuntimeException

Thrown if there is an attempt to mark a message put to Inbox with a label, which was not added for the Inbox instance.

LazyEndpoint

@FunctionalInterface()

public interface LazyEndpoint<I, M extends SignalEnvelope<? extends Object, ? extends Object, ? extends Object>> implements Function<T, R>

A lazily initialized MessageEndpoint, which should be used as a destination for inbox messages.

LocalDispatchingObserver

public final class LocalDispatchingObserver implements ShardObserver

An observer of changes to the shard contents, which triggers immediate delivery of the sharded messages.

MessageEndpoint

public interface MessageEndpoint<I, M extends SignalEnvelope<? extends Object, ? extends Object, ? extends Object>>

An endpoint for messages delivered to an abstract target.

Page

public interface Page<M extends ShardedRecord>

A page of messages obtained from a sharded storage in a read operation.

PickUpOutcomeMixin

public interface PickUpOutcomeMixin

A mixin of the PickUpOutcome that provides convenient methods for accessing the result.

RepeatDispatching

@FunctionalInterface()

public interface RepeatDispatching

Specifies the way to repeat the dispatching of InboxMessages.

RepositoryLookup

@FunctionalInterface()

public interface RepositoryLookup implements Function<T, R>

A function that searches for the ProjectionRepository instance by the type URL of the state of the managed projection.

RuntimeFailure

public final class RuntimeFailure extends FailedPickUp

Represents a scenario when shard could not be picked because of some occurred exception.

ShardedRecord

public interface ShardedRecord

A Protobuf Message used for storage in a sharded environment.

ShardedWorkRegistry

public interface ShardedWorkRegistry

The registry of the shard indexes along with the identifiers of the nodes, which process the messages corresponding to each index.

ShardEvent

public interface ShardEvent

An event which is always delivered via the shard, which index is determined by the identifier of this message.

ShardObserver

public interface ShardObserver

An abstract base for observers of the updates made to the contents of shards.

UniformAcrossAllShards

public final class UniformAcrossAllShards extends DeliveryStrategy implements Serializable

The strategy of splitting the entities into a number of shards uniformly.