io.aeron.command

Class ImageBuffersReadyFlyweight

java.lang.Object

io.aeron.command.ImageBuffersReadyFlyweight

public class ImageBuffersReadyFlyweight
extends java.lang.Object

Message to denote that new buffers for a publication image are ready for a subscription.

Note: Layout should be SBE 2.0 compliant so that the source identity 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
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  |                       Correlation ID                          |
  |                                                               |
  +---------------------------------------------------------------+
  |                         Session ID                            |
  +---------------------------------------------------------------+
  |                          Stream ID                            |
  +---------------------------------------------------------------+
  |                 Subscription Registration Id                  |
  |                                                               |
  +---------------------------------------------------------------+
  |                    Subscriber Position Id                     |
  +---------------------------------------------------------------+
  |                       Log File Length                         |
  +---------------------------------------------------------------+
  |                     Log File Name (ASCII)                    ...
 ...                                                              |
  +---------------------------------------------------------------+
  |                    Source identity Length                     |
  +---------------------------------------------------------------+
  |                    Source identity (ASCII)                   ...
 ...                                                              |
  +---------------------------------------------------------------+
 

Constructor Summary

Constructors

Constructor and Description
ImageBuffersReadyFlyweight()

Method Summary

Modifier and Type	Method and Description
long	correlationId() return correlation id field
ImageBuffersReadyFlyweight	correlationId(long correlationId) set correlation id field
int	length() Get the length of the current message
java.lang.String	logFileName() Return the Log Filename in ASCII
ImageBuffersReadyFlyweight	logFileName(java.lang.String logFileName) Set the log filename in ASCII
int	sessionId() return session id field
ImageBuffersReadyFlyweight	sessionId(int sessionId) set session id field
java.lang.String	sourceIdentity() Return the source identity string in ASCII
ImageBuffersReadyFlyweight	sourceIdentity(java.lang.String value) Set the source identity string in ASCII
int	streamId() return stream id field
ImageBuffersReadyFlyweight	streamId(int streamId) set stream id field
int	subscriberPositionId() Return the position Id for the subscriber
ImageBuffersReadyFlyweight	subscriberPositionId(int id) Set the position Id for the subscriber
long	subscriptionRegistrationId() Return the registration Id for the Subscription
ImageBuffersReadyFlyweight	subscriptionRegistrationId(long id) Set the registration Id for the Subscription
ImageBuffersReadyFlyweight	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

ImageBuffersReadyFlyweight

public ImageBuffersReadyFlyweight()

Method Detail

wrap

public final ImageBuffersReadyFlyweight 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 ImageBuffersReadyFlyweight correlationId(long correlationId)

set correlation id field

Parameters:

correlationId - field value

Returns:

flyweight

sessionId

public int sessionId()

return session id field

Returns:

session id field

sessionId

public ImageBuffersReadyFlyweight sessionId(int sessionId)

set session id field

Parameters:

sessionId - field value

Returns:

flyweight

streamId

public int streamId()

return stream id field

Returns:

stream id field

streamId

public ImageBuffersReadyFlyweight streamId(int streamId)

set stream id field

Parameters:

streamId - field value

Returns:

flyweight

subscriberPositionId

public ImageBuffersReadyFlyweight subscriberPositionId(int id)

Set the position Id for the subscriber

Parameters:

id - for the subscriber position

Returns:

flyweight

subscriberPositionId

public int subscriberPositionId()

Return the position Id for the subscriber

Returns:

position Id for the subscriber

subscriptionRegistrationId

public ImageBuffersReadyFlyweight subscriptionRegistrationId(long id)

Set the registration Id for the Subscription

Parameters:

id - for the Subscription

Returns:

flyweight

subscriptionRegistrationId

public long subscriptionRegistrationId()

Return the registration Id for the Subscription

Returns:

registration Id for the Subscription

logFileName

public java.lang.String logFileName()

Return the Log Filename in ASCII

Returns:

log filename

logFileName

public ImageBuffersReadyFlyweight logFileName(java.lang.String logFileName)

Set the log filename in ASCII

Parameters:

logFileName - for the image

Returns:

flyweight

sourceIdentity

public java.lang.String sourceIdentity()

Return the source identity string in ASCII

Returns:

source identity string

sourceIdentity

public ImageBuffersReadyFlyweight sourceIdentity(java.lang.String value)

Set the source identity string in ASCII

Parameters:

value - for the source identity

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