io.aeron.command

Class CounterMessageFlyweight

java.lang.Object

io.aeron.command.CorrelatedMessageFlyweight

io.aeron.command.CounterMessageFlyweight

public class CounterMessageFlyweight
extends CorrelatedMessageFlyweight

Message to denote a new counter.

Note: Layout should be SBE 2.0 compliant so that the label length is aligned.

See Also:

   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
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  |                         Correlation ID                        |
  |                                                               |
  +---------------------------------------------------------------+
  |                        Counter Type ID                        |
  +---------------------------------------------------------------+
  |                           Key Length                          |
  +---------------------------------------------------------------+
  |                           Key Buffer                         ...
 ...                                                              |
  +---------------------------------------------------------------+
  |                          Label Length                         |
  +---------------------------------------------------------------+
  |                          Label (ASCII)                       ...
 ...                                                              |
  +---------------------------------------------------------------+
 

Field Summary

Fields inherited from class io.aeron.command.CorrelatedMessageFlyweight

buffer, CLIENT_ID_FIELD_OFFSET, CORRELATION_ID_FIELD_OFFSET, LENGTH, offset

Constructor Summary

Constructors

Constructor and Description
CounterMessageFlyweight()

Method Summary

Modifier and Type	Method and Description
CounterMessageFlyweight	keyBuffer(org.agrona.DirectBuffer keyBuffer, int keyOffset, int keyLength) Fill the key buffer.
int	keyBufferLength() Length of the key buffer in bytes
int	keyBufferOffset() Offset of the key buffer
CounterMessageFlyweight	label(java.lang.String label) Fill the label.
CounterMessageFlyweight	labelBuffer(org.agrona.DirectBuffer labelBuffer, int labelOffset, int labelLength) Fill the label buffer.
int	labelBufferLength() Length of label buffer in bytes.
int	labelBufferOffset() Offset of label buffer.
int	length() Get the length of the current message
int	typeId() return type id field
CounterMessageFlyweight	typeId(long typeId) set counter type id field

Methods inherited from class io.aeron.command.CorrelatedMessageFlyweight

clientId, clientId, correlationId, correlationId, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

CounterMessageFlyweight

public CounterMessageFlyweight()

Method Detail

typeId

public int typeId()

return type id field

Returns:

type id field

typeId

public CounterMessageFlyweight typeId(long typeId)

set counter type id field

Parameters:

typeId - field value

Returns:

flyweight

keyBufferOffset

public int keyBufferOffset()

Offset of the key buffer

Returns:

offset of the key buffer

keyBufferLength

public int keyBufferLength()

Length of the key buffer in bytes

Returns:

length of key buffer in bytes

keyBuffer

public CounterMessageFlyweight keyBuffer(org.agrona.DirectBuffer keyBuffer,
                                         int keyOffset,
                                         int keyLength)

Fill the key buffer.

Parameters:

keyBuffer - containing the optional key for the counter.

keyOffset - within the keyBuffer at which the key begins.

keyLength - of the key in the keyBuffer.

Returns:

flyweight

labelBufferOffset

public int labelBufferOffset()

Offset of label buffer.

Returns:

offset of label buffer

labelBufferLength

public int labelBufferLength()

Length of label buffer in bytes.

Returns:

length of label buffer in bytes

labelBuffer

public CounterMessageFlyweight labelBuffer(org.agrona.DirectBuffer labelBuffer,
                                           int labelOffset,
                                           int labelLength)

Fill the label buffer.

Parameters:

labelBuffer - containing the mandatory label for the counter.

labelOffset - within the labelBuffer at which the label begins.

labelLength - of the label in the labelBuffer.

Returns:

flyweight

label

public CounterMessageFlyweight label(java.lang.String label)

Fill the label.

Parameters:

label - for the counter

Returns:

flyweight

length

public int length()

Get the length of the current message

NB: must be called after the data is written in order to be accurate.

Returns:

the length of the current message