AdminResponseDecoder (Aeron Message Transport)

java.lang.Object
- io.aeron.cluster.codecs.AdminResponseDecoder

public final class AdminResponseDecoder
extends Object

Response to the admin request.

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

AdminResponseDecoder()

Constructors
Constructor and Description
`AdminResponseDecoder()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`actingVersion()`
`StringBuilder`	`appendTo(StringBuilder builder)`
`DirectBuffer`	`buffer()`
`long`	`clusterSessionId()`
`static int`	`clusterSessionIdEncodingLength()`
`static int`	`clusterSessionIdEncodingOffset()`
`static int`	`clusterSessionIdId()`
`static long`	`clusterSessionIdMaxValue()`
`static String`	`clusterSessionIdMetaAttribute(MetaAttribute metaAttribute)`
`static long`	`clusterSessionIdMinValue()`
`static long`	`clusterSessionIdNullValue()`
`static int`	`clusterSessionIdSinceVersion()`
`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()`
`int`	`getMessage(Appendable appendable)`
`int`	`getMessage(byte[] dst, int dstOffset, int length)`
`int`	`getMessage(MutableDirectBuffer dst, int dstOffset, int length)`
`int`	`getPayload(byte[] dst, int dstOffset, int length)`
`int`	`getPayload(MutableDirectBuffer dst, int dstOffset, int length)`
`int`	`initialOffset()`
`int`	`limit()`
`void`	`limit(int limit)`
`String`	`message()`
`static String`	`messageCharacterEncoding()`
`static int`	`messageHeaderLength()`
`static int`	`messageId()`
`int`	`messageLength()`
`static String`	`messageMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`messageSinceVersion()`
`int`	`offset()`
`static int`	`payloadHeaderLength()`
`static int`	`payloadId()`
`int`	`payloadLength()`
`static String`	`payloadMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`payloadSinceVersion()`
`AdminRequestType`	`requestType()`
`static int`	`requestTypeEncodingLength()`
`static int`	`requestTypeEncodingOffset()`
`static int`	`requestTypeId()`
`static String`	`requestTypeMetaAttribute(MetaAttribute metaAttribute)`
`int`	`requestTypeRaw()`
`static int`	`requestTypeSinceVersion()`
`AdminResponseCode`	`responseCode()`
`static int`	`responseCodeEncodingLength()`
`static int`	`responseCodeEncodingOffset()`
`static int`	`responseCodeId()`
`static String`	`responseCodeMetaAttribute(MetaAttribute metaAttribute)`
`int`	`responseCodeRaw()`
`static int`	`responseCodeSinceVersion()`
`int`	`sbeBlockLength()`
`int`	`sbeDecodedLength()`
`AdminResponseDecoder`	`sbeRewind()`
`int`	`sbeSchemaId()`
`int`	`sbeSchemaVersion()`
`String`	`sbeSemanticType()`
`AdminResponseDecoder`	`sbeSkip()`
`int`	`sbeTemplateId()`
`int`	`skipMessage()`
`int`	`skipPayload()`
`String`	`toString()`
`AdminResponseDecoder`	`wrap(DirectBuffer buffer, int offset, int actingBlockLength, int actingVersion)`
`AdminResponseDecoder`	`wrapAndApplyHeader(DirectBuffer buffer, int offset, MessageHeaderDecoder headerDecoder)`
`void`	`wrapMessage(DirectBuffer wrapBuffer)`
`void`	`wrapPayload(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
- AdminResponseDecoder
```
public AdminResponseDecoder()
```

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 AdminResponseDecoder wrap(DirectBuffer buffer,
                                 int offset,
                                 int actingBlockLength,
                                 int actingVersion)

wrapAndApplyHeader

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

sbeRewind

public AdminResponseDecoder sbeRewind()

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

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

encodedLength
```
public int encodedLength()
```

limit
```
public int limit()
```

limit
```
public void limit(int limit)
```

clusterSessionIdId

public static int clusterSessionIdId()

clusterSessionIdSinceVersion

public static int clusterSessionIdSinceVersion()

clusterSessionIdEncodingOffset

public static int clusterSessionIdEncodingOffset()

clusterSessionIdEncodingLength

public static int clusterSessionIdEncodingLength()

clusterSessionIdMetaAttribute

public static String clusterSessionIdMetaAttribute(MetaAttribute metaAttribute)

clusterSessionIdNullValue

public static long clusterSessionIdNullValue()

clusterSessionIdMinValue

public static long clusterSessionIdMinValue()

clusterSessionIdMaxValue

public static long clusterSessionIdMaxValue()

clusterSessionId
```
public long clusterSessionId()
```

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

requestTypeId
```
public static int requestTypeId()
```

requestTypeSinceVersion

public static int requestTypeSinceVersion()

requestTypeEncodingOffset

public static int requestTypeEncodingOffset()

requestTypeEncodingLength

public static int requestTypeEncodingLength()

requestTypeMetaAttribute

public static String requestTypeMetaAttribute(MetaAttribute metaAttribute)

requestTypeRaw
```
public int requestTypeRaw()
```

requestType
```
public AdminRequestType requestType()
```

responseCodeId
```
public static int responseCodeId()
```

responseCodeSinceVersion

public static int responseCodeSinceVersion()

responseCodeEncodingOffset

public static int responseCodeEncodingOffset()

responseCodeEncodingLength

public static int responseCodeEncodingLength()

responseCodeMetaAttribute

public static String responseCodeMetaAttribute(MetaAttribute metaAttribute)

responseCodeRaw
```
public int responseCodeRaw()
```

responseCode

public AdminResponseCode responseCode()

messageId
```
public static int messageId()
```

messageSinceVersion

public static int messageSinceVersion()

messageCharacterEncoding

public static String messageCharacterEncoding()

messageMetaAttribute

public static String messageMetaAttribute(MetaAttribute metaAttribute)

messageHeaderLength

public static int messageHeaderLength()

messageLength
```
public int messageLength()
```

skipMessage
```
public int skipMessage()
```

getMessage

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

getMessage

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

wrapMessage

public void wrapMessage(DirectBuffer wrapBuffer)

message
```
public String message()
```

getMessage

public int getMessage(Appendable appendable)

payloadId
```
public static int payloadId()
```

payloadSinceVersion

public static int payloadSinceVersion()

payloadMetaAttribute

public static String payloadMetaAttribute(MetaAttribute metaAttribute)

payloadHeaderLength

public static int payloadHeaderLength()

payloadLength
```
public int payloadLength()
```

skipPayload
```
public int skipPayload()
```

getPayload

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

getPayload

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

wrapPayload

public void wrapPayload(DirectBuffer wrapBuffer)

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

toString in class Object

appendTo

public StringBuilder appendTo(StringBuilder builder)

sbeSkip
```
public AdminResponseDecoder sbeSkip()
```

Class AdminResponseDecoder

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

AdminResponseDecoder

Method Detail

sbeBlockLength

sbeTemplateId

sbeSchemaId

sbeSchemaVersion

sbeSemanticType

buffer

initialOffset

offset

wrap

wrapAndApplyHeader

sbeRewind

sbeDecodedLength

actingVersion

encodedLength

limit

limit

clusterSessionIdId

clusterSessionIdSinceVersion

clusterSessionIdEncodingOffset

clusterSessionIdEncodingLength

clusterSessionIdMetaAttribute

clusterSessionIdNullValue

clusterSessionIdMinValue

clusterSessionIdMaxValue

clusterSessionId

correlationIdId

correlationIdSinceVersion

correlationIdEncodingOffset

correlationIdEncodingLength

correlationIdMetaAttribute

correlationIdNullValue

correlationIdMinValue

correlationIdMaxValue

correlationId

requestTypeId

requestTypeSinceVersion

requestTypeEncodingOffset

requestTypeEncodingLength

requestTypeMetaAttribute

requestTypeRaw

requestType

responseCodeId

responseCodeSinceVersion

responseCodeEncodingOffset

responseCodeEncodingLength

responseCodeMetaAttribute

responseCodeRaw

responseCode

messageId

messageSinceVersion

messageCharacterEncoding

messageMetaAttribute

messageHeaderLength

messageLength

skipMessage

getMessage

getMessage

wrapMessage

message

getMessage

payloadId

payloadSinceVersion

payloadMetaAttribute

payloadHeaderLength

payloadLength