io.aeron.cluster.client

Interface ControlledEgressListener

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ControlledEgressListener

Interface for consuming messages coming from the cluster that also include administrative events in a controlled fashion like ControlledFragmentHandler. Only session messages may be controlled in consumption, other are consumed via ControlledFragmentHandler.Action.COMMIT.

Method Summary

Modifier and Type	Method and Description
default void	onAdminResponse(long clusterSessionId, long correlationId, AdminRequestType requestType, AdminResponseCode responseCode, String message, DirectBuffer payload, int payloadOffset, int payloadLength) Message returned in response to an admin request.
ControlledFragmentHandler.Action	onMessage(long clusterSessionId, long timestamp, DirectBuffer buffer, int offset, int length, Header header) Message event returned from the clustered service.
default void	onNewLeader(long clusterSessionId, long leadershipTermId, int leaderMemberId, String ingressEndpoints) Event indicating a new leader has been elected.
default void	onSessionEvent(long correlationId, long clusterSessionId, long leadershipTermId, int leaderMemberId, EventCode code, String detail) Session event emitted from the cluster which after connect can indicate an error or session close.

Method Detail

onMessage

ControlledFragmentHandler.Action onMessage(long clusterSessionId,
                                           long timestamp,
                                           DirectBuffer buffer,
                                           int offset,
                                           int length,
                                           Header header)

Message event returned from the clustered service.

Parameters:

clusterSessionId - to which the message belongs.

timestamp - at which the correlated ingress was sequenced in the cluster.

buffer - containing the message.

offset - at which the message begins.

length - of the message in bytes.

header - Aeron header associated with the message fragment.

Returns:

what action should be taken regarding advancement of the stream.

onSessionEvent

default void onSessionEvent(long correlationId,
                            long clusterSessionId,
                            long leadershipTermId,
                            int leaderMemberId,
                            EventCode code,
                            String detail)

Session event emitted from the cluster which after connect can indicate an error or session close.

Parameters:

correlationId - associated with the cluster ingress.

clusterSessionId - to which the event belongs.

leadershipTermId - for identifying the active term of leadership

leaderMemberId - identity of the active leader.

code - to indicate the type of event.

detail - Textual detail to explain the event.

onNewLeader

default void onNewLeader(long clusterSessionId,
                         long leadershipTermId,
                         int leaderMemberId,
                         String ingressEndpoints)

Event indicating a new leader has been elected.

Parameters:

clusterSessionId - to which the event belongs.

leadershipTermId - for identifying the active term of leadership

leaderMemberId - identity of the active leader.

ingressEndpoints - for connecting to the cluster which can be updated due to dynamic membership.

onAdminResponse

default void onAdminResponse(long clusterSessionId,
                             long correlationId,
                             AdminRequestType requestType,
                             AdminResponseCode responseCode,
                             String message,
                             DirectBuffer payload,
                             int payloadOffset,
                             int payloadLength)

Message returned in response to an admin request.

Parameters:

clusterSessionId - to which the response belongs.

correlationId - of the admin request.

requestType - of the admin request.

responseCode - describing the response.

message - describing the response (e.g. error message).

payload - delivered with the response, can be empty.

payloadOffset - into the payload buffer.

payloadLength - of the payload.