io.aeron.cluster.codecs

Class AdminRequestEncoder

java.lang.Object

io.aeron.cluster.codecs.AdminRequestEncoder

public final class AdminRequestEncoder
extends Object

Request to execute an admin command in the cluster.

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

Method Summary

Modifier and Type	Method and Description
StringBuilder	appendTo(StringBuilder builder)
MutableDirectBuffer	buffer()
AdminRequestEncoder	clusterSessionId(long value)
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()
AdminRequestEncoder	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()
int	initialOffset()
AdminRequestEncoder	leadershipTermId(long value)
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)
int	offset()
static int	payloadHeaderLength()
static int	payloadId()
static String	payloadMetaAttribute(MetaAttribute metaAttribute)
AdminRequestEncoder	putPayload(byte[] src, int srcOffset, int length)
AdminRequestEncoder	putPayload(DirectBuffer src, int srcOffset, int length)
AdminRequestEncoder	requestType(AdminRequestType value)
static int	requestTypeEncodingLength()
static int	requestTypeEncodingOffset()
static int	requestTypeId()
static String	requestTypeMetaAttribute(MetaAttribute metaAttribute)
static int	requestTypeSinceVersion()
int	sbeBlockLength()
int	sbeSchemaId()
int	sbeSchemaVersion()
String	sbeSemanticType()
int	sbeTemplateId()
String	toString()
AdminRequestEncoder	wrap(MutableDirectBuffer buffer, int offset)
AdminRequestEncoder	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

SEMANTIC_VERSION

public static final String SEMANTIC_VERSION

See Also:

Constant Field Values

BYTE_ORDER

public static final ByteOrder BYTE_ORDER

Constructor Detail

AdminRequestEncoder

public AdminRequestEncoder()

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 AdminRequestEncoder wrap(MutableDirectBuffer buffer,
                                int offset)

wrapAndApplyHeader

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

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 AdminRequestEncoder leadershipTermId(long value)

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 AdminRequestEncoder clusterSessionId(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 AdminRequestEncoder correlationId(long value)

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)

requestType

public AdminRequestEncoder requestType(AdminRequestType value)

payloadId

public static int payloadId()

payloadMetaAttribute

public static String payloadMetaAttribute(MetaAttribute metaAttribute)

payloadHeaderLength

public static int payloadHeaderLength()

putPayload

public AdminRequestEncoder putPayload(DirectBuffer src,
                                      int srcOffset,
                                      int length)

putPayload

public AdminRequestEncoder putPayload(byte[] src,
                                      int srcOffset,
                                      int length)

toString

public String toString()

Overrides:

toString in class Object

appendTo

public StringBuilder appendTo(StringBuilder builder)