io.aeron.archive.client

Class RecordingDescriptorPoller

java.lang.Object

io.aeron.archive.client.RecordingDescriptorPoller

public final class RecordingDescriptorPoller
extends Object

Encapsulate the polling, decoding, dispatching of recording descriptors from an archive.

Constructor Summary

Constructors

Constructor and Description
RecordingDescriptorPoller(Subscription subscription, ErrorHandler errorHandler, long controlSessionId, int fragmentLimit) Create a poller for a given subscription to an archive for control response messages.
RecordingDescriptorPoller(Subscription subscription, ErrorHandler errorHandler, RecordingSignalConsumer recordingSignalConsumer, long controlSessionId, int fragmentLimit) Create a poller for a given subscription to an archive for control response messages.

Method Summary

Modifier and Type	Method and Description
long	controlSessionId() Control session id for filtering responses.
boolean	isDispatchComplete() Is the dispatch of descriptors complete?
int	poll() Poll for recording events.
int	remainingRecordCount() Get the number of remaining records are expected.
void	reset(long correlationId, int recordCount, RecordingDescriptorConsumer consumer) Reset the poller to dispatch the descriptors returned from a query.
Subscription	subscription() Get the Subscription used for polling responses.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordingDescriptorPoller

public RecordingDescriptorPoller(Subscription subscription,
                                 ErrorHandler errorHandler,
                                 long controlSessionId,
                                 int fragmentLimit)

Create a poller for a given subscription to an archive for control response messages.

Parameters:

subscription - to poll for new events.

errorHandler - to call for asynchronous errors.

controlSessionId - to filter the responses.

fragmentLimit - to apply for each polling operation.

RecordingDescriptorPoller

public RecordingDescriptorPoller(Subscription subscription,
                                 ErrorHandler errorHandler,
                                 RecordingSignalConsumer recordingSignalConsumer,
                                 long controlSessionId,
                                 int fragmentLimit)

Create a poller for a given subscription to an archive for control response messages.

Parameters:

subscription - to poll for new events.

errorHandler - to call for asynchronous errors.

recordingSignalConsumer - for consuming interleaved recording signals on the control session.

controlSessionId - to filter the responses.

fragmentLimit - to apply for each polling operation.

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 recording events.

Returns:

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

controlSessionId

public long controlSessionId()

Control session id for filtering responses.

Returns:

control session id for filtering responses.

isDispatchComplete

public boolean isDispatchComplete()

Is the dispatch of descriptors complete?

Returns:

true if the dispatch of descriptors complete?

remainingRecordCount

public int remainingRecordCount()

Get the number of remaining records are expected.

Returns:

the number of remaining records are expected.

reset

public void reset(long correlationId,
                  int recordCount,
                  RecordingDescriptorConsumer consumer)

Reset the poller to dispatch the descriptors returned from a query.

Parameters:

correlationId - for the response.

recordCount - of descriptors to expect.

consumer - to which the recording descriptors are to be dispatched.

toString

public String toString()

Overrides:

toString in class Object