io.aeron.samples

Class CncFileReader

java.lang.Object

io.aeron.samples.CncFileReader

All Implemented Interfaces:

AutoCloseable

public final class CncFileReader
extends Object
implements AutoCloseable

Reader for Aeron CnC file represented by CncFileDescriptor which can be used for observability.

Method Summary

Modifier and Type	Method and Description
void	close()
int	cncVersion() Get the cnc version.
CountersReader	countersReader() Get the counters reader for querying counter values.
long	driverHeartbeatAgeMs() Get the number of milliseconds since the last driver heartbeat.
long	driverHeartbeatMs() Get the epoch timestamp (ms) of the last driver heartbeat.
static CncFileReader	map() Map an existing CnC file.
String	semanticVersion() Get the cnc semantic version.

Methods inherited from class java.lang.Object

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

Method Detail

map

public static CncFileReader map()

Map an existing CnC file.

Returns:

the CncFileReader wrapper for reading useful data from the cnc file.

Throws:

AeronException - if the cnc version major version is not compatible.

cncVersion

public int cncVersion()

Get the cnc version.

Returns:

the cnc version.

semanticVersion

public String semanticVersion()

Get the cnc semantic version.

Returns:

the cnc semantic version.

countersReader

public CountersReader countersReader()

Get the counters reader for querying counter values.

Returns:

the counters reader.

driverHeartbeatMs

public long driverHeartbeatMs()

Get the epoch timestamp (ms) of the last driver heartbeat.

Returns:

the epoch timestamp (ms) of the last driver heartbeat.

driverHeartbeatAgeMs

public long driverHeartbeatAgeMs()

Get the number of milliseconds since the last driver heartbeat.

Returns:

the number of milliseconds since the last driver heartbeat.

close

public void close()

Specified by:

close in interface AutoCloseable