io.axoniq.axonserver.connector

Interface ReplyChannel<T>

Type Parameters:

T - the type of message expected on this ReplyChannel

All Known Implementing Classes:

ForwardingReplyChannel

public interface ReplyChannel<T>

Interface providing access to the communication channel to send replies to incoming instructions. All instructions must be acknowledged by completing the reply channel after successfully sending all necessary replies.

One should not send messages after completing the reply channel. The behavior is such a case is undefined.

Method Summary

Modifier and Type	Method and Description
void	complete() Marks the inbound instruction as completed.
void	completeWithError(ErrorCategory errorCategory, String message) Marks the inbound instruction as exceptionally completed.
void	completeWithError(ErrorMessage errorMessage) Marks the inbound instruction as exceptionally completed.
void	send(T outboundMessage) Sends the given outboundMessage as a reply to an incoming instruction.
void	sendAck() Sends an receipt acknowledgement if one hasn't been sent yet for this instruction.
default void	sendLast(T outboundMessage) Sends the given response and marks the processing as completed, possibly signalling flow control that more query messages may be sent.
default void	sendNack() Sends a negative acknowledgement, indicating that the incoming message could not be handled as expected.
void	sendNack(ErrorMessage errorMessage) Sends a negative acknowledgement, indicating that the incoming message could not be handled as expected, using given errorMessage to describe the reason.

Method Detail

send

void send(T outboundMessage)

Sends the given outboundMessage as a reply to an incoming instruction. Where possible, the instruction identifiers should be set on the outbound message.

Parameters:

outboundMessage - the message to send

Implementation Note:

Implementations are encouraged to validate and correct these instruction identifiers.

sendLast

default void sendLast(T outboundMessage)

Sends the given response and marks the processing as completed, possibly signalling flow control that more query messages may be sent.

No more responses should be sent after invoking this method. The behavior in that case is undefined, and these messages are likely to be ignored.

sendAck

void sendAck()

Sends an receipt acknowledgement if one hasn't been sent yet for this instruction. If not explicitly sent, it will be sent once the complete() method is invoked.

If the incoming instruction has no instruction ID, this method does nothing.

sendNack

default void sendNack()

Sends a negative acknowledgement, indicating that the incoming message could not be handled as expected. Unlike sendNack(ErrorMessage), no specific error details are provided. If not explicitly sent, it will be send once the completeWithError(ErrorMessage) or completeWithError(ErrorCategory, String) methods are invoked.

If the incoming instruction has no instruction ID, this method does nothing.

See Also:

sendNack(ErrorMessage)

sendNack

void sendNack(ErrorMessage errorMessage)

Sends a negative acknowledgement, indicating that the incoming message could not be handled as expected, using given errorMessage to describe the reason. If not explicitly sent, it will be send once the completeWithError(ErrorMessage) or completeWithError(ErrorCategory, String) methods are invoked. The given errorMessage should provide sufficient information about the error.

If the incoming instruction has no instruction ID, this method does nothing.

complete

void complete()

Marks the inbound instruction as completed.

completeWithError

void completeWithError(ErrorMessage errorMessage)

Marks the inbound instruction as exceptionally completed. The given errorMessage should provide sufficient information about the error.

Parameters:

errorMessage - the ErrorMessage describing the error

completeWithError

void completeWithError(ErrorCategory errorCategory,
                       String message)

Marks the inbound instruction as exceptionally completed. The given errorCategory and message should provide sufficient information about the error.

Parameters:

errorCategory - the category that best described the error encountered

message - a message providing more details about the Error