Commands (Pulsar Common 2.7.2.10-rc-202109061352 API)

java.lang.Object
- org.apache.pulsar.common.protocol.Commands

```
public class Commands
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Commands.ChecksumType
Definition of possible checksum types.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Commands.ChecksumType` Definition of possible checksum types.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_MAX_MESSAGE_SIZE`
`static int`	`INVALID_MAX_MESSAGE_SIZE`
`static short`	`magicCrc32c`
`static int`	`MESSAGE_SIZE_FRAME_PADDING`

Constructor Summary

Constructors
Constructor and Description

Commands()

Constructors
Constructor and Description
`Commands()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static io.netty.buffer.ByteBuf`	`deSerializeSingleMessageInBatch(io.netty.buffer.ByteBuf uncompressedPayload, PulsarApi.SingleMessageMetadata.Builder singleMessageMetadataBuilder, int index, int batchSize)`
`static int`	`getCurrentProtocolVersion()`
`static PulsarApi.FeatureFlags`	`getFeatureFlags()`
`static int`	`getNumberOfMessagesInBatch(io.netty.buffer.ByteBuf metadataAndPayload, String subscription, long consumerId)`
`static SchemaType`	`getSchemaType(PulsarApi.Schema.Type type)`
`static boolean`	`hasChecksum(io.netty.buffer.ByteBuf buffer)`
`static long`	`initBatchMessageMetadata(PulsarApi.MessageMetadata.Builder messageMetadata, PulsarApi.MessageMetadata.Builder builder)`
`static io.netty.buffer.ByteBuf`	`newAck(long consumerId, long ledgerId, long entryId, BitSetRecyclable ackSet, PulsarApi.CommandAck.AckType ackType, PulsarApi.CommandAck.ValidationError validationError, Map<String,Long> properties)`
`static io.netty.buffer.ByteBuf`	`newAck(long consumerId, long ledgerId, long entryId, BitSetRecyclable ackSet, PulsarApi.CommandAck.AckType ackType, PulsarApi.CommandAck.ValidationError validationError, Map<String,Long> properties, long txnIdLeastBits, long txnIdMostBits, long requestId)`
`static io.netty.buffer.ByteBuf`	`newAck(long consumerId, long ledgerId, long entryId, BitSetRecyclable ackSet, PulsarApi.CommandAck.AckType ackType, PulsarApi.CommandAck.ValidationError validationError, Map<String,Long> properties, long txnIdLeastBits, long txnIdMostBits, long requestId, int batchSize)`
`static io.netty.buffer.ByteBuf`	`newAckResponse(long requestId, PulsarApi.ServerError error, String errorMsg, long consumerId)`
`static io.netty.buffer.ByteBuf`	`newActiveConsumerChange(long consumerId, boolean isActive)`
`static io.netty.buffer.ByteBuf`	`newAddPartitionToTxn(long requestId, long txnIdLeastBits, long txnIdMostBits, List<String> partitions)`
`static io.netty.buffer.ByteBuf`	`newAddPartitionToTxnResponse(long requestId, long txnIdLeastBits, long txnIdMostBits)`
`static io.netty.buffer.ByteBuf`	`newAddPartitionToTxnResponse(long requestId, long txnIdMostBits, PulsarApi.ServerError error, String errorMsg)`
`static io.netty.buffer.ByteBuf`	`newAddSubscriptionToTxn(long requestId, long txnIdLeastBits, long txnIdMostBits, List<PulsarApi.Subscription> subscription)`
`static io.netty.buffer.ByteBuf`	`newAddSubscriptionToTxnResponse(long requestId, long txnIdLeastBits, long txnIdMostBits)`
`static io.netty.buffer.ByteBuf`	`newAddSubscriptionToTxnResponse(long requestId, long txnIdMostBits, PulsarApi.ServerError error, String errorMsg)`
`static io.netty.buffer.ByteBuf`	`newAuthChallenge(String authMethod, AuthData brokerData, int clientProtocolVersion)`
`static io.netty.buffer.ByteBuf`	`newAuthResponse(String authMethod, AuthData clientData, int clientProtocolVersion, String clientVersion)`
`static io.netty.buffer.ByteBuf`	`newCloseConsumer(long consumerId, long requestId)`
`static io.netty.buffer.ByteBuf`	`newCloseProducer(long producerId, long requestId)`
`static io.netty.buffer.ByteBuf`	`newConnect(String authMethodName, AuthData authData, int protocolVersion, String libVersion, String targetBroker, String originalPrincipal, AuthData originalAuthData, String originalAuthMethod)`
`static io.netty.buffer.ByteBuf`	`newConnect(String authMethodName, String authData, int protocolVersion, String libVersion, String targetBroker, String originalPrincipal, String originalAuthData, String originalAuthMethod)`
`static io.netty.buffer.ByteBuf`	`newConnect(String authMethodName, String authData, String libVersion)`
`static io.netty.buffer.ByteBuf`	`newConnect(String authMethodName, String authData, String libVersion, String targetBroker)`
`static io.netty.buffer.ByteBuf`	`newConnect(String authMethodName, String authData, String libVersion, String targetBroker, String originalPrincipal, String clientAuthData, String clientAuthMethod)`
`static io.netty.buffer.ByteBuf`	`newConnected(int clientProtocoVersion)`
`static io.netty.buffer.ByteBuf`	`newConnected(int clientProtocolVersion, int maxMessageSize)`
`static PulsarApi.BaseCommand`	`newConnectedCommand(int clientProtocolVersion, int maxMessageSize)`
`static io.netty.buffer.ByteBuf`	`newConsumerStatsResponse(PulsarApi.CommandConsumerStatsResponse.Builder builder)`
`static io.netty.buffer.ByteBuf`	`newConsumerStatsResponse(PulsarApi.ServerError serverError, String errMsg, long requestId)`
`static io.netty.buffer.ByteBuf`	`newEndTxn(long requestId, long txnIdLeastBits, long txnIdMostBits, PulsarApi.TxnAction txnAction, List<PulsarApi.MessageIdData> messageIdList)`
`static io.netty.buffer.ByteBuf`	`newEndTxnOnPartition(long requestId, long txnIdLeastBits, long txnIdMostBits, String topic, PulsarApi.TxnAction txnAction, List<PulsarApi.MessageIdData> messageIdDataList)`
`static io.netty.buffer.ByteBuf`	`newEndTxnOnPartitionResponse(long requestId, long txnIdLeastBits, long txnIdMostBits)`
`static io.netty.buffer.ByteBuf`	`newEndTxnOnPartitionResponse(long requestId, PulsarApi.ServerError error, String errorMsg)`
`static io.netty.buffer.ByteBuf`	`newEndTxnOnSubscription(long requestId, long txnIdLeastBits, long txnIdMostBits, PulsarApi.Subscription subscription, PulsarApi.TxnAction txnAction)`
`static io.netty.buffer.ByteBuf`	`newEndTxnOnSubscription(long requestId, long txnIdLeastBits, long txnIdMostBits, String topic, String subscription, PulsarApi.TxnAction txnAction)`
`static io.netty.buffer.ByteBuf`	`newEndTxnOnSubscriptionResponse(long requestId, long txnIdLeastBits, long txnIdMostBits)`
`static io.netty.buffer.ByteBuf`	`newEndTxnOnSubscriptionResponse(long requestId, long txnIdLeastBits, long txnIdMostBits, PulsarApi.ServerError error, String errorMsg)`
`static io.netty.buffer.ByteBuf`	`newEndTxnResponse(long requestId, long txnIdLeastBits, long txnIdMostBits)`
`static io.netty.buffer.ByteBuf`	`newEndTxnResponse(long requestId, long txnIdMostBits, PulsarApi.ServerError error, String errorMsg)`
`static io.netty.buffer.ByteBuf`	`newError(long requestId, PulsarApi.ServerError error, String message)`
`static PulsarApi.BaseCommand`	`newErrorCommand(long requestId, PulsarApi.ServerError error, String message)`
`static io.netty.buffer.ByteBuf`	`newFlow(long consumerId, int messagePermits)`
`static io.netty.buffer.ByteBuf`	`newGetLastMessageId(long consumerId, long requestId)`
`static io.netty.buffer.ByteBuf`	`newGetLastMessageIdResponse(long requestId, PulsarApi.MessageIdData messageIdData, PulsarApi.MessageIdData consumerMarkDeletePosition)`
`static io.netty.buffer.ByteBuf`	`newGetOrCreateSchema(long requestId, String topic, SchemaInfo schemaInfo)`
`static io.netty.buffer.ByteBuf`	`newGetOrCreateSchemaResponse(long requestId, SchemaVersion schemaVersion)`
`static PulsarApi.BaseCommand`	`newGetOrCreateSchemaResponseCommand(long requestId, SchemaVersion schemaVersion)`
`static io.netty.buffer.ByteBuf`	`newGetOrCreateSchemaResponseError(long requestId, PulsarApi.ServerError error, String errorMessage)`
`static PulsarApi.BaseCommand`	`newGetOrCreateSchemaResponseErrorCommand(long requestId, PulsarApi.ServerError error, String errorMessage)`
`static io.netty.buffer.ByteBuf`	`newGetSchema(long requestId, String topic, Optional<SchemaVersion> version)`
`static io.netty.buffer.ByteBuf`	`newGetSchemaResponse(long requestId, PulsarApi.CommandGetSchemaResponse response)`
`static io.netty.buffer.ByteBuf`	`newGetSchemaResponse(long requestId, SchemaInfo schema, SchemaVersion version)`
`static PulsarApi.BaseCommand`	`newGetSchemaResponseCommand(long requestId, SchemaInfo schema, SchemaVersion version)`
`static io.netty.buffer.ByteBuf`	`newGetSchemaResponseError(long requestId, PulsarApi.ServerError error, String errorMessage)`
`static PulsarApi.BaseCommand`	`newGetSchemaResponseErrorCommand(long requestId, PulsarApi.ServerError error, String errorMessage)`
`static io.netty.buffer.ByteBuf`	`newGetTopicsOfNamespaceRequest(String namespace, long requestId, PulsarApi.CommandGetTopicsOfNamespace.Mode mode)`
`static io.netty.buffer.ByteBuf`	`newGetTopicsOfNamespaceResponse(List<String> topics, long requestId)`
`static PulsarApi.BaseCommand`	`newGetTopicsOfNamespaceResponseCommand(List<String> topics, long requestId)`
`static io.netty.buffer.ByteBuf`	`newLookup(String topic, boolean authoritative, long requestId)`
`static io.netty.buffer.ByteBuf`	`newLookup(String topic, String listenerName, boolean authoritative, long requestId)`
`static io.netty.buffer.ByteBuf`	`newLookupErrorResponse(PulsarApi.ServerError error, String errorMsg, long requestId)`
`static PulsarApi.BaseCommand`	`newLookupErrorResponseCommand(PulsarApi.ServerError error, String errorMsg, long requestId)`
`static io.netty.buffer.ByteBuf`	`newLookupResponse(String brokerServiceUrl, String brokerServiceUrlTls, boolean authoritative, PulsarApi.CommandLookupTopicResponse.LookupType response, long requestId, boolean proxyThroughServiceUrl)`
`static PulsarApi.BaseCommand`	`newLookupResponseCommand(String brokerServiceUrl, String brokerServiceUrlTls, boolean authoritative, PulsarApi.CommandLookupTopicResponse.LookupType response, long requestId, boolean proxyThroughServiceUrl)`
`static ByteBufPair`	`newMessage(long consumerId, PulsarApi.MessageIdData messageId, int redeliveryCount, io.netty.buffer.ByteBuf metadataAndPayload, long[] ackSet)`
`static PulsarApi.BaseCommand`	`newMessageCommand(long consumerId, PulsarApi.MessageIdData messageId, int redeliveryCount, long[] ackSet)`
`static io.netty.buffer.ByteBuf`	`newMultiMessageAck(long consumerId, List<org.apache.commons.lang3.tuple.Triple<Long,Long,ConcurrentBitSetRecyclable>> entries)`
`static io.netty.buffer.ByteBuf`	`newMultiMessageAckCommon(PulsarApi.CommandAck.Builder ackBuilder, List<org.apache.commons.lang3.tuple.Triple<Long,Long,ConcurrentBitSetRecyclable>> entries)`
`static io.netty.buffer.ByteBuf`	`newMultiTransactionMessageAck(long consumerId, TxnID txnID, List<org.apache.commons.lang3.tuple.Triple<Long,Long,ConcurrentBitSetRecyclable>> entries)`
`static io.netty.buffer.ByteBuf`	`newPartitionMetadataRequest(String topic, long requestId)`
`static io.netty.buffer.ByteBuf`	`newPartitionMetadataResponse(int partitions, long requestId)`
`static io.netty.buffer.ByteBuf`	`newPartitionMetadataResponse(PulsarApi.ServerError error, String errorMsg, long requestId)`
`static PulsarApi.BaseCommand`	`newPartitionMetadataResponseCommand(int partitions, long requestId)`
`static PulsarApi.BaseCommand`	`newPartitionMetadataResponseCommand(PulsarApi.ServerError error, String errorMsg, long requestId)`
`static io.netty.buffer.ByteBuf`	`newProducer(String topic, long producerId, long requestId, String producerName, boolean encrypted, Map<String,String> metadata)`
`static io.netty.buffer.ByteBuf`	`newProducer(String topic, long producerId, long requestId, String producerName, boolean encrypted, Map<String,String> metadata, SchemaInfo schemaInfo, long epoch, boolean userProvidedProducerName)`
`static io.netty.buffer.ByteBuf`	`newProducer(String topic, long producerId, long requestId, String producerName, Map<String,String> metadata)`
`static io.netty.buffer.ByteBuf`	`newProducerSuccess(long requestId, String producerName, long lastSequenceId, SchemaVersion schemaVersion)`
`static io.netty.buffer.ByteBuf`	`newProducerSuccess(long requestId, String producerName, SchemaVersion schemaVersion)`
`static PulsarApi.BaseCommand`	`newProducerSuccessCommand(long requestId, String producerName, long lastSequenceId, SchemaVersion schemaVersion)`
`static PulsarApi.BaseCommand`	`newProducerSuccessCommand(long requestId, String producerName, SchemaVersion schemaVersion)`
`static io.netty.buffer.ByteBuf`	`newReachedEndOfTopic(long consumerId)`
`static io.netty.buffer.ByteBuf`	`newRedeliverUnacknowledgedMessages(long consumerId)`
`static io.netty.buffer.ByteBuf`	`newRedeliverUnacknowledgedMessages(long consumerId, List<PulsarApi.MessageIdData> messageIds)`
`static io.netty.buffer.ByteBuf`	`newSeek(long consumerId, long requestId, long timestamp)`
`static io.netty.buffer.ByteBuf`	`newSeek(long consumerId, long requestId, long ledgerId, long entryId, long[] ackSet)`
`static ByteBufPair`	`newSend(long producerId, long sequenceId, int numMessaegs, Commands.ChecksumType checksumType, PulsarApi.MessageMetadata messageMetadata, io.netty.buffer.ByteBuf payload)`
`static ByteBufPair`	`newSend(long producerId, long sequenceId, int numMessages, long txnIdLeastBits, long txnIdMostBits, Commands.ChecksumType checksumType, PulsarApi.MessageMetadata messageData, io.netty.buffer.ByteBuf payload)`
`static ByteBufPair`	`newSend(long producerId, long lowestSequenceId, long highestSequenceId, int numMessaegs, Commands.ChecksumType checksumType, PulsarApi.MessageMetadata messageMetadata, io.netty.buffer.ByteBuf payload)`
`static ByteBufPair`	`newSend(long producerId, long lowestSequenceId, long highestSequenceId, int numMessages, long txnIdLeastBits, long txnIdMostBits, Commands.ChecksumType checksumType, PulsarApi.MessageMetadata messageData, io.netty.buffer.ByteBuf payload)`
`static io.netty.buffer.ByteBuf`	`newSendError(long producerId, long sequenceId, PulsarApi.ServerError error, String errorMsg)`
`static PulsarApi.BaseCommand`	`newSendErrorCommand(long producerId, long sequenceId, PulsarApi.ServerError error, String errorMsg)`
`static io.netty.buffer.ByteBuf`	`newSendReceipt(long producerId, long sequenceId, long highestId, long ledgerId, long entryId)`
`static PulsarApi.BaseCommand`	`newSendReceiptCommand(long producerId, long sequenceId, long highestId, long ledgerId, long entryId)`
`static io.netty.buffer.ByteBuf`	`newSubscribe(String topic, String subscription, long consumerId, long requestId, PulsarApi.CommandSubscribe.SubType subType, int priorityLevel, String consumerName, boolean isDurable, PulsarApi.MessageIdData startMessageId, Map<String,String> metadata, boolean readCompacted, boolean isReplicated, PulsarApi.CommandSubscribe.InitialPosition subscriptionInitialPosition, long startMessageRollbackDurationInSec, SchemaInfo schemaInfo, boolean createTopicIfDoesNotExist)`
`static io.netty.buffer.ByteBuf`	newSubscribe(String topic, String subscription, long consumerId, long requestId, PulsarApi.CommandSubscribe.SubType subType, int priorityLevel, String consumerName, boolean isDurable, PulsarApi.MessageIdData startMessageId, Map<String,String> metadata, boolean readCompacted, boolean isReplicated, PulsarApi.CommandSubscribe.InitialPosition subscriptionInitialPosition, long startMessageRollbackDurationInSec, SchemaInfo schemaInfo, boolean createTopicIfDoesNotExist, KeySharedPolicy keySharedPolicy)
`static io.netty.buffer.ByteBuf`	`newSubscribe(String topic, String subscription, long consumerId, long requestId, PulsarApi.CommandSubscribe.SubType subType, int priorityLevel, String consumerName, long resetStartMessageBackInSeconds)`
`static io.netty.buffer.ByteBuf`	`newSuccess(long requestId)`
`static PulsarApi.BaseCommand`	`newSuccessCommand(long requestId)`
`static io.netty.buffer.ByteBuf`	`newTxn(long tcId, long requestId, long ttlSeconds)`
`static io.netty.buffer.ByteBuf`	`newTxnResponse(long requestId, long txnIdLeastBits, long txnIdMostBits)`
`static io.netty.buffer.ByteBuf`	`newTxnResponse(long requestId, long txnIdMostBits, PulsarApi.ServerError error, String errorMsg)`
`static io.netty.buffer.ByteBuf`	`newUnsubscribe(long consumerId, long requestId)`
`static PulsarApi.MessageMetadata`	`parseMessageMetadata(io.netty.buffer.ByteBuf buffer)`
`static PulsarApi.MessageMetadata`	`peekMessageMetadata(io.netty.buffer.ByteBuf metadataAndPayload, String subscription, long consumerId)`
`static byte[]`	`peekStickyKey(io.netty.buffer.ByteBuf metadataAndPayload, String topic, String subscription)`
`static boolean`	`peerSupportJsonSchemaAvroFormat(int peerVersion)`
`static boolean`	`peerSupportsActiveConsumerListener(int peerVersion)`
`static boolean`	`peerSupportsGetLastMessageId(int peerVersion)`
`static boolean`	`peerSupportsGetOrCreateSchema(int peerVersion)`
`static boolean`	`peerSupportsMultiMessageAcknowledgment(int peerVersion)`
`static int`	`readChecksum(io.netty.buffer.ByteBuf buffer)` Read the checksum and advance the reader index in the buffer.
`static ByteBufPair`	`serializeCommandMessageWithSize(PulsarApi.BaseCommand cmd, io.netty.buffer.ByteBuf metadataAndPayload)`
`static io.netty.buffer.ByteBuf`	`serializeMetadataAndPayload(Commands.ChecksumType checksumType, PulsarApi.MessageMetadata msgMetadata, io.netty.buffer.ByteBuf payload)`
`static io.netty.buffer.ByteBuf`	`serializeSingleMessageInBatchWithPayload(PulsarApi.MessageMetadata.Builder msgBuilder, io.netty.buffer.ByteBuf payload, io.netty.buffer.ByteBuf batchBuffer)`
`static io.netty.buffer.ByteBuf`	`serializeSingleMessageInBatchWithPayload(PulsarApi.SingleMessageMetadata.Builder singleMessageMetadataBuilder, io.netty.buffer.ByteBuf payload, io.netty.buffer.ByteBuf batchBuffer)`
`static io.netty.buffer.ByteBuf`	`serializeWithSize(PulsarApi.BaseCommand.Builder cmdBuilder)`
`static io.netty.buffer.ByteBuf`	`serializeWithSize(PulsarApi.BaseCommand cmd)`
`static void`	`skipChecksumIfPresent(io.netty.buffer.ByteBuf buffer)`
`static void`	`skipMessageMetadata(io.netty.buffer.ByteBuf buffer)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- DEFAULT_MAX_MESSAGE_SIZE
```
public static final int DEFAULT_MAX_MESSAGE_SIZE
```
  See Also:
  
  Constant Field Values
