io.aeron

Class CncFileDescriptor

java.lang.Object

io.aeron.CncFileDescriptor

public class CncFileDescriptor
extends java.lang.Object

Description of the command and control file used between driver and clients.

File Layout

  +-----------------------------+
  |          Meta Data          |
  +-----------------------------+
  |      to-driver Buffer       |
  +-----------------------------+
  |      to-clients Buffer      |
  +-----------------------------+
  |   Counters Metadata Buffer  |
  +-----------------------------+
  |    Counters Values Buffer   |
  +-----------------------------+
  |          Error Log          |
  +-----------------------------+
 

Meta Data Layout CNC_VERSION

   0                   1                   2                   3
   0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  |                      Aeron CnC Version                        |
  +---------------------------------------------------------------+
  |                   to-driver buffer length                     |
  +---------------------------------------------------------------+
  |                  to-clients buffer length                     |
  +---------------------------------------------------------------+
  |               Counters Metadata buffer length                 |
  +---------------------------------------------------------------+
  |                Counters Values buffer length                  |
  +---------------------------------------------------------------+
  |                   Error Log buffer length                     |
  +---------------------------------------------------------------+
  |                   Client Liveness Timeout                     |
  |                                                               |
  +---------------------------------------------------------------+
  |                    Driver Start Timestamp                     |
  |                                                               |
  +---------------------------------------------------------------+
  |                         Driver PID                            |
  |                                                               |
  +---------------------------------------------------------------+
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLIENT_LIVENESS_TIMEOUT_FIELD_OFFSET
static java.lang.String	CNC_FILE
static int	CNC_VERSION
static int	CNC_VERSION_FIELD_OFFSET
static int	COUNTERS_METADATA_BUFFER_LENGTH_FIELD_OFFSET
static int	COUNTERS_VALUES_BUFFER_LENGTH_FIELD_OFFSET
static int	END_OF_METADATA_OFFSET
static int	ERROR_LOG_BUFFER_LENGTH_FIELD_OFFSET
static int	META_DATA_LENGTH
static int	PID_FIELD_OFFSET
static int	START_TIMESTAMP_FIELD_OFFSET
static int	TO_CLIENTS_BUFFER_LENGTH_FIELD_OFFSET
static int	TO_DRIVER_BUFFER_LENGTH_FIELD_OFFSET

Constructor Summary

Constructors

Constructor and Description
CncFileDescriptor()

Method Summary

Modifier and Type	Method and Description
static long	clientLivenessTimeout(org.agrona.DirectBuffer metaDataBuffer)
static int	clientLivenessTimeoutOffset(int baseOffset)
static int	cncVersionOffset(int baseOffset)
static int	computeCncFileLength(int totalLengthOfBuffers, int alignment) Compute the length of the cnc file and return it.
static int	countersMetaDataBufferLengthOffset(int baseOffset)
static int	countersValuesBufferLengthOffset(int baseOffset)
static org.agrona.concurrent.UnsafeBuffer	createCountersMetaDataBuffer(java.nio.ByteBuffer buffer, org.agrona.DirectBuffer metaDataBuffer)
static org.agrona.concurrent.UnsafeBuffer	createCountersValuesBuffer(java.nio.ByteBuffer buffer, org.agrona.DirectBuffer metaDataBuffer)
static org.agrona.concurrent.UnsafeBuffer	createErrorLogBuffer(java.nio.ByteBuffer buffer, org.agrona.DirectBuffer metaDataBuffer)
static org.agrona.concurrent.UnsafeBuffer	createMetaDataBuffer(java.nio.ByteBuffer buffer)
static org.agrona.concurrent.UnsafeBuffer	createToClientsBuffer(java.nio.ByteBuffer buffer, org.agrona.DirectBuffer metaDataBuffer)
static org.agrona.concurrent.UnsafeBuffer	createToDriverBuffer(java.nio.ByteBuffer buffer, org.agrona.DirectBuffer metaDataBuffer)
static int	errorLogBufferLengthOffset(int baseOffset)
static void	fillMetaData(org.agrona.concurrent.UnsafeBuffer cncMetaDataBuffer, int toDriverBufferLength, int toClientsBufferLength, int counterMetaDataBufferLength, int counterValuesBufferLength, long clientLivenessTimeout, int errorLogBufferLength, long startTimestamp, long pid)
static long	pid(org.agrona.DirectBuffer metaDataBuffer)
static int	pidOffset(int baseOffset)
static void	signalCncReady(org.agrona.concurrent.UnsafeBuffer cncMetaDataBuffer)
static long	startTimestamp(org.agrona.DirectBuffer metaDataBuffer)
static int	startTimestampOffset(int baseOffset)
static int	toClientsBufferLengthOffset(int baseOffset)
static int	toDriverBufferLengthOffset(int baseOffset)

Methods inherited from class java.lang.Object

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

Field Detail

CNC_FILE

public static final java.lang.String CNC_FILE

See Also:

