io.aeron.archive.codecs

Class ControlResponseEncoder

java.lang.Object

io.aeron.archive.codecs.ControlResponseEncoder

public final class ControlResponseEncoder
extends Object

Generic response to a control request. Error message will be empty if code is OK.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BLOCK_LENGTH
static ByteOrder	BYTE_ORDER
static int	SCHEMA_ID
static int	SCHEMA_VERSION
static int	TEMPLATE_ID

Constructor Summary

Constructors

Constructor and Description
ControlResponseEncoder()

Method Summary

Modifier and Type	Method and Description
StringBuilder	appendTo(StringBuilder builder)
MutableDirectBuffer	buffer()
ControlResponseEncoder	code(ControlResponseCode value)
static int	codeEncodingLength()
static int	codeEncodingOffset()
static int	codeId()
static String	codeMetaAttribute(MetaAttribute metaAttribute)
static int	codeSinceVersion()
ControlResponseEncoder	controlSessionId(long value)
static int	controlSessionIdEncodingLength()
static int	controlSessionIdEncodingOffset()
static int	controlSessionIdId()
static long	controlSessionIdMaxValue()
static String	controlSessionIdMetaAttribute(MetaAttribute metaAttribute)
static long	controlSessionIdMinValue()
static long	controlSessionIdNullValue()
static int	controlSessionIdSinceVersion()
ControlResponseEncoder	correlationId(long value)
static int	correlationIdEncodingLength()
static int	correlationIdEncodingOffset()
static int	correlationIdId()
static long	correlationIdMaxValue()
static String	correlationIdMetaAttribute(MetaAttribute metaAttribute)
static long	correlationIdMinValue()
static long	correlationIdNullValue()
static int	correlationIdSinceVersion()
int	encodedLength()
ControlResponseEncoder	errorMessage(CharSequence value)
ControlResponseEncoder	errorMessage(String value)
static String	errorMessageCharacterEncoding()
static int	errorMessageHeaderLength()
static int	errorMessageId()
static String	errorMessageMetaAttribute(MetaAttribute metaAttribute)
int	initialOffset()
int	limit()
void	limit(int limit)
int	offset()
ControlResponseEncoder	putErrorMessage(byte[] src, int srcOffset, int length)
ControlResponseEncoder	putErrorMessage(DirectBuffer src, int srcOffset, int length)
ControlResponseEncoder	relevantId(long value)
static int	relevantIdEncodingLength()
static int	relevantIdEncodingOffset()
static int	relevantIdId()
static long	relevantIdMaxValue()
static String	relevantIdMetaAttribute(MetaAttribute metaAttribute)
static long	relevantIdMinValue()
static long	relevantIdNullValue()
static int	relevantIdSinceVersion()
int	sbeBlockLength()
int	sbeSchemaId()
int	sbeSchemaVersion()
String	sbeSemanticType()
int	sbeTemplateId()
String	toString()
ControlResponseEncoder	version(int value)
static int	versionEncodingLength()
static int	versionEncodingOffset()
static int	versionId()
static int	versionMaxValue()
static String	versionMetaAttribute(MetaAttribute metaAttribute)
static int	versionMinValue()
static int	versionNullValue()
static int	versionSinceVersion()
ControlResponseEncoder	wrap(MutableDirectBuffer buffer, int offset)
ControlResponseEncoder	wrapAndApplyHeader(MutableDirectBuffer buffer, int offset, MessageHeaderEncoder headerEncoder)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BLOCK_LENGTH

public static final int BLOCK_LENGTH

See Also:

Constant Field Values

TEMPLATE_ID

public static final int TEMPLATE_ID

See Also:

Constant Field Values

SCHEMA_ID

public static final int SCHEMA_ID

See Also:

Constant Field Values

SCHEMA_VERSION

public static final int SCHEMA_VERSION

See Also:

Constant Field Values

BYTE_ORDER

public static final ByteOrder BYTE_ORDER

Constructor Detail

ControlResponseEncoder

public ControlResponseEncoder()

Method Detail

sbeBlockLength

public int sbeBlockLength()

sbeTemplateId

public int sbeTemplateId()

sbeSchemaId

public int sbeSchemaId()

sbeSchemaVersion

public int sbeSchemaVersion()