- MESSAGE_SIZE_FRAME_PADDING
```
public static final int MESSAGE_SIZE_FRAME_PADDING
```
  See Also:
  
  Constant Field Values
- INVALID_MAX_MESSAGE_SIZE
```
public static final int INVALID_MAX_MESSAGE_SIZE
```
  See Also:
  
  Constant Field Values
- magicCrc32c
```
public static final short magicCrc32c
```
  See Also:
  
  Constant Field Values

Constructor Detail
- Commands
```
public Commands()
```

Method Detail

newConnect

public static io.netty.buffer.ByteBuf newConnect(String authMethodName,
                                                 String authData,
                                                 String libVersion)

newConnect

public static io.netty.buffer.ByteBuf newConnect(String authMethodName,
                                                 String authData,
                                                 String libVersion,
                                                 String targetBroker)

newConnect

public static io.netty.buffer.ByteBuf newConnect(String authMethodName,
                                                 String authData,
                                                 String libVersion,
                                                 String targetBroker,
                                                 String originalPrincipal,
                                                 String clientAuthData,
                                                 String clientAuthMethod)

getFeatureFlags

public static PulsarApi.FeatureFlags getFeatureFlags()

newConnect

public static io.netty.buffer.ByteBuf newConnect(String authMethodName,
                                                 String authData,
                                                 int protocolVersion,
                                                 String libVersion,
                                                 String targetBroker,
                                                 String originalPrincipal,
                                                 String originalAuthData,
                                                 String originalAuthMethod)

