@CheckReturnValue @ParametersAreNonnullByDefault
See: Description
Interface | Description |
---|---|
ConsumerErrorHandler<M extends com.google.protobuf.Message> |
Functional interface for handlers of errors caused by consumers of messages.
|
ErrorHandler |
Functional interface for error handlers.
|
EventConsumer<E extends io.spine.base.EventMessage> |
Represents an operation which accepts an event message and its context.
|
EventObserver<E extends io.spine.base.EventMessage> |
Adapts gRPC streaming API to
EventConsumer by passing the received Event
to the BiConsumer.accept(Object, Object) method. |
QueryMixin |
Useful methods for
Query . |
ServerErrorHandler |
A handler for an error occurred when posting a message for asynchronous processing
at the server side.
|
StateConsumer<S extends io.spine.base.EntityState> |
Represents an operation that accepts a state of an entity.
|
SubscriptionMixin |
Useful methods for
Subscription . |
Class | Description |
---|---|
ActorRequestFactory |
A factory for various requests fired from the client-side by an actor.
|
ActorRequestFactory.Builder |
A builder for
ActorRequestFactory . |
Client |
The gRPC-based gateway for backend services such as
CommandService ,
QueryService , or SubscriptionService . |
Client.Builder |
The builder for the client.
|
ClientRequest |
Entry point for creating client requests.
|
CommandFactory |
A factory of
Command instances. |
CommandRequest |
Allows to post a command optionally subscribing to events that are immediate results
of handling this command.
|
CompositeEntityStateFilter |
A subscription filter which aggregates one or more
EntityState filters. |
CompositeEventFilter |
A composite subscription filter which can aggregate both event message and event context
filters.
|
CompositeQueryFilter |
A composite query filter which targets one or more entity
columns . |
ConnectionConstants |
Constant values shared between the client and the server code.
|
EntityStateFilter |
A subscription filter which targets an
EntityState . |
EventFilter |
A subscription filter which targets an
Event . |
EventSubscriptionRequest<E extends io.spine.base.EventMessage> |
Allows to subscribe to events using filtering conditions.
|
FilteringRequest<M extends com.google.protobuf.Message,R extends com.google.protobuf.Message,A extends TargetBuilder<R,A>,B extends FilteringRequest<M,R,A,B>> |
Abstract base for client requests that may filter messages by certain criteria.
|
Filters |
A factory of
Filter instances. |
QueryBuilder |
A builder for the
Query instances. |
QueryFactory |
A factory of
Query instances. |
QueryFilter |
A query filter which targets a column of an entity.
|
QueryRequest<S extends io.spine.base.EntityState> |
Allows to create a post a query for messages of the given type.
|
SubscribingRequest<M extends com.google.protobuf.Message,C extends io.spine.base.MessageContext,W extends com.google.protobuf.Message,B extends SubscribingRequest<M,C,W,B>> |
Abstract base for client requests that subscribe to messages.
|
SubscriptionRequest<S extends io.spine.base.EntityState> |
Allows to subscribe to updates of entity states using filtering conditions.
|
Subscriptions |
Maintains the list of the active subscriptions created by the
Client . |
TargetBuilder<T extends com.google.protobuf.Message,B extends TargetBuilder<T,B>> |
An abstract base for builders that create
Message instances
which have a Target and a FieldMask as attributes. |
TopicBuilder |
A builder for the
Topic instances. |
TopicFactory |
A factory of
Topic instances. |
The term actor used in this API means the user on behalf of whom requests are created and executed. The package provides two levels of API.
Client
APIClient
class
establishes this connection and serves as a fluent API gateway for composing and posting
requests.
ActorRequestFactory
APIThe Filters
utility class provides methods for composing filtering
conditions for both levels of the API.
When subscribing the Client API accepts an implementation of a functional interface
(see StateConsumer
and EventConsumer
).
Errors occurred when streaming or consuming messages are handled via
ErrorHandler
and ConsumerErrorHandler
correspondingly.