io.aeron.samples.echo

Class EchoPair

java.lang.Object

io.aeron.samples.echo.EchoPair

All Implemented Interfaces:

ControlledFragmentHandler, AutoCloseable

public class EchoPair
extends Object
implements ControlledFragmentHandler, AutoCloseable

Pub/sub pair that will copy all incoming fragments from the subscription onto the publication.

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

Constructor Summary

Constructors

Constructor and Description
EchoPair(long correlationId, Subscription subscription, Publication publication) Construct the echo pair.

Method Summary

Modifier and Type	Method and Description
void	close() Close the echo pair
long	correlationId() Get the correlationId
EchoMonitorMBean	monitor() Get the monitoring MBean for this echo pair.
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 subscription of the echo pair.

Methods inherited from class java.lang.Object

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

Field Detail

FRAGMENT_LIMIT

public static final int FRAGMENT_LIMIT

See Also:

Constant Field Values

Constructor Detail

EchoPair

public EchoPair(long correlationId,
                Subscription subscription,
                Publication publication)

Construct the echo pair.

Parameters:

correlationId - user supplied correlation id

subscription - to read fragments from

publication - to send fragments back to

Method Detail

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

Returns:

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

poll

public int poll()

Poll subscription of the echo pair.

Returns:

number of fragments processed

correlationId

public long correlationId()

Get the correlationId

Returns:

user supplied correlationId

monitor

public EchoMonitorMBean monitor()

Get the monitoring MBean for this echo pair.

Returns:

An instance of the monitoring MBean that can be installed into a JMX container.

close

public void close()

Close the echo pair

Specified by:

close in interface AutoCloseable