newConnect

public static io.netty.buffer.ByteBuf newConnect(String authMethodName,
                                                 AuthData authData,
                                                 int protocolVersion,
                                                 String libVersion,
                                                 String targetBroker,
                                                 String originalPrincipal,
                                                 AuthData originalAuthData,
                                                 String originalAuthMethod)

newConnected

public static io.netty.buffer.ByteBuf newConnected(int clientProtocoVersion)

newConnectedCommand

public static PulsarApi.BaseCommand newConnectedCommand(int clientProtocolVersion,
                                                        int maxMessageSize)

newConnected

public static io.netty.buffer.ByteBuf newConnected(int clientProtocolVersion,
                                                   int maxMessageSize)

newAuthChallenge

public static io.netty.buffer.ByteBuf newAuthChallenge(String authMethod,
                                                       AuthData brokerData,
                                                       int clientProtocolVersion)

newAuthResponse

public static io.netty.buffer.ByteBuf newAuthResponse(String authMethod,
                                                      AuthData clientData,
                                                      int clientProtocolVersion,
                                                      String clientVersion)

newSuccessCommand

public static PulsarApi.BaseCommand newSuccessCommand(long requestId)

newSuccess

public static io.netty.buffer.ByteBuf newSuccess(long requestId)

newProducerSuccessCommand