sbeSemanticType

public String sbeSemanticType()

buffer

public MutableDirectBuffer buffer()

initialOffset

public int initialOffset()

offset

public int offset()

wrap

public ControlResponseEncoder wrap(MutableDirectBuffer buffer,
                                   int offset)

wrapAndApplyHeader

public ControlResponseEncoder wrapAndApplyHeader(MutableDirectBuffer buffer,
                                                 int offset,
                                                 MessageHeaderEncoder headerEncoder)

encodedLength

public int encodedLength()

limit

public int limit()

limit

public void limit(int limit)

controlSessionIdId

public static int controlSessionIdId()

controlSessionIdSinceVersion

public static int controlSessionIdSinceVersion()

controlSessionIdEncodingOffset

public static int controlSessionIdEncodingOffset()

controlSessionIdEncodingLength

public static int controlSessionIdEncodingLength()

controlSessionIdMetaAttribute

public static String controlSessionIdMetaAttribute(MetaAttribute metaAttribute)

controlSessionIdNullValue

public static long controlSessionIdNullValue()

controlSessionIdMinValue

public static long controlSessionIdMinValue()

controlSessionIdMaxValue

public static long controlSessionIdMaxValue()

controlSessionId

public ControlResponseEncoder controlSessionId(long value)

correlationIdId

public static int correlationIdId()

correlationIdSinceVersion

public static int correlationIdSinceVersion()

correlationIdEncodingOffset

public static int correlationIdEncodingOffset()

correlationIdEncodingLength

public static int correlationIdEncodingLength()

correlationIdMetaAttribute

public static String correlationIdMetaAttribute(MetaAttribute metaAttribute)

correlationIdNullValue

public static long correlationIdNullValue()

correlationIdMinValue

public static long correlationIdMinValue()

correlationIdMaxValue

public static long correlationIdMaxValue()

correlationId

public ControlResponseEncoder correlationId(long value)

relevantIdId

public static int relevantIdId()

relevantIdSinceVersion

public static int relevantIdSinceVersion()

relevantIdEncodingOffset

public static int relevantIdEncodingOffset()

relevantIdEncodingLength

public static int relevantIdEncodingLength()

relevantIdMetaAttribute

public static String relevantIdMetaAttribute(MetaAttribute metaAttribute)

relevantIdNullValue

public static long relevantIdNullValue()

relevantIdMinValue

public static long relevantIdMinValue()

relevantIdMaxValue

public static long relevantIdMaxValue()

relevantId

public ControlResponseEncoder relevantId(long value)

codeId

public static int codeId()

codeSinceVersion

public static int codeSinceVersion()

codeEncodingOffset

public static int codeEncodingOffset()

codeEncodingLength

public static int codeEncodingLength()

codeMetaAttribute

public static String codeMetaAttribute(MetaAttribute metaAttribute)

code

public ControlResponseEncoder code(ControlResponseCode value)

versionId

public static int versionId()

versionSinceVersion

public static int versionSinceVersion()

versionEncodingOffset

public static int versionEncodingOffset()

versionEncodingLength

public static int versionEncodingLength()

versionMetaAttribute

public static String versionMetaAttribute(MetaAttribute metaAttribute)

versionNullValue

public static int versionNullValue()

versionMinValue

public static int versionMinValue()

versionMaxValue

public static int versionMaxValue()

version

public ControlResponseEncoder version(int value)

errorMessageId

public static int errorMessageId()

errorMessageCharacterEncoding

public static String errorMessageCharacterEncoding()

errorMessageMetaAttribute

public static String errorMessageMetaAttribute(MetaAttribute metaAttribute)

errorMessageHeaderLength

public static int errorMessageHeaderLength()

putErrorMessage

public ControlResponseEncoder putErrorMessage(DirectBuffer src,
                                              int srcOffset,
                                              int length)

putErrorMessage

public ControlResponseEncoder putErrorMessage(byte[] src,
                                              int srcOffset,
                                              int length)

errorMessage

public ControlResponseEncoder errorMessage(String value)

errorMessage

public ControlResponseEncoder errorMessage(CharSequence value)

toString

public String toString()

Overrides:

toString in class Object

appendTo

public StringBuilder appendTo(StringBuilder builder)