JoinLogDecoder (Aeron Message Transport)

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

```
public final class JoinLogDecoder
extends Object
```
Consensus Module instructing a service to join a log.

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

JoinLogDecoder()

Constructors
Constructor and Description
`JoinLogDecoder()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`actingVersion()`
`StringBuilder`	`appendTo(StringBuilder builder)`
`DirectBuffer`	`buffer()`
`int`	`encodedLength()`
`int`	`getLogChannel(Appendable appendable)`
`int`	`getLogChannel(byte[] dst, int dstOffset, int length)`
`int`	`getLogChannel(MutableDirectBuffer dst, int dstOffset, int length)`
`int`	`initialOffset()`
`BooleanType`	`isStartup()`
`static int`	`isStartupEncodingLength()`
`static int`	`isStartupEncodingOffset()`
`static int`	`isStartupId()`
`static String`	`isStartupMetaAttribute(MetaAttribute metaAttribute)`
`int`	`isStartupRaw()`
`static int`	`isStartupSinceVersion()`
`int`	`limit()`
`void`	`limit(int limit)`
`String`	`logChannel()`
`static String`	`logChannelCharacterEncoding()`
`static int`	`logChannelHeaderLength()`
`static int`	`logChannelId()`
`int`	`logChannelLength()`
`static String`	`logChannelMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`logChannelSinceVersion()`
`long`	`logPosition()`
`static int`	`logPositionEncodingLength()`
`static int`	`logPositionEncodingOffset()`
`static int`	`logPositionId()`
`static long`	`logPositionMaxValue()`
`static String`	`logPositionMetaAttribute(MetaAttribute metaAttribute)`
`static long`	`logPositionMinValue()`
`static long`	`logPositionNullValue()`
`static int`	`logPositionSinceVersion()`
`int`	`logSessionId()`
`static int`	`logSessionIdEncodingLength()`
`static int`	`logSessionIdEncodingOffset()`
`static int`	`logSessionIdId()`
`static int`	`logSessionIdMaxValue()`
`static String`	`logSessionIdMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`logSessionIdMinValue()`
`static int`	`logSessionIdNullValue()`
`static int`	`logSessionIdSinceVersion()`
`int`	`logStreamId()`
`static int`	`logStreamIdEncodingLength()`
`static int`	`logStreamIdEncodingOffset()`
`static int`	`logStreamIdId()`
`static int`	`logStreamIdMaxValue()`
`static String`	`logStreamIdMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`logStreamIdMinValue()`
`static int`	`logStreamIdNullValue()`
`static int`	`logStreamIdSinceVersion()`
`long`	`maxLogPosition()`
`static int`	`maxLogPositionEncodingLength()`
`static int`	`maxLogPositionEncodingOffset()`
`static int`	`maxLogPositionId()`
`static long`	`maxLogPositionMaxValue()`
`static String`	`maxLogPositionMetaAttribute(MetaAttribute metaAttribute)`
`static long`	`maxLogPositionMinValue()`
`static long`	`maxLogPositionNullValue()`
`static int`	`maxLogPositionSinceVersion()`
`int`	`memberId()`
`static int`	`memberIdEncodingLength()`
`static int`	`memberIdEncodingOffset()`
`static int`	`memberIdId()`
`static int`	`memberIdMaxValue()`
`static String`	`memberIdMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`memberIdMinValue()`
`static int`	`memberIdNullValue()`
`static int`	`memberIdSinceVersion()`
`int`	`offset()`
`int`	`role()`
`static int`	`roleEncodingLength()`
`static int`	`roleEncodingOffset()`
`static int`	`roleId()`
`static int`	`roleMaxValue()`
`static String`	`roleMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`roleMinValue()`
`static int`	`roleNullValue()`
`static int`	`roleSinceVersion()`
`int`	`sbeBlockLength()`
`int`	`sbeDecodedLength()`
`JoinLogDecoder`	`sbeRewind()`
`int`	`sbeSchemaId()`
`int`	`sbeSchemaVersion()`
`String`	`sbeSemanticType()`
`JoinLogDecoder`	`sbeSkip()`
`int`	`sbeTemplateId()`
`int`	`skipLogChannel()`
`String`	`toString()`
`JoinLogDecoder`	`wrap(DirectBuffer buffer, int offset, int actingBlockLength, int actingVersion)`
`JoinLogDecoder`	`wrapAndApplyHeader(DirectBuffer buffer, int offset, MessageHeaderDecoder headerDecoder)`
`void`	`wrapLogChannel(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
- JoinLogDecoder
```
public JoinLogDecoder()
```

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

wrapAndApplyHeader

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

sbeRewind
```
public JoinLogDecoder sbeRewind()
```

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

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

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

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

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

logPositionId
```
public static int logPositionId()
```

logPositionSinceVersion

public static int logPositionSinceVersion()

logPositionEncodingOffset

public static int logPositionEncodingOffset()

logPositionEncodingLength

public static int logPositionEncodingLength()

logPositionMetaAttribute

public static String logPositionMetaAttribute(MetaAttribute metaAttribute)

logPositionNullValue

public static long logPositionNullValue()

logPositionMinValue

public static long logPositionMinValue()

logPositionMaxValue

public static long logPositionMaxValue()

logPosition
```
public long logPosition()
```

maxLogPositionId
```
public static int maxLogPositionId()
```

maxLogPositionSinceVersion

public static int maxLogPositionSinceVersion()

maxLogPositionEncodingOffset

public static int maxLogPositionEncodingOffset()

maxLogPositionEncodingLength

public static int maxLogPositionEncodingLength()

maxLogPositionMetaAttribute

public static String maxLogPositionMetaAttribute(MetaAttribute metaAttribute)

maxLogPositionNullValue

public static long maxLogPositionNullValue()

maxLogPositionMinValue

public static long maxLogPositionMinValue()

maxLogPositionMaxValue

public static long maxLogPositionMaxValue()

maxLogPosition
```
public long maxLogPosition()
```

memberIdId
```
public static int memberIdId()
```

memberIdSinceVersion

public static int memberIdSinceVersion()

memberIdEncodingOffset

public static int memberIdEncodingOffset()

memberIdEncodingLength

public static int memberIdEncodingLength()

memberIdMetaAttribute

public static String memberIdMetaAttribute(MetaAttribute metaAttribute)

memberIdNullValue
```
public static int memberIdNullValue()
```

memberIdMinValue
```
public static int memberIdMinValue()
```

memberIdMaxValue
```
public static int memberIdMaxValue()
```

memberId
```
public int memberId()
```

logSessionIdId
```
public static int logSessionIdId()
```

logSessionIdSinceVersion

public static int logSessionIdSinceVersion()

logSessionIdEncodingOffset

public static int logSessionIdEncodingOffset()

logSessionIdEncodingLength

public static int logSessionIdEncodingLength()

logSessionIdMetaAttribute

public static String logSessionIdMetaAttribute(MetaAttribute metaAttribute)

logSessionIdNullValue

public static int logSessionIdNullValue()

logSessionIdMinValue

public static int logSessionIdMinValue()

logSessionIdMaxValue

public static int logSessionIdMaxValue()

logSessionId
```
public int logSessionId()
```

logStreamIdId
```
public static int logStreamIdId()
```

logStreamIdSinceVersion

public static int logStreamIdSinceVersion()

logStreamIdEncodingOffset

public static int logStreamIdEncodingOffset()

logStreamIdEncodingLength

public static int logStreamIdEncodingLength()

logStreamIdMetaAttribute

public static String logStreamIdMetaAttribute(MetaAttribute metaAttribute)

logStreamIdNullValue

public static int logStreamIdNullValue()

logStreamIdMinValue

public static int logStreamIdMinValue()

logStreamIdMaxValue

public static int logStreamIdMaxValue()

logStreamId
```
public int logStreamId()
```

isStartupId
```
public static int isStartupId()
```

isStartupSinceVersion

public static int isStartupSinceVersion()

isStartupEncodingOffset

public static int isStartupEncodingOffset()

isStartupEncodingLength

public static int isStartupEncodingLength()

isStartupMetaAttribute

public static String isStartupMetaAttribute(MetaAttribute metaAttribute)

isStartupRaw
```
public int isStartupRaw()
```

isStartup
```
public BooleanType isStartup()
```

roleId
```
public static int roleId()
```

roleSinceVersion
```
public static int roleSinceVersion()
```

roleEncodingOffset

public static int roleEncodingOffset()

roleEncodingLength

public static int roleEncodingLength()

roleMetaAttribute

public static String roleMetaAttribute(MetaAttribute metaAttribute)

roleNullValue
```
public static int roleNullValue()
```

roleMinValue
```
public static int roleMinValue()
```

roleMaxValue
```
public static int roleMaxValue()
```

role
```
public int role()
```

logChannelId
```
public static int logChannelId()
```

logChannelSinceVersion

public static int logChannelSinceVersion()

logChannelCharacterEncoding

public static String logChannelCharacterEncoding()

logChannelMetaAttribute

public static String logChannelMetaAttribute(MetaAttribute metaAttribute)

logChannelHeaderLength

public static int logChannelHeaderLength()

logChannelLength
```
public int logChannelLength()
```

skipLogChannel
```
public int skipLogChannel()
```

getLogChannel

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

getLogChannel

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

wrapLogChannel

public void wrapLogChannel(DirectBuffer wrapBuffer)

logChannel
```
public String logChannel()
```

getLogChannel

public int getLogChannel(Appendable appendable)

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

toString in class Object

appendTo

public StringBuilder appendTo(StringBuilder builder)

sbeSkip
```
public JoinLogDecoder sbeSkip()
```

Class JoinLogDecoder

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

JoinLogDecoder

Method Detail

sbeBlockLength

sbeTemplateId

sbeSchemaId

sbeSchemaVersion

sbeSemanticType

buffer

initialOffset

offset

wrap

wrapAndApplyHeader

sbeRewind

sbeDecodedLength

actingVersion

encodedLength

limit

limit

logPositionId

logPositionSinceVersion

logPositionEncodingOffset

logPositionEncodingLength

logPositionMetaAttribute

logPositionNullValue

logPositionMinValue

logPositionMaxValue

logPosition

maxLogPositionId

maxLogPositionSinceVersion

maxLogPositionEncodingOffset

maxLogPositionEncodingLength

maxLogPositionMetaAttribute

maxLogPositionNullValue

maxLogPositionMinValue

maxLogPositionMaxValue

maxLogPosition

memberIdId

memberIdSinceVersion

memberIdEncodingOffset

memberIdEncodingLength

memberIdMetaAttribute

memberIdNullValue

memberIdMinValue

memberIdMaxValue

memberId

logSessionIdId

logSessionIdSinceVersion

logSessionIdEncodingOffset

logSessionIdEncodingLength

logSessionIdMetaAttribute

logSessionIdNullValue

logSessionIdMinValue

logSessionIdMaxValue

logSessionId

logStreamIdId

logStreamIdSinceVersion

logStreamIdEncodingOffset

logStreamIdEncodingLength

logStreamIdMetaAttribute

logStreamIdNullValue

logStreamIdMinValue

logStreamIdMaxValue

logStreamId

isStartupId

isStartupSinceVersion

isStartupEncodingOffset

isStartupEncodingLength