org.tools4j.elara.plugin.metrics

Enum MetricsDescriptor

java.lang.Object

java.lang.Enum<MetricsDescriptor>

org.tools4j.elara.plugin.metrics.MetricsDescriptor

All Implemented Interfaces:

Serializable, Comparable<MetricsDescriptor>

public enum MetricsDescriptor
extends Enum<MetricsDescriptor>

Descriptor of frame layout for time and frequency counter metrics.

                           Time metrics frame

     0         1         2         3         4         5         6
     0 2 4 6 8 0 2 4 6 8 0 2 4 6 8 0 2 4 6 8 0 2 4 6 8 0 2 4 6 8 0 2 4
     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     |Version| Flags |     Index     |            Source             |
     +-------+-------+-------+-------+-------+-------+-------+-------+
     |                           Sequence                            |
     +-------+-------+-------+-------+-------+-------+-------+-------+
     |                             Time                              |
     +-------+-------+-------+-------+-------+-------+-------+-------+
     |                            Time 0                             |
     |                            Time 1                             |
     |                             ...                               |


                     Frequency counter metrics frame

     0         1         2         3         4         5         6
     0 2 4 6 8 0 2 4 6 8 0 2 4 6 8 0 2 4 6 8 0 2 4 6 8 0 2 4 6 8 0 2 4
     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     |Version|Flags=0|    Choice     |          Repetition           |
     +-------+-------+-------+-------+-------+-------+-------+-------+
     |                           Interval                            |
     +-------+-------+-------+-------+-------+-------+-------+-------+
     |                             Time                              |
     +-------+-------+-------+-------+-------+-------+-------+-------+
     |                            Count 0                            |
     |                            Count 1                            |
     |                             ...                               |

 

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHOICE_LENGTH
static int	CHOICE_OFFSET
static int	FLAGS_LENGTH
static int	FLAGS_OFFSET
static int	HEADER_LENGTH
static int	HEADER_OFFSET
static int	INDEX_LENGTH
static int	INDEX_OFFSET
static int	INTERVAL_LENGTH
static int	INTERVAL_OFFSET
static int	PAYLOAD_OFFSET
static int	REPETITION_LENGTH
static int	REPETITION_OFFSET
static int	SEQUENCE_LENGTH
static int	SEQUENCE_OFFSET
static int	SOURCE_LENGTH
static int	SOURCE_OFFSET
static int	TIME_LENGTH
static int	TIME_OFFSET
static byte	VERSION
static int	VERSION_LENGTH
static int	VERSION_OFFSET

Method Summary

Modifier and Type	Method and Description
static short	choice(DirectBuffer buffer)
static long	counter(int index, DirectBuffer buffer)
static byte	flags(DirectBuffer buffer)
static short	index(DirectBuffer buffer)
static long	interval(DirectBuffer buffer)
static boolean	isFrequencyMetrics(DirectBuffer buffer)
static boolean	isTimeMetrics(DirectBuffer buffer)
static int	repetition(DirectBuffer buffer)
static long	sequence(DirectBuffer buffer)
static int	source(DirectBuffer buffer)
static long	time(DirectBuffer buffer)
static long	time(int index, DirectBuffer buffer)
static MetricsDescriptor	valueOf(String name) Returns the enum constant of this type with the specified name.
static MetricsDescriptor[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
static byte	version(DirectBuffer buffer)

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

Field Detail

VERSION

public static final byte VERSION

See Also:

Constant Field Values

VERSION_OFFSET

public static final int VERSION_OFFSET

See Also:

Constant Field Values

VERSION_LENGTH

public static final int VERSION_LENGTH

See Also:

Constant Field Values

FLAGS_OFFSET

public static final int FLAGS_OFFSET

See Also:

Constant Field Values

FLAGS_LENGTH

public static final int FLAGS_LENGTH

See Also:

Constant Field Values

INDEX_OFFSET

public static final int INDEX_OFFSET

See Also:

Constant Field Values

INDEX_LENGTH

public static final int INDEX_LENGTH

See Also:

Constant Field Values

SOURCE_OFFSET

public static final int SOURCE_OFFSET

See Also:

Constant Field Values

SOURCE_LENGTH

public static final int SOURCE_LENGTH

See Also:

Constant Field Values

SEQUENCE_OFFSET

public static final int SEQUENCE_OFFSET

See Also:

Constant Field Values

SEQUENCE_LENGTH

public static final int SEQUENCE_LENGTH

See Also:

Constant Field Values

TIME_OFFSET

public static final int TIME_OFFSET

See Also:

Constant Field Values

TIME_LENGTH

public static final int TIME_LENGTH

See Also:

Constant Field Values

CHOICE_OFFSET

public static final int CHOICE_OFFSET

See Also:

Constant Field Values

CHOICE_LENGTH

public static final int CHOICE_LENGTH

See Also:

Constant Field Values

REPETITION_OFFSET

public static final int REPETITION_OFFSET

See Also:

Constant Field Values

REPETITION_LENGTH

public static final int REPETITION_LENGTH

See Also:

Constant Field Values

INTERVAL_OFFSET

public static final int INTERVAL_OFFSET

See Also:

Constant Field Values

INTERVAL_LENGTH

public static final int INTERVAL_LENGTH

See Also:

Constant Field Values

HEADER_OFFSET

public static final int HEADER_OFFSET

See Also:

Constant Field Values

HEADER_LENGTH

public static final int HEADER_LENGTH

See Also:

Constant Field Values

PAYLOAD_OFFSET

public static final int PAYLOAD_OFFSET

See Also:

Constant Field Values

Method Detail

values

public static MetricsDescriptor[] 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 (MetricsDescriptor c : MetricsDescriptor.values())
    System.out.println(c);

Returns:

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

valueOf

public static MetricsDescriptor valueOf(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:

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

NullPointerException - if the argument is null

version

public static byte version(DirectBuffer buffer)

flags

public static byte flags(DirectBuffer buffer)

isTimeMetrics

public static boolean isTimeMetrics(DirectBuffer buffer)

isFrequencyMetrics

public static boolean isFrequencyMetrics(DirectBuffer buffer)

index

public static short index(DirectBuffer buffer)

source

public static int source(DirectBuffer buffer)

sequence

public static long sequence(DirectBuffer buffer)

time

public static long time(DirectBuffer buffer)

choice

public static short choice(DirectBuffer buffer)

repetition

public static int repetition(DirectBuffer buffer)

interval

public static long interval(DirectBuffer buffer)

time

public static long time(int index,
                        DirectBuffer buffer)

counter

public static long counter(int index,
                           DirectBuffer buffer)