ControlResponseDecoder (Aeron Message Transport)

java.lang.Object
- io.aeron.archive.codecs.ControlResponseDecoder

```
public final class ControlResponseDecoder
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 String`	`SEMANTIC_VERSION`
`static int`	`TEMPLATE_ID`

Constructor Summary

Constructors
Constructor and Description

ControlResponseDecoder()

Constructors
Constructor and Description
`ControlResponseDecoder()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`actingVersion()`
`StringBuilder`	`appendTo(StringBuilder builder)`
`DirectBuffer`	`buffer()`
`ControlResponseCode`	`code()`
`static int`	`codeEncodingLength()`
`static int`	`codeEncodingOffset()`
`static int`	`codeId()`
`static String`	`codeMetaAttribute(MetaAttribute metaAttribute)`
`int`	`codeRaw()`
`static int`	`codeSinceVersion()`
`long`	`controlSessionId()`
`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()`
`long`	`correlationId()`
`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()`
`String`	`errorMessage()`
`static String`	`errorMessageCharacterEncoding()`
`static int`	`errorMessageHeaderLength()`
`static int`	`errorMessageId()`
`int`	`errorMessageLength()`
`static String`	`errorMessageMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`errorMessageSinceVersion()`
`int`	`getErrorMessage(Appendable appendable)`
`int`	`getErrorMessage(byte[] dst, int dstOffset, int length)`
`int`	`getErrorMessage(MutableDirectBuffer dst, int dstOffset, int length)`
`int`	`initialOffset()`
`int`	`limit()`
`void`	`limit(int limit)`
`int`	`offset()`
`long`	`relevantId()`
`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`	`sbeDecodedLength()`
`ControlResponseDecoder`	`sbeRewind()`
`int`	`sbeSchemaId()`
`int`	`sbeSchemaVersion()`
`String`	`sbeSemanticType()`
`ControlResponseDecoder`	`sbeSkip()`
`int`	`sbeTemplateId()`
`int`	`skipErrorMessage()`
`String`	`toString()`
`int`	`version()`
`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()`
`ControlResponseDecoder`	`wrap(DirectBuffer buffer, int offset, int actingBlockLength, int actingVersion)`
`ControlResponseDecoder`	`wrapAndApplyHeader(DirectBuffer buffer, int offset, MessageHeaderDecoder headerDecoder)`
`void`	`wrapErrorMessage(DirectBuffer wrapBuffer)`

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

SEMANTIC_VERSION

public static final String SEMANTIC_VERSION

See Also:: Constant Field Values

BYTE_ORDER

public static final ByteOrder BYTE_ORDER

Constructor Detail
- ControlResponseDecoder
```
public ControlResponseDecoder()
```

Method Detail

sbeBlockLength
```
public int sbeBlockLength()
```

sbeTemplateId
```
public int sbeTemplateId()
```

sbeSchemaId
```
public int sbeSchemaId()
```

sbeSchemaVersion
```
public int sbeSchemaVersion()
```

sbeSemanticType
```
public String sbeSemanticType()
```

buffer
```
public DirectBuffer buffer()
```

initialOffset
```
public int initialOffset()
```

offset
```
public int offset()
```

wrap

public ControlResponseDecoder wrap(DirectBuffer buffer,
                                   int offset,
                                   int actingBlockLength,
                                   int actingVersion)

wrapAndApplyHeader

public ControlResponseDecoder wrapAndApplyHeader(DirectBuffer buffer,
                                                 int offset,
                                                 MessageHeaderDecoder headerDecoder)

sbeRewind

public ControlResponseDecoder sbeRewind()

sbeDecodedLength
```
public int sbeDecodedLength()
```

actingVersion
```
public int actingVersion()
```

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 long controlSessionId()
```

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 long correlationId()
```

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 long relevantId()
```

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)

codeRaw
```
public int codeRaw()
```

code
```
public ControlResponseCode code()
```

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 int version()
```

errorMessageId
```
public static int errorMessageId()
```

errorMessageSinceVersion

public static int errorMessageSinceVersion()

errorMessageCharacterEncoding

public static String errorMessageCharacterEncoding()

errorMessageMetaAttribute

public static String errorMessageMetaAttribute(MetaAttribute metaAttribute)

errorMessageHeaderLength

public static int errorMessageHeaderLength()

errorMessageLength
```
public int errorMessageLength()
```

skipErrorMessage
```
public int skipErrorMessage()
```

getErrorMessage

public int getErrorMessage(MutableDirectBuffer dst,
                           int dstOffset,
                           int length)

getErrorMessage

public int getErrorMessage(byte[] dst,
                           int dstOffset,
                           int length)

wrapErrorMessage

public void wrapErrorMessage(DirectBuffer wrapBuffer)

errorMessage
```
public String errorMessage()
```

getErrorMessage

public int getErrorMessage(Appendable appendable)

toString
```
public String toString()
```
Overrides:

toString in class Object

appendTo

public StringBuilder appendTo(StringBuilder builder)

sbeSkip

public ControlResponseDecoder sbeSkip()

Class ControlResponseDecoder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BLOCK_LENGTH

TEMPLATE_ID

SCHEMA_ID

SCHEMA_VERSION

SEMANTIC_VERSION

BYTE_ORDER

Constructor Detail

ControlResponseDecoder

Method Detail

sbeBlockLength

sbeTemplateId

sbeSchemaId

sbeSchemaVersion

sbeSemanticType

buffer

initialOffset

offset

wrap

wrapAndApplyHeader

sbeRewind

sbeDecodedLength

actingVersion

encodedLength

limit

limit

controlSessionIdId

controlSessionIdSinceVersion

controlSessionIdEncodingOffset

controlSessionIdEncodingLength

controlSessionIdMetaAttribute

controlSessionIdNullValue

controlSessionIdMinValue

controlSessionIdMaxValue

controlSessionId

correlationIdId

correlationIdSinceVersion

correlationIdEncodingOffset

correlationIdEncodingLength

correlationIdMetaAttribute

correlationIdNullValue

correlationIdMinValue

correlationIdMaxValue

correlationId

relevantIdId

relevantIdSinceVersion

relevantIdEncodingOffset

relevantIdEncodingLength

relevantIdMetaAttribute

relevantIdNullValue

relevantIdMinValue

relevantIdMaxValue

relevantId

codeId

codeSinceVersion

codeEncodingOffset

codeEncodingLength

codeMetaAttribute

codeRaw

code

versionId

versionSinceVersion

versionEncodingOffset

versionEncodingLength

versionMetaAttribute

versionNullValue

versionMinValue

versionMaxValue

version

errorMessageId

errorMessageSinceVersion

errorMessageCharacterEncoding

errorMessageMetaAttribute

errorMessageHeaderLength

errorMessageLength