io.aeron.archive.client

Class RecordingEventsAdapter

java.lang.Object

io.aeron.archive.client.RecordingEventsAdapter

All Implemented Interfaces:

FragmentHandler

public final class RecordingEventsAdapter
extends Object
implements FragmentHandler

Encapsulate the polling, decoding, and dispatching of recording events.

Constructor Summary

Constructors

Constructor and Description
RecordingEventsAdapter(RecordingEventsListener listener, Subscription subscription, int fragmentLimit) Create an adapter for a given subscription to an archive for recording events.

Method Summary

Modifier and Type	Method and Description
void	onFragment(DirectBuffer buffer, int offset, int length, Header header) Callback for handling fragments of data being read from a log.
int	poll() Poll for recording events and dispatch them to the RecordingEventsListener for this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordingEventsAdapter

public RecordingEventsAdapter(RecordingEventsListener listener,
                              Subscription subscription,
                              int fragmentLimit)

Create an adapter for a given subscription to an archive for recording events.

Parameters:

listener - to which events are dispatched.

subscription - to poll for new events.

fragmentLimit - to apply for each polling operation.

Method Detail

poll

public int poll()

Poll for recording events and dispatch them to the RecordingEventsListener for this instance.

Returns:

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

onFragment

public void 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 FragmentHandler

Parameters:

buffer - containing the data.

offset - at which the data begins.

length - of the data in bytes.

header - representing the metadata for the data.