# Packages
Package log defines the logger interfaces used by pulsar client.
# Functions
DeserializeMessageID reconstruct a MessageID object from its serialized representation.
EarliestMessageID returns a messageID that points to the earliest message available in a topic.
No description provided by the author
LatestMessage returns a messageID that points to the latest message.
No description provided by the author
No description provided by the author
No description provided by the author
Create new Authentication provider with specified TLS certificate supplier.
No description provided by the author
Create new Authentication provider with specified TLS certificate and private key.
Create new Authentication provider with specified auth token.
Create new Authentication provider with specified auth token from a file.
NewAuthenticationTokenFromSupplier returns a token auth provider that gets the token data from a user supplied function.
No description provided by the author
No description provided by the author
No description provided by the author
NewDefaultRouter set the message routing mode for the partitioned producer.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewKeySharedPolicySticky construct KeySharedPolicy in Sticky mode with hashRanges formed in value pair list: [x1, x2, y1, y2, z1, z2], and must not overlap with each others.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Constants
.
Auto Consume Type.
Auto Publish Type.
Serialize and deserialize via Avro.
Higher compression rate, but slower.
.
A bytes array.
ReadError means failed to read from socketReadError Result = 6 AuthenticationError means authentication failed on brokerAuthenticationError Result = 7AuthorizationError Result = 8ErrorGettingAuthenticationData Result = 9 // Client cannot find authorization dataBrokerMetadataError Result = 10 // Broker failed in updating metadataBrokerPersistenceError Result = 11 // Broker failed to persist entryChecksumError Result = 12 // Corrupt message checksum failure ConsumerBusy means Exclusive consumer is already connected.
Default compression level.
No description provided by the author
No description provided by the author
A double number.
Exclusive there can be only 1 consumer on the same topic with the same subscription name.
Failover subscription mode, multiple consumer will be able to use the same subscription name but only 1 consumer will receive the messages.
Faster compression, with lower compression ration.
A float number.
A 16-byte integer.
A 32-byte integer.
A 64-byte integer.
A 8-byte integer.
No description provided by the author
JavaStringHash and Java String.hashCode() equivalent.
JSON object encoding and validation.
No description provided by the author
KeyShared subscription mode, multiple consumer will be able to use the same subscription and all messages with the same key will be dispatched to only one consumer.
KeySharedPolicyModeAutoSplit Auto split hash range key shared policy.
KeySharedPolicyModeSticky is Sticky attach topic with fixed hash range.
A Schema that contains Key Schema and Value Schema.
No description provided by the author
Murmur3_32Hash use Murmur3 hashing function.
No description provided by the author
No schema defined.
Protobuf message encoding and decoding.
ResultConnectError means failed to connect to broker.
ResultInvalidConfiguration means invalid configuration.
ResultInvalidTopicName means invalid topic name.
ResultLookupError means broker lookup failed.
ResultOk means no errors.
ResultTimeoutError means operation timed out.
ResultUnknownError means unknown error happened on broker.
Shared subscription mode, multiple consumer will be able to use the same subscription name and the messages will be dispatched according to a round-robin rotation between the connected consumers.
Simple String encoding with UTF-8.
Subscription not found.
Earliest position which means the start consuming position will be the first message.
Latest position which means the start consuming position will be the last message.
Topic not found.
No description provided by the author
No description provided by the author
# Variables
No description provided by the author
No description provided by the author
# Structs
No description provided by the author
No description provided by the author
No description provided by the author
Builder interface that is used to construct a Pulsar Client instance.
Pair of a Consumer and Message.
ConsumerOptions is used to configure and create instances of Consumer.
Configuration for Dead Letter Queue consumer policy.
No description provided by the author
Error implement error interface, composed of two parts: msg and result.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
KeySharedPolicy for KeyShared subscription.
ProducerMessage abstraction used in Pulsar producer.
No description provided by the author
No description provided by the author
ReaderMessage package Reader and Message as a struct to use.
ReaderOptions abstraction Reader options to use.
Encapsulates data around the schema definition.
No description provided by the author
# Interfaces
Opaque interface that represents the authentication credentials.
No description provided by the author
Consumer is an interface that abstracts behavior of Pulsar's consumer.
No description provided by the author
No description provided by the author
Message abstraction used in Pulsar.
MessageID identifier for a particular message.
Producer is used to publish messages on a topic.
No description provided by the author
Reader can be used to scan through all the messages currently available in a topic.
No description provided by the author
No description provided by the author
TopicMetadata is a interface of topic metadata.
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Result used to represent pulsar processing is an alias of type int.
No description provided by the author
No description provided by the author
SubscriptionType of subscription supported by Pulsar.