io.axoniq.axonserver.connector.impl

Class ControlChannelImpl

java.lang.Object

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

io.axoniq.axonserver.connector.impl.ControlChannelImpl

All Implemented Interfaces:

ControlChannel

public class ControlChannelImpl
extends AbstractAxonServerChannel<PlatformInboundInstruction>
implements ControlChannel

ControlChannel implementation, serving as the overall control and instruction connection between AxonServer and a client application.

Constructor Summary

Constructors

Constructor and Description
ControlChannelImpl(ClientIdentification clientIdentification, String context, ScheduledExecutorService executor, AxonServerManagedChannel channel, long processorInfoUpdateFrequency, Runnable reconnectHandler) Constructs a ControlChannelImpl.

Method Summary

Modifier and Type	Method and Description
void	connect() Connect this channel with AxonServer.
void	disableHeartbeat() Disable any previously enabled heartbeats.
void	disconnect() Disconnect this channel from AxonServer.
void	enableHeartbeat(long interval, long timeout, TimeUnit timeUnit) Enables sending heartbeat message to validate that the connection to AxonServer is alive.
boolean	isReady() Validate whether this channel has all required streams connected with AxonServer.
void	reconnect() Reconnect this channel with AxonServer.
Registration	registerEventProcessor(String processorName, Supplier<EventProcessorInfo> infoSupplier, ProcessorInstructionHandler instructionHandler) Registers an Event Processor with AxonServer, allowing AxonServer to request status information and provide instructions for the Processor.
Registration	registerInstructionHandler(PlatformOutboundInstruction.RequestCase type, InstructionHandler<PlatformOutboundInstruction,PlatformInboundInstruction> handler) Registers the given handler to handle a given type of instruction.
CompletableFuture<Void>	sendInstruction(PlatformInboundInstruction instruction) Send a the given instruction over this channel, returning the acknowledgment of the instruction asynchronously.

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

processAck, scheduleImmediateReconnect, scheduleReconnect, sendInstruction

Methods inherited from class java.lang.Object

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

Constructor Detail

ControlChannelImpl

public ControlChannelImpl(ClientIdentification clientIdentification,
                          String context,
                          ScheduledExecutorService executor,
                          AxonServerManagedChannel channel,
                          long processorInfoUpdateFrequency,
                          Runnable reconnectHandler)

Constructs a ControlChannelImpl.

Parameters:

clientIdentification - the information identifying the client application which is connecting. This information is used to pass on to message

context - the context this ControlChannel operates in

executor - a ScheduledExecutorService used to schedule reconnects of this channel, heartbeat message dispatching and processor information updates

channel - the AxonServerManagedChannel used to form the connection with AxonServer

processorInfoUpdateFrequency - the update frequency in milliseconds of event processor information

reconnectHandler - operation run when a reconnect request is received for this channel

Method Detail

connect

public void connect()

Description copied from class: AbstractAxonServerChannel

Connect this channel with AxonServer.

Specified by:

connect in class AbstractAxonServerChannel<PlatformInboundInstruction>

reconnect

public void reconnect()

Description copied from class: AbstractAxonServerChannel

Reconnect this channel with AxonServer.

Specified by:

reconnect in class AbstractAxonServerChannel<PlatformInboundInstruction>

disconnect

public void disconnect()

Description copied from class: AbstractAxonServerChannel

Disconnect this channel from AxonServer.

Specified by:

disconnect in class AbstractAxonServerChannel<PlatformInboundInstruction>

registerInstructionHandler

public Registration registerInstructionHandler(PlatformOutboundInstruction.RequestCase type,
                                               InstructionHandler<PlatformOutboundInstruction,PlatformInboundInstruction> handler)

Description copied from interface: ControlChannel

Registers the given handler to handle a given type of instruction. Any previous registrations of handlers for the given type of instruction are overwritten.

Note that de-registration of a handler will not reinstate any previously registered handler for the same type of instruction.

This method is intended to overwrite the default behavior for incoming instructions, or to provide support for non-default instructions.

Specified by:

registerInstructionHandler in interface ControlChannel

Parameters:

type - the type of instructions to handle

handler - the handler to invoke for incoming instructions

Returns:

a handle to unregister this instruction handler

registerEventProcessor

public Registration registerEventProcessor(String processorName,
                                           Supplier<EventProcessorInfo> infoSupplier,
                                           ProcessorInstructionHandler instructionHandler)

Description copied from interface: ControlChannel

Registers an Event Processor with AxonServer, allowing AxonServer to request status information and provide instructions for the Processor.

Specified by:

registerEventProcessor in interface ControlChannel

Parameters:

processorName - the name of the processor

infoSupplier - supplier for up-to-date status information of the processor

instructionHandler - handler for incoming instructions for the processor

Returns:

a handle to cancel the registration of the event processor

enableHeartbeat

public void enableHeartbeat(long interval,
                            long timeout,
                            TimeUnit timeUnit)

Description copied from interface: ControlChannel

Enables sending heartbeat message to validate that the connection to AxonServer is alive. This ensures a fully operational end-to-end connection with AxonServer.

When enabled, the client will abandon any connections on which no timely response to a heartbeat has been received. If heartbeats are also enabled on the AxonServer side, any heartbeat initiated by AxonServer will count as a valid connection confirmation.

Consecutive invocations of this method will alter the configuration, resetting heartbeat timers and reinitialize the heartbeat processing.

Specified by:

enableHeartbeat in interface ControlChannel

Parameters:

interval - the interval at which heartbeat messages are expected

timeout - the maximum time to wait for a confirmation after initiating a heartbeat message

timeUnit - the unit of time in which interval and timeout are expressed

disableHeartbeat

public void disableHeartbeat()

Description copied from interface: ControlChannel

Disable any previously enabled heartbeats. Heartbeat requests initiated by AxonServer will still be reacted to, but the client will no longer initiate a heartbeat, nor close a connection when it fails to receive confirmations.

Specified by:

disableHeartbeat in interface ControlChannel

sendInstruction

public CompletableFuture<Void> sendInstruction(PlatformInboundInstruction instruction)

Description copied from interface: ControlChannel

Send a the given instruction over this channel, returning the acknowledgment of the instruction asynchronously.

Specified by:

sendInstruction in interface ControlChannel

Parameters:

instruction - the PlatformInboundInstruction to send over this channel

Returns:

a CompletableFuture of the acknowledgement of the given instruction

isReady

public boolean isReady()

Description copied from class: AbstractAxonServerChannel

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.

Specified by:

isReady in class AbstractAxonServerChannel<PlatformInboundInstruction>

Returns:

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