public static PulsarApi.BaseCommand newProducerSuccessCommand(long requestId,
                                                              String producerName,
                                                              SchemaVersion schemaVersion)

newProducerSuccess

public static io.netty.buffer.ByteBuf newProducerSuccess(long requestId,
                                                         String producerName,
                                                         SchemaVersion schemaVersion)

newProducerSuccessCommand

public static PulsarApi.BaseCommand newProducerSuccessCommand(long requestId,
                                                              String producerName,
                                                              long lastSequenceId,
                                                              SchemaVersion schemaVersion)

newProducerSuccess

public static io.netty.buffer.ByteBuf newProducerSuccess(long requestId,
                                                         String producerName,
                                                         long lastSequenceId,
                                                         SchemaVersion schemaVersion)

newErrorCommand

public static PulsarApi.BaseCommand newErrorCommand(long requestId,
                                                    PulsarApi.ServerError error,
                                                    String message)

newError

public static io.netty.buffer.ByteBuf newError(long requestId,
                                               PulsarApi.ServerError error,
                                               String message)

newSendReceiptCommand

public static PulsarApi.BaseCommand newSendReceiptCommand(long producerId,
                                                          long sequenceId,
                                                          long highestId,
                                                          long ledgerId,
                                                          long entryId)

newSendReceipt

