io.aeron.command

Class ImageMessageFlyweight

java.lang.Object

io.aeron.command.ImageMessageFlyweight

public class ImageMessageFlyweight
extends java.lang.Object

Control message flyweight for any message that needs to represent a connection

   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                         |
  |                                                               |
  +---------------------------------------------------------------+
  |                 Subscription Registration ID                  |
  |                                                               |
  +---------------------------------------------------------------+
  |                          Stream ID                            |
  +---------------------------------------------------------------+
  |                       Channel Length                          |
  +---------------------------------------------------------------+
  |                       Channel (ASCII)                        ...
 ...                                                              |
  +---------------------------------------------------------------+
 

Constructor Summary

Constructors

Constructor and Description
ImageMessageFlyweight()

Method Summary

Modifier and Type	Method and Description
java.lang.String	channel() Get the channel field as ASCII
ImageMessageFlyweight	channel(java.lang.String channel) Set the channel field as ASCII
long	correlationId() return correlation id field
ImageMessageFlyweight	correlationId(long correlationId) set correlation id field
int	length() Get the length of the current message
int	streamId() return stream id field
ImageMessageFlyweight	streamId(int streamId) set stream id field
long	subscriptionRegistrationId() Registration ID for the subscription.
ImageMessageFlyweight	subscriptionRegistrationId(long registrationId) Set the tegistration ID for the subscription.
ImageMessageFlyweight	wrap(org.agrona.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

Constructor Detail

ImageMessageFlyweight

public ImageMessageFlyweight()

Method Detail

wrap

public final ImageMessageFlyweight wrap(org.agrona.MutableDirectBuffer buffer,
                                        int offset)

Wrap the buffer at a given offset for updates.

Parameters:

buffer - to wrap

offset - at which the message begins.

Returns:

for fluent API

correlationId

public long correlationId()

return correlation id field

Returns:

correlation id field

correlationId

public ImageMessageFlyweight correlationId(long correlationId)

set correlation id field

Parameters:

correlationId - field value

Returns:

flyweight

subscriptionRegistrationId

public long subscriptionRegistrationId()

Registration ID for the subscription.

Returns:

registration ID for the subscription.

subscriptionRegistrationId

public ImageMessageFlyweight subscriptionRegistrationId(long registrationId)

Set the tegistration ID for the subscription.

Parameters:

registrationId - for the subscription

Returns:

flyweight

streamId

public int streamId()

return stream id field

Returns:

stream id field

streamId

public ImageMessageFlyweight streamId(int streamId)

set stream id field

Parameters:

streamId - field value

Returns:

flyweight

channel

public java.lang.String channel()

Get the channel field as ASCII

Returns:

channel field

channel

public ImageMessageFlyweight channel(java.lang.String channel)

Set the channel field as ASCII

Parameters:

channel - field value

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