io.aeron.archive.client

Class ReplayParams

java.lang.Object

io.aeron.archive.client.ReplayParams

public class ReplayParams
extends Object

Fluent API for setting optional replay parameters. Not threadsafe. Allows the user to configure starting position, replay length, bounding counter (for a bounded replay) and the max length for file I/O operations.

Constructor Summary

Constructors

Constructor and Description
ReplayParams() Default, initialise all values to "null"

Method Summary

Modifier and Type	Method and Description
int	boundingLimitCounterId() Gets the counterId specified for the bounding the replay.
ReplayParams	boundingLimitCounterId(int boundingLimitCounterId) Sets the counter id to be used for bounding the replay.
int	fileIoMaxLength() Gets the maximum length for file IO operations in the replay.
ReplayParams	fileIoMaxLength(int fileIoMaxLength) The maximum size of a file operation when reading from the archive to execute the replay.
boolean	isBounded() Determines if the parameter setup has requested a bounded replay.
long	length() Length of the recording to replay.
ReplayParams	length(long length) The length of the recorded stream to replay.
long	position() Position to start the replay at.
ReplayParams	position(long position) Set the position to start the replay.
ReplayParams	reset() reset all value to "null", allows for an instance to be reused

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplayParams

public ReplayParams()

Default, initialise all values to "null"

Method Detail

reset

public ReplayParams reset()

reset all value to "null", allows for an instance to be reused

Returns:

this for a fluent API

position

public ReplayParams position(long position)

Set the position to start the replay. If set to AeronArchive.NULL_POSITION (which is the default) then the stream will be replayed from the start.

Parameters:

position - to start the replay from.

Returns:

this for a fluent API.

position

public long position()

Position to start the replay at.

Returns:

position for the start of the replay.

See Also:

position(long)

length

public ReplayParams length(long length)

The length of the recorded stream to replay. If set to AeronArchive.NULL_POSITION (the default) will replay a whole stream of unknown length. If set to Long.MAX_VALUE it will follow a live recording.

Parameters:

length - of the recording to be replayed.

Returns:

this for a fluent API.

length

public long length()

Length of the recording to replay.

Returns:

length of the recording to replay.

See Also:

length(long)

boundingLimitCounterId

public ReplayParams boundingLimitCounterId(int boundingLimitCounterId)

Sets the counter id to be used for bounding the replay. Setting this value will trigger the sending of a bounded replay request instead of a normal replay.

Parameters:

boundingLimitCounterId - counter to use to bound the replay

Returns:

this for a fluent API

boundingLimitCounterId

public int boundingLimitCounterId()

Gets the counterId specified for the bounding the replay. Returns Aeron.NULL_VALUE if unspecified.

Returns:

the counter id to bound the replay.

fileIoMaxLength

public ReplayParams fileIoMaxLength(int fileIoMaxLength)

The maximum size of a file operation when reading from the archive to execute the replay. Will use the value defined in the context otherwise. This can be used reduce the size of file IO operations to lower the priority of some replays. Setting it to a value larger than the context value will have no affect.

Parameters:

fileIoMaxLength - maximum length of a replay file operation

Returns:

this for a fluent API

fileIoMaxLength

public int fileIoMaxLength()

Gets the maximum length for file IO operations in the replay. Defaults to Aeron.NULL_VALUE if not set, which will trigger the use of the Archive.Context default.

Returns:

maximum file length for IO operations during replay.

isBounded

public boolean isBounded()

Determines if the parameter setup has requested a bounded replay.

Returns:

true if the replay should be bounded, false otherwise.