Module io.axoniq.connector.axonserver

Package io.axoniq.axonserver.connector.event.impl

Class BufferedEventStream

java.lang.Object

io.axoniq.axonserver.connector.impl.FlowControlledStream<T,R>

io.axoniq.axonserver.connector.impl.FlowControlledBuffer<T,R>

io.axoniq.axonserver.connector.impl.AbstractBufferedStream<EventWithToken,GetEventsRequest>

io.axoniq.axonserver.connector.event.impl.BufferedEventStream

All Implemented Interfaces:

EventStream, ResultStream<EventWithToken>, io.grpc.stub.ClientResponseObserver<GetEventsRequest,EventWithToken>, io.grpc.stub.StreamObserver<EventWithToken>, AutoCloseable

public class BufferedEventStream
extends AbstractBufferedStream<EventWithToken,GetEventsRequest>
implements EventStream

Buffering implementation of the EventStream used for Event processing.

Constructor Summary

Constructors

Constructor	Description
BufferedEventStream(ClientIdentification clientId, long trackingToken, int bufferSize, int refillBatch, boolean forceReadFromLeader)	Construct a BufferedEventStream, starting a position trackingToken with the given bufferSize.

Method Summary

Modifier and Type	Method	Description
protected GetEventsRequest	buildFlowControlMessage(FlowControl flowControl)	Build a flow control message of type OUT based on the given flowControl.
protected GetEventsRequest	buildInitialFlowControlMessage(FlowControl flowControl)	Builds the initial flow control message of type OUT based on the given flowControl.
void	excludePayloadType(String payloadType, String revision)	Instructs AxonServer to not send messages with the given payloadType and revision.
protected EventWithToken	terminalMessage()	Builds a terminal message of type T specifying when the this stream is closed.

Methods inherited from class io.axoniq.axonserver.connector.impl.AbstractBufferedStream

close, getError, isClosed, next, nextIfAvailable, nextIfAvailable, onAvailable, onCloseRequested, onCompleted, onError, onNext, peek

Methods inherited from class io.axoniq.axonserver.connector.impl.FlowControlledBuffer

beforeStart, getErrorResult, take, tryTake, tryTake, tryTake, tryTakeNow

Methods inherited from class io.axoniq.axonserver.connector.impl.FlowControlledStream

enableFlowControl, markConsumed, outboundStream

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.axoniq.axonserver.connector.ResultStream

close, getError, isClosed, next, nextIfAvailable, nextIfAvailable, onAvailable, peek

Constructor Detail

BufferedEventStream

public BufferedEventStream(ClientIdentification clientId,
                           long trackingToken,
                           int bufferSize,
                           int refillBatch,
                           boolean forceReadFromLeader)

Construct a BufferedEventStream, starting a position trackingToken with the given bufferSize.

Parameters:

clientId - The client identifier starting this stream.

trackingToken - The position to start this BufferedEventStream at.

bufferSize - The buffer size of this event stream.

refillBatch - The number of Events to consume prior refilling the buffer.

forceReadFromLeader - A boolean defining whether Events must be read from the leader.

Method Detail

buildFlowControlMessage

protected GetEventsRequest buildFlowControlMessage(FlowControl flowControl)

Description copied from class: FlowControlledStream

Build a flow control message of type OUT based on the given flowControl.

Specified by:

buildFlowControlMessage in class FlowControlledStream<EventWithToken,GetEventsRequest>

Parameters:

flowControl - the FlowControl message used to base this implementation's flow control message on

Returns:

the message used by this implementation to request new entries of type IN

buildInitialFlowControlMessage

protected GetEventsRequest buildInitialFlowControlMessage(FlowControl flowControl)

Description copied from class: FlowControlledStream

Builds the initial flow control message of type OUT based on the given flowControl.

Overrides:

buildInitialFlowControlMessage in class FlowControlledStream<EventWithToken,GetEventsRequest>

Parameters:

flowControl - the FlowControl message used to base this implementation's flow control message on

Returns:

the initial message used by this implementation to request new entries of type IN

terminalMessage

protected EventWithToken terminalMessage()

Description copied from class: FlowControlledBuffer

Builds a terminal message of type T specifying when the this stream is closed.

Specified by:

terminalMessage in class FlowControlledBuffer<EventWithToken,GetEventsRequest>

Returns:

a terminal message of type T specifying when the this stream is closed

excludePayloadType

public void excludePayloadType(String payloadType,
                               String revision)

Description copied from interface: EventStream

Instructs AxonServer to not send messages with the given payloadType and revision. This method is in no way a guarantee that these message will no longer be sent at all. Some messages may already have been en-route, and AxonServer may decide to send messages every once in a while as a "beacon" to relay progress of the tracking token. It may choose, however, to omit the actual payload, in that case.

Specified by:

excludePayloadType in interface EventStream

Parameters:

payloadType - the type of payload to exclude from the stream

revision - the revision of the payload to exclude from the stream