io.aeron.command

Class SubscriptionMessageFlyweight

java.lang.Object

io.aeron.command.CorrelatedMessageFlyweight

io.aeron.command.SubscriptionMessageFlyweight

public class SubscriptionMessageFlyweight
extends CorrelatedMessageFlyweight

Control message for adding or removing a 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 Correlation ID                   |
  |                                                               |
  +---------------------------------------------------------------+
  |                         Stream Id                             |
  +---------------------------------------------------------------+
  |                       Channel Length                          |
  +---------------------------------------------------------------+
  |                       Channel (ASCII)                        ...
 ...                                                              |
  +---------------------------------------------------------------+
 

Field Summary

Fields inherited from class io.aeron.command.CorrelatedMessageFlyweight

LENGTH

Constructor Summary

Constructors

Constructor and Description
SubscriptionMessageFlyweight()

Method Summary

Modifier and Type	Method and Description
void	appendChannel(Appendable appendable) Append the channel value to an Appendable.
String	channel() Get the channel field in ASCII.
SubscriptionMessageFlyweight	channel(String channel) Set channel field in ASCII.
static int	computeLength(int channelLength) Compute the length of the command message for a given channel length.
int	length() Length of the message in bytes.
long	registrationCorrelationId() The correlation id used in registration field.
SubscriptionMessageFlyweight	registrationCorrelationId(long correlationId) Set the registration correlation id field.
int	streamId() Get the stream id.
SubscriptionMessageFlyweight	streamId(int streamId) Set the stream id.
void	validateLength(int msgTypeId, int length) Validate buffer length is long enough for message.
SubscriptionMessageFlyweight	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

SubscriptionMessageFlyweight

public SubscriptionMessageFlyweight()

Method Detail

wrap

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

registrationCorrelationId

public long registrationCorrelationId()

The correlation id used in registration field.

Returns:

correlation id field.

registrationCorrelationId

public SubscriptionMessageFlyweight registrationCorrelationId(long correlationId)

Set the registration correlation id field.

Parameters:

correlationId - field value.

Returns:

this for a fluent API.

streamId

public int streamId()

Get the stream id.

Returns:

the stream id.

streamId

public SubscriptionMessageFlyweight streamId(int streamId)

Set the stream id.

Parameters:

streamId - the channel id.

Returns:

this for a fluent API.

channel

public String channel()

Get the channel field in ASCII.

Returns:

channel field.

appendChannel

public void appendChannel(Appendable appendable)

Append the channel value to an Appendable.

Parameters:

appendable - to append channel to.

channel

public SubscriptionMessageFlyweight channel(String channel)

Set channel field in ASCII.

Parameters:

channel - field value.

Returns:

this for a fluent API.

length

public int length()

Length of the message in bytes. Only valid after the channel is set.

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.

computeLength

public static int computeLength(int channelLength)

Compute the length of the command message for a given channel length.

Parameters:

channelLength - to be appended to the header.

Returns:

the length of the command message for a given channel length.