io.aeron.command

Class CorrelatedMessageFlyweight

java.lang.Object

io.aeron.command.CorrelatedMessageFlyweight

Direct Known Subclasses:

CounterMessageFlyweight, DestinationMessageFlyweight, PublicationMessageFlyweight, RemoveMessageFlyweight, SubscriptionMessageFlyweight, TerminateDriverFlyweight

public class CorrelatedMessageFlyweight
extends Object

Base flyweight that can be extended to track a client request.

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 | | | +---------------------------------------------------------------+

Field Summary

Fields

Modifier and Type	Field and Description
static int	LENGTH Length of the header.

Constructor Summary

Constructors

Constructor and Description
CorrelatedMessageFlyweight()

Method Summary

Modifier and Type	Method and Description
long	clientId() Get client id field.
CorrelatedMessageFlyweight	clientId(long clientId) set client id field
long	correlationId() Get correlation id field.
CorrelatedMessageFlyweight	correlationId(long correlationId) Set correlation id field.
void	validateLength(int msgTypeId, int length) Validate buffer length is long enough for message.
CorrelatedMessageFlyweight	wrap(MutableDirectBuffer buffer, int offset) Wrap the buffer at a given offset for updates.

Methods inherited from class java.lang.Object

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

Field Detail

LENGTH

public static final int LENGTH

Length of the header.

See Also:

Constant Field Values

Constructor Detail

CorrelatedMessageFlyweight

public CorrelatedMessageFlyweight()

Method Detail

wrap

public CorrelatedMessageFlyweight wrap(MutableDirectBuffer buffer,
                                       int offset)

Wrap the buffer at a given offset for updates.

Parameters:

buffer - to wrap.

offset - at which the message begins.

Returns:

this for a fluent API.

clientId

public long clientId()

Get client id field.

Returns:

client id field.

clientId

public CorrelatedMessageFlyweight clientId(long clientId)

set client id field

Parameters:

clientId - field value

Returns:

this for a fluent API.

correlationId

public long correlationId()

Get correlation id field.

Returns:

correlation id field.

correlationId

public CorrelatedMessageFlyweight correlationId(long correlationId)

Set correlation id field.

Parameters:

correlationId - field value.

Returns:

this for a fluent API.

validateLength

public void validateLength(int msgTypeId,
                           int length)

Validate buffer length is long enough for message.

Parameters:

msgTypeId - type of message.

length - of message in bytes to validate.