CatchupPositionDecoder (Aeron Message Transport)

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

```
public final class CatchupPositionDecoder
extends Object
```
The follower requests catchup from the leader starting at the given position.

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

CatchupPositionDecoder()

Constructors
Constructor and Description
`CatchupPositionDecoder()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`actingVersion()`
`StringBuilder`	`appendTo(StringBuilder builder)`
`DirectBuffer`	`buffer()`
`String`	`catchupEndpoint()`
`static String`	`catchupEndpointCharacterEncoding()`
`static int`	`catchupEndpointHeaderLength()`
`static int`	`catchupEndpointId()`
`int`	`catchupEndpointLength()`
`static String`	`catchupEndpointMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`catchupEndpointSinceVersion()`
`int`	`encodedLength()`
`int`	`followerMemberId()`
`static int`	`followerMemberIdEncodingLength()`
`static int`	`followerMemberIdEncodingOffset()`
`static int`	`followerMemberIdId()`
`static int`	`followerMemberIdMaxValue()`
`static String`	`followerMemberIdMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`followerMemberIdMinValue()`
`static int`	`followerMemberIdNullValue()`
`static int`	`followerMemberIdSinceVersion()`
`int`	`getCatchupEndpoint(Appendable appendable)`
`int`	`getCatchupEndpoint(byte[] dst, int dstOffset, int length)`
`int`	`getCatchupEndpoint(MutableDirectBuffer dst, int dstOffset, int length)`
`int`	`initialOffset()`
`long`	`leadershipTermId()`
`static int`	`leadershipTermIdEncodingLength()`
`static int`	`leadershipTermIdEncodingOffset()`
`static int`	`leadershipTermIdId()`
`static long`	`leadershipTermIdMaxValue()`
`static String`	`leadershipTermIdMetaAttribute(MetaAttribute metaAttribute)`
`static long`	`leadershipTermIdMinValue()`
`static long`	`leadershipTermIdNullValue()`
`static int`	`leadershipTermIdSinceVersion()`
`int`	`limit()`
`void`	`limit(int limit)`
`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`	`offset()`
`int`	`sbeBlockLength()`
`int`	`sbeDecodedLength()`
`CatchupPositionDecoder`	`sbeRewind()`
`int`	`sbeSchemaId()`
`int`	`sbeSchemaVersion()`
`String`	`sbeSemanticType()`
`CatchupPositionDecoder`	`sbeSkip()`
`int`	`sbeTemplateId()`
`int`	`skipCatchupEndpoint()`
`String`	`toString()`
`CatchupPositionDecoder`	`wrap(DirectBuffer buffer, int offset, int actingBlockLength, int actingVersion)`
`CatchupPositionDecoder`	`wrapAndApplyHeader(DirectBuffer buffer, int offset, MessageHeaderDecoder headerDecoder)`
`void`	`wrapCatchupEndpoint(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
- CatchupPositionDecoder
```
public CatchupPositionDecoder()
```

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

wrapAndApplyHeader

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

sbeRewind

public CatchupPositionDecoder sbeRewind()

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

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

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

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

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

leadershipTermIdId

public static int leadershipTermIdId()

leadershipTermIdSinceVersion

public static int leadershipTermIdSinceVersion()

leadershipTermIdEncodingOffset

public static int leadershipTermIdEncodingOffset()

leadershipTermIdEncodingLength

public static int leadershipTermIdEncodingLength()

leadershipTermIdMetaAttribute

public static String leadershipTermIdMetaAttribute(MetaAttribute metaAttribute)

leadershipTermIdNullValue

public static long leadershipTermIdNullValue()

leadershipTermIdMinValue

public static long leadershipTermIdMinValue()

leadershipTermIdMaxValue

public static long leadershipTermIdMaxValue()

leadershipTermId
```
public long leadershipTermId()
```

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

followerMemberIdId

public static int followerMemberIdId()

followerMemberIdSinceVersion

public static int followerMemberIdSinceVersion()

followerMemberIdEncodingOffset

public static int followerMemberIdEncodingOffset()

followerMemberIdEncodingLength

public static int followerMemberIdEncodingLength()

followerMemberIdMetaAttribute

public static String followerMemberIdMetaAttribute(MetaAttribute metaAttribute)

followerMemberIdNullValue

public static int followerMemberIdNullValue()

followerMemberIdMinValue

public static int followerMemberIdMinValue()

followerMemberIdMaxValue

public static int followerMemberIdMaxValue()

followerMemberId
```
public int followerMemberId()
```

catchupEndpointId
```
public static int catchupEndpointId()
```

catchupEndpointSinceVersion

public static int catchupEndpointSinceVersion()

catchupEndpointCharacterEncoding

public static String catchupEndpointCharacterEncoding()

catchupEndpointMetaAttribute

public static String catchupEndpointMetaAttribute(MetaAttribute metaAttribute)

catchupEndpointHeaderLength

public static int catchupEndpointHeaderLength()

catchupEndpointLength
```
public int catchupEndpointLength()
```

skipCatchupEndpoint
```
public int skipCatchupEndpoint()
```

getCatchupEndpoint

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

getCatchupEndpoint

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

wrapCatchupEndpoint

public void wrapCatchupEndpoint(DirectBuffer wrapBuffer)

catchupEndpoint
```
public String catchupEndpoint()
```

getCatchupEndpoint

public int getCatchupEndpoint(Appendable appendable)

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

toString in class Object

appendTo

public StringBuilder appendTo(StringBuilder builder)

sbeSkip

public CatchupPositionDecoder sbeSkip()

Class CatchupPositionDecoder

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

CatchupPositionDecoder

Method Detail

sbeBlockLength

sbeTemplateId

sbeSchemaId

sbeSchemaVersion

sbeSemanticType

buffer

initialOffset

offset

wrap

wrapAndApplyHeader

sbeRewind

sbeDecodedLength

actingVersion

encodedLength

limit

limit

leadershipTermIdId

leadershipTermIdSinceVersion

leadershipTermIdEncodingOffset

leadershipTermIdEncodingLength

leadershipTermIdMetaAttribute

leadershipTermIdNullValue

leadershipTermIdMinValue

leadershipTermIdMaxValue

leadershipTermId

logPositionId

logPositionSinceVersion

logPositionEncodingOffset

logPositionEncodingLength

logPositionMetaAttribute

logPositionNullValue

logPositionMinValue

logPositionMaxValue

logPosition

followerMemberIdId

followerMemberIdSinceVersion

followerMemberIdEncodingOffset

followerMemberIdEncodingLength

followerMemberIdMetaAttribute

followerMemberIdNullValue

followerMemberIdMinValue

followerMemberIdMaxValue

followerMemberId

catchupEndpointId

catchupEndpointSinceVersion

catchupEndpointCharacterEncoding

catchupEndpointMetaAttribute

catchupEndpointHeaderLength

catchupEndpointLength

skipCatchupEndpoint

getCatchupEndpoint

getCatchupEndpoint

wrapCatchupEndpoint

catchupEndpoint

getCatchupEndpoint

toString

appendTo

sbeSkip