Constant Field Values

CNC_VERSION

public static final int CNC_VERSION

See Also:

Constant Field Values

CNC_VERSION_FIELD_OFFSET

public static final int CNC_VERSION_FIELD_OFFSET

TO_DRIVER_BUFFER_LENGTH_FIELD_OFFSET

public static final int TO_DRIVER_BUFFER_LENGTH_FIELD_OFFSET

TO_CLIENTS_BUFFER_LENGTH_FIELD_OFFSET

public static final int TO_CLIENTS_BUFFER_LENGTH_FIELD_OFFSET

COUNTERS_METADATA_BUFFER_LENGTH_FIELD_OFFSET

public static final int COUNTERS_METADATA_BUFFER_LENGTH_FIELD_OFFSET

COUNTERS_VALUES_BUFFER_LENGTH_FIELD_OFFSET

public static final int COUNTERS_VALUES_BUFFER_LENGTH_FIELD_OFFSET

CLIENT_LIVENESS_TIMEOUT_FIELD_OFFSET

public static final int CLIENT_LIVENESS_TIMEOUT_FIELD_OFFSET

ERROR_LOG_BUFFER_LENGTH_FIELD_OFFSET

public static final int ERROR_LOG_BUFFER_LENGTH_FIELD_OFFSET

START_TIMESTAMP_FIELD_OFFSET

public static final int START_TIMESTAMP_FIELD_OFFSET

PID_FIELD_OFFSET

public static final int PID_FIELD_OFFSET

META_DATA_LENGTH

public static final int META_DATA_LENGTH

END_OF_METADATA_OFFSET

public static final int END_OF_METADATA_OFFSET

Constructor Detail

CncFileDescriptor

public CncFileDescriptor()

Method Detail

computeCncFileLength

public static int computeCncFileLength(int totalLengthOfBuffers,
                                       int alignment)

Compute the length of the cnc file and return it.

Parameters:

totalLengthOfBuffers - in bytes

alignment - for file length to adhere to

Returns:

cnc file length in bytes

cncVersionOffset

public static int cncVersionOffset(int baseOffset)

toDriverBufferLengthOffset

public static int toDriverBufferLengthOffset(int baseOffset)

toClientsBufferLengthOffset

public static int toClientsBufferLengthOffset(int baseOffset)

countersMetaDataBufferLengthOffset

public static int countersMetaDataBufferLengthOffset(int baseOffset)

countersValuesBufferLengthOffset

public static int countersValuesBufferLengthOffset(int baseOffset)

clientLivenessTimeoutOffset

public static int clientLivenessTimeoutOffset(int baseOffset)

errorLogBufferLengthOffset

public static int errorLogBufferLengthOffset(int baseOffset)

startTimestampOffset

public static int startTimestampOffset(int baseOffset)

pidOffset

public static int pidOffset(int baseOffset)

fillMetaData

public static void fillMetaData(org.agrona.concurrent.UnsafeBuffer cncMetaDataBuffer,
                                int toDriverBufferLength,
                                int toClientsBufferLength,
                                int counterMetaDataBufferLength,
                                int counterValuesBufferLength,
                                long clientLivenessTimeout,
                                int errorLogBufferLength,
                                long startTimestamp,
                                long pid)

signalCncReady

public static void signalCncReady(org.agrona.concurrent.UnsafeBuffer cncMetaDataBuffer)

createMetaDataBuffer

public static org.agrona.concurrent.UnsafeBuffer createMetaDataBuffer(java.nio.ByteBuffer buffer)

createToDriverBuffer

public static org.agrona.concurrent.UnsafeBuffer createToDriverBuffer(java.nio.ByteBuffer buffer,
                                                                      org.agrona.DirectBuffer metaDataBuffer)

createToClientsBuffer

public static org.agrona.concurrent.UnsafeBuffer createToClientsBuffer(java.nio.ByteBuffer buffer,
                                                                       org.agrona.DirectBuffer metaDataBuffer)

createCountersMetaDataBuffer

public static org.agrona.concurrent.UnsafeBuffer createCountersMetaDataBuffer(java.nio.ByteBuffer buffer,
                                                                              org.agrona.DirectBuffer metaDataBuffer)

createCountersValuesBuffer

public static org.agrona.concurrent.UnsafeBuffer createCountersValuesBuffer(java.nio.ByteBuffer buffer,
                                                                            org.agrona.DirectBuffer metaDataBuffer)

createErrorLogBuffer

public static org.agrona.concurrent.UnsafeBuffer createErrorLogBuffer(java.nio.ByteBuffer buffer,
                                                                      org.agrona.DirectBuffer metaDataBuffer)

clientLivenessTimeout

public static long clientLivenessTimeout(org.agrona.DirectBuffer metaDataBuffer)

startTimestamp

public static long startTimestamp(org.agrona.DirectBuffer metaDataBuffer)

pid

public static long pid(org.agrona.DirectBuffer metaDataBuffer)