io.aeron.archive.client

Class ControlResponsePoller

java.lang.Object

io.aeron.archive.client.ControlResponsePoller

All Implemented Interfaces:

ControlledFragmentHandler

public class ControlResponsePoller
extends Object
implements ControlledFragmentHandler

Encapsulate the polling and decoding of archive control protocol response messages.

Nested Class Summary

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

ControlledFragmentHandler.Action

Field Summary

Fields

Modifier and Type	Field and Description
static int	FRAGMENT_LIMIT Limit to apply when polling response messages.

Constructor Summary

Constructors

Constructor and Description
ControlResponsePoller(Subscription subscription) Create a poller for a given subscription to an archive for control response messages with a default fragment limit for polling as FRAGMENT_LIMIT.

Method Summary

Modifier and Type	Method and Description
ControlResponseCode	code() Get the response code of the last response.
long	controlSessionId() Control session id of the last polled message or Aeron.NULL_VALUE if poll returned nothing.
long	correlationId() Correlation id of the last polled message or Aeron.NULL_VALUE if poll returned nothing.
byte[]	encodedChallenge() Get the encoded challenge of the last challenge.
String	errorMessage() Get the error message of the last response.
boolean	isPollComplete() Has the last polling action received a complete message?
ControlledFragmentHandler.Action	onFragment(DirectBuffer buffer, int offset, int length, Header header) Callback for handling fragments of data being read from a log.
int	poll() Poll for control response events.
long	relevantId() Get the relevant id returned with the response, e.g.
Subscription	subscription() Get the Subscription used for polling responses.
String	toString()
int	version() Version response from the server in semantic version form.
boolean	wasChallenged() Was the last polling action received a challenge message?

Methods inherited from class java.lang.Object

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

Field Detail

FRAGMENT_LIMIT

public static final int FRAGMENT_LIMIT

Limit to apply when polling response messages.

See Also:

Constant Field Values

Constructor Detail

ControlResponsePoller

public ControlResponsePoller(Subscription subscription)

Create a poller for a given subscription to an archive for control response messages with a default fragment limit for polling as FRAGMENT_LIMIT.

Parameters:

subscription - to poll for new events.

Method Detail

subscription

public Subscription subscription()

Get the Subscription used for polling responses.

Returns:

the Subscription used for polling responses.

poll

public int poll()

Poll for control response events.

Returns:

the number of fragments read during the operation. Zero if no events are available.

controlSessionId

public long controlSessionId()

Control session id of the last polled message or Aeron.NULL_VALUE if poll returned nothing.

Returns:

control session id of the last polled message or Aeron.NULL_VALUE if poll returned nothing.

correlationId

public long correlationId()

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

Returns:

correlation id of the last polled message or Aeron.NULL_VALUE if poll returned nothing.

relevantId

public long relevantId()

Get the relevant id returned with the response, e.g. replay session id.

Returns:

the relevant id returned with the response.

version

public int version()

Version response from the server in semantic version form.

Returns:

response from the server in semantic version form.

isPollComplete

public boolean isPollComplete()

Has the last polling action received a complete message?

Returns:

true if the last polling action received a complete message?

code

public ControlResponseCode code()

Get the response code of the last response.

Returns:

the response code of the last response.

errorMessage

public String errorMessage()

Get the error message of the last response.

Returns:

the error message of the last response.

wasChallenged

public boolean wasChallenged()

Was the last polling action received a challenge message?

Returns:

true if the last polling action received was a challenge message, false if not.

encodedChallenge

public byte[] encodedChallenge()

Get the encoded challenge of the last challenge.

Returns:

the encoded challenge of the last challenge.

onFragment

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

Description copied from interface: ControlledFragmentHandler

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.

toString

public String toString()

Overrides:

toString in class Object