public static io.netty.buffer.ByteBuf newSendReceipt(long producerId,
                                                     long sequenceId,
                                                     long highestId,
                                                     long ledgerId,
                                                     long entryId)

newSendErrorCommand

public static PulsarApi.BaseCommand newSendErrorCommand(long producerId,
                                                        long sequenceId,
                                                        PulsarApi.ServerError error,
                                                        String errorMsg)

newSendError

public static io.netty.buffer.ByteBuf newSendError(long producerId,
                                                   long sequenceId,
                                                   PulsarApi.ServerError error,
                                                   String errorMsg)

hasChecksum

public static boolean hasChecksum(io.netty.buffer.ByteBuf buffer)

readChecksum
```
public static int readChecksum(io.netty.buffer.ByteBuf buffer)
```
Read the checksum and advance the reader index in the buffer.
Note: This method assume the checksum presence was already verified before.

skipChecksumIfPresent

public static void skipChecksumIfPresent(io.netty.buffer.ByteBuf buffer)

parseMessageMetadata

public static PulsarApi.MessageMetadata parseMessageMetadata(io.netty.buffer.ByteBuf buffer)

skipMessageMetadata

public static void skipMessageMetadata(io.netty.buffer.ByteBuf buffer)

newMessageCommand

public static PulsarApi.BaseCommand newMessageCommand(long consumerId,
                                                      PulsarApi.MessageIdData messageId,
                                                      int redeliveryCount,
                                                      long[] ackSet)

newMessage

public static ByteBufPair newMessage(long consumerId,
                                     PulsarApi.MessageIdData messageId,
                                     int redeliveryCount,
                                     io.netty.buffer.ByteBuf metadataAndPayload,
                                     long[] ackSet)

newSend

public static ByteBufPair newSend(long producerId,
                                  long sequenceId,
                                  int numMessaegs,
                                  Commands.ChecksumType checksumType,
                                  PulsarApi.MessageMetadata messageMetadata,
                                  io.netty.buffer.ByteBuf payload)

newSend

public static ByteBufPair newSend(long producerId,
                                  long lowestSequenceId,
                                  long highestSequenceId,
                                  int numMessaegs,
                                  Commands.ChecksumType checksumType,
                                  PulsarApi.MessageMetadata messageMetadata,
                                  io.netty.buffer.ByteBuf payload)

newSend

public static ByteBufPair newSend(long producerId,
                                  long sequenceId,
                                  int numMessages,
                                  long txnIdLeastBits,
                                  long txnIdMostBits,
                                  Commands.ChecksumType checksumType,
                                  PulsarApi.MessageMetadata messageData,
                                  io.netty.buffer.ByteBuf payload)

newSend

public static ByteBufPair newSend(long producerId,
                                  long lowestSequenceId,
                                  long highestSequenceId,
                                  int numMessages,
                                  long txnIdLeastBits,
                                  long txnIdMostBits,
                                  Commands.ChecksumType checksumType,
                                  PulsarApi.MessageMetadata messageData,
                                  io.netty.buffer.ByteBuf payload)

newSubscribe

public static io.netty.buffer.ByteBuf newSubscribe(String topic,
                                                   String subscription,
                                                   long consumerId,
                                                   long requestId,
                                                   PulsarApi.CommandSubscribe.SubType subType,
                                                   int priorityLevel,
                                                   String consumerName,
                                                   long resetStartMessageBackInSeconds)

newSubscribe

public static io.netty.buffer.ByteBuf newSubscribe(String topic,
                                                   String subscription,
                                                   long consumerId,
                                                   long requestId,
                                                   PulsarApi.CommandSubscribe.SubType subType,
                                                   int priorityLevel,
                                                   String consumerName,
                                                   boolean isDurable,
                                                   PulsarApi.MessageIdData startMessageId,
                                                   Map<String,String> metadata,
                                                   boolean readCompacted,
                                                   boolean isReplicated,
                                                   PulsarApi.CommandSubscribe.InitialPosition subscriptionInitialPosition,
                                                   long startMessageRollbackDurationInSec,
                                                   SchemaInfo schemaInfo,
                                                   boolean createTopicIfDoesNotExist)

newSubscribe

public static io.netty.buffer.ByteBuf newSubscribe(String topic,
                                                   String subscription,
                                                   long consumerId,
                                                   long requestId,
                                                   PulsarApi.CommandSubscribe.SubType subType,
                                                   int priorityLevel,
                                                   String consumerName,
                                                   boolean isDurable,
                                                   PulsarApi.MessageIdData startMessageId,
                                                   Map<String,String> metadata,
                                                   boolean readCompacted,
                                                   boolean isReplicated,
                                                   PulsarApi.CommandSubscribe.InitialPosition subscriptionInitialPosition,
                                                   long startMessageRollbackDurationInSec,
                                                   SchemaInfo schemaInfo,
                                                   boolean createTopicIfDoesNotExist,
                                                   KeySharedPolicy keySharedPolicy)

newUnsubscribe

public static io.netty.buffer.ByteBuf newUnsubscribe(long consumerId,
                                                     long requestId)

newActiveConsumerChange

public static io.netty.buffer.ByteBuf newActiveConsumerChange(long consumerId,
                                                              boolean isActive)

newSeek

public static io.netty.buffer.ByteBuf newSeek(long consumerId,
                                              long requestId,
                                              long ledgerId,
                                              long entryId,
                                              long[] ackSet)

newSeek

public static io.netty.buffer.ByteBuf newSeek(long consumerId,
                                              long requestId,
                                              long timestamp)

newCloseConsumer

public static io.netty.buffer.ByteBuf newCloseConsumer(long consumerId,
                                                       long requestId)

newReachedEndOfTopic

public static io.netty.buffer.ByteBuf newReachedEndOfTopic(long consumerId)

newCloseProducer

public static io.netty.buffer.ByteBuf newCloseProducer(long producerId,
                                                       long requestId)

