pulsar-client-cpp
Public Member Functions | Friends | List of all members
pulsar::Client Class Reference

Public Member Functions

 Client (const std::string &serviceUrl)
 
 Client (const std::string &serviceUrl, const ClientConfiguration &clientConfiguration)
 
Result createProducer (const std::string &topic, Producer &producer)
 
Result createProducer (const std::string &topic, const ProducerConfiguration &conf, Producer &producer)
 
void createProducerAsync (const std::string &topic, CreateProducerCallback callback)
 
void createProducerAsync (const std::string &topic, ProducerConfiguration conf, CreateProducerCallback callback)
 
Result subscribe (const std::string &topic, const std::string &consumerName, Consumer &consumer)
 
Result subscribe (const std::string &topic, const std::string &consumerName, const ConsumerConfiguration &conf, Consumer &consumer)
 
void subscribeAsync (const std::string &topic, const std::string &consumerName, SubscribeCallback callback)
 
void subscribeAsync (const std::string &topic, const std::string &consumerName, const ConsumerConfiguration &conf, SubscribeCallback callback)
 
Result close ()
 
void closeAsync (CloseCallback callback)
 
void shutdown ()
 

Friends

class PulsarFriend
 
class PulsarWrapper
 

Constructor & Destructor Documentation

◆ Client() [1/2]

pulsar::Client::Client ( const std::string &  serviceUrl)

Create a Pulsar client object connecting to the specified cluster address and using the default configuration.

Parameters
serviceUrlthe Pulsar endpoint to use (eg: pulsar://localhost:6650)

◆ Client() [2/2]

pulsar::Client::Client ( const std::string &  serviceUrl,
const ClientConfiguration clientConfiguration 
)

Create a Pulsar client object connecting to the specified cluster address and using the specified configuration.

Parameters
serviceUrlthe Pulsar endpoint to use (eg: http://brokerv2-pdev.messaging.corp.gq1.yahoo.com:4080 for Sandbox access)
clientConfigurationthe client configuration to use

Member Function Documentation

◆ close()

Result pulsar::Client::close ( )
Returns

◆ createProducer() [1/2]

Result pulsar::Client::createProducer ( const std::string &  topic,
Producer producer 
)

Create a producer with default configuration

See also
createProducer(const std::string&, const ProducerConfiguration&, Producer&)
Parameters
topicthe topic where the new producer will publish
producera non-const reference where the new producer will be copied
Returns
ResultOk if the producer has been successfully created
ResultError if there was an error

◆ createProducer() [2/2]

Result pulsar::Client::createProducer ( const std::string &  topic,
const ProducerConfiguration conf,
Producer producer 
)

Create a producer with specified configuration

See also
createProducer(const std::string&, const ProducerConfiguration&, Producer&)
Parameters
topicthe topic where the new producer will publish
confthe producer config to use
producera non-const reference where the new producer will be copied
Returns
ResultOk if the producer has been successfully created
ResultError if there was an error

The documentation for this class was generated from the following file: