io.axoniq.axonserver.connector.impl

Class AbstractAxonServerChannel<OUT>

java.lang.Object

io.axoniq.axonserver.connector.impl.AbstractAxonServerChannel<OUT>

Type Parameters:

OUT - generic defining the type of instructions a channel implementation can send

Direct Known Subclasses:

AdminChannelImpl, CommandChannelImpl, ControlChannelImpl, EventChannelImpl, QueryChannelImpl

public abstract class AbstractAxonServerChannel<OUT>
extends Object

Abstract class representing a channel with AxonServer.

Author:

Allard Buijze

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAxonServerChannel(ClientIdentification clientIdentification, ScheduledExecutorService executor, AxonServerManagedChannel axonServerManagedChannel) Instantiate an AbstractAxonServerChannel.

Method Summary

Modifier and Type	Method and Description
abstract void	connect() Connect this channel with AxonServer.
abstract void	disconnect() Disconnect this channel from AxonServer.
abstract boolean	isReady() Validate whether this channel has all required streams connected with AxonServer.
protected void	processAck(InstructionAck ack) Process the given ack by completing the instruction it refers to, if any can be found.
abstract void	reconnect() Reconnect this channel with AxonServer.
protected void	scheduleImmediateReconnect() Schedule an immediate attempt to reconnect with AxonServer.
protected void	scheduleReconnect(Throwable disconnectReason) Schedule an attempt to reconnect with AxonServer.
protected CompletableFuture<Void>	sendInstruction(OUT instruction, Function<OUT,String> instructionIdProvider, io.grpc.stub.StreamObserver<OUT> outboundStream) Send the given instruction over the given outboundStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAxonServerChannel

protected AbstractAxonServerChannel(ClientIdentification clientIdentification,
                                    ScheduledExecutorService executor,
                                    AxonServerManagedChannel axonServerManagedChannel)

Instantiate an AbstractAxonServerChannel.

Parameters:

executor - a ScheduledExecutorService used to schedule reconnections

axonServerManagedChannel - the AxonServerManagedChannel used to connect to AxonServer

Method Detail

sendInstruction

protected CompletableFuture<Void> sendInstruction(OUT instruction,
                                                  Function<OUT,String> instructionIdProvider,
                                                  io.grpc.stub.StreamObserver<OUT> outboundStream)

Send the given instruction over the given outboundStream. Will use the given instructionIdProvider to retrieve the instruction identifier to keep track when the instruction has been acknowledged.

Parameters:

instruction - the instruction of type OUT to send

instructionIdProvider - extraction function retrieving the instruction identifier from the given instruction

outboundStream - StreamObserver to send the given instruction over

Returns:

a CompletableFuture resolving successfully or exceptionally depending on the outcome of the dispatched instruction

processAck

protected void processAck(InstructionAck ack)

Process the given ack by completing the instruction it refers to, if any can be found.

Parameters:

ack - the InstructionAck referring to an instruction which has been sent through the sendInstruction(Object, Function, StreamObserver) method

scheduleReconnect

protected void scheduleReconnect(Throwable disconnectReason)

Schedule an attempt to reconnect with AxonServer. Depending on the disconnectReason, the reconnect attempt will be executed within 500ms or 5000ms.

Parameters:

disconnectReason - The reason why the previous connection failed.

scheduleImmediateReconnect

protected void scheduleImmediateReconnect()

Schedule an immediate attempt to reconnect with AxonServer.

connect

public abstract void connect()

Connect this channel with AxonServer.

reconnect

public abstract void reconnect()

Reconnect this channel with AxonServer.

disconnect

public abstract void disconnect()

Disconnect this channel from AxonServer.

isReady

public abstract boolean isReady()

Validate whether this channel has all required streams connected with AxonServer. If the state of the channel does not require any active streams, it is considered ready and will return true.

Returns:

true if this channel is connected with AxonServer or does not require any active connections, false otherwise