Module io.axoniq.connector.axonserver

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

Class BufferedPersistentStreamSegment

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<PersistentStreamEvent,StreamRequest>

io.axoniq.axonserver.connector.event.impl.BufferedPersistentStreamSegment

All Implemented Interfaces:

PersistentStreamSegment, ResultStream<PersistentStreamEvent>, io.grpc.stub.ClientResponseObserver<StreamRequest,PersistentStreamEvent>, io.grpc.stub.StreamObserver<PersistentStreamEvent>, AutoCloseable

public class BufferedPersistentStreamSegment
extends AbstractBufferedStream<PersistentStreamEvent,StreamRequest>
implements PersistentStreamSegment

Implementation of the PersistentStreamSegment.

Field Summary

Fields inherited from interface io.axoniq.axonserver.connector.event.PersistentStreamSegment

PENDING_WORK_DONE_MARKER

Constructor Summary

Constructors

Constructor	Description
BufferedPersistentStreamSegment(String streamId, int segment, int bufferSize, int refillBatch, LongConsumer progressCallback, Consumer<String> errorCallback)	Constructs a BufferedPersistentStreamSegment.

Method Summary

Modifier and Type	Method	Description
void	acknowledge(long token)	Sends the last processed token for this segment to Axon Server.
protected StreamRequest	buildFlowControlMessage(FlowControl flowControl)	Build a flow control message of type OUT based on the given flowControl.
void	close()	Requests the current stream to be closed.
void	error(String error)
boolean	isClosed()	Check whether this buffer has been closed off
void	onAvailable(Runnable callback)	Sets the given callback to execute when data is available for reading, or the stream has been closed.
void	onCompleted()
void	onSegmentClosed(Runnable callback)	Registers a callback that will be invoked when Axon Server closes the segment within the persistent stream connection.
int	segment()	Returns the segment number of the stream.
protected PersistentStreamEvent	terminalMessage()	Builds a terminal message of type T specifying when the this stream is closed.
String	toString()

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

getError, next, nextIfAvailable, nextIfAvailable, onCloseRequested, 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

buildInitialFlowControlMessage, enableFlowControl, markConsumed, outboundStream

Methods inherited from class java.lang.Object

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

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

getError, next, nextIfAvailable, nextIfAvailable, peek

Constructor Detail

BufferedPersistentStreamSegment

public BufferedPersistentStreamSegment(String streamId,
                                       int segment,
                                       int bufferSize,
                                       int refillBatch,
                                       LongConsumer progressCallback,
                                       Consumer<String> errorCallback)

Constructs a BufferedPersistentStreamSegment.

Parameters:

streamId - the id of the persistent stream

segment - the index of the segment

bufferSize - the number of events to buffer locally

refillBatch - the number of events to be consumed prior to refilling the buffer

progressCallback - the callback to invoke for acknowledging processed events

Method Detail

onSegmentClosed

public void onSegmentClosed(Runnable callback)

Description copied from interface: PersistentStreamSegment

Registers a callback that will be invoked when Axon Server closes the segment within the persistent stream connection. This happens when the number of segments in the persistent stream has changed or when Axon Server assigns a segment to another client.

Specified by:

onSegmentClosed in interface PersistentStreamSegment

Parameters:

callback - the callback to register

onCompleted

public void onCompleted()

Specified by:

onCompleted in interface io.grpc.stub.StreamObserver<PersistentStreamEvent>

Overrides:

onCompleted in class AbstractBufferedStream<PersistentStreamEvent,StreamRequest>

acknowledge

public void acknowledge(long token)

Description copied from interface: PersistentStreamSegment

Sends the last processed token for this segment to Axon Server. Clients may choose to notify each processed event, or to only sent progress information after a number of processed events.

Specified by:

acknowledge in interface PersistentStreamSegment

Parameters:

token - the last processed token for this segment

error

public void error(String error)

Specified by:

error in interface PersistentStreamSegment

isClosed

public boolean isClosed()

Description copied from class: FlowControlledBuffer

Check whether this buffer has been closed off

Specified by:

isClosed in interface ResultStream<PersistentStreamEvent>

Overrides:

isClosed in class AbstractBufferedStream<PersistentStreamEvent,StreamRequest>

Returns:

true if this buffer is closed, false otherwise

See Also:

ResultStream.getError()

segment

public int segment()

Description copied from interface: PersistentStreamSegment

Returns the segment number of the stream.

Specified by:

segment in interface PersistentStreamSegment

Returns:

the segment number of this stream

close

public void close()

Description copied from interface: ResultStream

Requests the current stream to be closed. It is up to the publishing end of the stream to honor the request.

Any elements received before closing are still available for reading.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ResultStream<PersistentStreamEvent>

Overrides:

close in class AbstractBufferedStream<PersistentStreamEvent,StreamRequest>

onAvailable

public void onAvailable(Runnable callback)

Description copied from interface: ResultStream

Sets the given callback to execute when data is available for reading, or the stream has been closed. Note that any registration will replace the previous one.

The callback is invoked in the publisher's thread. Invocations should be as short as possible, preferably delegating to a reader thead, instead of accessing the entries directly.

Specified by:

onAvailable in interface ResultStream<PersistentStreamEvent>

Overrides:

onAvailable in class AbstractBufferedStream<PersistentStreamEvent,StreamRequest>

Parameters:

callback - a {Runnable} to Runnable.run() when the next entry becomes available or null to disable callbacks

terminalMessage

protected PersistentStreamEvent 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<PersistentStreamEvent,StreamRequest>

Returns:

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

buildFlowControlMessage

protected StreamRequest 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<PersistentStreamEvent,StreamRequest>

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

toString

public String toString()

Overrides:

toString in class Object