io.aeron.cluster.client

Class EgressPoller

java.lang.Object

io.aeron.cluster.client.EgressPoller

All Implemented Interfaces:

ControlledFragmentHandler

public final class EgressPoller
extends Object
implements ControlledFragmentHandler

Poller for the egress from a cluster to capture administration message details.

Nested Class Summary

Nested classes/interfaces inherited from interface io.aeron.logbuffer.ControlledFragmentHandler

ControlledFragmentHandler.Action

Constructor Summary

Constructors

Constructor and Description
EgressPoller(Subscription subscription, int fragmentLimit) Construct a poller on the egress subscription.

Method Summary

Modifier and Type	Method and Description
long	clusterSessionId() Cluster session id of the last polled event or Aeron.NULL_VALUE if poll returned nothing.
long	correlationId() Correlation id of the last polled event or Aeron.NULL_VALUE if poll returned nothing.
String	detail() Get the detail returned in the last session event.
byte[]	encodedChallenge() Get the encoded challenge in the last challenge.
EventCode	eventCode() Get the event code returned from the last session event.
boolean	isChallenged() Was last message a challenge or not?
boolean	isPollComplete() Has the last polling action received a complete event?
int	leaderMemberId() Leader cluster member id of the last polled event or Aeron.NULL_VALUE if poll returned nothing.
long	leadershipTermId() Leadership term id of the last polled event or Aeron.NULL_VALUE if poll returned nothing.
ControlledFragmentHandler.Action	onFragment(DirectBuffer buffer, int offset, int length, Header header) Callback for handling fragments of data being read from a log.
int	poll() Reset last captured value and poll the egress subscription for output.
Subscription	subscription() Get the Subscription used for polling events.
int	templateId() Get the template id of the last received event.
int	version() Version response from the server in semantic version form.

Methods inherited from class java.lang.Object

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

Constructor Detail

EgressPoller

public EgressPoller(Subscription subscription,
                    int fragmentLimit)

Construct a poller on the egress subscription.

Parameters:

subscription - for egress from the cluster.

fragmentLimit - for each poll operation.

Method Detail

subscription

public Subscription subscription()

Get the Subscription used for polling events.

Returns:

the Subscription used for polling events.

templateId

public int templateId()

Get the template id of the last received event.

Returns:

the template id of the last received event.

clusterSessionId

public long clusterSessionId()

Cluster session id of the last polled event or Aeron.NULL_VALUE if poll returned nothing.

Returns:

cluster session id of the last polled event or Aeron.NULL_VALUE if not returned.

correlationId

public long correlationId()

Correlation id of the last polled event or Aeron.NULL_VALUE if poll returned nothing.

Returns:

correlation id of the last polled event or Aeron.NULL_VALUE if not returned.

leadershipTermId

public long leadershipTermId()

Leadership term id of the last polled event or Aeron.NULL_VALUE if poll returned nothing.

Returns:

leadership term id of the last polled event or Aeron.NULL_VALUE if not returned.

leaderMemberId

public int leaderMemberId()

Leader cluster member id of the last polled event or Aeron.NULL_VALUE if poll returned nothing.

Returns:

leader cluster member id of the last polled event or Aeron.NULL_VALUE if poll returned nothing.

eventCode

public EventCode eventCode()

Get the event code returned from the last session event.

Returns:

the event code returned from the last session event.

version

public int version()

Version response from the server in semantic version form.

Returns:

response from the server in semantic version form.

detail

public String detail()

Get the detail returned in the last session event.

Returns:

the detail returned in the last session event.

encodedChallenge

public byte[] encodedChallenge()

Get the encoded challenge in the last challenge.

Returns:

the encoded challenge in the last challenge or null if last message was not a challenge.

isPollComplete

public boolean isPollComplete()

Has the last polling action received a complete event?

Returns:

true if the last polling action received a complete event.

isChallenged

public boolean isChallenged()

Was last message a challenge or not?

Returns:

true if last message was a challenge or false if not.

poll

public int poll()

Reset last captured value and poll the egress subscription for output.

Returns:

number of fragments consumed.

onFragment

public ControlledFragmentHandler.Action onFragment(DirectBuffer buffer,
                                                   int offset,
                                                   int length,
                                                   Header header)

Callback for handling fragments of data being read from a log.

Within this callback reentrant calls to the Aeron client are not permitted and will result in undefined behaviour.

Specified by:

onFragment in interface ControlledFragmentHandler

Parameters:

buffer - containing the data.

offset - at which the data begins.

length - of the data in bytes.

header - representing the meta data for the data.

Returns:

The action to be taken with regard to the stream position after the callback.