newProducer

public static io.netty.buffer.ByteBuf newProducer(String topic,
                                                  long producerId,
                                                  long requestId,
                                                  String producerName,
                                                  Map<String,String> metadata)

newProducer

public static io.netty.buffer.ByteBuf newProducer(String topic,
                                                  long producerId,
                                                  long requestId,
                                                  String producerName,
                                                  boolean encrypted,
                                                  Map<String,String> metadata)

getSchemaType

public static SchemaType getSchemaType(PulsarApi.Schema.Type type)

newProducer

public static io.netty.buffer.ByteBuf newProducer(String topic,
                                                  long producerId,
                                                  long requestId,
                                                  String producerName,
                                                  boolean encrypted,
                                                  Map<String,String> metadata,
                                                  SchemaInfo schemaInfo,
                                                  long epoch,
                                                  boolean userProvidedProducerName)

newPartitionMetadataResponseCommand

public static PulsarApi.BaseCommand newPartitionMetadataResponseCommand(PulsarApi.ServerError error,
                                                                        String errorMsg,
                                                                        long requestId)

newPartitionMetadataResponse

public static io.netty.buffer.ByteBuf newPartitionMetadataResponse(PulsarApi.ServerError error,
                                                                   String errorMsg,
                                                                   long requestId)

newPartitionMetadataRequest

public static io.netty.buffer.ByteBuf newPartitionMetadataRequest(String topic,
                                                                  long requestId)

newPartitionMetadataResponseCommand

public static PulsarApi.BaseCommand newPartitionMetadataResponseCommand(int partitions,
                                                                        long requestId)

newPartitionMetadataResponse

public static io.netty.buffer.ByteBuf newPartitionMetadataResponse(int partitions,
                                                                   long requestId)

newLookup

public static io.netty.buffer.ByteBuf newLookup(String topic,
                                                boolean authoritative,
                                                long requestId)

newLookup

public static io.netty.buffer.ByteBuf newLookup(String topic,
                                                String listenerName,
                                                boolean authoritative,
                                                long requestId)

newLookupResponseCommand

public static PulsarApi.BaseCommand newLookupResponseCommand(String brokerServiceUrl,
                                                             String brokerServiceUrlTls,
                                                             boolean authoritative,
                                                             PulsarApi.CommandLookupTopicResponse.LookupType response,
                                                             long requestId,
                                                             boolean proxyThroughServiceUrl)

newLookupResponse

public static io.netty.buffer.ByteBuf newLookupResponse(String brokerServiceUrl,
                                                        String brokerServiceUrlTls,
                                                        boolean authoritative,
                                                        PulsarApi.CommandLookupTopicResponse.LookupType response,
                                                        long requestId,
                                                        boolean proxyThroughServiceUrl)

newLookupErrorResponseCommand

public static PulsarApi.BaseCommand newLookupErrorResponseCommand(PulsarApi.ServerError error,
                                                                  String errorMsg,
                                                                  long requestId)

newLookupErrorResponse

public static io.netty.buffer.ByteBuf newLookupErrorResponse(PulsarApi.ServerError error,
                                                             String errorMsg,
                                                             long requestId)

newMultiTransactionMessageAck

public static io.netty.buffer.ByteBuf newMultiTransactionMessageAck(long consumerId,
                                                                    TxnID txnID,
                                                                    List<org.apache.commons.lang3.tuple.Triple<Long,Long,ConcurrentBitSetRecyclable>> entries)

newMultiMessageAckCommon

public static io.netty.buffer.ByteBuf newMultiMessageAckCommon(PulsarApi.CommandAck.Builder ackBuilder,
                                                               List<org.apache.commons.lang3.tuple.Triple<Long,Long,ConcurrentBitSetRecyclable>> entries)

newMultiMessageAck

public static io.netty.buffer.ByteBuf newMultiMessageAck(long consumerId,
                                                         List<org.apache.commons.lang3.tuple.Triple<Long,Long,ConcurrentBitSetRecyclable>> entries)

newAck

public static io.netty.buffer.ByteBuf newAck(long consumerId,
                                             long ledgerId,
                                             long entryId,
                                             BitSetRecyclable ackSet,
                                             PulsarApi.CommandAck.AckType ackType,
                                             PulsarApi.CommandAck.ValidationError validationError,
                                             Map<String,Long> properties)

newAck

public static io.netty.buffer.ByteBuf newAck(long consumerId,
                                             long ledgerId,
                                             long entryId,
                                             BitSetRecyclable ackSet,
                                             PulsarApi.CommandAck.AckType ackType,
                                             PulsarApi.CommandAck.ValidationError validationError,
                                             Map<String,Long> properties,
                                             long txnIdLeastBits,
                                             long txnIdMostBits,
                                             long requestId,
                                             int batchSize)

newAck

public static io.netty.buffer.ByteBuf newAck(long consumerId,
                                             long ledgerId,
                                             long entryId,
                                             BitSetRecyclable ackSet,
                                             PulsarApi.CommandAck.AckType ackType,
                                             PulsarApi.CommandAck.ValidationError validationError,
                                             Map<String,Long> properties,
                                             long txnIdLeastBits,
                                             long txnIdMostBits,
                                             long requestId)

newAckResponse

public static io.netty.buffer.ByteBuf newAckResponse(long requestId,
                                                     PulsarApi.ServerError error,
                                                     String errorMsg,
                                                     long consumerId)

newFlow

public static io.netty.buffer.ByteBuf newFlow(long consumerId,
                                              int messagePermits)

newRedeliverUnacknowledgedMessages

public static io.netty.buffer.ByteBuf newRedeliverUnacknowledgedMessages(long consumerId)

newRedeliverUnacknowledgedMessages

public static io.netty.buffer.ByteBuf newRedeliverUnacknowledgedMessages(long consumerId,
                                                                         List<PulsarApi.MessageIdData> messageIds)

newConsumerStatsResponse

public static io.netty.buffer.ByteBuf newConsumerStatsResponse(PulsarApi.ServerError serverError,
                                                               String errMsg,
                                                               long requestId)

newConsumerStatsResponse

public static io.netty.buffer.ByteBuf newConsumerStatsResponse(PulsarApi.CommandConsumerStatsResponse.Builder builder)

newGetTopicsOfNamespaceRequest

