io.aeron.samples.archive

Class RecordingSignalCapture

java.lang.Object

io.aeron.samples.archive.RecordingSignalCapture

All Implemented Interfaces:

RecordingSignalConsumer

public final class RecordingSignalCapture
extends Object
implements RecordingSignalConsumer

A RecordingSignalConsumer implementation that captures recording signal data.

Usage example:

 
     final RecordingSignalCapture recordingSignalCapture = new RecordingSignalCapture();
     try (Aeron aeron = Aeron.connect(new Aeron.Context().aeronDirectoryName(aeronDirectoryName));
          AeronArchive archive = AeronArchive.connect(new AeronArchive.Context()
              .recordingSignalConsumer(recordingSignalCapture)
              .aeron(aeron)))
     {
         ...
         recordingSignalCapture.reset();
         archive.replicate(srcRecordingId, dstRecordingId, ...);

         recordingSignalCapture.awaitSignalForRecordingId(archive, dstRecordingId, RecordingSignal.STOP);
         final long stopPosition = recordingSignalCapture.position();

         recordingSignalCapture.reset();
         recordingSignalCapture.awaitSignalForRecordingId(archive, dstRecordingId, RecordingSignal.REPLICATE_END);
         ...
     }
 
 

Constructor Summary

Constructors

Constructor and Description
RecordingSignalCapture()

Method Summary

Modifier and Type	Method and Description
void	awaitSignalForCorrelationId(AeronArchive archive, long expectedCorrelationId, RecordingSignal expectedSignal) Uses AeronArchive.pollForRecordingSignals() until the specified signal is received.
void	awaitSignalForRecordingId(AeronArchive archive, long expectedRecordingId, RecordingSignal expectedSignal) Uses AeronArchive.pollForRecordingSignals() until the specified signal for the specified recording is received.
long	controlSessionId() Control session id captured when the onSignal(long, long, long, long, long, RecordingSignal) was last invoked.
long	correlationId() Correlation id captured when the onSignal(long, long, long, long, long, RecordingSignal) was last invoked.
void	onSignal(long controlSessionId, long correlationId, long recordingId, long subscriptionId, long position, RecordingSignal signal) Signal of operation taken on a recording.
long	position() Recording position captured when the onSignal(long, long, long, long, long, RecordingSignal) was last invoked.
long	recordingId() Recording id captured when the onSignal(long, long, long, long, long, RecordingSignal) was last invoked.
void	reset() Reset internal state before awaiting next signal.
RecordingSignal	signal() Recording signal captured when the onSignal(long, long, long, long, long, RecordingSignal) was last invoked.
long	subscriptionId() Subscription id captured when the onSignal(long, long, long, long, long, RecordingSignal) was last invoked.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordingSignalCapture

public RecordingSignalCapture()

Method Detail

onSignal

public void onSignal(long controlSessionId,
                     long correlationId,
                     long recordingId,
                     long subscriptionId,
                     long position,
                     RecordingSignal signal)

Signal of operation taken on a recording.

Specified by:

onSignal in interface RecordingSignalConsumer

Parameters:

controlSessionId - that initiated the operation.

correlationId - that initiated the operation, could be the replication id.

recordingId - which has signalled.

subscriptionId - of the Subscription associated with the recording.

position - of the recorded stream at the point of signal.

signal - type of the operation applied to the recording.

awaitSignalForCorrelationId

public void awaitSignalForCorrelationId(AeronArchive archive,
                                        long expectedCorrelationId,
                                        RecordingSignal expectedSignal)

Uses AeronArchive.pollForRecordingSignals() until the specified signal is received.

Parameters:

archive - client to poll for signals on.

expectedCorrelationId - to match the signal.

expectedSignal - to await.

awaitSignalForRecordingId

public void awaitSignalForRecordingId(AeronArchive archive,
                                      long expectedRecordingId,
                                      RecordingSignal expectedSignal)

Uses AeronArchive.pollForRecordingSignals() until the specified signal for the specified recording is received.

Parameters:

archive - client to poll for signals on.

expectedRecordingId - that should be delivered with the signal.

expectedSignal - to await.

reset

public void reset()

Reset internal state before awaiting next signal.

controlSessionId

public long controlSessionId()

Control session id captured when the onSignal(long, long, long, long, long, RecordingSignal) was last invoked.

Returns:

last captured control session id.

See Also:

onSignal(long, long, long, long, long, RecordingSignal)

correlationId

public long correlationId()

Correlation id captured when the onSignal(long, long, long, long, long, RecordingSignal) was last invoked.

Returns:

last captured correlation id.

See Also:

onSignal(long, long, long, long, long, RecordingSignal)

subscriptionId

public long subscriptionId()

Subscription id captured when the onSignal(long, long, long, long, long, RecordingSignal) was last invoked.

Returns:

last captured subscription id.

See Also:

onSignal(long, long, long, long, long, RecordingSignal)

recordingId

public long recordingId()

Recording id captured when the onSignal(long, long, long, long, long, RecordingSignal) was last invoked.

Returns:

last captured recording id.

See Also:

onSignal(long, long, long, long, long, RecordingSignal)

position

public long position()

Recording position captured when the onSignal(long, long, long, long, long, RecordingSignal) was last invoked.

Returns:

last captured recording position.

See Also:

onSignal(long, long, long, long, long, RecordingSignal)

signal

public RecordingSignal signal()

Recording signal captured when the onSignal(long, long, long, long, long, RecordingSignal) was last invoked.

Returns:

last captured recording signal.

See Also:

onSignal(long, long, long, long, long, RecordingSignal)