pulsar-client-cpp
Classes | Typedefs | Enumerations | Functions
pulsar Namespace Reference

Classes

class  AuthAthenz
 
class  Authentication
 
class  AuthenticationDataProvider
 
class  AuthFactory
 
class  AuthTls
 
class  BrokerConsumerStats
 
class  Client
 
class  ClientConfiguration
 
class  Consumer
 
class  ConsumerConfiguration
 
class  CryptoKeyReader
 
class  DeprecatedException
 
class  EncryptionKeyInfo
 
class  Logger
 
class  LoggerFactory
 
class  Message
 
class  MessageBuilder
 
class  MessageId
 
class  MessageRoutingPolicy
 
class  Producer
 
class  ProducerConfiguration
 
class  Reader
 
class  ReaderConfiguration
 
class  TopicMetadata
 

Typedefs

typedef boost::shared_ptr< AuthenticationDataProviderAuthenticationDataPtr
 
typedef boost::shared_ptr< AuthenticationAuthenticationPtr
 
typedef std::map< std::string, std::string > ParamMap
 
typedef boost::function< void(Result result, BrokerConsumerStats brokerConsumerStats)> BrokerConsumerStatsCallback
 
typedef boost::function< void(Result, Producer)> CreateProducerCallback
 
typedef boost::function< void(Result, Consumer)> SubscribeCallback
 
typedef boost::function< void(Result, Reader)> ReaderCallback
 
typedef boost::function< void(Result)> CloseCallback
 
typedef boost::function< void(Result result)> ResultCallback
 Callback definition for non-data operation.
 
typedef boost::function< void(Consumer consumer, const Message &msg)> MessageListener
 Callback definition for MessageListener.
 
typedef boost::shared_ptr< CryptoKeyReaderCryptoKeyReaderPtr
 
typedef boost::shared_ptr< EncryptionKeyInfoImpl > EncryptionKeyInfoImplPtr
 
typedef boost::shared_ptr< LoggerFactoryLoggerFactoryPtr
 
typedef boost::shared_ptr< MessageRoutingPolicyMessageRoutingPolicyPtr
 
typedef boost::function< void(Result, const Message &msg)> SendCallback
 
typedef boost::function< void(Result result, bool hasMessageAvailable)> HasMessageAvailableCallback
 
typedef boost::function< void(Reader reader, const Message &msg)> ReaderListener
 Callback definition for MessageListener.
 

Enumerations

enum  CompressionType { CompressionNone = 0, CompressionLZ4 = 1, CompressionZLib = 2 }
 
enum  ConsumerCryptoFailureAction { FAIL, DISCARD, CONSUME }
 
enum  ConsumerType { ConsumerExclusive, ConsumerShared, ConsumerFailover }
 
enum  ProducerCryptoFailureAction { FAIL, SEND }
 
enum  Result {
  ResultOk, ResultUnknownError, ResultInvalidConfiguration, ResultTimeout,
  ResultLookupError, ResultConnectError, ResultReadError, ResultAuthenticationError,
  ResultAuthorizationError, ResultErrorGettingAuthenticationData, ResultBrokerMetadataError, ResultBrokerPersistenceError,
  ResultChecksumError, ResultConsumerBusy, ResultNotConnected, ResultAlreadyClosed,
  ResultInvalidMessage, ResultConsumerNotInitialized, ResultProducerNotInitialized, ResultTooManyLookupRequestException,
  ResultInvalidTopicName, ResultInvalidUrl, ResultServiceUnitNotReady, ResultOperationNotSupported,
  ResultProducerBlockedQuotaExceededError, ResultProducerBlockedQuotaExceededException, ResultProducerQueueIsFull, ResultMessageTooBig,
  ResultTopicNotFound, ResultSubscriptionNotFound, ResultConsumerNotFound, ResultUnsupportedVersionError,
  ResultTopicTerminated, ResultCryptoError
}
 

Functions

const char * strResult (Result result)
 

Detailed Description

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Enumeration Type Documentation

Enumerator
ConsumerExclusive 

There can be only 1 consumer on the same topic with the same consumerName

ConsumerShared 

Multiple consumers will be able to use the same consumerName and the messages will be dispatched according to a round-robin rotation between the connected consumers

ConsumerFailover 

Only one consumer is active on the subscription; Subscription can have N consumers connected one of which will get promoted to master if the current master becomes inactive

Collection of return codes

Enumerator
ResultUnknownError 

Operation successful.

ResultInvalidConfiguration 

Unknown error happened on broker.

ResultTimeout 

Invalid configuration.

ResultLookupError 

Operation timed out.

ResultConnectError 

Broker lookup failed.

ResultReadError 

Failed to connect to broker.

ResultAuthenticationError 

Failed to read from socket.

ResultAuthorizationError 

Authentication failed on broker.

ResultErrorGettingAuthenticationData 

Client is not authorized to create producer/consumer.

ResultBrokerMetadataError 

Client cannot find authorization data.

ResultBrokerPersistenceError 

Broker failed in updating metadata.

ResultChecksumError 

Broker failed to persist entry.

ResultConsumerBusy 

Corrupt message checksum failure.

ResultNotConnected 

Exclusive consumer is already connected.

ResultAlreadyClosed 

Producer/Consumer is not currently connected to broker.

ResultInvalidMessage 

Producer/Consumer is already closed and not accepting any operation.

ResultConsumerNotInitialized 

Error in publishing an already used message.

ResultProducerNotInitialized 

Consumer is not initialized.

ResultTooManyLookupRequestException 

Producer is not initialized.

ResultInvalidTopicName 

Too Many concurrent LookupRequest.

ResultInvalidUrl 

Invalid topic name.

ResultServiceUnitNotReady 

Client Initialized with Invalid Broker Url (VIP Url passed to Client Constructor)

ResultOperationNotSupported 

Service Unit unloaded between client did lookup and producer/consumer got created

ResultProducerBlockedQuotaExceededException 

Producer is blocked.

ResultProducerQueueIsFull 

Producer is getting exception.

ResultMessageTooBig 

Producer queue is full.

ResultTopicNotFound 

Trying to send a messages exceeding the max size.

ResultSubscriptionNotFound 

Topic not found.

ResultConsumerNotFound 

Subscription not found.

ResultUnsupportedVersionError 

Consumer not found.

ResultTopicTerminated 

Error when an older client/version doesn't support a required feature.

ResultCryptoError 

Topic was already terminated.

Error when crypto operation fails