public static io.netty.buffer.ByteBuf newGetTopicsOfNamespaceRequest(String namespace,
                                                                     long requestId,
                                                                     PulsarApi.CommandGetTopicsOfNamespace.Mode mode)

newGetTopicsOfNamespaceResponseCommand

public static PulsarApi.BaseCommand newGetTopicsOfNamespaceResponseCommand(List<String> topics,
                                                                           long requestId)

newGetTopicsOfNamespaceResponse

public static io.netty.buffer.ByteBuf newGetTopicsOfNamespaceResponse(List<String> topics,
                                                                      long requestId)

newGetLastMessageId

public static io.netty.buffer.ByteBuf newGetLastMessageId(long consumerId,
                                                          long requestId)

newGetLastMessageIdResponse

public static io.netty.buffer.ByteBuf newGetLastMessageIdResponse(long requestId,
                                                                  PulsarApi.MessageIdData messageIdData,
                                                                  PulsarApi.MessageIdData consumerMarkDeletePosition)

newGetSchema

public static io.netty.buffer.ByteBuf newGetSchema(long requestId,
                                                   String topic,
                                                   Optional<SchemaVersion> version)

newGetSchemaResponse

public static io.netty.buffer.ByteBuf newGetSchemaResponse(long requestId,
                                                           PulsarApi.CommandGetSchemaResponse response)

newGetSchemaResponseCommand

public static PulsarApi.BaseCommand newGetSchemaResponseCommand(long requestId,
                                                                SchemaInfo schema,
                                                                SchemaVersion version)

newGetSchemaResponse

public static io.netty.buffer.ByteBuf newGetSchemaResponse(long requestId,
                                                           SchemaInfo schema,
                                                           SchemaVersion version)

newGetSchemaResponseErrorCommand

public static PulsarApi.BaseCommand newGetSchemaResponseErrorCommand(long requestId,
                                                                     PulsarApi.ServerError error,
                                                                     String errorMessage)

newGetSchemaResponseError

public static io.netty.buffer.ByteBuf newGetSchemaResponseError(long requestId,
                                                                PulsarApi.ServerError error,
                                                                String errorMessage)

newGetOrCreateSchema

public static io.netty.buffer.ByteBuf newGetOrCreateSchema(long requestId,
                                                           String topic,
                                                           SchemaInfo schemaInfo)

newGetOrCreateSchemaResponseCommand

public static PulsarApi.BaseCommand newGetOrCreateSchemaResponseCommand(long requestId,
                                                                        SchemaVersion schemaVersion)

newGetOrCreateSchemaResponse

public static io.netty.buffer.ByteBuf newGetOrCreateSchemaResponse(long requestId,
                                                                   SchemaVersion schemaVersion)

newGetOrCreateSchemaResponseErrorCommand

public static PulsarApi.BaseCommand newGetOrCreateSchemaResponseErrorCommand(long requestId,
                                                                             PulsarApi.ServerError error,
                                                                             String errorMessage)

newGetOrCreateSchemaResponseError

public static io.netty.buffer.ByteBuf newGetOrCreateSchemaResponseError(long requestId,
                                                                        PulsarApi.ServerError error,
                                                                        String errorMessage)

peekStickyKey

public static byte[] peekStickyKey(io.netty.buffer.ByteBuf metadataAndPayload,
                                   String topic,
                                   String subscription)

newTxn

public static io.netty.buffer.ByteBuf newTxn(long tcId,
                                             long requestId,
                                             long ttlSeconds)

newTxnResponse

public static io.netty.buffer.ByteBuf newTxnResponse(long requestId,
                                                     long txnIdLeastBits,
                                                     long txnIdMostBits)

newTxnResponse

public static io.netty.buffer.ByteBuf newTxnResponse(long requestId,
                                                     long txnIdMostBits,
                                                     PulsarApi.ServerError error,
                                                     String errorMsg)

newAddPartitionToTxn

public static io.netty.buffer.ByteBuf newAddPartitionToTxn(long requestId,
                                                           long txnIdLeastBits,
                                                           long txnIdMostBits,
                                                           List<String> partitions)

newAddPartitionToTxnResponse

public static io.netty.buffer.ByteBuf newAddPartitionToTxnResponse(long requestId,
                                                                   long txnIdLeastBits,
                                                                   long txnIdMostBits)

newAddPartitionToTxnResponse

public static io.netty.buffer.ByteBuf newAddPartitionToTxnResponse(long requestId,
                                                                   long txnIdMostBits,
                                                                   PulsarApi.ServerError error,
                                                                   String errorMsg)

newAddSubscriptionToTxn

public static io.netty.buffer.ByteBuf newAddSubscriptionToTxn(long requestId,
                                                              long txnIdLeastBits,
                                                              long txnIdMostBits,
                                                              List<PulsarApi.Subscription> subscription)

newAddSubscriptionToTxnResponse

public static io.netty.buffer.ByteBuf newAddSubscriptionToTxnResponse(long requestId,
                                                                      long txnIdLeastBits,
                                                                      long txnIdMostBits)

newAddSubscriptionToTxnResponse

public static io.netty.buffer.ByteBuf newAddSubscriptionToTxnResponse(long requestId,
                                                                      long txnIdMostBits,
                                                                      PulsarApi.ServerError error,
                                                                      String errorMsg)

newEndTxn

public static io.netty.buffer.ByteBuf newEndTxn(long requestId,
                                                long txnIdLeastBits,
                                                long txnIdMostBits,
                                                PulsarApi.TxnAction txnAction,
                                                List<PulsarApi.MessageIdData> messageIdList)

newEndTxnResponse

public static io.netty.buffer.ByteBuf newEndTxnResponse(long requestId,
                                                        long txnIdLeastBits,
                                                        long txnIdMostBits)

newEndTxnResponse

public static io.netty.buffer.ByteBuf newEndTxnResponse(long requestId,
                                                        long txnIdMostBits,
                                                        PulsarApi.ServerError error,
                                                        String errorMsg)

newEndTxnOnPartition

public static io.netty.buffer.ByteBuf newEndTxnOnPartition(long requestId,
                                                           long txnIdLeastBits,
                                                           long txnIdMostBits,
                                                           String topic,
                                                           PulsarApi.TxnAction txnAction,
                                                           List<PulsarApi.MessageIdData> messageIdDataList)

