Module io.axoniq.connector.axonserver

Package io.axoniq.axonserver.connector.query.impl

Class SubscriptionQueryStream

java.lang.Object

io.axoniq.axonserver.connector.impl.FlowControlledStream<SubscriptionQueryResponse,SubscriptionQueryRequest>

io.axoniq.axonserver.connector.query.impl.SubscriptionQueryStream

All Implemented Interfaces:

io.grpc.stub.ClientResponseObserver<SubscriptionQueryRequest,SubscriptionQueryResponse>, io.grpc.stub.StreamObserver<SubscriptionQueryResponse>

public class SubscriptionQueryStream
extends FlowControlledStream<SubscriptionQueryResponse,SubscriptionQueryRequest>

A FlowControlledStream implementation to return the results of a SubscriptionQuery.

Constructor Summary

Constructors

Constructor	Description
SubscriptionQueryStream(String subscriptionQueryId, CompletableFuture<QueryResponse> initialResultFuture, String clientId, Supplier<ResultStream<QueryResponse>> initialResultSupplier, int bufferSize, int fetchSize)	Instantiates a SubscriptionQueryStream to stream SubscriptionQuery results.

Method Summary

Modifier and Type	Method	Description
void	beforeStart(io.grpc.stub.ClientCallStreamObserver<SubscriptionQueryRequest> requestStream)
protected SubscriptionQueryRequest	buildFlowControlMessage(FlowControl flowControl)	Build a flow control message of type OUT based on the given flowControl.
void	enableFlowControl()	Enables flow control for this stream.
ResultStream<QueryResponse>	initialStream()	Returns the ResultStream buffering the initial results to this subscription query.
void	onCompleted()
void	onError(Throwable t)
void	onNext(SubscriptionQueryResponse value)
ResultStream<QueryUpdate>	updatesBuffer()	Returns the ResultStream buffering the QueryUpdates to this subscription query.

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

buildInitialFlowControlMessage, markConsumed, outboundStream

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionQueryStream

public SubscriptionQueryStream(String subscriptionQueryId,
                               CompletableFuture<QueryResponse> initialResultFuture,
                               String clientId,
                               Supplier<ResultStream<QueryResponse>> initialResultSupplier,
                               int bufferSize,
                               int fetchSize)

Instantiates a SubscriptionQueryStream to stream SubscriptionQuery results.

Parameters:

subscriptionQueryId - the identifier of this subscription query

clientId - the identifier of the client initiating the subscription query

initialResultSupplier - a Supplier providing the initial ResultStream of the subscription query

bufferSize - the size of the update updatesBuffer()

fetchSize - the number of updates to be consumed prior to refilling the update updatesBuffer()

Method Detail

updatesBuffer

public ResultStream<QueryUpdate> updatesBuffer()

Returns the ResultStream buffering the QueryUpdates to this subscription query.

Returns:

the ResultStream buffering the QueryUpdates to this subscription query

initialStream

public ResultStream<QueryResponse> initialStream()

Returns the ResultStream buffering the initial results to this subscription query.

Returns:

the ResultStream buffering the initial results to this subscription query

onNext

public void onNext(SubscriptionQueryResponse value)

onError

public void onError(Throwable t)

onCompleted

public void onCompleted()

beforeStart

public void beforeStart(io.grpc.stub.ClientCallStreamObserver<SubscriptionQueryRequest> requestStream)

Specified by:

beforeStart in interface io.grpc.stub.ClientResponseObserver<SubscriptionQueryRequest,SubscriptionQueryResponse>

Overrides:

beforeStart in class FlowControlledStream<SubscriptionQueryResponse,SubscriptionQueryRequest>

enableFlowControl

public void enableFlowControl()

Description copied from class: FlowControlledStream

Enables flow control for this stream. Will only set up flow control if the permits batch size is larger than 0.

Overrides:

enableFlowControl in class FlowControlledStream<SubscriptionQueryResponse,SubscriptionQueryRequest>

buildFlowControlMessage

protected SubscriptionQueryRequest 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<SubscriptionQueryResponse,SubscriptionQueryRequest>

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