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

Field Summary

Fields inherited from class io.aeron.command.CorrelatedMessageFlyweight

LENGTH

Constructor Summary

Constructors

Constructor and Description
CounterMessageFlyweight()

Method Summary

Modifier and Type	Method and Description
static int	computeLength(int keyLength, int labelLength) Compute the length of the command message given key and label length.
CounterMessageFlyweight	keyBuffer(DirectBuffer keyBuffer, int keyOffset, int keyLength) Fill the key buffer.
int	keyBufferLength() Length of the key buffer in bytes.
int	keyBufferOffset() Relative offset of the key buffer.
CounterMessageFlyweight	label(String label) Fill the label.
CounterMessageFlyweight	labelBuffer(DirectBuffer labelBuffer, int labelOffset, int labelLength) Fill the label buffer.
int	labelBufferLength() Length of label buffer in bytes.
int	labelBufferOffset() Relative offset of label buffer.
int	length() Get the length of the current message.
String	toString()
int	typeId() Get type id field.
CounterMessageFlyweight	typeId(int typeId) Set counter type id field.
void	validateLength(int msgTypeId, int length) Validate buffer length is long enough for message.
CounterMessageFlyweight	wrap(MutableDirectBuffer buffer, int offset) Wrap the buffer at a given offset for updates.

Methods inherited from class io.aeron.command.CorrelatedMessageFlyweight

clientId, clientId, correlationId, correlationId

Methods inherited from class java.lang.Object

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

Constructor Detail

CounterMessageFlyweight

public CounterMessageFlyweight()

Method Detail

wrap

public CounterMessageFlyweight wrap(MutableDirectBuffer buffer,
                                    int offset)

Wrap the buffer at a given offset for updates.

Overrides:

wrap in class CorrelatedMessageFlyweight

Parameters:

buffer - to wrap.

offset - at which the message begins.

Returns:

this for a fluent API.

typeId

public int typeId()

Get type id field.

Returns:

type id field.

typeId

public CounterMessageFlyweight typeId(int typeId)

Set counter type id field.

Parameters:

typeId - field value.

Returns:

this for a fluent API.

keyBufferOffset

public int keyBufferOffset()

Relative offset of the key buffer.

Returns:

relative 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(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:

this for a fluent API.

labelBufferOffset

public int labelBufferOffset()

Relative offset of label buffer.

Returns:

relative 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(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:

this for a fluent API.

label

public CounterMessageFlyweight label(String label)

Fill the label.

Parameters:

label - for the counter.

Returns:

this for a fluent API.

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

validateLength

public void validateLength(int msgTypeId,
                           int length)

Validate buffer length is long enough for message.

Overrides:

validateLength in class CorrelatedMessageFlyweight

Parameters:

msgTypeId - type of message.

length - of message in bytes to validate.

computeLength

public static int computeLength(int keyLength,
                                int labelLength)

Compute the length of the command message given key and label length.

Parameters:

keyLength - to be appended.

labelLength - to be appended.

Returns:

the length of the command message given key and label length.

toString

public String toString()

Overrides:

toString in class Object