io.aeron.command

Class RemoveMessageFlyweight

java.lang.Object

io.aeron.command.CorrelatedMessageFlyweight

io.aeron.command.RemoveMessageFlyweight

public class RemoveMessageFlyweight
extends CorrelatedMessageFlyweight

Control message for removing a Publication or Subscription.

   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                            |
  |                                                               |
  +---------------------------------------------------------------+
  |                    Command Correlation ID                     |
  |                                                               |
  +---------------------------------------------------------------+
  |                       Registration ID                         |
  |                                                               |
  +---------------------------------------------------------------+
 

Field Summary

Fields inherited from class io.aeron.command.CorrelatedMessageFlyweight

LENGTH

Constructor Summary

Constructors

Constructor and Description
RemoveMessageFlyweight()

Method Summary

Modifier and Type	Method and Description
static int	length() Length of the message in bytes.
long	registrationId() Get the registration id field.
RemoveMessageFlyweight	registrationId(long registrationId) Set registration id field.
void	validateLength(int msgTypeId, int length) Validate buffer length is long enough for message.
RemoveMessageFlyweight	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, toString, wait, wait, wait

Constructor Detail

RemoveMessageFlyweight

public RemoveMessageFlyweight()

Method Detail

wrap

public RemoveMessageFlyweight 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.

registrationId

public long registrationId()

Get the registration id field.

Returns:

registration id field.

registrationId

public RemoveMessageFlyweight registrationId(long registrationId)

Set registration id field.

Parameters:

registrationId - field value.

Returns:

this for a fluent API.

length

public static int length()

Length of the message in bytes.

Returns:

length of the message in bytes.

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.