io.aeron.command

Class PublicationBuffersReadyFlyweight

java.lang.Object

io.aeron.command.PublicationBuffersReadyFlyweight

public class PublicationBuffersReadyFlyweight
extends Object

Message to denote that new buffers have been setup for a publication.

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                        |
  |                                                               |
  +---------------------------------------------------------------+
  |                        Registration ID                        |
  |                                                               |
  +---------------------------------------------------------------+
  |                          Session ID                           |
  +---------------------------------------------------------------+
  |                           Stream ID                           |
  +---------------------------------------------------------------+
  |                  Publication Limit Counter ID                 |
  +---------------------------------------------------------------+
  |                  Channel Status Indicator ID                  |
  +---------------------------------------------------------------+
  |                        Log File Length                        |
  +---------------------------------------------------------------+
  |                     Log File Name (ASCII)                    ...
 ...                                                              |
  +---------------------------------------------------------------+
 

Constructor Summary

Constructors

Constructor and Description
PublicationBuffersReadyFlyweight()

Method Summary

Modifier and Type	Method and Description
void	appendLogFileName(Appendable appendable) Append the log file name to an Appendable.
int	channelStatusCounterId() The channel status counter id.
PublicationBuffersReadyFlyweight	channelStatusCounterId(int counterId) Set channel status counter id field.
long	correlationId() Get the correlation id field.
PublicationBuffersReadyFlyweight	correlationId(long correlationId) Set the correlation id field.
int	length() Get the length of the current message
String	logFileName() Get the log file name in ASCII.
PublicationBuffersReadyFlyweight	logFileName(String logFileName) Set the log file name in ASCII.
int	publicationLimitCounterId() The publication limit counter id.
PublicationBuffersReadyFlyweight	publicationLimitCounterId(int positionCounterId) set position counter id field.
long	registrationId() Get the registration id field.
PublicationBuffersReadyFlyweight	registrationId(long registrationId) Set the correlation id field.
int	sessionId() Get the session id field.
PublicationBuffersReadyFlyweight	sessionId(int sessionId) Set the session id field.
int	streamId() Get the stream id field.
PublicationBuffersReadyFlyweight	streamId(int streamId) Set the stream id field.
PublicationBuffersReadyFlyweight	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

Constructor Detail

PublicationBuffersReadyFlyweight

public PublicationBuffersReadyFlyweight()

Method Detail

wrap

public final PublicationBuffersReadyFlyweight 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.

correlationId

public long correlationId()

Get the correlation id field.

Returns:

correlation id field.

correlationId

public PublicationBuffersReadyFlyweight correlationId(long correlationId)

Set the correlation id field.

Parameters:

correlationId - field value.

Returns:

this for a fluent API.

registrationId

public long registrationId()

Get the registration id field.

Returns:

registration id field.

registrationId

public PublicationBuffersReadyFlyweight registrationId(long registrationId)

Set the correlation id field.

Parameters:

registrationId - field value.

Returns:

this for a fluent API.

sessionId

public int sessionId()

Get the session id field.

Returns:

session id field.

sessionId

public PublicationBuffersReadyFlyweight sessionId(int sessionId)

Set the session id field.

Parameters:

sessionId - field value.

Returns:

this for a fluent API.

streamId

public int streamId()

Get the stream id field.

Returns:

stream id field.

streamId

public PublicationBuffersReadyFlyweight streamId(int streamId)

Set the stream id field.

Parameters:

streamId - field value.

Returns:

this for a fluent API.

publicationLimitCounterId

public int publicationLimitCounterId()

The publication limit counter id.

Returns:

publication limit counter id.

publicationLimitCounterId

public PublicationBuffersReadyFlyweight publicationLimitCounterId(int positionCounterId)

set position counter id field.

Parameters:

positionCounterId - field value.

Returns:

this for a fluent API.

channelStatusCounterId

public int channelStatusCounterId()

The channel status counter id.

Returns:

channel status counter id.

channelStatusCounterId

public PublicationBuffersReadyFlyweight channelStatusCounterId(int counterId)

Set channel status counter id field.

Parameters:

counterId - field value.

Returns:

this for a fluent API.

logFileName

public String logFileName()

Get the log file name in ASCII.

Returns:

the log file name in ASCII.

appendLogFileName

public void appendLogFileName(Appendable appendable)

Append the log file name to an Appendable.

Parameters:

appendable - to append log file name to.

logFileName

public PublicationBuffersReadyFlyweight logFileName(String logFileName)

Set the log file name in ASCII.

Parameters:

logFileName - for the publication buffers.

Returns:

the log file name in ASCII.

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