io.aeron.driver.status

Enum SystemCounterDescriptor

java.lang.Object

java.lang.Enum<SystemCounterDescriptor>

io.aeron.driver.status.SystemCounterDescriptor

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SystemCounterDescriptor>

public enum SystemCounterDescriptor
extends java.lang.Enum<SystemCounterDescriptor>

System wide counters for monitoring. These are separate from counters used for position tracking on streams.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BYTES_RECEIVED
BYTES_SENT
CLIENT_TIMEOUTS
CONDUCTOR_PROXY_FAILS
CONTROLLABLE_IDLE_STRATEGY
ERRORS
FLOW_CONTROL_OVER_RUNS
FLOW_CONTROL_UNDER_RUNS
FREE_FAILS
HEARTBEATS_RECEIVED
HEARTBEATS_SENT
INVALID_PACKETS
LOSS_GAP_FILLS
NAK_MESSAGES_RECEIVED
NAK_MESSAGES_SENT
POSSIBLE_TTL_ASYMMETRY
RECEIVER_PROXY_FAILS
RETRANSMITS_SENT
SENDER_FLOW_CONTROL_LIMITS
SENDER_PROXY_FAILS
SHORT_SENDS
STATUS_MESSAGES_RECEIVED
STATUS_MESSAGES_SENT
UNBLOCKED_COMMANDS
UNBLOCKED_PUBLICATIONS

Field Summary

Fields

Modifier and Type	Field and Description
static int	SYSTEM_COUNTER_TYPE_ID All system counters have the same type id, i.e.

Method Summary

Modifier and Type	Method and Description
static SystemCounterDescriptor	get(int id) Get the SystemCounterDescriptor for a given id.
int	id() The unique identity for the system counter.
java.lang.String	label() The human readable label to identify a system counter.
org.agrona.concurrent.status.AtomicCounter	newCounter(org.agrona.concurrent.status.CountersManager countersManager) Create a new counter for the enumerated descriptor.
static SystemCounterDescriptor	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SystemCounterDescriptor[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BYTES_SENT

public static final SystemCounterDescriptor BYTES_SENT

BYTES_RECEIVED

public static final SystemCounterDescriptor BYTES_RECEIVED

RECEIVER_PROXY_FAILS

public static final SystemCounterDescriptor RECEIVER_PROXY_FAILS

SENDER_PROXY_FAILS

public static final SystemCounterDescriptor SENDER_PROXY_FAILS

CONDUCTOR_PROXY_FAILS

public static final SystemCounterDescriptor CONDUCTOR_PROXY_FAILS

NAK_MESSAGES_SENT

public static final SystemCounterDescriptor NAK_MESSAGES_SENT

NAK_MESSAGES_RECEIVED

public static final SystemCounterDescriptor NAK_MESSAGES_RECEIVED

STATUS_MESSAGES_SENT

public static final SystemCounterDescriptor STATUS_MESSAGES_SENT

STATUS_MESSAGES_RECEIVED

public static final SystemCounterDescriptor STATUS_MESSAGES_RECEIVED

HEARTBEATS_SENT

public static final SystemCounterDescriptor HEARTBEATS_SENT

HEARTBEATS_RECEIVED

public static final SystemCounterDescriptor HEARTBEATS_RECEIVED

RETRANSMITS_SENT

public static final SystemCounterDescriptor RETRANSMITS_SENT

FLOW_CONTROL_UNDER_RUNS

public static final SystemCounterDescriptor FLOW_CONTROL_UNDER_RUNS

FLOW_CONTROL_OVER_RUNS

public static final SystemCounterDescriptor FLOW_CONTROL_OVER_RUNS

INVALID_PACKETS

public static final SystemCounterDescriptor INVALID_PACKETS

ERRORS

public static final SystemCounterDescriptor ERRORS

SHORT_SENDS

public static final SystemCounterDescriptor SHORT_SENDS

FREE_FAILS

public static final SystemCounterDescriptor FREE_FAILS

SENDER_FLOW_CONTROL_LIMITS

public static final SystemCounterDescriptor SENDER_FLOW_CONTROL_LIMITS

UNBLOCKED_PUBLICATIONS

public static final SystemCounterDescriptor UNBLOCKED_PUBLICATIONS

UNBLOCKED_COMMANDS

public static final SystemCounterDescriptor UNBLOCKED_COMMANDS

POSSIBLE_TTL_ASYMMETRY

public static final SystemCounterDescriptor POSSIBLE_TTL_ASYMMETRY

CONTROLLABLE_IDLE_STRATEGY

public static final SystemCounterDescriptor CONTROLLABLE_IDLE_STRATEGY

LOSS_GAP_FILLS

public static final SystemCounterDescriptor LOSS_GAP_FILLS

CLIENT_TIMEOUTS

public static final SystemCounterDescriptor CLIENT_TIMEOUTS

Field Detail

SYSTEM_COUNTER_TYPE_ID

public static final int SYSTEM_COUNTER_TYPE_ID

All system counters have the same type id, i.e. system counters are the same type. Other types can exist.

See Also:

Constant Field Values

Method Detail

values

public static SystemCounterDescriptor[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SystemCounterDescriptor c : SystemCounterDescriptor.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SystemCounterDescriptor valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

get

public static SystemCounterDescriptor get(int id)

Get the SystemCounterDescriptor for a given id.

Parameters:

id - for the descriptor.

Returns:

the descriptor if found otherwise null.

id

public int id()

The unique identity for the system counter.

Returns:

the unique identity for the system counter.

label

public java.lang.String label()

The human readable label to identify a system counter.

Returns:

the human readable label to identify a system counter.

newCounter

public org.agrona.concurrent.status.AtomicCounter newCounter(org.agrona.concurrent.status.CountersManager countersManager)

Create a new counter for the enumerated descriptor.

Parameters:

countersManager - for managing the underlying storage.

Returns:

a new counter for the enumerated descriptor.