io.aeron.command

Class ErrorResponseFlyweight

java.lang.Object

io.aeron.command.ErrorResponseFlyweight

public class ErrorResponseFlyweight
extends java.lang.Object

Control message flyweight for any errors sent from driver to clients

   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
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  |              Offending Command Correlation ID                 |
  |                                                               |
  +---------------------------------------------------------------+
  |                         Error Code                            |
  +---------------------------------------------------------------+
  |                   Error Message Length                        |
  +---------------------------------------------------------------+
  |                       Error Message                          ...
 ...                                                              |
  +---------------------------------------------------------------+
 

Constructor Summary

Constructors

Constructor and Description
ErrorResponseFlyweight()

Method Summary

Modifier and Type	Method and Description
ErrorCode	errorCode() Error code for the command.
ErrorResponseFlyweight	errorCode(ErrorCode code) Set the error code for the command.
int	errorCodeValue() Error code value for the command.
java.lang.String	errorMessage() Error message associated with the error.
ErrorResponseFlyweight	errorMessage(java.lang.String message) Set the error message
int	length() Length of the error response in bytes.
long	offendingCommandCorrelationId() Return correlation ID of the offending command.
ErrorResponseFlyweight	offendingCommandCorrelationId(long correlationId) Set correlation ID of the offending command.
ErrorResponseFlyweight	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

ErrorResponseFlyweight

public ErrorResponseFlyweight()

Method Detail

wrap

public final ErrorResponseFlyweight 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

offendingCommandCorrelationId

public long offendingCommandCorrelationId()

Return correlation ID of the offending command.

Returns:

correlation ID of the offending command

offendingCommandCorrelationId

public ErrorResponseFlyweight offendingCommandCorrelationId(long correlationId)

Set correlation ID of the offending command.

Parameters:

correlationId - of the offending command

Returns:

flyweight

errorCode

public ErrorCode errorCode()

Error code for the command.

Returns:

error code for the command

errorCodeValue

public int errorCodeValue()

Error code value for the command.

Returns:

error code value for the command

errorCode

public ErrorResponseFlyweight errorCode(ErrorCode code)

Set the error code for the command.

Parameters:

code - for the error

Returns:

flyweight

errorMessage

public java.lang.String errorMessage()

Error message associated with the error.

Returns:

error message

errorMessage

public ErrorResponseFlyweight errorMessage(java.lang.String message)

Set the error message

Parameters:

message - to associate with the error

Returns:

flyweight

length

public int length()

Length of the error response in bytes.

Returns:

length of the error response