io.aeron.logbuffer

Class TermReader

java.lang.Object

io.aeron.logbuffer.TermReader

public class TermReader
extends java.lang.Object

A term buffer reader.

Note: Reading from the term is thread safe, but each thread needs its own instance of this class.

Constructor Summary

Constructors

Constructor and Description
TermReader()

Method Summary

Modifier and Type	Method and Description
static int	fragmentsRead(long readOutcome) The number of fragments that have been read.
static int	offset(long readOutcome) The offset up to which the term has progressed.
static long	pack(int offset, int fragmentsRead) Pack the values for fragmentsRead and offset into a long for returning on the stack.
static long	read(org.agrona.concurrent.UnsafeBuffer termBuffer, int offset, FragmentHandler handler, int fragmentsLimit, Header header, org.agrona.ErrorHandler errorHandler) Reads data from a term in a log buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

TermReader

public TermReader()

Method Detail

read

public static long read(org.agrona.concurrent.UnsafeBuffer termBuffer,
                        int offset,
                        FragmentHandler handler,
                        int fragmentsLimit,
                        Header header,
                        org.agrona.ErrorHandler errorHandler)

Reads data from a term in a log buffer. If a fragmentsLimit of 0 or less is passed then at least one read will be attempted.

Parameters:

termBuffer - to be read for fragments.

offset - offset within the buffer that the read should begin.

handler - the handler for data that has been read

fragmentsLimit - limit the number of fragments read.

header - to be used for mapping over the header for a given fragment.

errorHandler - to be notified if an error occurs during the callback.

Returns:

the number of fragments read

pack

public static long pack(int offset,
                        int fragmentsRead)

Pack the values for fragmentsRead and offset into a long for returning on the stack.

Parameters:

offset - value to be packed.

fragmentsRead - value to be packed.

Returns:

a long with both ints packed into it.

fragmentsRead

public static int fragmentsRead(long readOutcome)

The number of fragments that have been read.

Parameters:

readOutcome - into which the fragments read value has been packed.

Returns:

the number of fragments that have been read.

offset

public static int offset(long readOutcome)

The offset up to which the term has progressed.

Parameters:

readOutcome - into which the offset value has been packed.

Returns:

the offset up to which the term has progressed.