io.aeron.archive.client

Class ControlResponseAdapter

java.lang.Object

io.aeron.archive.client.ControlResponseAdapter

All Implemented Interfaces:

FragmentHandler

public class ControlResponseAdapter
extends Object
implements FragmentHandler

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

Constructor Summary

Constructors

Constructor and Description
ControlResponseAdapter(ControlResponseListener listener, Subscription subscription, int fragmentLimit) Create an adapter for a given subscription to an archive for control response messages.

Method Summary

Modifier and Type	Method and Description
static void	dispatchDescriptor(RecordingDescriptorDecoder decoder, RecordingDescriptorConsumer consumer) Dispatch a descriptor message to a consumer by reading the fields in the correct order.
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 ControlResponseListener for this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

ControlResponseAdapter

public ControlResponseAdapter(ControlResponseListener listener,
                              Subscription subscription,
                              int fragmentLimit)

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

Parameters:

listener - to which responses 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 ControlResponseListener for this instance.

Returns:

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

dispatchDescriptor

public static void dispatchDescriptor(RecordingDescriptorDecoder decoder,
                                      RecordingDescriptorConsumer consumer)

Dispatch a descriptor message to a consumer by reading the fields in the correct order.

Parameters:

decoder - which wraps the encoded message ready for reading.

consumer - to which the decoded fields should be passed.

onFragment

public void onFragment(DirectBuffer buffer,
                       int offset,
                       int length,
                       Header header)

Description copied from interface: FragmentHandler

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 meta data for the data.