newEndTxnOnPartitionResponse

public static io.netty.buffer.ByteBuf newEndTxnOnPartitionResponse(long requestId,
                                                                   long txnIdLeastBits,
                                                                   long txnIdMostBits)

newEndTxnOnPartitionResponse

public static io.netty.buffer.ByteBuf newEndTxnOnPartitionResponse(long requestId,
                                                                   PulsarApi.ServerError error,
                                                                   String errorMsg)

newEndTxnOnSubscription

public static io.netty.buffer.ByteBuf newEndTxnOnSubscription(long requestId,
                                                              long txnIdLeastBits,
                                                              long txnIdMostBits,
                                                              String topic,
                                                              String subscription,
                                                              PulsarApi.TxnAction txnAction)

newEndTxnOnSubscription

public static io.netty.buffer.ByteBuf newEndTxnOnSubscription(long requestId,
                                                              long txnIdLeastBits,
                                                              long txnIdMostBits,
                                                              PulsarApi.Subscription subscription,
                                                              PulsarApi.TxnAction txnAction)

newEndTxnOnSubscriptionResponse

public static io.netty.buffer.ByteBuf newEndTxnOnSubscriptionResponse(long requestId,
                                                                      long txnIdLeastBits,
                                                                      long txnIdMostBits)

newEndTxnOnSubscriptionResponse

public static io.netty.buffer.ByteBuf newEndTxnOnSubscriptionResponse(long requestId,
                                                                      long txnIdLeastBits,
                                                                      long txnIdMostBits,
                                                                      PulsarApi.ServerError error,
                                                                      String errorMsg)

serializeWithSize

public static io.netty.buffer.ByteBuf serializeWithSize(PulsarApi.BaseCommand.Builder cmdBuilder)

serializeWithSize

public static io.netty.buffer.ByteBuf serializeWithSize(PulsarApi.BaseCommand cmd)

serializeMetadataAndPayload

public static io.netty.buffer.ByteBuf serializeMetadataAndPayload(Commands.ChecksumType checksumType,
                                                                  PulsarApi.MessageMetadata msgMetadata,
                                                                  io.netty.buffer.ByteBuf payload)

initBatchMessageMetadata

public static long initBatchMessageMetadata(PulsarApi.MessageMetadata.Builder messageMetadata,
                                            PulsarApi.MessageMetadata.Builder builder)

serializeSingleMessageInBatchWithPayload

public static io.netty.buffer.ByteBuf serializeSingleMessageInBatchWithPayload(PulsarApi.SingleMessageMetadata.Builder singleMessageMetadataBuilder,
                                                                               io.netty.buffer.ByteBuf payload,
                                                                               io.netty.buffer.ByteBuf batchBuffer)

serializeSingleMessageInBatchWithPayload

public static io.netty.buffer.ByteBuf serializeSingleMessageInBatchWithPayload(PulsarApi.MessageMetadata.Builder msgBuilder,
                                                                               io.netty.buffer.ByteBuf payload,
                                                                               io.netty.buffer.ByteBuf batchBuffer)

deSerializeSingleMessageInBatch

public static io.netty.buffer.ByteBuf deSerializeSingleMessageInBatch(io.netty.buffer.ByteBuf uncompressedPayload,
                                                                      PulsarApi.SingleMessageMetadata.Builder singleMessageMetadataBuilder,
                                                                      int index,
                                                                      int batchSize)
                                                               throws IOException

Throws:: IOException

serializeCommandMessageWithSize

public static ByteBufPair serializeCommandMessageWithSize(PulsarApi.BaseCommand cmd,
                                                          io.netty.buffer.ByteBuf metadataAndPayload)

getNumberOfMessagesInBatch

public static int getNumberOfMessagesInBatch(io.netty.buffer.ByteBuf metadataAndPayload,
                                             String subscription,
                                             long consumerId)

peekMessageMetadata

public static PulsarApi.MessageMetadata peekMessageMetadata(io.netty.buffer.ByteBuf metadataAndPayload,
                                                            String subscription,
                                                            long consumerId)

getCurrentProtocolVersion

public static int getCurrentProtocolVersion()

peerSupportsGetLastMessageId

public static boolean peerSupportsGetLastMessageId(int peerVersion)

peerSupportsActiveConsumerListener

public static boolean peerSupportsActiveConsumerListener(int peerVersion)

peerSupportsMultiMessageAcknowledgment

public static boolean peerSupportsMultiMessageAcknowledgment(int peerVersion)

peerSupportJsonSchemaAvroFormat

public static boolean peerSupportJsonSchemaAvroFormat(int peerVersion)

peerSupportsGetOrCreateSchema

public static boolean peerSupportsGetOrCreateSchema(int peerVersion)

Class Commands

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MAX_MESSAGE_SIZE

MESSAGE_SIZE_FRAME_PADDING

INVALID_MAX_MESSAGE_SIZE

magicCrc32c

Constructor Detail

Commands

Method Detail

newConnect

newConnect

newConnect

getFeatureFlags

newConnect

newConnect

newConnected

newConnectedCommand

newConnected

newAuthChallenge

newAuthResponse

newSuccessCommand

newSuccess

newProducerSuccessCommand

newProducerSuccess

newProducerSuccessCommand

newProducerSuccess

newErrorCommand

newError

newSendReceiptCommand

newSendReceipt

newSendErrorCommand

newSendError

hasChecksum

readChecksum

skipChecksumIfPresent

parseMessageMetadata

skipMessageMetadata

newMessageCommand

newMessage

newSend

newSend

newSend

newSend

newSubscribe

newSubscribe

newSubscribe

newUnsubscribe

newActiveConsumerChange

newSeek

newSeek

newCloseConsumer

newReachedEndOfTopic

newCloseProducer

newProducer

newProducer

getSchemaType

newProducer

newPartitionMetadataResponseCommand

newPartitionMetadataResponse

newPartitionMetadataRequest

newPartitionMetadataResponseCommand

newPartitionMetadataResponse

newLookup

newLookup

newLookupResponseCommand

newLookupResponse

newLookupErrorResponseCommand

newLookupErrorResponse

newMultiTransactionMessageAck

newMultiMessageAckCommon

newMultiMessageAck

newAck

newAck

newAck

newAckResponse