diff --git a/static/api/cpp/3.5.x/_authentication_8h_source.html b/static/api/cpp/3.5.x/_authentication_8h_source.html new file mode 100644 index 000000000000..b64a91b72018 --- /dev/null +++ b/static/api/cpp/3.5.x/_authentication_8h_source.html @@ -0,0 +1,439 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/Authentication.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
Authentication.h
+
+
+
1
+
19#ifndef PULSAR_AUTHENTICATION_H_
+
20#define PULSAR_AUTHENTICATION_H_
+
21
+
22#include <pulsar/Result.h>
+
23#include <pulsar/defines.h>
+
24
+
25#include <functional>
+
26#include <map>
+
27#include <memory>
+
28#include <string>
+
29#include <vector>
+
30
+
+
31namespace pulsar {
+
32
+
33class ClientConfiguration;
+
34class Authentication;
+
35
+
+
36class PULSAR_PUBLIC AuthenticationDataProvider {
+
37 public:
+
38 virtual ~AuthenticationDataProvider();
+
39
+
43 virtual bool hasDataForTls();
+
44
+
48 virtual std::string getTlsCertificates();
+
49
+
53 virtual std::string getTlsPrivateKey();
+
54
+
58 virtual bool hasDataForHttp();
+
59
+
63 virtual std::string getHttpAuthType();
+
64
+
68 virtual std::string getHttpHeaders();
+
69
+
73 virtual bool hasDataFromCommand();
+
74
+
78 virtual std::string getCommandData();
+
79
+
80 protected:
+
81 AuthenticationDataProvider();
+
82};
+
+
83
+
84typedef std::shared_ptr<AuthenticationDataProvider> AuthenticationDataPtr;
+
85typedef std::shared_ptr<Authentication> AuthenticationPtr;
+
86typedef std::map<std::string, std::string> ParamMap;
+
87
+
+
88class PULSAR_PUBLIC Authentication {
+
89 public:
+
90 virtual ~Authentication();
+
91
+
95 virtual const std::string getAuthMethodName() const = 0;
+
96
+
+
104 virtual Result getAuthData(AuthenticationDataPtr& authDataContent) {
+
105 authDataContent = authData_;
+
106 return ResultOk;
+
107 }
+
+
108
+
120 static ParamMap parseDefaultFormatAuthParams(const std::string& authParamsString);
+
121
+
122 protected:
+
123 Authentication();
+
124 AuthenticationDataPtr authData_;
+
125 friend class ClientConfiguration;
+
126};
+
+
127
+
+
136class PULSAR_PUBLIC AuthFactory {
+
137 public:
+
138 static AuthenticationPtr Disabled();
+
139
+
145 static AuthenticationPtr create(const std::string& pluginNameOrDynamicLibPath);
+
146
+
153 static AuthenticationPtr create(const std::string& pluginNameOrDynamicLibPath,
+
154 const std::string& authParamsString);
+
155
+
172 static AuthenticationPtr create(const std::string& pluginNameOrDynamicLibPath, ParamMap& params);
+
173
+
174 protected:
+
175 static bool isShutdownHookRegistered_;
+
176 static std::vector<void*> loadedLibrariesHandles_;
+
177 static void release_handles();
+
178};
+
+
179
+
+
183class PULSAR_PUBLIC AuthTls : public Authentication {
+
184 public:
+
185 AuthTls(AuthenticationDataPtr&);
+
186 ~AuthTls();
+
187
+
194 static AuthenticationPtr create(ParamMap& params);
+
195
+
201 static AuthenticationPtr create(const std::string& authParamsString);
+
202
+
209 static AuthenticationPtr create(const std::string& certificatePath, const std::string& privateKeyPath);
+
210
+
214 const std::string getAuthMethodName() const;
+
215
+
223 Result getAuthData(AuthenticationDataPtr& authDataTls);
+
224
+
225 private:
+
226 AuthenticationDataPtr authDataTls_;
+
227};
+
+
228
+
229typedef std::function<std::string()> TokenSupplier;
+
230
+
+
234class PULSAR_PUBLIC AuthToken : public Authentication {
+
235 public:
+
236 AuthToken(AuthenticationDataPtr&);
+
237 ~AuthToken();
+
238
+
254 static AuthenticationPtr create(ParamMap& params);
+
255
+
261 static AuthenticationPtr create(const std::string& authParamsString);
+
262
+
269 static AuthenticationPtr createWithToken(const std::string& token);
+
270
+
277 static AuthenticationPtr create(const TokenSupplier& tokenSupplier);
+
278
+
282 const std::string getAuthMethodName() const;
+
283
+
291 Result getAuthData(AuthenticationDataPtr& authDataToken);
+
292
+
293 private:
+
294 AuthenticationDataPtr authDataToken_;
+
295};
+
+
296
+
+
300class PULSAR_PUBLIC AuthBasic : public Authentication {
+
301 public:
+
302 explicit AuthBasic(AuthenticationDataPtr&);
+
303 ~AuthBasic() override;
+
304
+
311 static AuthenticationPtr create(ParamMap& params);
+
312
+
318 static AuthenticationPtr create(const std::string& authParamsString);
+
319
+
323 static AuthenticationPtr create(const std::string& username, const std::string& password);
+
324
+
328 static AuthenticationPtr create(const std::string& username, const std::string& password,
+
329 const std::string& method);
+
330
+
334 const std::string getAuthMethodName() const override;
+
335
+
343 Result getAuthData(AuthenticationDataPtr& authDataBasic) override;
+
344
+
345 private:
+
346 AuthenticationDataPtr authDataBasic_;
+
347};
+
+
348
+
+
352class PULSAR_PUBLIC AuthAthenz : public Authentication {
+
353 public:
+
354 AuthAthenz(AuthenticationDataPtr&);
+
355 ~AuthAthenz();
+
356
+
366 static AuthenticationPtr create(ParamMap& params);
+
367
+
373 static AuthenticationPtr create(const std::string& authParamsString);
+
374
+
378 const std::string getAuthMethodName() const;
+
379
+
387 Result getAuthData(AuthenticationDataPtr& authDataAthenz);
+
388
+
389 private:
+
390 AuthenticationDataPtr authDataAthenz_;
+
391};
+
+
392
+
393// OAuth 2.0 token and associated information.
+
394// currently mainly works for access token
+
+
395class Oauth2TokenResult {
+
396 public:
+
397 enum
+
398 {
+
399 undefined_expiration = -1
+
400 };
+
401
+
402 Oauth2TokenResult();
+
403 ~Oauth2TokenResult();
+
404
+
410 Oauth2TokenResult& setAccessToken(const std::string& accessToken);
+
411
+
417 Oauth2TokenResult& setIdToken(const std::string& idToken);
+
418
+
425 Oauth2TokenResult& setRefreshToken(const std::string& refreshToken);
+
426
+
432 Oauth2TokenResult& setExpiresIn(const int64_t expiresIn);
+
433
+
437 const std::string& getAccessToken() const;
+
438
+
442 const std::string& getIdToken() const;
+
443
+
448 const std::string& getRefreshToken() const;
+
449
+
453 int64_t getExpiresIn() const;
+
454
+
455 private:
+
456 // map to json "access_token"
+
457 std::string accessToken_;
+
458 // map to json "id_token"
+
459 std::string idToken_;
+
460 // map to json "refresh_token"
+
461 std::string refreshToken_;
+
462 // map to json "expires_in"
+
463 int64_t expiresIn_;
+
464};
+
+
465
+
466typedef std::shared_ptr<Oauth2TokenResult> Oauth2TokenResultPtr;
+
467
+
+
468class Oauth2Flow {
+
469 public:
+
470 virtual ~Oauth2Flow();
+
471
+
475 virtual void initialize() = 0;
+
476
+
481 virtual Oauth2TokenResultPtr authenticate() = 0;
+
482
+
486 virtual void close() = 0;
+
487
+
488 protected:
+
489 Oauth2Flow();
+
490};
+
+
491
+
492typedef std::shared_ptr<Oauth2Flow> FlowPtr;
+
493
+
+
494class CachedToken {
+
495 public:
+
496 virtual ~CachedToken();
+
497
+
501 virtual bool isExpired() = 0;
+
502
+
508 virtual AuthenticationDataPtr getAuthData() = 0;
+
509
+
510 protected:
+
511 CachedToken();
+
512};
+
+
513
+
514typedef std::shared_ptr<CachedToken> CachedTokenPtr;
+
515
+
+
528class PULSAR_PUBLIC AuthOauth2 : public Authentication {
+
529 public:
+
530 AuthOauth2(ParamMap& params);
+
531 ~AuthOauth2();
+
532
+
541 static AuthenticationPtr create(ParamMap& params);
+
542
+
548 static AuthenticationPtr create(const std::string& authParamsString);
+
549
+
553 const std::string getAuthMethodName() const;
+
554
+
562 Result getAuthData(AuthenticationDataPtr& authDataOauth2);
+
563
+
564 private:
+
565 FlowPtr flowPtr_;
+
566 CachedTokenPtr cachedTokenPtr_;
+
567};
+
+
568
+
569} // namespace pulsar
+
+
570
+
571#endif /* PULSAR_AUTHENTICATION_H_ */
+
pulsar::AuthAthenz
Definition Authentication.h:352
+
pulsar::AuthAthenz::getAuthData
Result getAuthData(AuthenticationDataPtr &authDataAthenz)
+
pulsar::AuthAthenz::getAuthMethodName
const std::string getAuthMethodName() const
+
pulsar::AuthAthenz::create
static AuthenticationPtr create(ParamMap &params)
+
pulsar::AuthAthenz::create
static AuthenticationPtr create(const std::string &authParamsString)
+
pulsar::AuthBasic
Definition Authentication.h:300
+
pulsar::AuthBasic::getAuthData
Result getAuthData(AuthenticationDataPtr &authDataBasic) override
+
pulsar::AuthBasic::create
static AuthenticationPtr create(const std::string &username, const std::string &password)
+
pulsar::AuthBasic::create
static AuthenticationPtr create(const std::string &username, const std::string &password, const std::string &method)
+
pulsar::AuthBasic::create
static AuthenticationPtr create(const std::string &authParamsString)
+
pulsar::AuthBasic::getAuthMethodName
const std::string getAuthMethodName() const override
+
pulsar::AuthBasic::create
static AuthenticationPtr create(ParamMap &params)
+
pulsar::AuthFactory
Definition Authentication.h:136
+
pulsar::AuthFactory::create
static AuthenticationPtr create(const std::string &pluginNameOrDynamicLibPath)
+
pulsar::AuthFactory::create
static AuthenticationPtr create(const std::string &pluginNameOrDynamicLibPath, ParamMap &params)
+
pulsar::AuthFactory::create
static AuthenticationPtr create(const std::string &pluginNameOrDynamicLibPath, const std::string &authParamsString)
+
pulsar::AuthOauth2
Definition Authentication.h:528
+
pulsar::AuthOauth2::create
static AuthenticationPtr create(ParamMap &params)
+
pulsar::AuthOauth2::getAuthMethodName
const std::string getAuthMethodName() const
+
pulsar::AuthOauth2::create
static AuthenticationPtr create(const std::string &authParamsString)
+
pulsar::AuthOauth2::getAuthData
Result getAuthData(AuthenticationDataPtr &authDataOauth2)
+
pulsar::AuthTls
Definition Authentication.h:183
+
pulsar::AuthTls::create
static AuthenticationPtr create(const std::string &authParamsString)
+
pulsar::AuthTls::getAuthMethodName
const std::string getAuthMethodName() const
+
pulsar::AuthTls::create
static AuthenticationPtr create(ParamMap &params)
+
pulsar::AuthTls::create
static AuthenticationPtr create(const std::string &certificatePath, const std::string &privateKeyPath)
+
pulsar::AuthTls::getAuthData
Result getAuthData(AuthenticationDataPtr &authDataTls)
+
pulsar::AuthToken
Definition Authentication.h:234
+
pulsar::AuthToken::getAuthMethodName
const std::string getAuthMethodName() const
+
pulsar::AuthToken::getAuthData
Result getAuthData(AuthenticationDataPtr &authDataToken)
+
pulsar::AuthToken::createWithToken
static AuthenticationPtr createWithToken(const std::string &token)
+
pulsar::AuthToken::create
static AuthenticationPtr create(const std::string &authParamsString)
+
pulsar::AuthToken::create
static AuthenticationPtr create(ParamMap &params)
+
pulsar::AuthToken::create
static AuthenticationPtr create(const TokenSupplier &tokenSupplier)
+
pulsar::AuthenticationDataProvider
Definition Authentication.h:36
+ +
pulsar::AuthenticationDataProvider::getCommandData
virtual std::string getCommandData()
+
pulsar::AuthenticationDataProvider::getTlsPrivateKey
virtual std::string getTlsPrivateKey()
+
pulsar::AuthenticationDataProvider::getHttpHeaders
virtual std::string getHttpHeaders()
+
pulsar::AuthenticationDataProvider::getHttpAuthType
virtual std::string getHttpAuthType()
+
pulsar::AuthenticationDataProvider::getTlsCertificates
virtual std::string getTlsCertificates()
+ + +
pulsar::Authentication
Definition Authentication.h:88
+
pulsar::Authentication::parseDefaultFormatAuthParams
static ParamMap parseDefaultFormatAuthParams(const std::string &authParamsString)
+
pulsar::Authentication::getAuthData
virtual Result getAuthData(AuthenticationDataPtr &authDataContent)
Definition Authentication.h:104
+
pulsar::Authentication::getAuthMethodName
virtual const std::string getAuthMethodName() const =0
+
pulsar::CachedToken
Definition Authentication.h:494
+
pulsar::CachedToken::isExpired
virtual bool isExpired()=0
+
pulsar::CachedToken::getAuthData
virtual AuthenticationDataPtr getAuthData()=0
+
pulsar::ClientConfiguration
Definition ClientConfiguration.h:29
+
pulsar::Oauth2Flow
Definition Authentication.h:468
+
pulsar::Oauth2Flow::authenticate
virtual Oauth2TokenResultPtr authenticate()=0
+
pulsar::Oauth2Flow::initialize
virtual void initialize()=0
+
pulsar::Oauth2Flow::close
virtual void close()=0
+
pulsar::Oauth2TokenResult
Definition Authentication.h:395
+
pulsar::Oauth2TokenResult::getExpiresIn
int64_t getExpiresIn() const
+
pulsar::Oauth2TokenResult::getAccessToken
const std::string & getAccessToken() const
+
pulsar::Oauth2TokenResult::setRefreshToken
Oauth2TokenResult & setRefreshToken(const std::string &refreshToken)
+
pulsar::Oauth2TokenResult::setIdToken
Oauth2TokenResult & setIdToken(const std::string &idToken)
+
pulsar::Oauth2TokenResult::setExpiresIn
Oauth2TokenResult & setExpiresIn(const int64_t expiresIn)
+
pulsar::Oauth2TokenResult::getRefreshToken
const std::string & getRefreshToken() const
+
pulsar::Oauth2TokenResult::getIdToken
const std::string & getIdToken() const
+
pulsar::Oauth2TokenResult::setAccessToken
Oauth2TokenResult & setAccessToken(const std::string &accessToken)
+
pulsar
Definition Authentication.h:31
+
pulsar::Result
Result
Definition Result.h:32
+
pulsar::ResultOk
@ ResultOk
An internal error code used for retry.
Definition Result.h:34
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_batch_receive_policy_8h_source.html b/static/api/cpp/3.5.x/_batch_receive_policy_8h_source.html new file mode 100644 index 000000000000..4615918d61a9 --- /dev/null +++ b/static/api/cpp/3.5.x/_batch_receive_policy_8h_source.html @@ -0,0 +1,130 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/BatchReceivePolicy.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
BatchReceivePolicy.h
+
+
+
1
+
19#ifndef BATCH_RECEIVE_POLICY_HPP_
+
20#define BATCH_RECEIVE_POLICY_HPP_
+
21
+
22#include <pulsar/defines.h>
+
23
+
24#include <memory>
+
25
+
26namespace pulsar {
+
27
+
28struct BatchReceivePolicyImpl;
+
29
+
+
52class PULSAR_PUBLIC BatchReceivePolicy {
+
53 public:
+
57 BatchReceivePolicy();
+
58
+
66 BatchReceivePolicy(int maxNumMessage, long maxNumBytes, long timeoutMs);
+
67
+
73 long getTimeoutMs() const;
+
74
+
79 int getMaxNumMessages() const;
+
80
+
85 long getMaxNumBytes() const;
+
86
+
87 private:
+
88 std::shared_ptr<BatchReceivePolicyImpl> impl_;
+
89};
+
+
90} // namespace pulsar
+
91
+
92#endif /* BATCH_RECEIVE_POLICY_HPP_ */
+
pulsar::BatchReceivePolicy
Definition BatchReceivePolicy.h:52
+ + + + +
pulsar::BatchReceivePolicy::BatchReceivePolicy
BatchReceivePolicy(int maxNumMessage, long maxNumBytes, long timeoutMs)
+
pulsar
Definition Authentication.h:31
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_broker_consumer_stats_8h_source.html b/static/api/cpp/3.5.x/_broker_consumer_stats_8h_source.html new file mode 100644 index 000000000000..d5abaecc8e8e --- /dev/null +++ b/static/api/cpp/3.5.x/_broker_consumer_stats_8h_source.html @@ -0,0 +1,174 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/BrokerConsumerStats.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
BrokerConsumerStats.h
+
+
+
1
+
19#ifndef PULSAR_CPP_BROKERCONSUMERSTATS_H
+
20#define PULSAR_CPP_BROKERCONSUMERSTATS_H
+
21
+
22#include <pulsar/ConsumerType.h>
+
23#include <pulsar/Result.h>
+
24#include <pulsar/defines.h>
+
25
+
26#include <functional>
+
27#include <iostream>
+
28#include <memory>
+
29
+
30namespace pulsar {
+
31class BrokerConsumerStatsImplBase;
+
32class PulsarWrapper;
+
33
+
34/* @note: isValid() or getXXX() methods are not allowed on an invalid BrokerConsumerStats */
+
+
35class PULSAR_PUBLIC BrokerConsumerStats {
+
36 private:
+
37 std::shared_ptr<BrokerConsumerStatsImplBase> impl_;
+
38
+
39 public:
+
40 BrokerConsumerStats() = default;
+
41 explicit BrokerConsumerStats(std::shared_ptr<BrokerConsumerStatsImplBase> impl);
+
42
+
43 virtual ~BrokerConsumerStats() = default;
+
44
+
46 virtual bool isValid() const;
+
47
+
49 virtual double getMsgRateOut() const;
+
50
+
52 virtual double getMsgThroughputOut() const;
+
53
+
55 virtual double getMsgRateRedeliver() const;
+
56
+
58 virtual const std::string getConsumerName() const;
+
59
+
61 virtual uint64_t getAvailablePermits() const;
+
62
+
64 virtual uint64_t getUnackedMessages() const;
+
65
+
67 virtual bool isBlockedConsumerOnUnackedMsgs() const;
+
68
+
70 virtual const std::string getAddress() const;
+
71
+
73 virtual const std::string getConnectedSince() const;
+
74
+
76 virtual const ConsumerType getType() const;
+
77
+
79 virtual double getMsgRateExpired() const;
+
80
+
82 virtual uint64_t getMsgBacklog() const;
+
83
+
85 std::shared_ptr<BrokerConsumerStatsImplBase> getImpl() const;
+
86
+
87 friend class PulsarWrapper;
+
88 friend PULSAR_PUBLIC std::ostream &operator<<(std::ostream &os, const BrokerConsumerStats &obj);
+
89};
+
+
90typedef std::function<void(Result result, BrokerConsumerStats brokerConsumerStats)>
+
91 BrokerConsumerStatsCallback;
+
92} // namespace pulsar
+
93
+
94#endif // PULSAR_CPP_BROKERCONSUMERSTATS_H
+
pulsar::BrokerConsumerStats
Definition BrokerConsumerStats.h:35
+
pulsar::BrokerConsumerStats::getMsgRateOut
virtual double getMsgRateOut() const
+
pulsar::BrokerConsumerStats::getAvailablePermits
virtual uint64_t getAvailablePermits() const
+
pulsar::BrokerConsumerStats::getConsumerName
virtual const std::string getConsumerName() const
+
pulsar::BrokerConsumerStats::getImpl
std::shared_ptr< BrokerConsumerStatsImplBase > getImpl() const
+
pulsar::BrokerConsumerStats::getType
virtual const ConsumerType getType() const
+
pulsar::BrokerConsumerStats::getMsgBacklog
virtual uint64_t getMsgBacklog() const
+
pulsar::BrokerConsumerStats::isValid
virtual bool isValid() const
+
pulsar::BrokerConsumerStats::getAddress
virtual const std::string getAddress() const
+
pulsar::BrokerConsumerStats::getMsgThroughputOut
virtual double getMsgThroughputOut() const
+
pulsar::BrokerConsumerStats::getConnectedSince
virtual const std::string getConnectedSince() const
+
pulsar::BrokerConsumerStats::getMsgRateExpired
virtual double getMsgRateExpired() const
+
pulsar::BrokerConsumerStats::isBlockedConsumerOnUnackedMsgs
virtual bool isBlockedConsumerOnUnackedMsgs() const
+
pulsar::BrokerConsumerStats::getUnackedMessages
virtual uint64_t getUnackedMessages() const
+
pulsar::BrokerConsumerStats::getMsgRateRedeliver
virtual double getMsgRateRedeliver() const
+
pulsar
Definition Authentication.h:31
+
pulsar::ConsumerType
ConsumerType
Definition ConsumerType.h:24
+
pulsar::Result
Result
Definition Result.h:32
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_client_8h_source.html b/static/api/cpp/3.5.x/_client_8h_source.html new file mode 100644 index 000000000000..ea08a3e2c94d --- /dev/null +++ b/static/api/cpp/3.5.x/_client_8h_source.html @@ -0,0 +1,257 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/Client.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
Client.h
+
+
+
1
+
19#ifndef PULSAR_CLIENT_HPP_
+
20#define PULSAR_CLIENT_HPP_
+
21
+
22#include <pulsar/ClientConfiguration.h>
+
23#include <pulsar/ConsoleLoggerFactory.h>
+
24#include <pulsar/Consumer.h>
+
25#include <pulsar/FileLoggerFactory.h>
+
26#include <pulsar/Message.h>
+
27#include <pulsar/MessageBuilder.h>
+
28#include <pulsar/Producer.h>
+
29#include <pulsar/Reader.h>
+
30#include <pulsar/Result.h>
+
31#include <pulsar/Schema.h>
+
32#include <pulsar/TableView.h>
+
33#include <pulsar/defines.h>
+
34
+
35#include <string>
+
36
+
37namespace pulsar {
+
38typedef std::function<void(Result, Producer)> CreateProducerCallback;
+
39typedef std::function<void(Result, Consumer)> SubscribeCallback;
+
40typedef std::function<void(Result, Reader)> ReaderCallback;
+
41typedef std::function<void(Result, TableView)> TableViewCallback;
+
42typedef std::function<void(Result, const std::vector<std::string>&)> GetPartitionsCallback;
+
43typedef std::function<void(Result)> CloseCallback;
+
44
+
45class ClientImpl;
+
46class PulsarFriend;
+
47class PulsarWrapper;
+
48
+
+
49class PULSAR_PUBLIC Client {
+
50 public:
+
58 Client(const std::string& serviceUrl);
+
59
+
69 Client(const std::string& serviceUrl, const ClientConfiguration& clientConfiguration);
+
70
+
81 Result createProducer(const std::string& topic, Producer& producer);
+
82
+
94 Result createProducer(const std::string& topic, const ProducerConfiguration& conf, Producer& producer);
+
95
+
104 void createProducerAsync(const std::string& topic, CreateProducerCallback callback);
+
105
+
113 void createProducerAsync(const std::string& topic, ProducerConfiguration conf,
+
114 CreateProducerCallback callback);
+
115
+
124 Result subscribe(const std::string& topic, const std::string& subscriptionName, Consumer& consumer);
+
125
+
134 Result subscribe(const std::string& topic, const std::string& subscriptionName,
+
135 const ConsumerConfiguration& conf, Consumer& consumer);
+
136
+
146 void subscribeAsync(const std::string& topic, const std::string& subscriptionName,
+
147 SubscribeCallback callback);
+
148
+
159 void subscribeAsync(const std::string& topic, const std::string& subscriptionName,
+
160 const ConsumerConfiguration& conf, SubscribeCallback callback);
+
161
+
169 Result subscribe(const std::vector<std::string>& topics, const std::string& subscriptionName,
+
170 Consumer& consumer);
+
171
+
180 Result subscribe(const std::vector<std::string>& topics, const std::string& subscriptionName,
+
181 const ConsumerConfiguration& conf, Consumer& consumer);
+
182
+
193 void subscribeAsync(const std::vector<std::string>& topics, const std::string& subscriptionName,
+
194 SubscribeCallback callback);
+
195
+
206 void subscribeAsync(const std::vector<std::string>& topics, const std::string& subscriptionName,
+
207 const ConsumerConfiguration& conf, SubscribeCallback callback);
+
208
+
212 Result subscribeWithRegex(const std::string& regexPattern, const std::string& subscriptionName,
+
213 Consumer& consumer);
+
214
+
219 Result subscribeWithRegex(const std::string& regexPattern, const std::string& subscriptionName,
+
220 const ConsumerConfiguration& conf, Consumer& consumer);
+
221
+
229 void subscribeWithRegexAsync(const std::string& regexPattern, const std::string& subscriptionName,
+
230 SubscribeCallback callback);
+
231
+
242 void subscribeWithRegexAsync(const std::string& regexPattern, const std::string& subscriptionName,
+
243 const ConsumerConfiguration& conf, SubscribeCallback callback);
+
244
+
274 Result createReader(const std::string& topic, const MessageId& startMessageId,
+
275 const ReaderConfiguration& conf, Reader& reader);
+
276
+
303 void createReaderAsync(const std::string& topic, const MessageId& startMessageId,
+
304 const ReaderConfiguration& conf, ReaderCallback callback);
+
305
+
318 Result createTableView(const std::string& topic, const TableViewConfiguration& conf,
+
319 TableView& tableView);
+
320
+
333 void createTableViewAsync(const std::string& topic, const TableViewConfiguration& conf,
+
334 TableViewCallback callBack);
+
335
+
349 Result getPartitionsForTopic(const std::string& topic, std::vector<std::string>& partitions);
+
350
+
366 void getPartitionsForTopicAsync(const std::string& topic, GetPartitionsCallback callback);
+
367
+
372 Result close();
+
373
+
383 void closeAsync(CloseCallback callback);
+
384
+
391 void shutdown();
+
392
+
398 uint64_t getNumberOfProducers();
+
399
+
405 uint64_t getNumberOfConsumers();
+
406
+
414 void getSchemaInfoAsync(const std::string& topic, int64_t version,
+
415 std::function<void(Result, const SchemaInfo&)> callback);
+
416
+
417 private:
+
418 Client(const std::shared_ptr<ClientImpl>);
+
419
+
420 friend class PulsarFriend;
+
421 friend class PulsarWrapper;
+
422 std::shared_ptr<ClientImpl> impl_;
+
423};
+
+
424} // namespace pulsar
+
425
+
426#endif /* PULSAR_CLIENT_HPP_ */
+
pulsar::ClientConfiguration
Definition ClientConfiguration.h:29
+
pulsar::Client
Definition Client.h:49
+
pulsar::Client::subscribeWithRegex
Result subscribeWithRegex(const std::string &regexPattern, const std::string &subscriptionName, Consumer &consumer)
+
pulsar::Client::subscribeWithRegex
Result subscribeWithRegex(const std::string &regexPattern, const std::string &subscriptionName, const ConsumerConfiguration &conf, Consumer &consumer)
+
pulsar::Client::getNumberOfConsumers
uint64_t getNumberOfConsumers()
Get the number of alive consumers on the current client.
+
pulsar::Client::subscribe
Result subscribe(const std::string &topic, const std::string &subscriptionName, const ConsumerConfiguration &conf, Consumer &consumer)
+
pulsar::Client::Client
Client(const std::string &serviceUrl, const ClientConfiguration &clientConfiguration)
+
pulsar::Client::getPartitionsForTopic
Result getPartitionsForTopic(const std::string &topic, std::vector< std::string > &partitions)
+
pulsar::Client::getPartitionsForTopicAsync
void getPartitionsForTopicAsync(const std::string &topic, GetPartitionsCallback callback)
+
pulsar::Client::subscribeAsync
void subscribeAsync(const std::vector< std::string > &topics, const std::string &subscriptionName, SubscribeCallback callback)
+
pulsar::Client::createProducerAsync
void createProducerAsync(const std::string &topic, ProducerConfiguration conf, CreateProducerCallback callback)
+
pulsar::Client::subscribeWithRegexAsync
void subscribeWithRegexAsync(const std::string &regexPattern, const std::string &subscriptionName, SubscribeCallback callback)
+
pulsar::Client::getNumberOfProducers
uint64_t getNumberOfProducers()
Get the number of alive producers on the current client.
+
pulsar::Client::subscribeAsync
void subscribeAsync(const std::string &topic, const std::string &subscriptionName, SubscribeCallback callback)
+
pulsar::Client::createProducerAsync
void createProducerAsync(const std::string &topic, CreateProducerCallback callback)
+
pulsar::Client::subscribeAsync
void subscribeAsync(const std::string &topic, const std::string &subscriptionName, const ConsumerConfiguration &conf, SubscribeCallback callback)
+
pulsar::Client::subscribe
Result subscribe(const std::vector< std::string > &topics, const std::string &subscriptionName, const ConsumerConfiguration &conf, Consumer &consumer)
+
pulsar::Client::createProducer
Result createProducer(const std::string &topic, Producer &producer)
+
pulsar::Client::subscribe
Result subscribe(const std::string &topic, const std::string &subscriptionName, Consumer &consumer)
+
pulsar::Client::getSchemaInfoAsync
void getSchemaInfoAsync(const std::string &topic, int64_t version, std::function< void(Result, const SchemaInfo &)> callback)
+
pulsar::Client::createProducer
Result createProducer(const std::string &topic, const ProducerConfiguration &conf, Producer &producer)
+
pulsar::Client::createTableView
Result createTableView(const std::string &topic, const TableViewConfiguration &conf, TableView &tableView)
+
pulsar::Client::createReaderAsync
void createReaderAsync(const std::string &topic, const MessageId &startMessageId, const ReaderConfiguration &conf, ReaderCallback callback)
+
pulsar::Client::subscribeWithRegexAsync
void subscribeWithRegexAsync(const std::string &regexPattern, const std::string &subscriptionName, const ConsumerConfiguration &conf, SubscribeCallback callback)
+
pulsar::Client::close
Result close()
+
pulsar::Client::Client
Client(const std::string &serviceUrl)
+
pulsar::Client::closeAsync
void closeAsync(CloseCallback callback)
+
pulsar::Client::createReader
Result createReader(const std::string &topic, const MessageId &startMessageId, const ReaderConfiguration &conf, Reader &reader)
+
pulsar::Client::createTableViewAsync
void createTableViewAsync(const std::string &topic, const TableViewConfiguration &conf, TableViewCallback callBack)
+
pulsar::Client::subscribe
Result subscribe(const std::vector< std::string > &topics, const std::string &subscriptionName, Consumer &consumer)
+ +
pulsar::Client::subscribeAsync
void subscribeAsync(const std::vector< std::string > &topics, const std::string &subscriptionName, const ConsumerConfiguration &conf, SubscribeCallback callback)
+
pulsar::ConsumerConfiguration
Definition ConsumerConfiguration.h:65
+
pulsar::Consumer
Definition Consumer.h:37
+
pulsar::MessageId
Definition MessageId.h:34
+
pulsar::ProducerConfiguration
Definition ProducerConfiguration.h:45
+
pulsar::Producer
Definition Producer.h:36
+
pulsar::ReaderConfiguration
Definition ReaderConfiguration.h:49
+
pulsar::Reader
Definition Reader.h:37
+
pulsar::SchemaInfo
Definition Schema.h:146
+
pulsar::TableView
Definition TableView.h:38
+
pulsar
Definition Authentication.h:31
+
pulsar::Result
Result
Definition Result.h:32
+
pulsar::TableViewConfiguration
Definition TableViewConfiguration.h:27
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_client_configuration_8h_source.html b/static/api/cpp/3.5.x/_client_configuration_8h_source.html new file mode 100644 index 000000000000..b47470a36a15 --- /dev/null +++ b/static/api/cpp/3.5.x/_client_configuration_8h_source.html @@ -0,0 +1,298 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/ClientConfiguration.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
ClientConfiguration.h
+
+
+
1
+
19#ifndef PULSAR_CLIENTCONFIGURATION_H_
+
20#define PULSAR_CLIENTCONFIGURATION_H_
+
21
+
22#include <pulsar/Authentication.h>
+
23#include <pulsar/Logger.h>
+
24#include <pulsar/defines.h>
+
25
+
26namespace pulsar {
+
27class PulsarWrapper;
+
28struct ClientConfigurationImpl;
+
+
29class PULSAR_PUBLIC ClientConfiguration {
+
30 public:
+
31 ClientConfiguration();
+
32 ~ClientConfiguration();
+
33 ClientConfiguration(const ClientConfiguration&);
+
34 ClientConfiguration& operator=(const ClientConfiguration&);
+
35 enum ProxyProtocol
+
36 {
+
37 SNI = 0
+
38 };
+
39
+
46 ClientConfiguration& setMemoryLimit(uint64_t memoryLimitBytes);
+
47
+
51 uint64_t getMemoryLimit() const;
+
52
+
61 ClientConfiguration& setConnectionsPerBroker(int connectionsPerBroker);
+
62
+
66 int getConnectionsPerBroker() const;
+
67
+
73 ClientConfiguration& setAuth(const AuthenticationPtr& authentication);
+
74
+
78 Authentication& getAuth() const;
+
79
+
86 ClientConfiguration& setOperationTimeoutSeconds(int timeout);
+
87
+
91 int getOperationTimeoutSeconds() const;
+
92
+
99 ClientConfiguration& setIOThreads(int threads);
+
100
+
104 int getIOThreads() const;
+
105
+
116 ClientConfiguration& setMessageListenerThreads(int threads);
+
117
+
121 int getMessageListenerThreads() const;
+
122
+
131 ClientConfiguration& setConcurrentLookupRequest(int concurrentLookupRequest);
+
132
+
136 int getConcurrentLookupRequest() const;
+
137
+
144 ClientConfiguration& setMaxLookupRedirects(int maxLookupRedirects);
+
145
+
149 int getMaxLookupRedirects() const;
+
150
+
157 ClientConfiguration& setInitialBackoffIntervalMs(int initialBackoffIntervalMs);
+
158
+
162 int getInitialBackoffIntervalMs() const;
+
163
+
170 ClientConfiguration& setMaxBackoffIntervalMs(int maxBackoffIntervalMs);
+
171
+
175 int getMaxBackoffIntervalMs() const;
+
176
+
188 ClientConfiguration& setLogger(LoggerFactory* loggerFactory);
+
189
+
197 ClientConfiguration& setUseTls(bool useTls);
+
198
+
202 bool isUseTls() const;
+
203
+
209 ClientConfiguration& setTlsPrivateKeyFilePath(const std::string& tlsKeyFilePath);
+
210
+
214 const std::string& getTlsPrivateKeyFilePath() const;
+
215
+
221 ClientConfiguration& setTlsCertificateFilePath(const std::string& tlsCertificateFilePath);
+
222
+
226 const std::string& getTlsCertificateFilePath() const;
+
227
+
233 ClientConfiguration& setTlsTrustCertsFilePath(const std::string& tlsTrustCertsFilePath);
+
234
+
238 const std::string& getTlsTrustCertsFilePath() const;
+
239
+
247 ClientConfiguration& setTlsAllowInsecureConnection(bool allowInsecure);
+
248
+
252 bool isTlsAllowInsecureConnection() const;
+
253
+
267 ClientConfiguration& setValidateHostName(bool validateHostName);
+
268
+
272 bool isValidateHostName() const;
+
273
+
279 ClientConfiguration& setListenerName(const std::string& listenerName);
+
280
+
284 const std::string& getListenerName() const;
+
285
+
293 ClientConfiguration& setStatsIntervalInSeconds(const unsigned int&);
+
294
+
298 const unsigned int& getStatsIntervalInSeconds() const;
+
299
+
309 ClientConfiguration& setPartititionsUpdateInterval(unsigned int intervalInSeconds);
+
310
+
314 unsigned int getPartitionsUpdateInterval() const;
+
315
+
325 ClientConfiguration& setConnectionTimeout(int timeoutMs);
+
326
+
336 ClientConfiguration& setProxyServiceUrl(const std::string& proxyServiceUrl);
+
337
+
338 const std::string& getProxyServiceUrl() const;
+
339
+
350 ClientConfiguration& setProxyProtocol(ProxyProtocol proxyProtocol);
+
351
+
352 ProxyProtocol getProxyProtocol() const;
+
353
+
357 int getConnectionTimeout() const;
+
358
+
359 friend class ClientImpl;
+
360 friend class PulsarWrapper;
+
361
+
362 private:
+
363 const AuthenticationPtr& getAuthPtr() const;
+
364 std::shared_ptr<ClientConfigurationImpl> impl_;
+
365
+
366 // By default, when the client connects to the broker, a version string like "Pulsar-CPP-v<x.y.z>" will be
+
367 // carried and saved by the broker. The client version string could be queried from the topic stats.
+
368 //
+
369 // This method provides a way to add more description to a specific `Client` instance. If it's configured,
+
370 // the description will be appended to the original client version string, with '-' as the separator.
+
371 //
+
372 // For example, if the client version is 3.2.0, and the description is "forked", the final client version
+
373 // string will be "Pulsar-CPP-v3.2.0-forked".
+
374 //
+
375 // NOTE: This method should only be called by the PulsarWrapper and the length should not exceed 64.
+
376 //
+
377 // For example, you can add a PulsarWrapper class like:
+
378 //
+
379 // ```c++
+
380 // namespace pulsar {
+
381 // class PulsarWrapper {
+
382 // static ClientConfiguration clientConfig() {
+
383 // ClientConfiguration conf;
+
384 // conf.setDescription("forked");
+
385 // return conf;
+
386 // }
+
387 // };
+
388 // }
+
389 // ```
+
390 //
+
391 // Then, call the method before passing the `conf` to the constructor of `Client`:
+
392 //
+
393 // ```c++
+
394 // auto conf = PulsarWrapper::clientConfig();
+
395 // // Set other attributes of `conf` here...
+
396 // Client client{"pulsar://localhost:6650", conf);
+
397 // ```
+
398 ClientConfiguration& setDescription(const std::string& description);
+
399
+
400 const std::string& getDescription() const noexcept;
+
401};
+
+
402} // namespace pulsar
+
403
+
404#endif /* PULSAR_CLIENTCONFIGURATION_H_ */
+
pulsar::Authentication
Definition Authentication.h:88
+
pulsar::ClientConfiguration
Definition ClientConfiguration.h:29
+
pulsar::ClientConfiguration::getConnectionsPerBroker
int getConnectionsPerBroker() const
+
pulsar::ClientConfiguration::setStatsIntervalInSeconds
ClientConfiguration & setStatsIntervalInSeconds(const unsigned int &)
+
pulsar::ClientConfiguration::getInitialBackoffIntervalMs
int getInitialBackoffIntervalMs() const
+
pulsar::ClientConfiguration::setValidateHostName
ClientConfiguration & setValidateHostName(bool validateHostName)
+
pulsar::ClientConfiguration::isTlsAllowInsecureConnection
bool isTlsAllowInsecureConnection() const
+
pulsar::ClientConfiguration::setLogger
ClientConfiguration & setLogger(LoggerFactory *loggerFactory)
+
pulsar::ClientConfiguration::getTlsTrustCertsFilePath
const std::string & getTlsTrustCertsFilePath() const
+
pulsar::ClientConfiguration::setAuth
ClientConfiguration & setAuth(const AuthenticationPtr &authentication)
+
pulsar::ClientConfiguration::getListenerName
const std::string & getListenerName() const
+
pulsar::ClientConfiguration::getAuth
Authentication & getAuth() const
+
pulsar::ClientConfiguration::setConnectionsPerBroker
ClientConfiguration & setConnectionsPerBroker(int connectionsPerBroker)
+
pulsar::ClientConfiguration::getStatsIntervalInSeconds
const unsigned int & getStatsIntervalInSeconds() const
+
pulsar::ClientConfiguration::setMaxBackoffIntervalMs
ClientConfiguration & setMaxBackoffIntervalMs(int maxBackoffIntervalMs)
+
pulsar::ClientConfiguration::getTlsCertificateFilePath
const std::string & getTlsCertificateFilePath() const
+ +
pulsar::ClientConfiguration::setPartititionsUpdateInterval
ClientConfiguration & setPartititionsUpdateInterval(unsigned int intervalInSeconds)
+
pulsar::ClientConfiguration::setMessageListenerThreads
ClientConfiguration & setMessageListenerThreads(int threads)
+
pulsar::ClientConfiguration::setTlsTrustCertsFilePath
ClientConfiguration & setTlsTrustCertsFilePath(const std::string &tlsTrustCertsFilePath)
+
pulsar::ClientConfiguration::setConnectionTimeout
ClientConfiguration & setConnectionTimeout(int timeoutMs)
+
pulsar::ClientConfiguration::getMaxBackoffIntervalMs
int getMaxBackoffIntervalMs() const
+
pulsar::ClientConfiguration::setIOThreads
ClientConfiguration & setIOThreads(int threads)
+
pulsar::ClientConfiguration::getOperationTimeoutSeconds
int getOperationTimeoutSeconds() const
+
pulsar::ClientConfiguration::setTlsCertificateFilePath
ClientConfiguration & setTlsCertificateFilePath(const std::string &tlsCertificateFilePath)
+
pulsar::ClientConfiguration::setProxyServiceUrl
ClientConfiguration & setProxyServiceUrl(const std::string &proxyServiceUrl)
+
pulsar::ClientConfiguration::getMessageListenerThreads
int getMessageListenerThreads() const
+
pulsar::ClientConfiguration::getTlsPrivateKeyFilePath
const std::string & getTlsPrivateKeyFilePath() const
+ +
pulsar::ClientConfiguration::setTlsPrivateKeyFilePath
ClientConfiguration & setTlsPrivateKeyFilePath(const std::string &tlsKeyFilePath)
+
pulsar::ClientConfiguration::setConcurrentLookupRequest
ClientConfiguration & setConcurrentLookupRequest(int concurrentLookupRequest)
+
pulsar::ClientConfiguration::getPartitionsUpdateInterval
unsigned int getPartitionsUpdateInterval() const
+
pulsar::ClientConfiguration::setTlsAllowInsecureConnection
ClientConfiguration & setTlsAllowInsecureConnection(bool allowInsecure)
+
pulsar::ClientConfiguration::getMemoryLimit
uint64_t getMemoryLimit() const
+
pulsar::ClientConfiguration::getConcurrentLookupRequest
int getConcurrentLookupRequest() const
+ +
pulsar::ClientConfiguration::setMaxLookupRedirects
ClientConfiguration & setMaxLookupRedirects(int maxLookupRedirects)
+
pulsar::ClientConfiguration::setOperationTimeoutSeconds
ClientConfiguration & setOperationTimeoutSeconds(int timeout)
+ +
pulsar::ClientConfiguration::setListenerName
ClientConfiguration & setListenerName(const std::string &listenerName)
+
pulsar::ClientConfiguration::setProxyProtocol
ClientConfiguration & setProxyProtocol(ProxyProtocol proxyProtocol)
+
pulsar::ClientConfiguration::setMemoryLimit
ClientConfiguration & setMemoryLimit(uint64_t memoryLimitBytes)
+
pulsar::ClientConfiguration::setUseTls
ClientConfiguration & setUseTls(bool useTls)
+ +
pulsar::ClientConfiguration::setInitialBackoffIntervalMs
ClientConfiguration & setInitialBackoffIntervalMs(int initialBackoffIntervalMs)
+
pulsar::LoggerFactory
Definition Logger.h:58
+
pulsar
Definition Authentication.h:31
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_compression_type_8h_source.html b/static/api/cpp/3.5.x/_compression_type_8h_source.html new file mode 100644 index 000000000000..e094419ee17a --- /dev/null +++ b/static/api/cpp/3.5.x/_compression_type_8h_source.html @@ -0,0 +1,108 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/CompressionType.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
CompressionType.h
+
+
+
1
+
19#ifndef PULSAR_COMPRESSIONTYPE_H_
+
20#define PULSAR_COMPRESSIONTYPE_H_
+
21
+
22namespace pulsar {
+
23enum CompressionType
+
24{
+
25 CompressionNone = 0,
+
26 CompressionLZ4 = 1,
+
27 CompressionZLib = 2,
+
28 CompressionZSTD = 3,
+
29 CompressionSNAPPY = 4
+
30};
+
31}
+
32
+
33#endif /* PULSAR_COMPRESSIONTYPE_H_ */
+
pulsar
Definition Authentication.h:31
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_console_logger_factory_8h_source.html b/static/api/cpp/3.5.x/_console_logger_factory_8h_source.html new file mode 100644 index 000000000000..01817d26610f --- /dev/null +++ b/static/api/cpp/3.5.x/_console_logger_factory_8h_source.html @@ -0,0 +1,120 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/ConsoleLoggerFactory.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
ConsoleLoggerFactory.h
+
+
+
1
+
20#pragma once
+
21
+
22#include <pulsar/Logger.h>
+
23
+
24namespace pulsar {
+
25
+
26class ConsoleLoggerFactoryImpl;
+
27
+
+
49class PULSAR_PUBLIC ConsoleLoggerFactory : public LoggerFactory {
+
50 public:
+
51 explicit ConsoleLoggerFactory(Logger::Level level = Logger::LEVEL_INFO);
+
52
+
53 ~ConsoleLoggerFactory();
+
54
+
55 Logger* getLogger(const std::string& fileName) override;
+
56
+
57 private:
+
58 std::unique_ptr<ConsoleLoggerFactoryImpl> impl_;
+
59};
+
+
60
+
61} // namespace pulsar
+
pulsar::ConsoleLoggerFactory
Definition ConsoleLoggerFactory.h:49
+
pulsar::ConsoleLoggerFactory::getLogger
Logger * getLogger(const std::string &fileName) override
+
pulsar::LoggerFactory
Definition Logger.h:58
+
pulsar::Logger
Definition Logger.h:28
+
pulsar
Definition Authentication.h:31
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_consumer_8h_source.html b/static/api/cpp/3.5.x/_consumer_8h_source.html new file mode 100644 index 000000000000..ed474bc79e3a --- /dev/null +++ b/static/api/cpp/3.5.x/_consumer_8h_source.html @@ -0,0 +1,270 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/Consumer.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
Consumer.h
+
+
+
1
+
19#ifndef CONSUMER_HPP_
+
20#define CONSUMER_HPP_
+
21
+
22#include <pulsar/BrokerConsumerStats.h>
+
23#include <pulsar/ConsumerConfiguration.h>
+
24#include <pulsar/TypedMessage.h>
+
25#include <pulsar/defines.h>
+
26
+
27#include <iostream>
+
28
+
29namespace pulsar {
+
30class PulsarWrapper;
+
31class ConsumerImplBase;
+
32class PulsarFriend;
+
33typedef std::shared_ptr<ConsumerImplBase> ConsumerImplBasePtr;
+
+
37class PULSAR_PUBLIC Consumer {
+
38 public:
+
42 Consumer();
+
43 virtual ~Consumer() = default;
+
44
+
48 const std::string& getTopic() const;
+
49
+
53 const std::string& getSubscriptionName() const;
+
54
+
58 const std::string& getConsumerName() const;
+
59
+
73 Result unsubscribe();
+
74
+
86 void unsubscribeAsync(ResultCallback callback);
+
87
+
98 Result receive(Message& msg);
+
99
+
100 template <typename T>
+
101 Result receive(TypedMessage<T>& msg, typename TypedMessage<T>::Decoder decoder) {
+
102 Message rawMsg;
+
103 auto result = receive(rawMsg);
+
104 msg = TypedMessage<T>{rawMsg, decoder};
+
105 return result;
+
106 }
+
107
+
116 Result receive(Message& msg, int timeoutMs);
+
117
+
118 template <typename T>
+
119 Result receive(TypedMessage<T>& msg, int timeoutMs, typename TypedMessage<T>::Decoder decoder) {
+
120 Message rawMsg;
+
121 auto result = receive(rawMsg, timeoutMs);
+
122 msg = TypedMessage<T>{rawMsg, decoder};
+
123 return result;
+
124 }
+
125
+
137 void receiveAsync(ReceiveCallback callback);
+
138
+
139 template <typename T>
+
140 void receiveAsync(std::function<void(Result result, const TypedMessage<T>&)> callback,
+
141 typename TypedMessage<T>::Decoder decoder) {
+
142 receiveAsync([callback, decoder](Result result, const Message& msg) {
+
143 callback(result, TypedMessage<T>{msg, decoder});
+
144 });
+
145 }
+
146
+
157 Result batchReceive(Messages& msgs);
+
158
+
170 void batchReceiveAsync(BatchReceiveCallback callback);
+
171
+
183 Result acknowledge(const Message& message);
+
184
+
195 Result acknowledge(const MessageId& messageId);
+
196
+
201 Result acknowledge(const MessageIdList& messageIdList);
+
202
+
212 void acknowledgeAsync(const Message& message, ResultCallback callback);
+
213
+
223 void acknowledgeAsync(const MessageId& messageId, ResultCallback callback);
+
224
+
231 void acknowledgeAsync(const MessageIdList& messageIdList, ResultCallback callback);
+
232
+
250 Result acknowledgeCumulative(const Message& message);
+
251
+
268 Result acknowledgeCumulative(const MessageId& messageId);
+
269
+
280 void acknowledgeCumulativeAsync(const Message& message, ResultCallback callback);
+
281
+
292 void acknowledgeCumulativeAsync(const MessageId& messageId, ResultCallback callback);
+
293
+
324 void negativeAcknowledge(const Message& message);
+
325
+
356 void negativeAcknowledge(const MessageId& messageId);
+
357
+
361 Result close();
+
362
+
367 void closeAsync(ResultCallback callback);
+
368
+
372 Result pauseMessageListener();
+
373
+
378 Result resumeMessageListener();
+
379
+
389 void redeliverUnacknowledgedMessages();
+
390
+
403 Result getBrokerConsumerStats(BrokerConsumerStats& brokerConsumerStats);
+
404
+
416 void getBrokerConsumerStatsAsync(BrokerConsumerStatsCallback callback);
+
417
+
428 Result seek(const MessageId& messageId);
+
429
+
436 Result seek(uint64_t timestamp);
+
437
+
448 virtual void seekAsync(const MessageId& messageId, ResultCallback callback);
+
449
+
456 virtual void seekAsync(uint64_t timestamp, ResultCallback callback);
+
457
+
461 bool isConnected() const;
+
462
+
467 void getLastMessageIdAsync(GetLastMessageIdCallback callback);
+
468
+
472 Result getLastMessageId(MessageId& messageId);
+
473
+
474 private:
+
475 ConsumerImplBasePtr impl_;
+
476 explicit Consumer(ConsumerImplBasePtr);
+
477
+
478 friend class PulsarFriend;
+
479 friend class PulsarWrapper;
+
480 friend class MultiTopicsConsumerImpl;
+
481 friend class ConsumerImpl;
+
482 friend class ClientImpl;
+
483 friend class ConsumerTest;
+
484};
+
+
485} // namespace pulsar
+
486
+
487#endif /* CONSUMER_HPP_ */
+
pulsar::BrokerConsumerStats
Definition BrokerConsumerStats.h:35
+
pulsar::Consumer
Definition Consumer.h:37
+
pulsar::Consumer::seekAsync
virtual void seekAsync(uint64_t timestamp, ResultCallback callback)
+
pulsar::Consumer::receiveAsync
void receiveAsync(ReceiveCallback callback)
+
pulsar::Consumer::getBrokerConsumerStatsAsync
void getBrokerConsumerStatsAsync(BrokerConsumerStatsCallback callback)
+
pulsar::Consumer::resumeMessageListener
Result resumeMessageListener()
+
pulsar::Consumer::closeAsync
void closeAsync(ResultCallback callback)
+
pulsar::Consumer::acknowledgeAsync
void acknowledgeAsync(const MessageId &messageId, ResultCallback callback)
+
pulsar::Consumer::acknowledge
Result acknowledge(const Message &message)
+
pulsar::Consumer::negativeAcknowledge
void negativeAcknowledge(const Message &message)
+
pulsar::Consumer::redeliverUnacknowledgedMessages
void redeliverUnacknowledgedMessages()
+
pulsar::Consumer::acknowledgeCumulative
Result acknowledgeCumulative(const Message &message)
+
pulsar::Consumer::seek
Result seek(const MessageId &messageId)
+
pulsar::Consumer::batchReceive
Result batchReceive(Messages &msgs)
+
pulsar::Consumer::unsubscribe
Result unsubscribe()
+
pulsar::Consumer::acknowledge
Result acknowledge(const MessageIdList &messageIdList)
+
pulsar::Consumer::acknowledgeCumulativeAsync
void acknowledgeCumulativeAsync(const MessageId &messageId, ResultCallback callback)
+
pulsar::Consumer::getBrokerConsumerStats
Result getBrokerConsumerStats(BrokerConsumerStats &brokerConsumerStats)
+
pulsar::Consumer::acknowledgeCumulativeAsync
void acknowledgeCumulativeAsync(const Message &message, ResultCallback callback)
+
pulsar::Consumer::pauseMessageListener
Result pauseMessageListener()
+
pulsar::Consumer::acknowledgeAsync
void acknowledgeAsync(const MessageIdList &messageIdList, ResultCallback callback)
+
pulsar::Consumer::acknowledgeCumulative
Result acknowledgeCumulative(const MessageId &messageId)
+
pulsar::Consumer::getConsumerName
const std::string & getConsumerName() const
+
pulsar::Consumer::acknowledgeAsync
void acknowledgeAsync(const Message &message, ResultCallback callback)
+
pulsar::Consumer::unsubscribeAsync
void unsubscribeAsync(ResultCallback callback)
+ +
pulsar::Consumer::isConnected
bool isConnected() const
+
pulsar::Consumer::receive
Result receive(Message &msg)
+
pulsar::Consumer::batchReceiveAsync
void batchReceiveAsync(BatchReceiveCallback callback)
+
pulsar::Consumer::receive
Result receive(Message &msg, int timeoutMs)
+
pulsar::Consumer::getTopic
const std::string & getTopic() const
+
pulsar::Consumer::seek
Result seek(uint64_t timestamp)
+
pulsar::Consumer::acknowledge
Result acknowledge(const MessageId &messageId)
+
pulsar::Consumer::seekAsync
virtual void seekAsync(const MessageId &messageId, ResultCallback callback)
+
pulsar::Consumer::getSubscriptionName
const std::string & getSubscriptionName() const
+
pulsar::Consumer::getLastMessageId
Result getLastMessageId(MessageId &messageId)
+
pulsar::Consumer::getLastMessageIdAsync
void getLastMessageIdAsync(GetLastMessageIdCallback callback)
+
pulsar::Consumer::negativeAcknowledge
void negativeAcknowledge(const MessageId &messageId)
+ +
pulsar::Message
Definition Message.h:44
+
pulsar::MessageId
Definition MessageId.h:34
+
pulsar::TypedMessage
Definition TypedMessage.h:28
+
pulsar
Definition Authentication.h:31
+
pulsar::Messages
std::vector< Message > Messages
Callback definition for non-data operation.
Definition ConsumerConfiguration.h:49
+
pulsar::ResultCallback
std::function< void(Result result)> ResultCallback
Callback definition for non-data operation.
Definition ConsumerConfiguration.h:50
+
pulsar::Result
Result
Definition Result.h:32
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_consumer_configuration_8h_source.html b/static/api/cpp/3.5.x/_consumer_configuration_8h_source.html new file mode 100644 index 000000000000..e0ebc6f22f32 --- /dev/null +++ b/static/api/cpp/3.5.x/_consumer_configuration_8h_source.html @@ -0,0 +1,396 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/ConsumerConfiguration.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
ConsumerConfiguration.h
+
+
+
1
+
19#ifndef PULSAR_CONSUMERCONFIGURATION_H_
+
20#define PULSAR_CONSUMERCONFIGURATION_H_
+
21
+
22#include <pulsar/ConsumerCryptoFailureAction.h>
+
23#include <pulsar/ConsumerEventListener.h>
+
24#include <pulsar/ConsumerInterceptor.h>
+
25#include <pulsar/ConsumerType.h>
+
26#include <pulsar/CryptoKeyReader.h>
+
27#include <pulsar/InitialPosition.h>
+
28#include <pulsar/KeySharedPolicy.h>
+
29#include <pulsar/Message.h>
+
30#include <pulsar/RegexSubscriptionMode.h>
+
31#include <pulsar/Result.h>
+
32#include <pulsar/Schema.h>
+
33#include <pulsar/TypedMessage.h>
+
34#include <pulsar/defines.h>
+
35
+
36#include <functional>
+
37#include <memory>
+
38
+
39#include "BatchReceivePolicy.h"
+
40#include "DeadLetterPolicy.h"
+
41
+
42namespace pulsar {
+
43
+
44class Consumer;
+
45class PulsarWrapper;
+
46class PulsarFriend;
+
47
+
49typedef std::vector<Message> Messages;
+
50typedef std::function<void(Result result)> ResultCallback;
+
51typedef std::function<void(Result, const Message& msg)> ReceiveCallback;
+
52typedef std::function<void(Result, const Messages& msgs)> BatchReceiveCallback;
+
53typedef std::function<void(Result result, MessageId messageId)> GetLastMessageIdCallback;
+
54
+
56typedef std::function<void(Consumer& consumer, const Message& msg)> MessageListener;
+
57
+
58typedef std::shared_ptr<ConsumerEventListener> ConsumerEventListenerPtr;
+
59
+
60struct ConsumerConfigurationImpl;
+
61
+
+
65class PULSAR_PUBLIC ConsumerConfiguration {
+
66 public:
+
67 ConsumerConfiguration();
+
68 ~ConsumerConfiguration();
+
69 ConsumerConfiguration(const ConsumerConfiguration&);
+
70 ConsumerConfiguration& operator=(const ConsumerConfiguration&);
+
71
+
76 ConsumerConfiguration clone() const;
+
77
+
86 ConsumerConfiguration& setSchema(const SchemaInfo& schemaInfo);
+
87
+
91 const SchemaInfo& getSchema() const;
+
92
+
105 ConsumerConfiguration& setConsumerType(ConsumerType consumerType);
+
106
+
110 ConsumerType getConsumerType() const;
+
111
+
120 ConsumerConfiguration& setKeySharedPolicy(KeySharedPolicy keySharedPolicy);
+
121
+
125 KeySharedPolicy getKeySharedPolicy() const;
+
126
+
132 ConsumerConfiguration& setMessageListener(MessageListener messageListener);
+
133
+
134 template <typename T>
+
135 ConsumerConfiguration& setTypedMessageListener(
+
136 std::function<void(Consumer&, const TypedMessage<T>&)> listener,
+
137 typename TypedMessage<T>::Decoder decoder) {
+
138 return setMessageListener([listener, decoder](Consumer& consumer, const Message& msg) {
+
139 listener(consumer, TypedMessage<T>{msg, decoder});
+
140 });
+
141 }
+
142
+
146 MessageListener getMessageListener() const;
+
147
+
151 bool hasMessageListener() const;
+
152
+
157 ConsumerConfiguration& setConsumerEventListener(ConsumerEventListenerPtr eventListener);
+
158
+
162 ConsumerEventListenerPtr getConsumerEventListener() const;
+
163
+
167 bool hasConsumerEventListener() const;
+
168
+
190 void setReceiverQueueSize(int size);
+
191
+
195 int getReceiverQueueSize() const;
+
196
+
205 void setMaxTotalReceiverQueueSizeAcrossPartitions(int maxTotalReceiverQueueSizeAcrossPartitions);
+
206
+
210 int getMaxTotalReceiverQueueSizeAcrossPartitions() const;
+
211
+
217 void setConsumerName(const std::string& consumerName);
+
218
+
222 const std::string& getConsumerName() const;
+
223
+
234 void setUnAckedMessagesTimeoutMs(const uint64_t milliSeconds);
+
235
+
239 long getUnAckedMessagesTimeoutMs() const;
+
240
+
252 void setTickDurationInMs(const uint64_t milliSeconds);
+
253
+
257 long getTickDurationInMs() const;
+
258
+
271 void setNegativeAckRedeliveryDelayMs(long redeliveryDelayMillis);
+
272
+
278 long getNegativeAckRedeliveryDelayMs() const;
+
279
+
288 void setAckGroupingTimeMs(long ackGroupingMillis);
+
289
+
295 long getAckGroupingTimeMs() const;
+
296
+
303 void setAckGroupingMaxSize(long maxGroupingSize);
+
304
+
310 long getAckGroupingMaxSize() const;
+
311
+
319 void setBrokerConsumerStatsCacheTimeInMs(const long cacheTimeInMs);
+
320
+
324 long getBrokerConsumerStatsCacheTimeInMs() const;
+
325
+
329 bool isEncryptionEnabled() const;
+
330
+
334 const CryptoKeyReaderPtr getCryptoKeyReader() const;
+
335
+
341 ConsumerConfiguration& setCryptoKeyReader(CryptoKeyReaderPtr cryptoKeyReader);
+
342
+
346 ConsumerCryptoFailureAction getCryptoFailureAction() const;
+
347
+
351 ConsumerConfiguration& setCryptoFailureAction(ConsumerCryptoFailureAction action);
+
352
+
356 bool isReadCompacted() const;
+
357
+
371 void setReadCompacted(bool compacted);
+
372
+
380 void setPatternAutoDiscoveryPeriod(int periodInSeconds);
+
381
+
385 int getPatternAutoDiscoveryPeriod() const;
+
386
+
393 ConsumerConfiguration& setRegexSubscriptionMode(RegexSubscriptionMode regexSubscriptionMode);
+
394
+
398 RegexSubscriptionMode getRegexSubscriptionMode() const;
+
399
+
406 void setSubscriptionInitialPosition(InitialPosition subscriptionInitialPosition);
+
407
+
411 InitialPosition getSubscriptionInitialPosition() const;
+
412
+
419 void setBatchReceivePolicy(const BatchReceivePolicy& batchReceivePolicy);
+
420
+
426 const BatchReceivePolicy& getBatchReceivePolicy() const;
+
427
+
455 void setDeadLetterPolicy(const DeadLetterPolicy& deadLetterPolicy);
+
456
+
462 const DeadLetterPolicy& getDeadLetterPolicy() const;
+
463
+
470 void setReplicateSubscriptionStateEnabled(bool enabled);
+
471
+
475 bool isReplicateSubscriptionStateEnabled() const;
+
476
+
484 bool hasProperty(const std::string& name) const;
+
485
+
492 const std::string& getProperty(const std::string& name) const;
+
493
+
497 std::map<std::string, std::string>& getProperties() const;
+
498
+
504 ConsumerConfiguration& setProperty(const std::string& name, const std::string& value);
+
505
+
509 ConsumerConfiguration& setProperties(const std::map<std::string, std::string>& properties);
+
510
+
514 std::map<std::string, std::string>& getSubscriptionProperties() const;
+
515
+
523 ConsumerConfiguration& setSubscriptionProperties(
+
524 const std::map<std::string, std::string>& subscriptionProperties);
+
525
+
532 ConsumerConfiguration& setPriorityLevel(int priorityLevel);
+
533
+
537 int getPriorityLevel() const;
+
538
+
560 ConsumerConfiguration& setMaxPendingChunkedMessage(size_t maxPendingChunkedMessage);
+
561
+
565 size_t getMaxPendingChunkedMessage() const;
+
566
+
577 ConsumerConfiguration& setAutoAckOldestChunkedMessageOnQueueFull(
+
578 bool autoAckOldestChunkedMessageOnQueueFull);
+
579
+
583 bool isAutoAckOldestChunkedMessageOnQueueFull() const;
+
584
+
594 ConsumerConfiguration& setExpireTimeOfIncompleteChunkedMessageMs(
+
595 long expireTimeOfIncompleteChunkedMessageMs);
+
596
+
603 long getExpireTimeOfIncompleteChunkedMessageMs() const;
+
604
+
612 ConsumerConfiguration& setStartMessageIdInclusive(bool startMessageIdInclusive);
+
613
+
617 bool isStartMessageIdInclusive() const;
+
618
+
629 ConsumerConfiguration& setBatchIndexAckEnabled(bool enabled);
+
630
+
634 bool isBatchIndexAckEnabled() const;
+
635
+
642 ConsumerConfiguration& intercept(const std::vector<ConsumerInterceptorPtr>& interceptors);
+
643
+
644 const std::vector<ConsumerInterceptorPtr>& getInterceptors() const;
+
645
+
655 ConsumerConfiguration& setAckReceiptEnabled(bool ackReceiptEnabled);
+
656
+
660 bool isAckReceiptEnabled() const;
+
661
+
662 friend class PulsarWrapper;
+
663 friend class PulsarFriend;
+
664
+
665 private:
+
666 std::shared_ptr<ConsumerConfigurationImpl> impl_;
+
667};
+
+
668} // namespace pulsar
+
669#endif /* PULSAR_CONSUMERCONFIGURATION_H_ */
+
pulsar::BatchReceivePolicy
Definition BatchReceivePolicy.h:52
+
pulsar::ConsumerConfiguration
Definition ConsumerConfiguration.h:65
+
pulsar::ConsumerConfiguration::setProperties
ConsumerConfiguration & setProperties(const std::map< std::string, std::string > &properties)
+
pulsar::ConsumerConfiguration::setPriorityLevel
ConsumerConfiguration & setPriorityLevel(int priorityLevel)
+
pulsar::ConsumerConfiguration::getDeadLetterPolicy
const DeadLetterPolicy & getDeadLetterPolicy() const
+
pulsar::ConsumerConfiguration::setBatchIndexAckEnabled
ConsumerConfiguration & setBatchIndexAckEnabled(bool enabled)
+
pulsar::ConsumerConfiguration::getConsumerType
ConsumerType getConsumerType() const
+ +
pulsar::ConsumerConfiguration::getBrokerConsumerStatsCacheTimeInMs
long getBrokerConsumerStatsCacheTimeInMs() const
+
pulsar::ConsumerConfiguration::setReceiverQueueSize
void setReceiverQueueSize(int size)
+ +
pulsar::ConsumerConfiguration::getMessageListener
MessageListener getMessageListener() const
+
pulsar::ConsumerConfiguration::getCryptoFailureAction
ConsumerCryptoFailureAction getCryptoFailureAction() const
+
pulsar::ConsumerConfiguration::getUnAckedMessagesTimeoutMs
long getUnAckedMessagesTimeoutMs() const
+
pulsar::ConsumerConfiguration::intercept
ConsumerConfiguration & intercept(const std::vector< ConsumerInterceptorPtr > &interceptors)
+
pulsar::ConsumerConfiguration::setAutoAckOldestChunkedMessageOnQueueFull
ConsumerConfiguration & setAutoAckOldestChunkedMessageOnQueueFull(bool autoAckOldestChunkedMessageOnQueueFull)
+
pulsar::ConsumerConfiguration::setAckReceiptEnabled
ConsumerConfiguration & setAckReceiptEnabled(bool ackReceiptEnabled)
+
pulsar::ConsumerConfiguration::setBrokerConsumerStatsCacheTimeInMs
void setBrokerConsumerStatsCacheTimeInMs(const long cacheTimeInMs)
+
pulsar::ConsumerConfiguration::getMaxPendingChunkedMessage
size_t getMaxPendingChunkedMessage() const
+ +
pulsar::ConsumerConfiguration::isReplicateSubscriptionStateEnabled
bool isReplicateSubscriptionStateEnabled() const
+
pulsar::ConsumerConfiguration::isAutoAckOldestChunkedMessageOnQueueFull
bool isAutoAckOldestChunkedMessageOnQueueFull() const
+
pulsar::ConsumerConfiguration::setConsumerType
ConsumerConfiguration & setConsumerType(ConsumerType consumerType)
+
pulsar::ConsumerConfiguration::getPatternAutoDiscoveryPeriod
int getPatternAutoDiscoveryPeriod() const
+
pulsar::ConsumerConfiguration::setRegexSubscriptionMode
ConsumerConfiguration & setRegexSubscriptionMode(RegexSubscriptionMode regexSubscriptionMode)
+
pulsar::ConsumerConfiguration::setKeySharedPolicy
ConsumerConfiguration & setKeySharedPolicy(KeySharedPolicy keySharedPolicy)
+
pulsar::ConsumerConfiguration::setBatchReceivePolicy
void setBatchReceivePolicy(const BatchReceivePolicy &batchReceivePolicy)
+
pulsar::ConsumerConfiguration::setPatternAutoDiscoveryPeriod
void setPatternAutoDiscoveryPeriod(int periodInSeconds)
+
pulsar::ConsumerConfiguration::setAckGroupingMaxSize
void setAckGroupingMaxSize(long maxGroupingSize)
+
pulsar::ConsumerConfiguration::getProperties
std::map< std::string, std::string > & getProperties() const
+ +
pulsar::ConsumerConfiguration::getExpireTimeOfIncompleteChunkedMessageMs
long getExpireTimeOfIncompleteChunkedMessageMs() const
+
pulsar::ConsumerConfiguration::getSubscriptionInitialPosition
InitialPosition getSubscriptionInitialPosition() const
+ +
pulsar::ConsumerConfiguration::setConsumerEventListener
ConsumerConfiguration & setConsumerEventListener(ConsumerEventListenerPtr eventListener)
+
pulsar::ConsumerConfiguration::getCryptoKeyReader
const CryptoKeyReaderPtr getCryptoKeyReader() const
+
pulsar::ConsumerConfiguration::setReplicateSubscriptionStateEnabled
void setReplicateSubscriptionStateEnabled(bool enabled)
+ +
pulsar::ConsumerConfiguration::getRegexSubscriptionMode
RegexSubscriptionMode getRegexSubscriptionMode() const
+
pulsar::ConsumerConfiguration::setSchema
ConsumerConfiguration & setSchema(const SchemaInfo &schemaInfo)
+
pulsar::ConsumerConfiguration::getNegativeAckRedeliveryDelayMs
long getNegativeAckRedeliveryDelayMs() const
+
pulsar::ConsumerConfiguration::setDeadLetterPolicy
void setDeadLetterPolicy(const DeadLetterPolicy &deadLetterPolicy)
+
pulsar::ConsumerConfiguration::hasProperty
bool hasProperty(const std::string &name) const
+
pulsar::ConsumerConfiguration::getProperty
const std::string & getProperty(const std::string &name) const
+
pulsar::ConsumerConfiguration::setTickDurationInMs
void setTickDurationInMs(const uint64_t milliSeconds)
+
pulsar::ConsumerConfiguration::getBatchReceivePolicy
const BatchReceivePolicy & getBatchReceivePolicy() const
+
pulsar::ConsumerConfiguration::isStartMessageIdInclusive
bool isStartMessageIdInclusive() const
+
pulsar::ConsumerConfiguration::setMessageListener
ConsumerConfiguration & setMessageListener(MessageListener messageListener)
+
pulsar::ConsumerConfiguration::setConsumerName
void setConsumerName(const std::string &consumerName)
+
pulsar::ConsumerConfiguration::setMaxTotalReceiverQueueSizeAcrossPartitions
void setMaxTotalReceiverQueueSizeAcrossPartitions(int maxTotalReceiverQueueSizeAcrossPartitions)
+
pulsar::ConsumerConfiguration::setMaxPendingChunkedMessage
ConsumerConfiguration & setMaxPendingChunkedMessage(size_t maxPendingChunkedMessage)
+
pulsar::ConsumerConfiguration::setCryptoKeyReader
ConsumerConfiguration & setCryptoKeyReader(CryptoKeyReaderPtr cryptoKeyReader)
+
pulsar::ConsumerConfiguration::getSubscriptionProperties
std::map< std::string, std::string > & getSubscriptionProperties() const
+
pulsar::ConsumerConfiguration::setCryptoFailureAction
ConsumerConfiguration & setCryptoFailureAction(ConsumerCryptoFailureAction action)
+
pulsar::ConsumerConfiguration::setSubscriptionInitialPosition
void setSubscriptionInitialPosition(InitialPosition subscriptionInitialPosition)
+
pulsar::ConsumerConfiguration::hasConsumerEventListener
bool hasConsumerEventListener() const
+ +
pulsar::ConsumerConfiguration::getMaxTotalReceiverQueueSizeAcrossPartitions
int getMaxTotalReceiverQueueSizeAcrossPartitions() const
+
pulsar::ConsumerConfiguration::setExpireTimeOfIncompleteChunkedMessageMs
ConsumerConfiguration & setExpireTimeOfIncompleteChunkedMessageMs(long expireTimeOfIncompleteChunkedMessageMs)
+ +
pulsar::ConsumerConfiguration::setProperty
ConsumerConfiguration & setProperty(const std::string &name, const std::string &value)
+
pulsar::ConsumerConfiguration::getSchema
const SchemaInfo & getSchema() const
+
pulsar::ConsumerConfiguration::setUnAckedMessagesTimeoutMs
void setUnAckedMessagesTimeoutMs(const uint64_t milliSeconds)
+
pulsar::ConsumerConfiguration::getConsumerEventListener
ConsumerEventListenerPtr getConsumerEventListener() const
+
pulsar::ConsumerConfiguration::getKeySharedPolicy
KeySharedPolicy getKeySharedPolicy() const
+
pulsar::ConsumerConfiguration::setReadCompacted
void setReadCompacted(bool compacted)
+
pulsar::ConsumerConfiguration::clone
ConsumerConfiguration clone() const
+
pulsar::ConsumerConfiguration::setSubscriptionProperties
ConsumerConfiguration & setSubscriptionProperties(const std::map< std::string, std::string > &subscriptionProperties)
+
pulsar::ConsumerConfiguration::setNegativeAckRedeliveryDelayMs
void setNegativeAckRedeliveryDelayMs(long redeliveryDelayMillis)
+
pulsar::ConsumerConfiguration::getConsumerName
const std::string & getConsumerName() const
+
pulsar::ConsumerConfiguration::setAckGroupingTimeMs
void setAckGroupingTimeMs(long ackGroupingMillis)
+
pulsar::ConsumerConfiguration::setStartMessageIdInclusive
ConsumerConfiguration & setStartMessageIdInclusive(bool startMessageIdInclusive)
+ + +
pulsar::Consumer
Definition Consumer.h:37
+
pulsar::DeadLetterPolicy
Definition DeadLetterPolicy.h:36
+
pulsar::KeySharedPolicy
Definition KeySharedPolicy.h:52
+
pulsar::Message
Definition Message.h:44
+
pulsar::MessageId
Definition MessageId.h:34
+
pulsar::SchemaInfo
Definition Schema.h:146
+
pulsar::TypedMessage
Definition TypedMessage.h:28
+
pulsar
Definition Authentication.h:31
+
pulsar::MessageListener
std::function< void(Consumer &consumer, const Message &msg)> MessageListener
Callback definition for MessageListener.
Definition ConsumerConfiguration.h:56
+
pulsar::RegexSubscriptionMode
RegexSubscriptionMode
Definition RegexSubscriptionMode.h:24
+
pulsar::ConsumerType
ConsumerType
Definition ConsumerType.h:24
+
pulsar::Messages
std::vector< Message > Messages
Callback definition for non-data operation.
Definition ConsumerConfiguration.h:49
+
pulsar::ResultCallback
std::function< void(Result result)> ResultCallback
Callback definition for non-data operation.
Definition ConsumerConfiguration.h:50
+
pulsar::Result
Result
Definition Result.h:32
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_consumer_crypto_failure_action_8h_source.html b/static/api/cpp/3.5.x/_consumer_crypto_failure_action_8h_source.html new file mode 100644 index 000000000000..754879ce6515 --- /dev/null +++ b/static/api/cpp/3.5.x/_consumer_crypto_failure_action_8h_source.html @@ -0,0 +1,111 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/ConsumerCryptoFailureAction.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
ConsumerCryptoFailureAction.h
+
+
+
1
+
19#ifndef CONSUMERCRYPTOFAILUREACTION_H_
+
20#define CONSUMERCRYPTOFAILUREACTION_H_
+
21
+
22namespace pulsar {
+
23
+
24enum class ConsumerCryptoFailureAction
+
25{
+
26 FAIL, // This is the default option to fail consume until crypto succeeds
+
27 DISCARD, // Message is silently acknowledged and not delivered to the application
+
28 CONSUME // Deliver the encrypted message to the application. It's the application's
+
29 // responsibility to decrypt the message. If message is also compressed,
+
30 // decompression will fail. If message contain batch messages, client will
+
31 // not be able to retrieve individual messages in the batch
+
32};
+
33
+
34} /* namespace pulsar */
+
35
+
36#endif /* CONSUMERCRYPTOFAILUREACTION_H_ */
+
pulsar
Definition Authentication.h:31
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_consumer_event_listener_8h_source.html b/static/api/cpp/3.5.x/_consumer_event_listener_8h_source.html new file mode 100644 index 000000000000..82acbf8e4275 --- /dev/null +++ b/static/api/cpp/3.5.x/_consumer_event_listener_8h_source.html @@ -0,0 +1,117 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/ConsumerEventListener.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
ConsumerEventListener.h
+
+
+
1
+
19#ifndef PULSAR_CONSUMEREVENTLISTENER_H_
+
20#define PULSAR_CONSUMEREVENTLISTENER_H_
+
21
+
22#include <pulsar/defines.h>
+
23
+
24namespace pulsar {
+
25
+
26class Consumer;
+
27
+
+
28class PULSAR_PUBLIC ConsumerEventListener {
+
29 public:
+
30 virtual ~ConsumerEventListener(){};
+
37 virtual void becameActive(Consumer consumer, int partitionId) = 0;
+
38
+
46 virtual void becameInactive(Consumer consumer, int partitionId) = 0;
+
47};
+
+
48} // namespace pulsar
+
49#endif /* PULSAR_CONSUMEREVENTLISTENER_H_ */
+
pulsar::ConsumerEventListener
Definition ConsumerEventListener.h:28
+
pulsar::ConsumerEventListener::becameInactive
virtual void becameInactive(Consumer consumer, int partitionId)=0
Notified when the consumer group is changed, and the consumer is still inactive or becomes inactive.
+
pulsar::ConsumerEventListener::becameActive
virtual void becameActive(Consumer consumer, int partitionId)=0
Notified when the consumer group is changed, and the consumer becomes active.
+
pulsar::Consumer
Definition Consumer.h:37
+
pulsar
Definition Authentication.h:31
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_consumer_interceptor_8h_source.html b/static/api/cpp/3.5.x/_consumer_interceptor_8h_source.html new file mode 100644 index 000000000000..152133f23612 --- /dev/null +++ b/static/api/cpp/3.5.x/_consumer_interceptor_8h_source.html @@ -0,0 +1,137 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/ConsumerInterceptor.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
ConsumerInterceptor.h
+
+
+
1
+
20#ifndef PULSAR_CPP_CONSUMER_INTERCEPTOR_H
+
21#define PULSAR_CPP_CONSUMER_INTERCEPTOR_H
+
22
+
23#include <pulsar/Message.h>
+
24#include <pulsar/Result.h>
+
25#include <pulsar/defines.h>
+
26
+
27#include <set>
+
28
+
29namespace pulsar {
+
30
+
31class Consumer;
+
32
+
+
43class PULSAR_PUBLIC ConsumerInterceptor {
+
44 public:
+
45 virtual ~ConsumerInterceptor() {}
+
49 virtual void close() {}
+
50
+
80 virtual Message beforeConsume(const Consumer& consumer, const Message& message) = 0;
+
81
+
92 virtual void onAcknowledge(const Consumer& consumer, Result result, const MessageId& messageID) = 0;
+
93
+
104 virtual void onAcknowledgeCumulative(const Consumer& consumer, Result result,
+
105 const MessageId& messageID) = 0;
+
106
+
115 virtual void onNegativeAcksSend(const Consumer& consumer, const std::set<MessageId>& messageIds) = 0;
+
116};
+
+
117
+
118typedef std::shared_ptr<ConsumerInterceptor> ConsumerInterceptorPtr;
+
119} // namespace pulsar
+
120
+
121#endif // PULSAR_CPP_CONSUMER_INTERCEPTOR_H
+
pulsar::Consumer
Definition Consumer.h:37
+
pulsar::ConsumerInterceptor
Definition ConsumerInterceptor.h:43
+
pulsar::ConsumerInterceptor::beforeConsume
virtual Message beforeConsume(const Consumer &consumer, const Message &message)=0
+
pulsar::ConsumerInterceptor::onNegativeAcksSend
virtual void onNegativeAcksSend(const Consumer &consumer, const std::set< MessageId > &messageIds)=0
+
pulsar::ConsumerInterceptor::onAcknowledge
virtual void onAcknowledge(const Consumer &consumer, Result result, const MessageId &messageID)=0
+
pulsar::ConsumerInterceptor::onAcknowledgeCumulative
virtual void onAcknowledgeCumulative(const Consumer &consumer, Result result, const MessageId &messageID)=0
+
pulsar::ConsumerInterceptor::close
virtual void close()
Definition ConsumerInterceptor.h:49
+
pulsar::Message
Definition Message.h:44
+
pulsar::MessageId
Definition MessageId.h:34
+
pulsar
Definition Authentication.h:31
+
pulsar::Result
Result
Definition Result.h:32
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_consumer_type_8h_source.html b/static/api/cpp/3.5.x/_consumer_type_8h_source.html new file mode 100644 index 000000000000..52e04aef9c98 --- /dev/null +++ b/static/api/cpp/3.5.x/_consumer_type_8h_source.html @@ -0,0 +1,117 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/ConsumerType.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
ConsumerType.h
+
+
+
1
+
19#ifndef PULSAR_CPP_CONSUMERTYPE_H
+
20#define PULSAR_CPP_CONSUMERTYPE_H
+
21
+
22namespace pulsar {
+ +
47}
+
48
+
49#endif // PULSAR_CPP_CONSUMERTYPE_H
+
pulsar
Definition Authentication.h:31
+
pulsar::ConsumerType
ConsumerType
Definition ConsumerType.h:24
+
pulsar::ConsumerExclusive
@ ConsumerExclusive
Definition ConsumerType.h:28
+
pulsar::ConsumerFailover
@ ConsumerFailover
Definition ConsumerType.h:39
+
pulsar::ConsumerShared
@ ConsumerShared
Definition ConsumerType.h:34
+
pulsar::ConsumerKeyShared
@ ConsumerKeyShared
Definition ConsumerType.h:45
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_crypto_key_reader_8h_source.html b/static/api/cpp/3.5.x/_crypto_key_reader_8h_source.html new file mode 100644 index 000000000000..b5f3e29a5e6f --- /dev/null +++ b/static/api/cpp/3.5.x/_crypto_key_reader_8h_source.html @@ -0,0 +1,151 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/CryptoKeyReader.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
CryptoKeyReader.h
+
+
+
1
+
19#ifndef CRYPTOKEYREADER_H_
+
20#define CRYPTOKEYREADER_H_
+
21
+
22#include <pulsar/EncryptionKeyInfo.h>
+
23#include <pulsar/Result.h>
+
24#include <pulsar/defines.h>
+
25
+
26namespace pulsar {
+
27
+
+
31class PULSAR_PUBLIC CryptoKeyReader {
+
32 public:
+
33 CryptoKeyReader();
+
34 virtual ~CryptoKeyReader();
+
35
+
52 virtual Result getPublicKey(const std::string& keyName, std::map<std::string, std::string>& metadata,
+
53 EncryptionKeyInfo& encKeyInfo) const = 0;
+
54
+
63 virtual Result getPrivateKey(const std::string& keyName, std::map<std::string, std::string>& metadata,
+
64 EncryptionKeyInfo& encKeyInfo) const = 0;
+
65
+
66}; /* namespace pulsar */
+
+
67
+
68typedef std::shared_ptr<CryptoKeyReader> CryptoKeyReaderPtr;
+
69
+
+
70class PULSAR_PUBLIC DefaultCryptoKeyReader : public CryptoKeyReader {
+
71 private:
+
72 std::string publicKeyPath_;
+
73 std::string privateKeyPath_;
+
74 void readFile(std::string fileName, std::string& fileContents) const;
+
75
+
76 public:
+
86 DefaultCryptoKeyReader(const std::string& publicKeyPath, const std::string& privateKeyPath);
+
87 ~DefaultCryptoKeyReader();
+
88
+
103 Result getPublicKey(const std::string& keyName, std::map<std::string, std::string>& metadata,
+
104 EncryptionKeyInfo& encKeyInfo) const;
+
105
+
116 Result getPrivateKey(const std::string& keyName, std::map<std::string, std::string>& metadata,
+
117 EncryptionKeyInfo& encKeyInfo) const;
+
118 static CryptoKeyReaderPtr create(const std::string& publicKeyPath, const std::string& privateKeyPath);
+
119}; /* namespace pulsar */
+
+
120
+
121} // namespace pulsar
+
122
+
123#endif /* CRYPTOKEYREADER_H_ */
+
pulsar::CryptoKeyReader
Definition CryptoKeyReader.h:31
+
pulsar::CryptoKeyReader::getPrivateKey
virtual Result getPrivateKey(const std::string &keyName, std::map< std::string, std::string > &metadata, EncryptionKeyInfo &encKeyInfo) const =0
+
pulsar::CryptoKeyReader::getPublicKey
virtual Result getPublicKey(const std::string &keyName, std::map< std::string, std::string > &metadata, EncryptionKeyInfo &encKeyInfo) const =0
+
pulsar::DefaultCryptoKeyReader
Definition CryptoKeyReader.h:70
+
pulsar::DefaultCryptoKeyReader::getPublicKey
Result getPublicKey(const std::string &keyName, std::map< std::string, std::string > &metadata, EncryptionKeyInfo &encKeyInfo) const
+
pulsar::DefaultCryptoKeyReader::getPrivateKey
Result getPrivateKey(const std::string &keyName, std::map< std::string, std::string > &metadata, EncryptionKeyInfo &encKeyInfo) const
+
pulsar::DefaultCryptoKeyReader::DefaultCryptoKeyReader
DefaultCryptoKeyReader(const std::string &publicKeyPath, const std::string &privateKeyPath)
+
pulsar::EncryptionKeyInfo
Definition EncryptionKeyInfo.h:35
+
pulsar
Definition Authentication.h:31
+
pulsar::Result
Result
Definition Result.h:32
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_dead_letter_policy_8h_source.html b/static/api/cpp/3.5.x/_dead_letter_policy_8h_source.html new file mode 100644 index 000000000000..c9eedfd65d5b --- /dev/null +++ b/static/api/cpp/3.5.x/_dead_letter_policy_8h_source.html @@ -0,0 +1,133 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/DeadLetterPolicy.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
DeadLetterPolicy.h
+
+
+
1
+
19#ifndef DEAD_LETTER_POLICY_HPP_
+
20#define DEAD_LETTER_POLICY_HPP_
+
21
+
22#include <pulsar/defines.h>
+
23
+
24#include <memory>
+
25#include <string>
+
26
+
27namespace pulsar {
+
28
+
29struct DeadLetterPolicyImpl;
+
30
+
+
36class PULSAR_PUBLIC DeadLetterPolicy {
+
37 public:
+
38 DeadLetterPolicy();
+
39
+
45 const std::string& getDeadLetterTopic() const;
+
46
+
52 int getMaxRedeliverCount() const;
+
53
+
59 const std::string& getInitialSubscriptionName() const;
+
60
+
61 private:
+
62 friend class DeadLetterPolicyBuilder;
+
63
+
64 typedef std::shared_ptr<DeadLetterPolicyImpl> DeadLetterPolicyImplPtr;
+
65 DeadLetterPolicyImplPtr impl_;
+
66
+
67 explicit DeadLetterPolicy(const DeadLetterPolicyImplPtr& impl);
+
68};
+
+
69} // namespace pulsar
+
70
+
71#endif /* DEAD_LETTER_POLICY_HPP_ */
+
pulsar::DeadLetterPolicyBuilder
Definition DeadLetterPolicyBuilder.h:44
+
pulsar::DeadLetterPolicy
Definition DeadLetterPolicy.h:36
+
pulsar::DeadLetterPolicy::getMaxRedeliverCount
int getMaxRedeliverCount() const
+
pulsar::DeadLetterPolicy::getInitialSubscriptionName
const std::string & getInitialSubscriptionName() const
+
pulsar::DeadLetterPolicy::getDeadLetterTopic
const std::string & getDeadLetterTopic() const
+
pulsar
Definition Authentication.h:31
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_dead_letter_policy_builder_8h_source.html b/static/api/cpp/3.5.x/_dead_letter_policy_builder_8h_source.html new file mode 100644 index 000000000000..8ffc150b6561 --- /dev/null +++ b/static/api/cpp/3.5.x/_dead_letter_policy_builder_8h_source.html @@ -0,0 +1,131 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/DeadLetterPolicyBuilder.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
DeadLetterPolicyBuilder.h
+
+
+
1
+
19#ifndef DEAD_LETTER_POLICY_BUILD_HPP_
+
20#define DEAD_LETTER_POLICY_BUILD_HPP_
+
21
+
22#include <pulsar/DeadLetterPolicy.h>
+
23#include <pulsar/defines.h>
+
24
+
25#include <memory>
+
26
+
27namespace pulsar {
+
28
+
29struct DeadLetterPolicyImpl;
+
30
+
+
44class PULSAR_PUBLIC DeadLetterPolicyBuilder {
+
45 public:
+
46 DeadLetterPolicyBuilder();
+
47
+
56 DeadLetterPolicyBuilder& deadLetterTopic(const std::string& deadLetterTopic);
+
57
+
68 DeadLetterPolicyBuilder& maxRedeliverCount(int maxRedeliverCount);
+
69
+
80 DeadLetterPolicyBuilder& initialSubscriptionName(const std::string& initialSubscriptionName);
+
81
+
87 DeadLetterPolicy build();
+
88
+
89 private:
+
90 std::shared_ptr<DeadLetterPolicyImpl> impl_;
+
91};
+
+
92} // namespace pulsar
+
93
+
94#endif /* DEAD_LETTER_POLICY_BUILD_HPP_ */
+
pulsar::DeadLetterPolicyBuilder
Definition DeadLetterPolicyBuilder.h:44
+ +
pulsar::DeadLetterPolicyBuilder::deadLetterTopic
DeadLetterPolicyBuilder & deadLetterTopic(const std::string &deadLetterTopic)
+
pulsar::DeadLetterPolicyBuilder::initialSubscriptionName
DeadLetterPolicyBuilder & initialSubscriptionName(const std::string &initialSubscriptionName)
+
pulsar::DeadLetterPolicyBuilder::maxRedeliverCount
DeadLetterPolicyBuilder & maxRedeliverCount(int maxRedeliverCount)
+
pulsar::DeadLetterPolicy
Definition DeadLetterPolicy.h:36
+
pulsar
Definition Authentication.h:31
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_deprecated_exception_8h_source.html b/static/api/cpp/3.5.x/_deprecated_exception_8h_source.html new file mode 100644 index 000000000000..c24036e7b3d3 --- /dev/null +++ b/static/api/cpp/3.5.x/_deprecated_exception_8h_source.html @@ -0,0 +1,115 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/DeprecatedException.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
DeprecatedException.h
+
+
+
1
+
19#ifndef DEPRECATED_EXCEPTION_HPP_
+
20#define DEPRECATED_EXCEPTION_HPP_
+
21
+
22#include <pulsar/defines.h>
+
23
+
24#include <stdexcept>
+
25#include <string>
+
26
+
27namespace pulsar {
+
+
28class PULSAR_PUBLIC DeprecatedException : public std::runtime_error {
+
29 public:
+
30 explicit DeprecatedException(const std::string& __arg);
+
31
+
32 private:
+
33 static const std::string message_prefix;
+
34};
+
+
35} // namespace pulsar
+
36
+
37#endif // DEPRECATED_EXCEPTION_HPP_
+
pulsar::DeprecatedException
Definition DeprecatedException.h:28
+
pulsar
Definition Authentication.h:31
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_encryption_key_info_8h_source.html b/static/api/cpp/3.5.x/_encryption_key_info_8h_source.html new file mode 100644 index 000000000000..4b9fb5dd9b8e --- /dev/null +++ b/static/api/cpp/3.5.x/_encryption_key_info_8h_source.html @@ -0,0 +1,149 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/EncryptionKeyInfo.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
EncryptionKeyInfo.h
+
+
+
1
+
19#ifndef ENCRYPTIONKEYINFO_H_
+
20#define ENCRYPTIONKEYINFO_H_
+
21
+
22#include <pulsar/defines.h>
+
23
+
24#include <iostream>
+
25#include <map>
+
26#include <memory>
+
27
+
28namespace pulsar {
+
29
+
30class EncryptionKeyInfoImpl;
+
31class PulsarWrapper;
+
32
+
33typedef std::shared_ptr<EncryptionKeyInfoImpl> EncryptionKeyInfoImplPtr;
+
34
+
+
35class PULSAR_PUBLIC EncryptionKeyInfo {
+
36 /*
+
37 * This object contains the encryption key and corresponding metadata which contains
+
38 * additional information about the key such as version, timestammp
+
39 */
+
40
+
41 public:
+
42 typedef std::map<std::string, std::string> StringMap;
+
43
+
44 EncryptionKeyInfo();
+
45
+
50 EncryptionKeyInfo(std::string key, StringMap& metadata);
+
51
+
55 std::string& getKey();
+
56
+
62 void setKey(std::string key);
+
63
+
67 StringMap& getMetadata(void);
+
68
+
74 void setMetadata(StringMap& metadata);
+
75
+
76 private:
+
77 explicit EncryptionKeyInfo(EncryptionKeyInfoImplPtr);
+
78
+
79 EncryptionKeyInfoImplPtr impl_;
+
80
+
81 friend class PulsarWrapper;
+
82};
+
+
83
+
84} /* namespace pulsar */
+
85
+
86#endif /* ENCRYPTIONKEYINFO_H_ */
+
pulsar::EncryptionKeyInfo
Definition EncryptionKeyInfo.h:35
+
pulsar::EncryptionKeyInfo::setKey
void setKey(std::string key)
+
pulsar::EncryptionKeyInfo::getKey
std::string & getKey()
+
pulsar::EncryptionKeyInfo::setMetadata
void setMetadata(StringMap &metadata)
+
pulsar::EncryptionKeyInfo::getMetadata
StringMap & getMetadata(void)
+
pulsar::EncryptionKeyInfo::EncryptionKeyInfo
EncryptionKeyInfo(std::string key, StringMap &metadata)
+
pulsar
Definition Authentication.h:31
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_file_logger_factory_8h_source.html b/static/api/cpp/3.5.x/_file_logger_factory_8h_source.html new file mode 100644 index 000000000000..959d7024d0a5 --- /dev/null +++ b/static/api/cpp/3.5.x/_file_logger_factory_8h_source.html @@ -0,0 +1,121 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/FileLoggerFactory.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
FileLoggerFactory.h
+
+
+
1
+
20#pragma once
+
21
+
22#include <pulsar/Logger.h>
+
23
+
24namespace pulsar {
+
25
+
26class FileLoggerFactoryImpl;
+
27
+
+
47class PULSAR_PUBLIC FileLoggerFactory : public pulsar::LoggerFactory {
+
48 public:
+
55 FileLoggerFactory(Logger::Level level, const std::string& logFilePath);
+
56
+
57 ~FileLoggerFactory();
+
58
+
59 pulsar::Logger* getLogger(const std::string& filename) override;
+
60
+
61 private:
+
62 std::unique_ptr<FileLoggerFactoryImpl> impl_;
+
63};
+
+
64
+
65} // namespace pulsar
+
pulsar::FileLoggerFactory
Definition FileLoggerFactory.h:47
+
pulsar::FileLoggerFactory::getLogger
pulsar::Logger * getLogger(const std::string &filename) override
+
pulsar::FileLoggerFactory::FileLoggerFactory
FileLoggerFactory(Logger::Level level, const std::string &logFilePath)
+
pulsar::LoggerFactory
Definition Logger.h:58
+
pulsar::Logger
Definition Logger.h:28
+
pulsar
Definition Authentication.h:31
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_initial_position_8h_source.html b/static/api/cpp/3.5.x/_initial_position_8h_source.html new file mode 100644 index 000000000000..50a58b446889 --- /dev/null +++ b/static/api/cpp/3.5.x/_initial_position_8h_source.html @@ -0,0 +1,105 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/InitialPosition.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
InitialPosition.h
+
+
+
1
+
19#ifndef PULSAR_CPP_INITIAL_POSITION_H
+
20#define PULSAR_CPP_INITIAL_POSITION_H
+
21
+
22namespace pulsar {
+
23enum InitialPosition
+
24{
+
25 InitialPositionLatest,
+
26 InitialPositionEarliest
+
27};
+
28}
+
29
+
30#endif // PULSAR_CPP_INITIAL_POSITION_H
+
pulsar
Definition Authentication.h:31
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_key_shared_policy_8h_source.html b/static/api/cpp/3.5.x/_key_shared_policy_8h_source.html new file mode 100644 index 000000000000..bf4e006af562 --- /dev/null +++ b/static/api/cpp/3.5.x/_key_shared_policy_8h_source.html @@ -0,0 +1,160 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/KeySharedPolicy.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
KeySharedPolicy.h
+
+
+
1
+
19#pragma once
+
20
+
21#include <pulsar/defines.h>
+
22
+
23#include <memory>
+
24#include <utility>
+
25#include <vector>
+
26
+
27namespace pulsar {
+
28
+
+
32enum KeySharedMode
+
33{
+
34
+
38 AUTO_SPLIT = 0,
+
39
+
44 STICKY = 1
+
45};
+
+
46
+
47struct KeySharedPolicyImpl;
+
48
+
49typedef std::pair<int, int> StickyRange;
+
50typedef std::vector<StickyRange> StickyRanges;
+
51
+
+
52class PULSAR_PUBLIC KeySharedPolicy {
+
53 public:
+
54 KeySharedPolicy();
+
55 ~KeySharedPolicy();
+
56
+
57 KeySharedPolicy(const KeySharedPolicy&);
+
58 KeySharedPolicy& operator=(const KeySharedPolicy&);
+
59
+
64 KeySharedPolicy clone() const;
+
65
+
72 KeySharedPolicy& setKeySharedMode(KeySharedMode keySharedMode);
+
73
+
77 KeySharedMode getKeySharedMode() const;
+
78
+
89 KeySharedPolicy& setAllowOutOfOrderDelivery(bool allowOutOfOrderDelivery);
+
90
+
94 bool isAllowOutOfOrderDelivery() const;
+
95
+
100 KeySharedPolicy& setStickyRanges(std::initializer_list<StickyRange> ranges);
+
101
+
105 KeySharedPolicy& setStickyRanges(const StickyRanges& ranges);
+
106
+
110 StickyRanges getStickyRanges() const;
+
111
+
112 private:
+
113 std::shared_ptr<KeySharedPolicyImpl> impl_;
+
114};
+
+
115} // namespace pulsar
+
pulsar::KeySharedPolicy
Definition KeySharedPolicy.h:52
+
pulsar::KeySharedPolicy::clone
KeySharedPolicy clone() const
+
pulsar::KeySharedPolicy::getKeySharedMode
KeySharedMode getKeySharedMode() const
+
pulsar::KeySharedPolicy::setAllowOutOfOrderDelivery
KeySharedPolicy & setAllowOutOfOrderDelivery(bool allowOutOfOrderDelivery)
+
pulsar::KeySharedPolicy::setKeySharedMode
KeySharedPolicy & setKeySharedMode(KeySharedMode keySharedMode)
+
pulsar::KeySharedPolicy::getStickyRanges
StickyRanges getStickyRanges() const
+
pulsar::KeySharedPolicy::setStickyRanges
KeySharedPolicy & setStickyRanges(const StickyRanges &ranges)
+
pulsar::KeySharedPolicy::isAllowOutOfOrderDelivery
bool isAllowOutOfOrderDelivery() const
+
pulsar::KeySharedPolicy::setStickyRanges
KeySharedPolicy & setStickyRanges(std::initializer_list< StickyRange > ranges)
+
pulsar
Definition Authentication.h:31
+
pulsar::KeySharedMode
KeySharedMode
Definition KeySharedPolicy.h:33
+
pulsar::AUTO_SPLIT
@ AUTO_SPLIT
Definition KeySharedPolicy.h:38
+
pulsar::STICKY
@ STICKY
Definition KeySharedPolicy.h:44
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_key_value_8h_source.html b/static/api/cpp/3.5.x/_key_value_8h_source.html new file mode 100644 index 000000000000..ea878c154cb7 --- /dev/null +++ b/static/api/cpp/3.5.x/_key_value_8h_source.html @@ -0,0 +1,138 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/KeyValue.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
KeyValue.h
+
+
+
1
+
19#ifndef KEY_VALUE_HPP_
+
20#define KEY_VALUE_HPP_
+
21
+
22#include <memory>
+
23#include <string>
+
24
+
25#include "Schema.h"
+
26#include "defines.h"
+
27
+
28namespace pulsar {
+
29
+
30class KeyValueImpl;
+
31
+
+
35class PULSAR_PUBLIC KeyValue {
+
36 public:
+
44 KeyValue(std::string &&key, std::string &&value);
+
45
+
51 std::string getKey() const;
+
52
+
59 const void *getValue() const;
+
60
+
66 size_t getValueLength() const;
+
67
+
73 std::string getValueAsString() const;
+
74
+
75 private:
+
76 typedef std::shared_ptr<KeyValueImpl> KeyValueImplPtr;
+
77 KeyValue(KeyValueImplPtr keyValueImplPtr);
+
78 KeyValueImplPtr impl_;
+
79 friend class Message;
+
80 friend class MessageBuilder;
+
81};
+
+
82} // namespace pulsar
+
83
+
84#endif /* KEY_VALUE_HPP_ */
+
pulsar::KeyValue
Definition KeyValue.h:35
+
pulsar::KeyValue::getValueLength
size_t getValueLength() const
+
pulsar::KeyValue::getKey
std::string getKey() const
+
pulsar::KeyValue::getValue
const void * getValue() const
+
pulsar::KeyValue::getValueAsString
std::string getValueAsString() const
+
pulsar::KeyValue::KeyValue
KeyValue(std::string &&key, std::string &&value)
+
pulsar::MessageBuilder
Definition MessageBuilder.h:33
+
pulsar::Message
Definition Message.h:44
+
pulsar
Definition Authentication.h:31
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_logger_8h_source.html b/static/api/cpp/3.5.x/_logger_8h_source.html new file mode 100644 index 000000000000..4dc4ce98e8f5 --- /dev/null +++ b/static/api/cpp/3.5.x/_logger_8h_source.html @@ -0,0 +1,136 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/Logger.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
Logger.h
+
+
+
1
+
19#pragma once
+
20
+
21#include <pulsar/defines.h>
+
22
+
23#include <memory>
+
24#include <string>
+
25
+
26namespace pulsar {
+
27
+
+
28class PULSAR_PUBLIC Logger {
+
29 public:
+
30 enum Level
+
31 {
+
32 LEVEL_DEBUG = 0,
+
33 LEVEL_INFO = 1,
+
34 LEVEL_WARN = 2,
+
35 LEVEL_ERROR = 3
+
36 };
+
37
+
38 virtual ~Logger() {}
+
39
+
46 virtual bool isEnabled(Level level) = 0;
+
47
+
55 virtual void log(Level level, int line, const std::string& message) = 0;
+
56};
+
+
57
+
+
58class PULSAR_PUBLIC LoggerFactory {
+
59 public:
+
60 virtual ~LoggerFactory() {}
+
61
+
69 virtual Logger* getLogger(const std::string& fileName) = 0;
+
70};
+
+
71
+
72} // namespace pulsar
+
pulsar::LoggerFactory
Definition Logger.h:58
+
pulsar::LoggerFactory::getLogger
virtual Logger * getLogger(const std::string &fileName)=0
+
pulsar::Logger
Definition Logger.h:28
+
pulsar::Logger::isEnabled
virtual bool isEnabled(Level level)=0
+
pulsar::Logger::log
virtual void log(Level level, int line, const std::string &message)=0
+
pulsar
Definition Authentication.h:31
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_message_8h_source.html b/static/api/cpp/3.5.x/_message_8h_source.html new file mode 100644 index 000000000000..1a09658bdf55 --- /dev/null +++ b/static/api/cpp/3.5.x/_message_8h_source.html @@ -0,0 +1,230 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/Message.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
Message.h
+
+
+
1
+
19#ifndef MESSAGE_HPP_
+
20#define MESSAGE_HPP_
+
21
+
22#include <pulsar/defines.h>
+
23
+
24#include <map>
+
25#include <memory>
+
26#include <string>
+
27
+
28#include "KeyValue.h"
+
29#include "MessageId.h"
+
30
+
31namespace pulsar {
+
32namespace proto {
+
33class CommandMessage;
+
34class BrokerEntryMetadata;
+
35class MessageMetadata;
+
36class SingleMessageMetadata;
+
37} // namespace proto
+
38
+
39class SharedBuffer;
+
40class MessageBuilder;
+
41class MessageImpl;
+
42class PulsarWrapper;
+
43
+
+
44class PULSAR_PUBLIC Message {
+
45 public:
+
46 typedef std::map<std::string, std::string> StringMap;
+
47
+
48 Message();
+
49
+
56 const StringMap& getProperties() const;
+
57
+
65 bool hasProperty(const std::string& name) const;
+
66
+
73 const std::string& getProperty(const std::string& name) const;
+
74
+
81 const void* getData() const;
+
82
+
88 std::size_t getLength() const;
+
89
+
98#if defined(_MSC_VER) && !defined(NDEBUG)
+
99 const std::string& getDataAsString() const;
+
100#else
+
101 std::string getDataAsString() const;
+
102#endif
+
103
+
109 KeyValue getKeyValueData() const;
+
110
+
120 const MessageId& getMessageId() const;
+
121
+
126 void setMessageId(const MessageId& messageId) const;
+
127
+
132 int64_t getIndex() const;
+
133
+
138 const std::string& getPartitionKey() const;
+
139
+
143 bool hasPartitionKey() const;
+
144
+
150 const std::string& getOrderingKey() const;
+
151
+
158 bool hasOrderingKey() const;
+
159
+
164 uint64_t getPublishTimestamp() const;
+
165
+
169 uint64_t getEventTimestamp() const;
+
170
+
174 const std::string& getTopicName() const;
+
175
+
179 const int getRedeliveryCount() const;
+
180
+
184 bool hasSchemaVersion() const;
+
185
+
191 int64_t getLongSchemaVersion() const;
+
192
+
196 const std::string& getSchemaVersion() const;
+
197
+
198 bool operator==(const Message& msg) const;
+
199
+
200 protected:
+
201 typedef std::shared_ptr<MessageImpl> MessageImplPtr;
+
202 MessageImplPtr impl_;
+
203
+
204 Message(MessageImplPtr& impl);
+
205 Message(const MessageId& messageId, proto::BrokerEntryMetadata& brokerEntryMetadata,
+
206 proto::MessageMetadata& metadata, SharedBuffer& payload);
+
208 Message(const MessageId& messageId, proto::BrokerEntryMetadata& brokerEntryMetadata,
+
209 proto::MessageMetadata& metadata, SharedBuffer& payload,
+
210 proto::SingleMessageMetadata& singleMetadata, const std::shared_ptr<std::string>& topicName);
+
211 friend class PartitionedProducerImpl;
+
212 friend class MultiTopicsConsumerImpl;
+
213 friend class MessageBuilder;
+
214 friend class ConsumerImpl;
+
215 friend class ProducerImpl;
+
216 friend class Commands;
+
217 friend class BatchMessageContainerBase;
+
218 friend class BatchAcknowledgementTracker;
+
219 friend class PulsarWrapper;
+
220 friend class MessageBatch;
+
221 friend struct OpSendMsg;
+
222
+
223 friend PULSAR_PUBLIC std::ostream& operator<<(std::ostream& s, const StringMap& map);
+
224 friend PULSAR_PUBLIC std::ostream& operator<<(std::ostream& s, const Message& msg);
+
225 friend class PulsarFriend;
+
226};
+
+
227} // namespace pulsar
+
228
+
229#endif /* MESSAGE_HPP_ */
+
pulsar::KeyValue
Definition KeyValue.h:35
+
pulsar::MessageBatch
Definition MessageBatch.h:29
+
pulsar::MessageBuilder
Definition MessageBuilder.h:33
+
pulsar::Message
Definition Message.h:44
+
pulsar::Message::getPartitionKey
const std::string & getPartitionKey() const
+
pulsar::Message::hasPartitionKey
bool hasPartitionKey() const
+
pulsar::Message::getKeyValueData
KeyValue getKeyValueData() const
+
pulsar::Message::setMessageId
void setMessageId(const MessageId &messageId) const
+
pulsar::Message::getDataAsString
std::string getDataAsString() const
+
pulsar::Message::getLongSchemaVersion
int64_t getLongSchemaVersion() const
+
pulsar::Message::hasSchemaVersion
bool hasSchemaVersion() const
+
pulsar::Message::getProperty
const std::string & getProperty(const std::string &name) const
+
pulsar::Message::getIndex
int64_t getIndex() const
+
pulsar::Message::getEventTimestamp
uint64_t getEventTimestamp() const
+
pulsar::Message::Message
Message(const MessageId &messageId, proto::BrokerEntryMetadata &brokerEntryMetadata, proto::MessageMetadata &metadata, SharedBuffer &payload, proto::SingleMessageMetadata &singleMetadata, const std::shared_ptr< std::string > &topicName)
Used for Batch Messages.
+
pulsar::Message::getLength
std::size_t getLength() const
+
pulsar::Message::getOrderingKey
const std::string & getOrderingKey() const
+
pulsar::Message::getData
const void * getData() const
+
pulsar::Message::getPublishTimestamp
uint64_t getPublishTimestamp() const
+
pulsar::Message::getSchemaVersion
const std::string & getSchemaVersion() const
+
pulsar::Message::getRedeliveryCount
const int getRedeliveryCount() const
+
pulsar::Message::hasOrderingKey
bool hasOrderingKey() const
+
pulsar::Message::hasProperty
bool hasProperty(const std::string &name) const
+
pulsar::Message::getMessageId
const MessageId & getMessageId() const
+
pulsar::Message::getProperties
const StringMap & getProperties() const
+
pulsar::Message::getTopicName
const std::string & getTopicName() const
+
pulsar::MessageId
Definition MessageId.h:34
+
pulsar
Definition Authentication.h:31
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_message_batch_8h_source.html b/static/api/cpp/3.5.x/_message_batch_8h_source.html new file mode 100644 index 000000000000..fe5020d1ccf1 --- /dev/null +++ b/static/api/cpp/3.5.x/_message_batch_8h_source.html @@ -0,0 +1,128 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/MessageBatch.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
MessageBatch.h
+
+
+
1
+
20#ifndef LIB_MESSAGE_BATCH_H
+
21#define LIB_MESSAGE_BATCH_H
+
22#include <pulsar/Message.h>
+
23#include <pulsar/defines.h>
+
24
+
25#include <vector>
+
26
+
27namespace pulsar {
+
28
+
+
29class PULSAR_PUBLIC MessageBatch {
+
30 public:
+
31 MessageBatch();
+
32
+
33 MessageBatch& withMessageId(const MessageId& messageId);
+
34
+
35 MessageBatch& parseFrom(const std::string& payload, uint32_t batchSize);
+
36
+
37 MessageBatch& parseFrom(const SharedBuffer& payload, uint32_t batchSize);
+
38
+
39 const std::vector<Message>& messages();
+
40
+
41 private:
+
42 typedef std::shared_ptr<MessageImpl> MessageImplPtr;
+
43 MessageImplPtr impl_;
+
44 Message batchMessage_;
+
45
+
46 std::vector<Message> batch_;
+
47};
+
+
48} // namespace pulsar
+
49#endif // LIB_MESSAGE_BATCH_H
+
pulsar::MessageBatch
Definition MessageBatch.h:29
+
pulsar::Message
Definition Message.h:44
+
pulsar::MessageId
Definition MessageId.h:34
+
pulsar
Definition Authentication.h:31
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_message_builder_8h_source.html b/static/api/cpp/3.5.x/_message_builder_8h_source.html new file mode 100644 index 000000000000..db2ea3e1393b --- /dev/null +++ b/static/api/cpp/3.5.x/_message_builder_8h_source.html @@ -0,0 +1,183 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/MessageBuilder.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
MessageBuilder.h
+
+
+
1
+
19#ifndef MESSAGE_BUILDER_H
+
20#define MESSAGE_BUILDER_H
+
21
+
22#include <pulsar/KeyValue.h>
+
23#include <pulsar/Message.h>
+
24#include <pulsar/defines.h>
+
25
+
26#include <chrono>
+
27#include <string>
+
28#include <vector>
+
29
+
30namespace pulsar {
+
31class PulsarWrapper;
+
32
+
+
33class PULSAR_PUBLIC MessageBuilder {
+
34 public:
+
35 MessageBuilder();
+
36
+
37 typedef std::map<std::string, std::string> StringMap;
+
38
+
42 Message build();
+
43
+
47 MessageBuilder& setContent(const void* data, size_t size);
+
48
+
55 MessageBuilder& setContent(const std::string& data);
+
56
+
62 MessageBuilder& setContent(std::string&& data);
+
63
+
69 MessageBuilder& setContent(const KeyValue& data);
+
70
+
76 MessageBuilder& setAllocatedContent(void* data, size_t size);
+
77
+
83 MessageBuilder& setProperty(const std::string& name, const std::string& value);
+
84
+
88 MessageBuilder& setProperties(const StringMap& properties);
+
89
+
94 MessageBuilder& setPartitionKey(const std::string& partitionKey);
+
95
+
100 MessageBuilder& setOrderingKey(const std::string& orderingKey);
+
101
+
107 MessageBuilder& setDeliverAfter(const std::chrono::milliseconds delay);
+
108
+
115 MessageBuilder& setDeliverAt(uint64_t deliveryTimestamp);
+
116
+
120 MessageBuilder& setEventTimestamp(uint64_t eventTimestamp);
+
121
+
138 MessageBuilder& setSequenceId(int64_t sequenceId);
+
139
+
150 MessageBuilder& setReplicationClusters(const std::vector<std::string>& clusters);
+
151
+
157 MessageBuilder& disableReplication(bool flag);
+
158
+
163 MessageBuilder& create();
+
164
+
165 protected:
+
166 const char* data() const;
+
167 std::size_t size() const;
+
168
+
169 private:
+
170 void checkMetadata();
+
171 static std::shared_ptr<MessageImpl> createMessageImpl();
+
172 Message::MessageImplPtr impl_;
+
173
+
174 friend class PulsarWrapper;
+
175};
+
+
176} // namespace pulsar
+
177
+
178#endif
+
pulsar::KeyValue
Definition KeyValue.h:35
+
pulsar::MessageBuilder
Definition MessageBuilder.h:33
+
pulsar::MessageBuilder::setDeliverAt
MessageBuilder & setDeliverAt(uint64_t deliveryTimestamp)
+ +
pulsar::MessageBuilder::setPartitionKey
MessageBuilder & setPartitionKey(const std::string &partitionKey)
+
pulsar::MessageBuilder::setContent
MessageBuilder & setContent(const void *data, size_t size)
+
pulsar::MessageBuilder::setAllocatedContent
MessageBuilder & setAllocatedContent(void *data, size_t size)
+
pulsar::MessageBuilder::setDeliverAfter
MessageBuilder & setDeliverAfter(const std::chrono::milliseconds delay)
+
pulsar::MessageBuilder::setEventTimestamp
MessageBuilder & setEventTimestamp(uint64_t eventTimestamp)
+
pulsar::MessageBuilder::setOrderingKey
MessageBuilder & setOrderingKey(const std::string &orderingKey)
+
pulsar::MessageBuilder::setContent
MessageBuilder & setContent(const KeyValue &data)
+
pulsar::MessageBuilder::setContent
MessageBuilder & setContent(std::string &&data)
+
pulsar::MessageBuilder::setProperties
MessageBuilder & setProperties(const StringMap &properties)
+
pulsar::MessageBuilder::setSequenceId
MessageBuilder & setSequenceId(int64_t sequenceId)
+
pulsar::MessageBuilder::create
MessageBuilder & create()
+
pulsar::MessageBuilder::setReplicationClusters
MessageBuilder & setReplicationClusters(const std::vector< std::string > &clusters)
+
pulsar::MessageBuilder::setProperty
MessageBuilder & setProperty(const std::string &name, const std::string &value)
+
pulsar::MessageBuilder::setContent
MessageBuilder & setContent(const std::string &data)
+
pulsar::MessageBuilder::disableReplication
MessageBuilder & disableReplication(bool flag)
+
pulsar::Message
Definition Message.h:44
+
pulsar
Definition Authentication.h:31
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_message_id_8h_source.html b/static/api/cpp/3.5.x/_message_id_8h_source.html new file mode 100644 index 000000000000..e023b822740c --- /dev/null +++ b/static/api/cpp/3.5.x/_message_id_8h_source.html @@ -0,0 +1,183 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/MessageId.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
MessageId.h
+
+
+
1
+
19#ifndef MESSAGE_ID_H
+
20#define MESSAGE_ID_H
+
21
+
22#include <pulsar/defines.h>
+
23#include <stdint.h>
+
24
+
25#include <iosfwd>
+
26#include <memory>
+
27#include <string>
+
28#include <vector>
+
29
+
30namespace pulsar {
+
31
+
32class MessageIdImpl;
+
33
+
+
34class PULSAR_PUBLIC MessageId {
+
35 public:
+
36 MessageId& operator=(const MessageId&);
+
37 MessageId();
+
38
+
51 explicit MessageId(int32_t partition, int64_t ledgerId, int64_t entryId, int32_t batchIndex);
+
52
+
56 static const MessageId& earliest();
+
57
+
61 static const MessageId& latest();
+
62
+
66 void serialize(std::string& result) const;
+
67
+
73 const std::string& getTopicName() const;
+
74
+
79 void setTopicName(const std::string& topicName);
+
80
+
84 static MessageId deserialize(const std::string& serializedMessageId);
+
85
+
86 // These functions compare the message order as stored in bookkeeper
+
87 bool operator<(const MessageId& other) const;
+
88 bool operator<=(const MessageId& other) const;
+
89 bool operator>(const MessageId& other) const;
+
90 bool operator>=(const MessageId& other) const;
+
91 bool operator==(const MessageId& other) const;
+
92 bool operator!=(const MessageId& other) const;
+
93
+
94 int64_t ledgerId() const;
+
95 int64_t entryId() const;
+
96 int32_t batchIndex() const;
+
97 int32_t partition() const;
+
98 int32_t batchSize() const;
+
99
+
100 private:
+
101 friend class ConsumerImpl;
+
102 friend class ReaderImpl;
+
103 friend class Message;
+
104 friend class MessageImpl;
+
105 friend class Commands;
+
106 friend class PartitionedProducerImpl;
+
107 friend class MultiTopicsConsumerImpl;
+
108 friend class UnAckedMessageTrackerEnabled;
+
109 friend class BatchAcknowledgementTracker;
+
110 friend class PulsarWrapper;
+
111 friend class PulsarFriend;
+
112 friend class NegativeAcksTracker;
+
113 friend class MessageIdBuilder;
+
114 friend class ChunkMessageIdImpl;
+
115
+
116 void setTopicName(const std::shared_ptr<std::string>& topic);
+
117
+
118 friend PULSAR_PUBLIC std::ostream& operator<<(std::ostream& s, const MessageId& messageId);
+
119
+
120 typedef std::shared_ptr<MessageIdImpl> MessageIdImplPtr;
+
121 MessageIdImplPtr impl_;
+
122
+
123 explicit MessageId(const MessageIdImplPtr& impl);
+
124};
+
+
125
+
126typedef std::vector<MessageId> MessageIdList;
+
127} // namespace pulsar
+
128
+
129#endif // MESSAGE_ID_H
+
pulsar::Message
Definition Message.h:44
+
pulsar::MessageIdBuilder
Definition MessageIdBuilder.h:54
+
pulsar::MessageId
Definition MessageId.h:34
+
pulsar::MessageId::deserialize
static MessageId deserialize(const std::string &serializedMessageId)
+
pulsar::MessageId::earliest
static const MessageId & earliest()
+
pulsar::MessageId::setTopicName
void setTopicName(const std::string &topicName)
+
pulsar::MessageId::getTopicName
const std::string & getTopicName() const
+
pulsar::MessageId::MessageId
MessageId(int32_t partition, int64_t ledgerId, int64_t entryId, int32_t batchIndex)
+
pulsar::MessageId::serialize
void serialize(std::string &result) const
+
pulsar::MessageId::latest
static const MessageId & latest()
+
pulsar
Definition Authentication.h:31
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_message_id_builder_8h_source.html b/static/api/cpp/3.5.x/_message_id_builder_8h_source.html new file mode 100644 index 000000000000..d76095282c78 --- /dev/null +++ b/static/api/cpp/3.5.x/_message_id_builder_8h_source.html @@ -0,0 +1,142 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/MessageIdBuilder.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
MessageIdBuilder.h
+
+
+
1
+
19#pragma once
+
20
+
21#include <pulsar/MessageId.h>
+
22
+
23#include <memory>
+
24
+
25namespace pulsar {
+
26
+
27namespace proto {
+
28class MessageIdData;
+
29}
+
30
+
+
54class PULSAR_PUBLIC MessageIdBuilder {
+
55 public:
+
56 explicit MessageIdBuilder();
+
57
+
61 static MessageIdBuilder from(const MessageId& messageId);
+
62
+
69 static MessageIdBuilder from(const proto::MessageIdData& messageIdData);
+
70
+
74 MessageId build() const;
+
75
+
81 MessageIdBuilder& ledgerId(int64_t ledgerId);
+
82
+
88 MessageIdBuilder& entryId(int64_t entryId);
+
89
+
95 MessageIdBuilder& partition(int32_t partition);
+
96
+
102 MessageIdBuilder& batchIndex(int32_t batchIndex);
+
103
+
109 MessageIdBuilder& batchSize(int32_t batchSize);
+
110
+
111 private:
+
112 std::shared_ptr<MessageIdImpl> impl_;
+
113};
+
+
114
+
115} // namespace pulsar
+
pulsar::MessageIdBuilder
Definition MessageIdBuilder.h:54
+
pulsar::MessageIdBuilder::batchSize
MessageIdBuilder & batchSize(int32_t batchSize)
+
pulsar::MessageIdBuilder::batchIndex
MessageIdBuilder & batchIndex(int32_t batchIndex)
+
pulsar::MessageIdBuilder::partition
MessageIdBuilder & partition(int32_t partition)
+
pulsar::MessageIdBuilder::from
static MessageIdBuilder from(const proto::MessageIdData &messageIdData)
+
pulsar::MessageIdBuilder::build
MessageId build() const
+
pulsar::MessageIdBuilder::from
static MessageIdBuilder from(const MessageId &messageId)
+
pulsar::MessageIdBuilder::ledgerId
MessageIdBuilder & ledgerId(int64_t ledgerId)
+
pulsar::MessageIdBuilder::entryId
MessageIdBuilder & entryId(int64_t entryId)
+
pulsar::MessageId
Definition MessageId.h:34
+
pulsar
Definition Authentication.h:31
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_message_routing_policy_8h_source.html b/static/api/cpp/3.5.x/_message_routing_policy_8h_source.html new file mode 100644 index 000000000000..fea95268bb78 --- /dev/null +++ b/static/api/cpp/3.5.x/_message_routing_policy_8h_source.html @@ -0,0 +1,140 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/MessageRoutingPolicy.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
MessageRoutingPolicy.h
+
+
+
1
+
19#ifndef PULSAR_MESSAGE_ROUTING_POLICY_HEADER_
+
20#define PULSAR_MESSAGE_ROUTING_POLICY_HEADER_
+
21
+
22#include <pulsar/DeprecatedException.h>
+
23#include <pulsar/Message.h>
+
24#include <pulsar/TopicMetadata.h>
+
25#include <pulsar/defines.h>
+
26
+
27#include <memory>
+
28
+
29/*
+
30 * Implement this interface to define custom policy giving message to
+
31 * partition mapping.
+
32 */
+
33namespace pulsar {
+
34
+
+
35class PULSAR_PUBLIC MessageRoutingPolicy {
+
36 public:
+
37 virtual ~MessageRoutingPolicy() {}
+
38
+
+
42 virtual int getPartition(const Message& msg) {
+
43 throw DeprecatedException(
+
44 "Use int getPartition(const Message& msg,"
+
45 " const TopicMetadata& topicMetadata)");
+
46 }
+
+
47
+
+
55 virtual int getPartition(const Message& msg, const TopicMetadata& topicMetadata) {
+
56 return getPartition(msg);
+
57 }
+
+
58};
+
+
59
+
60typedef std::shared_ptr<MessageRoutingPolicy> MessageRoutingPolicyPtr;
+
61} // namespace pulsar
+
62
+
63#endif // PULSAR_MESSAGE_ROUTING_POLICY_HEADER_
+
pulsar::DeprecatedException
Definition DeprecatedException.h:28
+
pulsar::Message
Definition Message.h:44
+
pulsar::MessageRoutingPolicy
Definition MessageRoutingPolicy.h:35
+
pulsar::MessageRoutingPolicy::getPartition
virtual int getPartition(const Message &msg, const TopicMetadata &topicMetadata)
Definition MessageRoutingPolicy.h:55
+
pulsar::MessageRoutingPolicy::getPartition
virtual int getPartition(const Message &msg)
Definition MessageRoutingPolicy.h:42
+
pulsar::TopicMetadata
Definition TopicMetadata.h:28
+
pulsar
Definition Authentication.h:31
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_producer_8h_source.html b/static/api/cpp/3.5.x/_producer_8h_source.html new file mode 100644 index 000000000000..42cadedabea3 --- /dev/null +++ b/static/api/cpp/3.5.x/_producer_8h_source.html @@ -0,0 +1,173 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/Producer.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
Producer.h
+
+
+
1
+
19#ifndef PRODUCER_HPP_
+
20#define PRODUCER_HPP_
+
21
+
22#include <pulsar/ProducerConfiguration.h>
+
23#include <pulsar/defines.h>
+
24#include <stdint.h>
+
25
+
26#include <memory>
+
27
+
28namespace pulsar {
+
29class ProducerImplBase;
+
30class PulsarWrapper;
+
31class PulsarFriend;
+
32
+
33typedef std::function<void(Result)> FlushCallback;
+
34typedef std::shared_ptr<ProducerImplBase> ProducerImplBasePtr;
+
35
+
+
36class PULSAR_PUBLIC Producer {
+
37 public:
+
41 Producer();
+
42
+
46 const std::string& getTopic() const;
+
47
+
51 const std::string& getProducerName() const;
+
52
+
58 Result send(const Message& msg);
+
59
+
84 Result send(const Message& msg, MessageId& messageId);
+
85
+
100 void sendAsync(const Message& msg, SendCallback callback);
+
101
+
106 Result flush();
+
107
+
112 void flushAsync(FlushCallback callback);
+
113
+
126 int64_t getLastSequenceId() const;
+
127
+
136 const std::string& getSchemaVersion() const;
+
137
+
147 Result close();
+
148
+
156 void closeAsync(CloseCallback callback);
+
157
+
161 bool isConnected() const;
+
162
+
163 private:
+
164 explicit Producer(ProducerImplBasePtr);
+
165
+
166 friend class ClientImpl;
+
167 friend class PulsarFriend;
+
168 friend class PulsarWrapper;
+
169 friend class ProducerImpl;
+
170
+
171 ProducerImplBasePtr impl_;
+
172
+
173 // For unit test case BatchMessageTest::producerFailureResult only
+
174 void producerFailMessages(Result result);
+
175};
+
+
176} // namespace pulsar
+
177
+
178#endif /* PRODUCER_HPP_ */
+
pulsar::Message
Definition Message.h:44
+
pulsar::MessageId
Definition MessageId.h:34
+
pulsar::Producer
Definition Producer.h:36
+ + +
pulsar::Producer::isConnected
bool isConnected() const
+ +
pulsar::Producer::getSchemaVersion
const std::string & getSchemaVersion() const
+
pulsar::Producer::flushAsync
void flushAsync(FlushCallback callback)
+
pulsar::Producer::send
Result send(const Message &msg, MessageId &messageId)
+
pulsar::Producer::closeAsync
void closeAsync(CloseCallback callback)
+
pulsar::Producer::sendAsync
void sendAsync(const Message &msg, SendCallback callback)
+
pulsar::Producer::getLastSequenceId
int64_t getLastSequenceId() const
+
pulsar::Producer::getTopic
const std::string & getTopic() const
+
pulsar::Producer::getProducerName
const std::string & getProducerName() const
+
pulsar::Producer::send
Result send(const Message &msg)
+
pulsar
Definition Authentication.h:31
+
pulsar::Result
Result
Definition Result.h:32
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_producer_configuration_8h_source.html b/static/api/cpp/3.5.x/_producer_configuration_8h_source.html new file mode 100644 index 000000000000..5dd799827496 --- /dev/null +++ b/static/api/cpp/3.5.x/_producer_configuration_8h_source.html @@ -0,0 +1,330 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/ProducerConfiguration.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
ProducerConfiguration.h
+
+
+
1
+
19#ifndef PULSAR_PRODUCERCONFIGURATION_H_
+
20#define PULSAR_PRODUCERCONFIGURATION_H_
+
21#include <pulsar/CompressionType.h>
+
22#include <pulsar/CryptoKeyReader.h>
+
23#include <pulsar/Message.h>
+
24#include <pulsar/MessageRoutingPolicy.h>
+
25#include <pulsar/ProducerCryptoFailureAction.h>
+
26#include <pulsar/ProducerInterceptor.h>
+
27#include <pulsar/Result.h>
+
28#include <pulsar/Schema.h>
+
29#include <pulsar/defines.h>
+
30
+
31#include <functional>
+
32#include <set>
+
33
+
34namespace pulsar {
+
35
+
36typedef std::function<void(Result, const MessageId& messageId)> SendCallback;
+
37typedef std::function<void(Result)> CloseCallback;
+
38
+
39struct ProducerConfigurationImpl;
+
40class PulsarWrapper;
+
41
+
+
45class PULSAR_PUBLIC ProducerConfiguration {
+
46 public:
+
47 enum PartitionsRoutingMode
+
48 {
+
49 UseSinglePartition,
+
50 RoundRobinDistribution,
+
51 CustomPartition
+
52 };
+
53 enum HashingScheme
+
54 {
+
55 Murmur3_32Hash,
+
56 BoostHash,
+
57 JavaStringHash
+
58 };
+
+
59 enum BatchingType
+
60 {
+
70 DefaultBatching,
+
71
+
81 KeyBasedBatching
+
82 };
+
+
+
83 enum ProducerAccessMode
+
84 {
+
88 Shared = 0,
+
89
+
93 Exclusive = 1,
+
94
+
98 WaitForExclusive = 2,
+
99
+
104 ExclusiveWithFencing = 3
+
105 };
+
+
106
+
107 ProducerConfiguration();
+
108 ~ProducerConfiguration();
+
109 ProducerConfiguration(const ProducerConfiguration&);
+
110 ProducerConfiguration& operator=(const ProducerConfiguration&);
+
111
+
118 ProducerConfiguration& setProducerName(const std::string& producerName);
+
119
+
123 const std::string& getProducerName() const;
+
124
+
137 ProducerConfiguration& setSchema(const SchemaInfo& schemaInfo);
+
138
+
142 const SchemaInfo& getSchema() const;
+
143
+
147 ProducerConfiguration& setSendTimeout(int sendTimeoutMs);
+
148
+
159 int getSendTimeout() const;
+
160
+
172 ProducerConfiguration& setInitialSequenceId(int64_t initialSequenceId);
+
173
+
177 int64_t getInitialSequenceId() const;
+
178
+
194 ProducerConfiguration& setCompressionType(CompressionType compressionType);
+
195
+
199 CompressionType getCompressionType() const;
+
200
+
212 ProducerConfiguration& setMaxPendingMessages(int maxPendingMessages);
+
213
+
217 int getMaxPendingMessages() const;
+
218
+
229 ProducerConfiguration& setMaxPendingMessagesAcrossPartitions(int maxPendingMessagesAcrossPartitions);
+
230
+
234 int getMaxPendingMessagesAcrossPartitions() const;
+
235
+
244 ProducerConfiguration& setPartitionsRoutingMode(const PartitionsRoutingMode& mode);
+
245
+
249 PartitionsRoutingMode getPartitionsRoutingMode() const;
+
250
+
257 ProducerConfiguration& setMessageRouter(const MessageRoutingPolicyPtr& router);
+
258
+
262 const MessageRoutingPolicyPtr& getMessageRouterPtr() const;
+
263
+
282 ProducerConfiguration& setHashingScheme(const HashingScheme& scheme);
+
283
+
287 HashingScheme getHashingScheme() const;
+
288
+
303 ProducerConfiguration& setLazyStartPartitionedProducers(bool);
+
304
+
308 bool getLazyStartPartitionedProducers() const;
+
309
+
313 ProducerConfiguration& setBlockIfQueueFull(bool);
+
314
+
319 bool getBlockIfQueueFull() const;
+
320
+
321 // Zero queue size feature will not be supported on consumer end if batching is enabled
+
322
+
338 ProducerConfiguration& setBatchingEnabled(const bool& batchingEnabled);
+
339
+
347 const bool& getBatchingEnabled() const;
+
348
+
360 ProducerConfiguration& setBatchingMaxMessages(const unsigned int& batchingMaxMessages);
+
361
+
365 const unsigned int& getBatchingMaxMessages() const;
+
366
+
379 ProducerConfiguration& setBatchingMaxAllowedSizeInBytes(
+
380 const unsigned long& batchingMaxAllowedSizeInBytes);
+
381
+
385 const unsigned long& getBatchingMaxAllowedSizeInBytes() const;
+
386
+
394 ProducerConfiguration& setBatchingMaxPublishDelayMs(const unsigned long& batchingMaxPublishDelayMs);
+
395
+
399 const unsigned long& getBatchingMaxPublishDelayMs() const;
+
400
+
406 ProducerConfiguration& setBatchingType(BatchingType batchingType);
+
407
+
412 BatchingType getBatchingType() const;
+
413
+
417 const CryptoKeyReaderPtr getCryptoKeyReader() const;
+
418
+
425 ProducerConfiguration& setCryptoKeyReader(CryptoKeyReaderPtr cryptoKeyReader);
+
426
+
430 ProducerCryptoFailureAction getCryptoFailureAction() const;
+
431
+
439 ProducerConfiguration& setCryptoFailureAction(ProducerCryptoFailureAction action);
+
440
+
444 const std::set<std::string>& getEncryptionKeys() const;
+
445
+
449 bool isEncryptionEnabled() const;
+
450
+
463 ProducerConfiguration& addEncryptionKey(std::string key);
+
464
+
472 bool hasProperty(const std::string& name) const;
+
473
+
480 const std::string& getProperty(const std::string& name) const;
+
481
+
485 std::map<std::string, std::string>& getProperties() const;
+
486
+
493 ProducerConfiguration& setProperty(const std::string& name, const std::string& value);
+
494
+
498 ProducerConfiguration& setProperties(const std::map<std::string, std::string>& properties);
+
499
+
521 ProducerConfiguration& setChunkingEnabled(bool chunkingEnabled);
+
522
+
526 bool isChunkingEnabled() const;
+
527
+
535 ProducerConfiguration& setAccessMode(const ProducerAccessMode& accessMode);
+
536
+
540 ProducerAccessMode getAccessMode() const;
+
541
+
542 ProducerConfiguration& intercept(const std::vector<ProducerInterceptorPtr>& interceptors);
+
543
+
544 const std::vector<ProducerInterceptorPtr>& getInterceptors() const;
+
545
+
546 private:
+
547 std::shared_ptr<ProducerConfigurationImpl> impl_;
+
548
+
549 friend class PulsarWrapper;
+
550 friend class ConsumerImpl;
+
551 friend class ProducerImpl;
+
552};
+
+
553} // namespace pulsar
+
554#endif /* PULSAR_PRODUCERCONFIGURATION_H_ */
+
pulsar::ProducerConfiguration
Definition ProducerConfiguration.h:45
+
pulsar::ProducerConfiguration::getProperty
const std::string & getProperty(const std::string &name) const
+
pulsar::ProducerConfiguration::getSchema
const SchemaInfo & getSchema() const
+
pulsar::ProducerConfiguration::setBatchingMaxMessages
ProducerConfiguration & setBatchingMaxMessages(const unsigned int &batchingMaxMessages)
+
pulsar::ProducerConfiguration::setSendTimeout
ProducerConfiguration & setSendTimeout(int sendTimeoutMs)
+
pulsar::ProducerConfiguration::setAccessMode
ProducerConfiguration & setAccessMode(const ProducerAccessMode &accessMode)
+
pulsar::ProducerConfiguration::getBatchingMaxMessages
const unsigned int & getBatchingMaxMessages() const
+ +
pulsar::ProducerConfiguration::setBatchingMaxPublishDelayMs
ProducerConfiguration & setBatchingMaxPublishDelayMs(const unsigned long &batchingMaxPublishDelayMs)
+
pulsar::ProducerConfiguration::setCompressionType
ProducerConfiguration & setCompressionType(CompressionType compressionType)
+ +
pulsar::ProducerConfiguration::getProperties
std::map< std::string, std::string > & getProperties() const
+
pulsar::ProducerConfiguration::getCryptoKeyReader
const CryptoKeyReaderPtr getCryptoKeyReader() const
+
pulsar::ProducerConfiguration::setProperties
ProducerConfiguration & setProperties(const std::map< std::string, std::string > &properties)
+
pulsar::ProducerConfiguration::getAccessMode
ProducerAccessMode getAccessMode() const
+
pulsar::ProducerConfiguration::getProducerName
const std::string & getProducerName() const
+
pulsar::ProducerConfiguration::setHashingScheme
ProducerConfiguration & setHashingScheme(const HashingScheme &scheme)
+
pulsar::ProducerConfiguration::getEncryptionKeys
const std::set< std::string > & getEncryptionKeys() const
+
pulsar::ProducerConfiguration::addEncryptionKey
ProducerConfiguration & addEncryptionKey(std::string key)
+ +
pulsar::ProducerConfiguration::getCompressionType
CompressionType getCompressionType() const
+
pulsar::ProducerConfiguration::setPartitionsRoutingMode
ProducerConfiguration & setPartitionsRoutingMode(const PartitionsRoutingMode &mode)
+
pulsar::ProducerConfiguration::setCryptoKeyReader
ProducerConfiguration & setCryptoKeyReader(CryptoKeyReaderPtr cryptoKeyReader)
+ +
pulsar::ProducerConfiguration::getBatchingMaxAllowedSizeInBytes
const unsigned long & getBatchingMaxAllowedSizeInBytes() const
+
pulsar::ProducerConfiguration::hasProperty
bool hasProperty(const std::string &name) const
+
pulsar::ProducerConfiguration::getMessageRouterPtr
const MessageRoutingPolicyPtr & getMessageRouterPtr() const
+
pulsar::ProducerConfiguration::setProducerName
ProducerConfiguration & setProducerName(const std::string &producerName)
+
pulsar::ProducerConfiguration::getCryptoFailureAction
ProducerCryptoFailureAction getCryptoFailureAction() const
+
pulsar::ProducerConfiguration::setInitialSequenceId
ProducerConfiguration & setInitialSequenceId(int64_t initialSequenceId)
+
pulsar::ProducerConfiguration::getBatchingType
BatchingType getBatchingType() const
+
pulsar::ProducerConfiguration::getInitialSequenceId
int64_t getInitialSequenceId() const
+
pulsar::ProducerConfiguration::ProducerAccessMode
ProducerAccessMode
Definition ProducerConfiguration.h:84
+
pulsar::ProducerConfiguration::setProperty
ProducerConfiguration & setProperty(const std::string &name, const std::string &value)
+
pulsar::ProducerConfiguration::getMaxPendingMessagesAcrossPartitions
int getMaxPendingMessagesAcrossPartitions() const
+
pulsar::ProducerConfiguration::setBatchingMaxAllowedSizeInBytes
ProducerConfiguration & setBatchingMaxAllowedSizeInBytes(const unsigned long &batchingMaxAllowedSizeInBytes)
+
pulsar::ProducerConfiguration::getHashingScheme
HashingScheme getHashingScheme() const
+
pulsar::ProducerConfiguration::setBatchingType
ProducerConfiguration & setBatchingType(BatchingType batchingType)
+
pulsar::ProducerConfiguration::setMessageRouter
ProducerConfiguration & setMessageRouter(const MessageRoutingPolicyPtr &router)
+
pulsar::ProducerConfiguration::setMaxPendingMessagesAcrossPartitions
ProducerConfiguration & setMaxPendingMessagesAcrossPartitions(int maxPendingMessagesAcrossPartitions)
+
pulsar::ProducerConfiguration::setCryptoFailureAction
ProducerConfiguration & setCryptoFailureAction(ProducerCryptoFailureAction action)
+
pulsar::ProducerConfiguration::getLazyStartPartitionedProducers
bool getLazyStartPartitionedProducers() const
+
pulsar::ProducerConfiguration::getBatchingMaxPublishDelayMs
const unsigned long & getBatchingMaxPublishDelayMs() const
+
pulsar::ProducerConfiguration::setChunkingEnabled
ProducerConfiguration & setChunkingEnabled(bool chunkingEnabled)
+
pulsar::ProducerConfiguration::BatchingType
BatchingType
Definition ProducerConfiguration.h:60
+
pulsar::ProducerConfiguration::DefaultBatching
@ DefaultBatching
Definition ProducerConfiguration.h:70
+ +
pulsar::ProducerConfiguration::getBatchingEnabled
const bool & getBatchingEnabled() const
+
pulsar::ProducerConfiguration::setBlockIfQueueFull
ProducerConfiguration & setBlockIfQueueFull(bool)
+
pulsar::ProducerConfiguration::getPartitionsRoutingMode
PartitionsRoutingMode getPartitionsRoutingMode() const
+
pulsar::ProducerConfiguration::setMaxPendingMessages
ProducerConfiguration & setMaxPendingMessages(int maxPendingMessages)
+
pulsar::ProducerConfiguration::setLazyStartPartitionedProducers
ProducerConfiguration & setLazyStartPartitionedProducers(bool)
+
pulsar::ProducerConfiguration::setSchema
ProducerConfiguration & setSchema(const SchemaInfo &schemaInfo)
+
pulsar::ProducerConfiguration::setBatchingEnabled
ProducerConfiguration & setBatchingEnabled(const bool &batchingEnabled)
+
pulsar::SchemaInfo
Definition Schema.h:146
+
pulsar
Definition Authentication.h:31
+
pulsar::Result
Result
Definition Result.h:32
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_producer_crypto_failure_action_8h_source.html b/static/api/cpp/3.5.x/_producer_crypto_failure_action_8h_source.html new file mode 100644 index 000000000000..3cff7b0f039f --- /dev/null +++ b/static/api/cpp/3.5.x/_producer_crypto_failure_action_8h_source.html @@ -0,0 +1,107 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/ProducerCryptoFailureAction.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
ProducerCryptoFailureAction.h
+
+
+
1
+
19#ifndef PRODUCERCRYPTOFAILUREACTION_H_
+
20#define PRODUCERCRYPTOFAILUREACTION_H_
+
21
+
22namespace pulsar {
+
23
+
24enum class ProducerCryptoFailureAction
+
25{
+
26 FAIL, // This is the default option to fail send if crypto operation fails
+
27 SEND // Ignore crypto failure and proceed with sending unencrypted messages
+
28};
+
29
+
30} /* namespace pulsar */
+
31
+
32#endif /* PRODUCERCRYPTOFAILUREACTION_H_ */
+
pulsar
Definition Authentication.h:31
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_producer_interceptor_8h_source.html b/static/api/cpp/3.5.x/_producer_interceptor_8h_source.html new file mode 100644 index 000000000000..4fc7cb34816b --- /dev/null +++ b/static/api/cpp/3.5.x/_producer_interceptor_8h_source.html @@ -0,0 +1,133 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/ProducerInterceptor.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
ProducerInterceptor.h
+
+
+
1
+
20#ifndef PULSAR_PRODUCER_INTERCEPTOR_H
+
21#define PULSAR_PRODUCER_INTERCEPTOR_H
+
22
+
23#include <pulsar/Message.h>
+
24#include <pulsar/Result.h>
+
25#include <pulsar/defines.h>
+
26
+
27namespace pulsar {
+
28
+
29class Producer;
+
30
+
+
42class PULSAR_PUBLIC ProducerInterceptor {
+
43 public:
+
44 virtual ~ProducerInterceptor() {}
+
45
+
49 virtual void close() {}
+
50
+
80 virtual Message beforeSend(const Producer& producer, const Message& message) = 0;
+
81
+
99 virtual void onSendAcknowledgement(const Producer& producer, Result result, const Message& message,
+
100 const MessageId& messageID) = 0;
+
101
+
108 virtual void onPartitionsChange(const std::string& topicName, int partitions) {}
+
109};
+
+
110
+
111typedef std::shared_ptr<ProducerInterceptor> ProducerInterceptorPtr;
+
112} // namespace pulsar
+
113
+
114#endif // PULSAR_PRODUCER_INTERCEPTOR_H
+
pulsar::Message
Definition Message.h:44
+
pulsar::MessageId
Definition MessageId.h:34
+
pulsar::Producer
Definition Producer.h:36
+
pulsar::ProducerInterceptor
Definition ProducerInterceptor.h:42
+
pulsar::ProducerInterceptor::close
virtual void close()
Definition ProducerInterceptor.h:49
+
pulsar::ProducerInterceptor::onPartitionsChange
virtual void onPartitionsChange(const std::string &topicName, int partitions)
Definition ProducerInterceptor.h:108
+
pulsar::ProducerInterceptor::onSendAcknowledgement
virtual void onSendAcknowledgement(const Producer &producer, Result result, const Message &message, const MessageId &messageID)=0
+
pulsar::ProducerInterceptor::beforeSend
virtual Message beforeSend(const Producer &producer, const Message &message)=0
+
pulsar
Definition Authentication.h:31
+
pulsar::Result
Result
Definition Result.h:32
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_protobuf_native_schema_8h_source.html b/static/api/cpp/3.5.x/_protobuf_native_schema_8h_source.html new file mode 100644 index 000000000000..43a959709818 --- /dev/null +++ b/static/api/cpp/3.5.x/_protobuf_native_schema_8h_source.html @@ -0,0 +1,105 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/ProtobufNativeSchema.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
ProtobufNativeSchema.h
+
+
+
1
+
19#pragma once
+
20
+
21#include <google/protobuf/descriptor.h>
+
22#include <pulsar/Schema.h>
+
23
+
24namespace pulsar {
+
25
+
33PULSAR_PUBLIC SchemaInfo createProtobufNativeSchema(const google::protobuf::Descriptor* descriptor);
+
34
+
35} // namespace pulsar
+
pulsar::SchemaInfo
Definition Schema.h:146
+
pulsar
Definition Authentication.h:31
+
pulsar::createProtobufNativeSchema
PULSAR_PUBLIC SchemaInfo createProtobufNativeSchema(const google::protobuf::Descriptor *descriptor)
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_reader_8h_source.html b/static/api/cpp/3.5.x/_reader_8h_source.html new file mode 100644 index 000000000000..3d45d735c427 --- /dev/null +++ b/static/api/cpp/3.5.x/_reader_8h_source.html @@ -0,0 +1,179 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/Reader.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
Reader.h
+
+
+
1
+
19#ifndef PULSAR_READER_HPP_
+
20#define PULSAR_READER_HPP_
+
21
+
22#include <pulsar/Message.h>
+
23#include <pulsar/ReaderConfiguration.h>
+
24#include <pulsar/defines.h>
+
25
+
26namespace pulsar {
+
27class PulsarWrapper;
+
28class PulsarFriend;
+
29class ReaderImpl;
+
30
+
31typedef std::function<void(Result result, bool hasMessageAvailable)> HasMessageAvailableCallback;
+
32typedef std::function<void(Result result, const Message& message)> ReadNextCallback;
+
33
+
+
37class PULSAR_PUBLIC Reader {
+
38 public:
+
42 Reader();
+
43
+
47 const std::string& getTopic() const;
+
48
+
59 Result readNext(Message& msg);
+
60
+
70 Result readNext(Message& msg, int timeoutMs);
+
71
+
77 void readNextAsync(ReadNextCallback callback);
+
78
+
84 Result close();
+
85
+
91 void closeAsync(ResultCallback callback);
+
92
+
96 void hasMessageAvailableAsync(HasMessageAvailableCallback callback);
+
97
+
101 Result hasMessageAvailable(bool& hasMessageAvailable);
+
102
+
113 Result seek(const MessageId& msgId);
+
114
+
121 Result seek(uint64_t timestamp);
+
122
+
133 void seekAsync(const MessageId& msgId, ResultCallback callback);
+
134
+
141 void seekAsync(uint64_t timestamp, ResultCallback callback);
+
142
+
146 bool isConnected() const;
+
147
+
152 void getLastMessageIdAsync(GetLastMessageIdCallback callback);
+
153
+
157 Result getLastMessageId(MessageId& messageId);
+
158
+
159 private:
+
160 typedef std::shared_ptr<ReaderImpl> ReaderImplPtr;
+
161 ReaderImplPtr impl_;
+
162 explicit Reader(ReaderImplPtr);
+
163
+
164 friend class PulsarFriend;
+
165 friend class PulsarWrapper;
+
166 friend class ReaderImpl;
+
167 friend class TableViewImpl;
+
168 friend class ReaderTest;
+
169};
+
+
170} // namespace pulsar
+
171
+
172#endif /* PULSAR_READER_HPP_ */
+
pulsar::Message
Definition Message.h:44
+
pulsar::MessageId
Definition MessageId.h:34
+
pulsar::Reader
Definition Reader.h:37
+
pulsar::Reader::hasMessageAvailableAsync
void hasMessageAvailableAsync(HasMessageAvailableCallback callback)
+
pulsar::Reader::readNext
Result readNext(Message &msg)
+
pulsar::Reader::getTopic
const std::string & getTopic() const
+ +
pulsar::Reader::readNextAsync
void readNextAsync(ReadNextCallback callback)
+
pulsar::Reader::getLastMessageIdAsync
void getLastMessageIdAsync(GetLastMessageIdCallback callback)
+
pulsar::Reader::closeAsync
void closeAsync(ResultCallback callback)
+
pulsar::Reader::readNext
Result readNext(Message &msg, int timeoutMs)
+
pulsar::Reader::seek
Result seek(const MessageId &msgId)
+
pulsar::Reader::hasMessageAvailable
Result hasMessageAvailable(bool &hasMessageAvailable)
+
pulsar::Reader::getLastMessageId
Result getLastMessageId(MessageId &messageId)
+
pulsar::Reader::isConnected
bool isConnected() const
+
pulsar::Reader::close
Result close()
+
pulsar::Reader::seekAsync
void seekAsync(const MessageId &msgId, ResultCallback callback)
+
pulsar::Reader::seekAsync
void seekAsync(uint64_t timestamp, ResultCallback callback)
+
pulsar::Reader::seek
Result seek(uint64_t timestamp)
+
pulsar
Definition Authentication.h:31
+
pulsar::ResultCallback
std::function< void(Result result)> ResultCallback
Callback definition for non-data operation.
Definition ConsumerConfiguration.h:50
+
pulsar::Result
Result
Definition Result.h:32
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_reader_configuration_8h_source.html b/static/api/cpp/3.5.x/_reader_configuration_8h_source.html new file mode 100644 index 000000000000..7d9c0c85cf5d --- /dev/null +++ b/static/api/cpp/3.5.x/_reader_configuration_8h_source.html @@ -0,0 +1,244 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/ReaderConfiguration.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
ReaderConfiguration.h
+
+
+
1
+
19#ifndef PULSAR_READER_CONFIGURATION_H_
+
20#define PULSAR_READER_CONFIGURATION_H_
+
21
+
22#include <pulsar/ConsumerCryptoFailureAction.h>
+
23#include <pulsar/CryptoKeyReader.h>
+
24#include <pulsar/Message.h>
+
25#include <pulsar/Result.h>
+
26#include <pulsar/Schema.h>
+
27#include <pulsar/defines.h>
+
28
+
29#include <functional>
+
30#include <memory>
+
31
+
32namespace pulsar {
+
33
+
34class Reader;
+
35class PulsarWrapper;
+
36
+
38typedef std::function<void(Result result)> ResultCallback;
+
39typedef std::function<void(Result result, MessageId messageId)> GetLastMessageIdCallback;
+
40
+
42typedef std::function<void(Reader reader, const Message& msg)> ReaderListener;
+
43
+
44struct ReaderConfigurationImpl;
+
45
+
+
49class PULSAR_PUBLIC ReaderConfiguration {
+
50 public:
+
51 ReaderConfiguration();
+
52 ~ReaderConfiguration();
+
53 ReaderConfiguration(const ReaderConfiguration&);
+
54 ReaderConfiguration& operator=(const ReaderConfiguration&);
+
55
+
64 ReaderConfiguration& setSchema(const SchemaInfo& schemaInfo);
+
65
+
69 const SchemaInfo& getSchema() const;
+
70
+
75 ReaderConfiguration& setReaderListener(ReaderListener listener);
+
76
+
80 ReaderListener getReaderListener() const;
+
81
+
85 bool hasReaderListener() const;
+
86
+
108 void setReceiverQueueSize(int size);
+
109
+
113 int getReceiverQueueSize() const;
+
114
+
120 void setReaderName(const std::string& readerName);
+
121
+
125 const std::string& getReaderName() const;
+
126
+
134 void setSubscriptionRolePrefix(const std::string& subscriptionRolePrefix);
+
135
+
139 const std::string& getSubscriptionRolePrefix() const;
+
140
+
154 void setReadCompacted(bool compacted);
+
155
+
159 bool isReadCompacted() const;
+
160
+
167 void setInternalSubscriptionName(std::string internalSubscriptionName);
+
168
+
172 const std::string& getInternalSubscriptionName() const;
+
173
+
181 void setUnAckedMessagesTimeoutMs(const uint64_t milliSeconds);
+
182
+
186 long getUnAckedMessagesTimeoutMs() const;
+
187
+
200 void setTickDurationInMs(const uint64_t milliSeconds);
+
201
+
205 long getTickDurationInMs() const;
+
206
+
215 void setAckGroupingTimeMs(long ackGroupingMillis);
+
216
+
222 long getAckGroupingTimeMs() const;
+
223
+
230 void setAckGroupingMaxSize(long maxGroupingSize);
+
231
+
237 long getAckGroupingMaxSize() const;
+
238
+
242 bool isEncryptionEnabled() const;
+
243
+
247 const CryptoKeyReaderPtr getCryptoKeyReader() const;
+
248
+
254 ReaderConfiguration& setCryptoKeyReader(CryptoKeyReaderPtr cryptoKeyReader);
+
255
+
259 ConsumerCryptoFailureAction getCryptoFailureAction() const;
+
260
+
264 ReaderConfiguration& setCryptoFailureAction(ConsumerCryptoFailureAction action);
+
265
+
274 ReaderConfiguration& setStartMessageIdInclusive(bool startMessageIdInclusive);
+
275
+
279 bool isStartMessageIdInclusive() const;
+
280
+
288 bool hasProperty(const std::string& name) const;
+
289
+
296 const std::string& getProperty(const std::string& name) const;
+
297
+
301 std::map<std::string, std::string>& getProperties() const;
+
302
+
308 ReaderConfiguration& setProperty(const std::string& name, const std::string& value);
+
309
+
313 ReaderConfiguration& setProperties(const std::map<std::string, std::string>& properties);
+
314
+
315 private:
+
316 std::shared_ptr<ReaderConfigurationImpl> impl_;
+
317};
+
+
318} // namespace pulsar
+
319#endif /* PULSAR_READER_CONFIGURATION_H_ */
+
pulsar::Message
Definition Message.h:44
+
pulsar::ReaderConfiguration
Definition ReaderConfiguration.h:49
+
pulsar::ReaderConfiguration::setReceiverQueueSize
void setReceiverQueueSize(int size)
+
pulsar::ReaderConfiguration::hasProperty
bool hasProperty(const std::string &name) const
+ +
pulsar::ReaderConfiguration::setUnAckedMessagesTimeoutMs
void setUnAckedMessagesTimeoutMs(const uint64_t milliSeconds)
+
pulsar::ReaderConfiguration::setProperties
ReaderConfiguration & setProperties(const std::map< std::string, std::string > &properties)
+
pulsar::ReaderConfiguration::getTickDurationInMs
long getTickDurationInMs() const
+
pulsar::ReaderConfiguration::setTickDurationInMs
void setTickDurationInMs(const uint64_t milliSeconds)
+
pulsar::ReaderConfiguration::setSubscriptionRolePrefix
void setSubscriptionRolePrefix(const std::string &subscriptionRolePrefix)
+
pulsar::ReaderConfiguration::isStartMessageIdInclusive
bool isStartMessageIdInclusive() const
+
pulsar::ReaderConfiguration::getUnAckedMessagesTimeoutMs
long getUnAckedMessagesTimeoutMs() const
+
pulsar::ReaderConfiguration::setCryptoKeyReader
ReaderConfiguration & setCryptoKeyReader(CryptoKeyReaderPtr cryptoKeyReader)
+
pulsar::ReaderConfiguration::getSchema
const SchemaInfo & getSchema() const
+
pulsar::ReaderConfiguration::setCryptoFailureAction
ReaderConfiguration & setCryptoFailureAction(ConsumerCryptoFailureAction action)
+
pulsar::ReaderConfiguration::setReaderName
void setReaderName(const std::string &readerName)
+
pulsar::ReaderConfiguration::setProperty
ReaderConfiguration & setProperty(const std::string &name, const std::string &value)
+ +
pulsar::ReaderConfiguration::getInternalSubscriptionName
const std::string & getInternalSubscriptionName() const
+
pulsar::ReaderConfiguration::getProperties
std::map< std::string, std::string > & getProperties() const
+
pulsar::ReaderConfiguration::isEncryptionEnabled
bool isEncryptionEnabled() const
+
pulsar::ReaderConfiguration::getReaderListener
ReaderListener getReaderListener() const
+
pulsar::ReaderConfiguration::setReadCompacted
void setReadCompacted(bool compacted)
+
pulsar::ReaderConfiguration::getProperty
const std::string & getProperty(const std::string &name) const
+
pulsar::ReaderConfiguration::setAckGroupingTimeMs
void setAckGroupingTimeMs(long ackGroupingMillis)
+
pulsar::ReaderConfiguration::setReaderListener
ReaderConfiguration & setReaderListener(ReaderListener listener)
+
pulsar::ReaderConfiguration::setSchema
ReaderConfiguration & setSchema(const SchemaInfo &schemaInfo)
+ +
pulsar::ReaderConfiguration::setStartMessageIdInclusive
ReaderConfiguration & setStartMessageIdInclusive(bool startMessageIdInclusive)
+
pulsar::ReaderConfiguration::getAckGroupingTimeMs
long getAckGroupingTimeMs() const
+
pulsar::ReaderConfiguration::getReaderName
const std::string & getReaderName() const
+
pulsar::ReaderConfiguration::getCryptoKeyReader
const CryptoKeyReaderPtr getCryptoKeyReader() const
+
pulsar::ReaderConfiguration::setInternalSubscriptionName
void setInternalSubscriptionName(std::string internalSubscriptionName)
+
pulsar::ReaderConfiguration::getSubscriptionRolePrefix
const std::string & getSubscriptionRolePrefix() const
+
pulsar::ReaderConfiguration::getCryptoFailureAction
ConsumerCryptoFailureAction getCryptoFailureAction() const
+
pulsar::ReaderConfiguration::setAckGroupingMaxSize
void setAckGroupingMaxSize(long maxGroupingSize)
+
pulsar::ReaderConfiguration::getAckGroupingMaxSize
long getAckGroupingMaxSize() const
+
pulsar::Reader
Definition Reader.h:37
+
pulsar::SchemaInfo
Definition Schema.h:146
+
pulsar
Definition Authentication.h:31
+
pulsar::ReaderListener
std::function< void(Reader reader, const Message &msg)> ReaderListener
Callback definition for MessageListener.
Definition ReaderConfiguration.h:42
+
pulsar::ResultCallback
std::function< void(Result result)> ResultCallback
Callback definition for non-data operation.
Definition ConsumerConfiguration.h:50
+
pulsar::Result
Result
Definition Result.h:32
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_regex_subscription_mode_8h_source.html b/static/api/cpp/3.5.x/_regex_subscription_mode_8h_source.html new file mode 100644 index 000000000000..87e5ebbf12fa --- /dev/null +++ b/static/api/cpp/3.5.x/_regex_subscription_mode_8h_source.html @@ -0,0 +1,114 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/RegexSubscriptionMode.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
RegexSubscriptionMode.h
+
+
+
1
+
19#ifndef PULSAR_CPP_REGEX_SUB_MODE_H
+
20#define PULSAR_CPP_REGEX_SUB_MODE_H
+
21
+
22namespace pulsar {
+
+
23enum RegexSubscriptionMode
+
24{
+
28 PersistentOnly = 0,
+
29
+
33 NonPersistentOnly = 1,
+
34
+
38 AllTopics = 2
+
39};
+
+
40}
+
41
+
42#endif // PULSAR_CPP_REGEX_SUB_MODE_H
+
pulsar
Definition Authentication.h:31
+
pulsar::RegexSubscriptionMode
RegexSubscriptionMode
Definition RegexSubscriptionMode.h:24
+
pulsar::NonPersistentOnly
@ NonPersistentOnly
Definition RegexSubscriptionMode.h:33
+
pulsar::PersistentOnly
@ PersistentOnly
Definition RegexSubscriptionMode.h:28
+
pulsar::AllTopics
@ AllTopics
Definition RegexSubscriptionMode.h:38
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_result_8h_source.html b/static/api/cpp/3.5.x/_result_8h_source.html new file mode 100644 index 000000000000..b3a700b6ef35 --- /dev/null +++ b/static/api/cpp/3.5.x/_result_8h_source.html @@ -0,0 +1,223 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/Result.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
Result.h
+
+
+
1
+
19#ifndef ERROR_HPP_
+
20#define ERROR_HPP_
+
21
+
22#include <pulsar/defines.h>
+
23
+
24#include <iosfwd>
+
25
+
26namespace pulsar {
+
27
+
+
31enum Result
+
32{
+
33 ResultRetryable = -1,
+
34 ResultOk = 0,
+
35
+
36 ResultUnknownError,
+
37
+
38 ResultInvalidConfiguration,
+
39
+
40 ResultTimeout,
+
41 ResultLookupError,
+
42 ResultConnectError,
+
43 ResultReadError,
+
44
+
45 ResultAuthenticationError,
+
46 ResultAuthorizationError,
+
47 ResultErrorGettingAuthenticationData,
+
48
+
49 ResultBrokerMetadataError,
+
50 ResultBrokerPersistenceError,
+
51 ResultChecksumError,
+
52
+
53 ResultConsumerBusy,
+
54 ResultNotConnected,
+
55 ResultAlreadyClosed,
+
56
+
57 ResultInvalidMessage,
+
58
+
59 ResultConsumerNotInitialized,
+
60 ResultProducerNotInitialized,
+
61 ResultProducerBusy,
+
62 ResultTooManyLookupRequestException,
+
63
+
64 ResultInvalidTopicName,
+
65 ResultInvalidUrl,
+
66 ResultServiceUnitNotReady,
+
68 ResultOperationNotSupported,
+
69 ResultProducerBlockedQuotaExceededError,
+
70 ResultProducerBlockedQuotaExceededException,
+
71 ResultProducerQueueIsFull,
+
72 ResultMessageTooBig,
+
73 ResultTopicNotFound,
+
74 ResultSubscriptionNotFound,
+
75 ResultConsumerNotFound,
+
76 ResultUnsupportedVersionError,
+
77 ResultTopicTerminated,
+
78 ResultCryptoError,
+
79
+
80 ResultIncompatibleSchema,
+
81 ResultConsumerAssignError,
+
83 ResultCumulativeAcknowledgementNotAllowedError,
+
85 ResultTransactionCoordinatorNotFoundError,
+
86 ResultInvalidTxnStatusError,
+
87 ResultNotAllowedError,
+
88 ResultTransactionConflict,
+
89 ResultTransactionNotFound,
+
90 ResultProducerFenced,
+
91
+
92 ResultMemoryBufferIsFull,
+
93
+
94 ResultInterrupted,
+
95
+
96 ResultDisconnected,
+
97};
+
+
98
+
99// Return string representation of result code
+
100PULSAR_PUBLIC const char* strResult(Result result);
+
101
+
102PULSAR_PUBLIC std::ostream& operator<<(std::ostream& s, pulsar::Result result);
+
103} // namespace pulsar
+
104
+
105#endif /* ERROR_HPP_ */
+
pulsar
Definition Authentication.h:31
+
pulsar::Result
Result
Definition Result.h:32
+
pulsar::ResultNotConnected
@ ResultNotConnected
Exclusive consumer is already connected.
Definition Result.h:54
+
pulsar::ResultTooManyLookupRequestException
@ ResultTooManyLookupRequestException
Producer with same name is already connected.
Definition Result.h:62
+
pulsar::ResultSubscriptionNotFound
@ ResultSubscriptionNotFound
Topic not found.
Definition Result.h:74
+
pulsar::ResultOk
@ ResultOk
An internal error code used for retry.
Definition Result.h:34
+
pulsar::ResultProducerQueueIsFull
@ ResultProducerQueueIsFull
Producer is getting exception.
Definition Result.h:71
+
pulsar::ResultUnknownError
@ ResultUnknownError
Operation successful.
Definition Result.h:36
+
pulsar::ResultBrokerMetadataError
@ ResultBrokerMetadataError
Client cannot find authorization data.
Definition Result.h:49
+
pulsar::ResultDisconnected
@ ResultDisconnected
Interrupted while waiting to dequeue.
Definition Result.h:96
+
pulsar::ResultAuthenticationError
@ ResultAuthenticationError
Failed to read from socket.
Definition Result.h:45
+
pulsar::ResultProducerNotInitialized
@ ResultProducerNotInitialized
Consumer is not initialized.
Definition Result.h:60
+
pulsar::ResultCumulativeAcknowledgementNotAllowedError
@ ResultCumulativeAcknowledgementNotAllowedError
Definition Result.h:83
+
pulsar::ResultTransactionConflict
@ ResultTransactionConflict
Not allowed.
Definition Result.h:88
+
pulsar::ResultBrokerPersistenceError
@ ResultBrokerPersistenceError
Broker failed in updating metadata.
Definition Result.h:50
+
pulsar::ResultLookupError
@ ResultLookupError
Operation timed out.
Definition Result.h:41
+
pulsar::ResultMessageTooBig
@ ResultMessageTooBig
Producer queue is full.
Definition Result.h:72
+
pulsar::ResultConsumerNotInitialized
@ ResultConsumerNotInitialized
Error in publishing an already used message.
Definition Result.h:59
+
pulsar::ResultAuthorizationError
@ ResultAuthorizationError
Authentication failed on broker.
Definition Result.h:46
+
pulsar::ResultConsumerBusy
@ ResultConsumerBusy
Corrupt message checksum failure.
Definition Result.h:53
+
pulsar::ResultOperationNotSupported
@ ResultOperationNotSupported
Definition Result.h:68
+
pulsar::ResultChecksumError
@ ResultChecksumError
Broker failed to persist entry.
Definition Result.h:51
+
pulsar::ResultTopicTerminated
@ ResultTopicTerminated
Error when an older client/version doesn't support a required feature.
Definition Result.h:77
+
pulsar::ResultProducerFenced
@ ResultProducerFenced
Transaction not found.
Definition Result.h:90
+
pulsar::ResultTransactionCoordinatorNotFoundError
@ ResultTransactionCoordinatorNotFoundError
Definition Result.h:85
+
pulsar::ResultInterrupted
@ ResultInterrupted
Client-wide memory limit has been reached.
Definition Result.h:94
+
pulsar::ResultInvalidUrl
@ ResultInvalidUrl
Invalid topic name.
Definition Result.h:65
+
pulsar::ResultAlreadyClosed
@ ResultAlreadyClosed
Producer/Consumer is not currently connected to broker.
Definition Result.h:55
+
pulsar::ResultInvalidTxnStatusError
@ ResultInvalidTxnStatusError
Transaction coordinator not found.
Definition Result.h:86
+
pulsar::ResultMemoryBufferIsFull
@ ResultMemoryBufferIsFull
Producer was fenced by broker.
Definition Result.h:92
+
pulsar::ResultErrorGettingAuthenticationData
@ ResultErrorGettingAuthenticationData
Client is not authorized to create producer/consumer.
Definition Result.h:47
+
pulsar::ResultInvalidMessage
@ ResultInvalidMessage
Producer/Consumer is already closed and not accepting any operation.
Definition Result.h:57
+
pulsar::ResultUnsupportedVersionError
@ ResultUnsupportedVersionError
Consumer not found.
Definition Result.h:76
+
pulsar::ResultReadError
@ ResultReadError
Failed to connect to broker.
Definition Result.h:43
+
pulsar::ResultConnectError
@ ResultConnectError
Broker lookup failed.
Definition Result.h:42
+
pulsar::ResultProducerBlockedQuotaExceededException
@ ResultProducerBlockedQuotaExceededException
Producer is blocked.
Definition Result.h:70
+
pulsar::ResultConsumerAssignError
@ ResultConsumerAssignError
Specified schema is incompatible with the topic's schema.
Definition Result.h:81
+
pulsar::ResultCryptoError
@ ResultCryptoError
Topic was already terminated.
Definition Result.h:78
+
pulsar::ResultConsumerNotFound
@ ResultConsumerNotFound
Subscription not found.
Definition Result.h:75
+
pulsar::ResultProducerBusy
@ ResultProducerBusy
Producer is not initialized.
Definition Result.h:61
+
pulsar::ResultTopicNotFound
@ ResultTopicNotFound
Trying to send a messages exceeding the max size.
Definition Result.h:73
+
pulsar::ResultNotAllowedError
@ ResultNotAllowedError
Invalid txn status error.
Definition Result.h:87
+
pulsar::ResultInvalidConfiguration
@ ResultInvalidConfiguration
Unknown error happened on broker.
Definition Result.h:38
+
pulsar::ResultTimeout
@ ResultTimeout
Invalid configuration.
Definition Result.h:40
+
pulsar::ResultTransactionNotFound
@ ResultTransactionNotFound
Transaction ack conflict.
Definition Result.h:89
+
pulsar::ResultServiceUnitNotReady
@ ResultServiceUnitNotReady
Client Initialized with Invalid Broker Url (VIP Url passed to Client Constructor)
Definition Result.h:66
+
pulsar::ResultInvalidTopicName
@ ResultInvalidTopicName
Too Many concurrent LookupRequest.
Definition Result.h:64
+
pulsar::ResultIncompatibleSchema
@ ResultIncompatibleSchema
Error when crypto operation fails.
Definition Result.h:80
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_schema_8h_source.html b/static/api/cpp/3.5.x/_schema_8h_source.html new file mode 100644 index 000000000000..1a6f8b3f6053 --- /dev/null +++ b/static/api/cpp/3.5.x/_schema_8h_source.html @@ -0,0 +1,222 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/Schema.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
Schema.h
+
+
+
1
+
19#pragma once
+
20
+
21#include <pulsar/defines.h>
+
22
+
23#include <iosfwd>
+
24#include <map>
+
25#include <memory>
+
26#include <string>
+
27
+
28namespace pulsar {
+
29
+
+
33enum class KeyValueEncodingType
+
34{
+
38 SEPARATED,
+
39
+
43 INLINE
+
44};
+
+
45
+
46// Return string representation of result code
+
47PULSAR_PUBLIC const char *strEncodingType(pulsar::KeyValueEncodingType encodingType);
+
48
+
49PULSAR_PUBLIC KeyValueEncodingType enumEncodingType(std::string encodingTypeStr);
+
50
+
+
51enum SchemaType
+
52{
+
56 NONE = 0,
+
57
+
61 STRING = 1,
+
62
+
66 JSON = 2,
+
67
+
71 PROTOBUF = 3,
+
72
+
76 AVRO = 4,
+
77
+
81 INT8 = 6,
+
82
+
86 INT16 = 7,
+
87
+
91 INT32 = 8,
+
92
+
96 INT64 = 9,
+
97
+
101 FLOAT = 10,
+
102
+
106 DOUBLE = 11,
+
107
+
111 KEY_VALUE = 15,
+
112
+
116 PROTOBUF_NATIVE = 20,
+
117
+
121 BYTES = -1,
+
122
+
126 AUTO_CONSUME = -3,
+
127
+
131 AUTO_PUBLISH = -4,
+
132};
+
+
133
+
134// Return string representation of result code
+
135PULSAR_PUBLIC const char *strSchemaType(SchemaType schemaType);
+
136
+
137PULSAR_PUBLIC SchemaType enumSchemaType(std::string schemaTypeStr);
+
138
+
139class SchemaInfoImpl;
+
140
+
141typedef std::map<std::string, std::string> StringMap;
+
142
+
+
146class PULSAR_PUBLIC SchemaInfo {
+
147 public:
+
158 SchemaInfo();
+
159
+
166 SchemaInfo(SchemaType schemaType, const std::string &name, const std::string &schema,
+
167 const StringMap &properties = StringMap());
+
168
+
174 SchemaInfo(const SchemaInfo &keySchema, const SchemaInfo &valueSchema,
+
175 const KeyValueEncodingType &keyValueEncodingType = KeyValueEncodingType::INLINE);
+
176
+
180 SchemaType getSchemaType() const;
+
181
+
185 const std::string &getName() const;
+
186
+
190 const std::string &getSchema() const;
+
191
+
195 const StringMap &getProperties() const;
+
196
+
197 private:
+
198 typedef std::shared_ptr<SchemaInfoImpl> SchemaInfoImplPtr;
+
199 SchemaInfoImplPtr impl_;
+
200};
+
+
201
+
202} // namespace pulsar
+
203
+
204PULSAR_PUBLIC std::ostream &operator<<(std::ostream &s, pulsar::SchemaType schemaType);
+
205
+
206PULSAR_PUBLIC std::ostream &operator<<(std::ostream &s, pulsar::KeyValueEncodingType encodingType);
+
pulsar::SchemaInfo
Definition Schema.h:146
+
pulsar::SchemaInfo::getProperties
const StringMap & getProperties() const
+
pulsar::SchemaInfo::getSchemaType
SchemaType getSchemaType() const
+ +
pulsar::SchemaInfo::SchemaInfo
SchemaInfo(SchemaType schemaType, const std::string &name, const std::string &schema, const StringMap &properties=StringMap())
+
pulsar::SchemaInfo::SchemaInfo
SchemaInfo(const SchemaInfo &keySchema, const SchemaInfo &valueSchema, const KeyValueEncodingType &keyValueEncodingType=KeyValueEncodingType::INLINE)
+
pulsar::SchemaInfo::getSchema
const std::string & getSchema() const
+
pulsar::SchemaInfo::getName
const std::string & getName() const
+
pulsar
Definition Authentication.h:31
+
pulsar::KeyValueEncodingType
KeyValueEncodingType
Definition Schema.h:34
+ + +
pulsar::SchemaType
SchemaType
Definition Schema.h:52
+
pulsar::INT64
@ INT64
Definition Schema.h:96
+
pulsar::JSON
@ JSON
Definition Schema.h:66
+
pulsar::DOUBLE
@ DOUBLE
Definition Schema.h:106
+
pulsar::PROTOBUF_NATIVE
@ PROTOBUF_NATIVE
Definition Schema.h:116
+
pulsar::INT8
@ INT8
Definition Schema.h:81
+
pulsar::BYTES
@ BYTES
Definition Schema.h:121
+
pulsar::PROTOBUF
@ PROTOBUF
Definition Schema.h:71
+
pulsar::FLOAT
@ FLOAT
Definition Schema.h:101
+
pulsar::AUTO_CONSUME
@ AUTO_CONSUME
Definition Schema.h:126
+
pulsar::INT16
@ INT16
Definition Schema.h:86
+
pulsar::KEY_VALUE
@ KEY_VALUE
Definition Schema.h:111
+
pulsar::STRING
@ STRING
Definition Schema.h:61
+
pulsar::INT32
@ INT32
Definition Schema.h:91
+
pulsar::AVRO
@ AVRO
Definition Schema.h:76
+
pulsar::AUTO_PUBLISH
@ AUTO_PUBLISH
Definition Schema.h:131
+
pulsar::NONE
@ NONE
Definition Schema.h:56
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_table_view_8h_source.html b/static/api/cpp/3.5.x/_table_view_8h_source.html new file mode 100644 index 000000000000..7809b18d1951 --- /dev/null +++ b/static/api/cpp/3.5.x/_table_view_8h_source.html @@ -0,0 +1,157 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/TableView.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
TableView.h
+
+
+
1
+
19#ifndef TABEL_VIEW_HPP_
+
20#define TABEL_VIEW_HPP_
+
21
+
22#include <pulsar/Result.h>
+
23#include <pulsar/TableViewConfiguration.h>
+
24#include <pulsar/defines.h>
+
25
+
26#include <functional>
+
27#include <unordered_map>
+
28
+
29namespace pulsar {
+
30
+
31class TableViewImpl;
+
32
+
33typedef std::function<void(Result result)> ResultCallback;
+
34typedef std::function<void(const std::string& key, const std::string& value)> TableViewAction;
+
+
38class PULSAR_PUBLIC TableView {
+
39 public:
+
43 TableView();
+
44
+
69 bool retrieveValue(const std::string& key, std::string& value);
+
70
+
78 bool getValue(const std::string& key, std::string& value) const;
+
79
+
85 bool containsKey(const std::string& key) const;
+
86
+
90 std::unordered_map<std::string, std::string> snapshot();
+
91
+
95 std::size_t size() const;
+
96
+
101 void forEach(TableViewAction action);
+
102
+
107 void forEachAndListen(TableViewAction action);
+
108
+
112 void closeAsync(ResultCallback callback);
+
113
+
117 Result close();
+
118
+
119 private:
+
120 typedef std::shared_ptr<TableViewImpl> TableViewImplPtr;
+
121 TableViewImplPtr impl_;
+
122 explicit TableView(TableViewImplPtr);
+
123
+
124 friend class PulsarFriend;
+
125 friend class ClientImpl;
+
126};
+
+
127} // namespace pulsar
+
128
+
129#endif /* TABEL_VIEW_HPP_ */
+
pulsar::TableView
Definition TableView.h:38
+
pulsar::TableView::containsKey
bool containsKey(const std::string &key) const
+
pulsar::TableView::snapshot
std::unordered_map< std::string, std::string > snapshot()
+ +
pulsar::TableView::retrieveValue
bool retrieveValue(const std::string &key, std::string &value)
+
pulsar::TableView::closeAsync
void closeAsync(ResultCallback callback)
+
pulsar::TableView::getValue
bool getValue(const std::string &key, std::string &value) const
+
pulsar::TableView::forEachAndListen
void forEachAndListen(TableViewAction action)
+
pulsar::TableView::forEach
void forEach(TableViewAction action)
+ +
pulsar::TableView::size
std::size_t size() const
+
pulsar
Definition Authentication.h:31
+
pulsar::ResultCallback
std::function< void(Result result)> ResultCallback
Callback definition for non-data operation.
Definition ConsumerConfiguration.h:50
+
pulsar::Result
Result
Definition Result.h:32
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_table_view_configuration_8h_source.html b/static/api/cpp/3.5.x/_table_view_configuration_8h_source.html new file mode 100644 index 000000000000..ba5cefe061c0 --- /dev/null +++ b/static/api/cpp/3.5.x/_table_view_configuration_8h_source.html @@ -0,0 +1,115 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/TableViewConfiguration.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
TableViewConfiguration.h
+
+
+
1
+
19#ifndef PULSAR_TABLEVIEW_CONFIGURATION_H_
+
20#define PULSAR_TABLEVIEW_CONFIGURATION_H_
+
21
+
22#include <pulsar/Schema.h>
+
23#include <pulsar/defines.h>
+
24
+
25namespace pulsar {
+
26
+
+
27struct TableViewConfiguration {
+
28 // Declare the schema of the data that this table view will be accepting.
+
29 // The schema will be checked against the schema of the topic, and the
+
30 // table view creation will fail if it's not compatible.
+
31 SchemaInfo schemaInfo;
+
32 // The name of the subscription to the topic. Default value is reader-{random string}.
+
33 std::string subscriptionName;
+
34};
+
+
35} // namespace pulsar
+
36#endif /* PULSAR_TABLEVIEW_CONFIGURATION_H_ */
+
pulsar::SchemaInfo
Definition Schema.h:146
+
pulsar
Definition Authentication.h:31
+
pulsar::TableViewConfiguration
Definition TableViewConfiguration.h:27
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_topic_metadata_8h_source.html b/static/api/cpp/3.5.x/_topic_metadata_8h_source.html new file mode 100644 index 000000000000..28349fead03b --- /dev/null +++ b/static/api/cpp/3.5.x/_topic_metadata_8h_source.html @@ -0,0 +1,112 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/TopicMetadata.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
TopicMetadata.h
+
+
+
1
+
19#ifndef TOPIC_METADATA_HPP_
+
20#define TOPIC_METADATA_HPP_
+
21
+
22#include <pulsar/defines.h>
+
23
+
24namespace pulsar {
+
+
28class PULSAR_PUBLIC TopicMetadata {
+
29 public:
+
30 virtual ~TopicMetadata() {}
+
31
+
35 virtual int getNumPartitions() const = 0;
+
36};
+
+
37} // namespace pulsar
+
38
+
39#endif /* TOPIC_METADATA_HPP_ */
+
pulsar::TopicMetadata
Definition TopicMetadata.h:28
+
pulsar::TopicMetadata::getNumPartitions
virtual int getNumPartitions() const =0
+
pulsar
Definition Authentication.h:31
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_typed_message_8h_source.html b/static/api/cpp/3.5.x/_typed_message_8h_source.html new file mode 100644 index 000000000000..7ed38d9f8df9 --- /dev/null +++ b/static/api/cpp/3.5.x/_typed_message_8h_source.html @@ -0,0 +1,130 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/TypedMessage.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
TypedMessage.h
+
+
+
1
+
19#pragma once
+
20
+
21#include <pulsar/Message.h>
+
22
+
23#include <functional>
+
24
+
25namespace pulsar {
+
26
+
27template <typename T>
+
+
28class TypedMessage : public Message {
+
29 public:
+
30 using Decoder = std::function<T(const char*, std::size_t)>;
+
31
+
32 TypedMessage() = default;
+
33
+
34 TypedMessage(
+
35 const Message& message, Decoder decoder = [](const char*, std::size_t) { return T{}; })
+
36 : Message(message), decoder_(decoder) {}
+
37
+
38 T getValue() const { return decoder_(static_cast<const char*>(getData()), getLength()); }
+
39
+
40 TypedMessage& setDecoder(Decoder decoder) {
+
41 decoder_ = decoder;
+
42 return *this;
+
43 }
+
44
+
45 private:
+
46 Decoder decoder_;
+
47};
+
+
48
+
49} // namespace pulsar
+
pulsar::Message
Definition Message.h:44
+
pulsar::Message::getLength
std::size_t getLength() const
+
pulsar::Message::getData
const void * getData() const
+
pulsar::TypedMessage
Definition TypedMessage.h:28
+
pulsar
Definition Authentication.h:31
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/_typed_message_builder_8h_source.html b/static/api/cpp/3.5.x/_typed_message_builder_8h_source.html new file mode 100644 index 000000000000..9eac4aa458d7 --- /dev/null +++ b/static/api/cpp/3.5.x/_typed_message_builder_8h_source.html @@ -0,0 +1,162 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/TypedMessageBuilder.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
TypedMessageBuilder.h
+
+
+
1
+
19#pragma once
+
20
+
21#include <pulsar/MessageBuilder.h>
+
22
+
23#include <functional>
+
24
+
25namespace pulsar {
+
26
+
27template <typename T>
+
+
28class TypedMessageBuilder : public MessageBuilder {
+
29 public:
+
30 using Encoder = std::function<std::string(const T&)>;
+
31 using Validator = std::function<void(const char* data, size_t)>;
+
32
+
33 TypedMessageBuilder(
+
34 Encoder encoder, Validator validator = [](const char*, std::size_t) {})
+
35 : encoder_(encoder), validator_(validator) {}
+
36
+
37 TypedMessageBuilder& setValue(const T& value) {
+
38 setContent(encoder_(value));
+
39 if (validator_) {
+
40 validator_(data(), size());
+
41 }
+
42 return *this;
+
43 }
+
44
+
45 private:
+
46 const Encoder encoder_;
+
47 const Validator validator_;
+
48};
+
+
49
+
50template <>
+
+
51class TypedMessageBuilder<std::string> : public MessageBuilder {
+
52 public:
+
53 // The validator should throw an exception to indicate the message is corrupted.
+
54 using Validator = std::function<void(const char* data, size_t)>;
+
55
+
56 TypedMessageBuilder(Validator validator = nullptr) : validator_(validator) {}
+
57
+
58 TypedMessageBuilder& setValue(const std::string& value) {
+
59 if (validator_) {
+
60 validator_(value.data(), value.size());
+
61 }
+
62 setContent(value);
+
63 return *this;
+
64 }
+
65
+
66 TypedMessageBuilder& setValue(std::string&& value) {
+
67 if (validator_) {
+
68 validator_(value.data(), value.size());
+
69 }
+
70 setContent(std::move(value));
+
71 return *this;
+
72 }
+
73
+
74 private:
+
75 Validator validator_;
+
76};
+
+
77using BytesMessageBuilder = TypedMessageBuilder<std::string>;
+
78
+
79} // namespace pulsar
+
pulsar::MessageBuilder
Definition MessageBuilder.h:33
+
pulsar::MessageBuilder::setContent
MessageBuilder & setContent(const void *data, size_t size)
+
pulsar::TypedMessageBuilder< std::string >
Definition TypedMessageBuilder.h:51
+
pulsar::TypedMessageBuilder
Definition TypedMessageBuilder.h:28
+
pulsar
Definition Authentication.h:31
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/annotated.html b/static/api/cpp/3.5.x/annotated.html new file mode 100644 index 000000000000..0250d9377289 --- /dev/null +++ b/static/api/cpp/3.5.x/annotated.html @@ -0,0 +1,139 @@ + + + + + + + +pulsar-client-cpp: Class List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Class List
+
+
+
Here are the classes, structs, unions and interfaces with brief descriptions:
+
[detail level 12]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 ▼Npulsar
 CAuthAthenz
 CAuthBasic
 CAuthentication
 CAuthenticationDataProvider
 CAuthFactory
 CAuthOauth2
 CAuthTls
 CAuthToken
 CBatchReceivePolicy
 CBrokerConsumerStats
 CCachedToken
 CClient
 CClientConfiguration
 CConsoleLoggerFactory
 CConsumer
 CConsumerConfiguration
 CConsumerEventListener
 CConsumerInterceptor
 CCryptoKeyReader
 CDeadLetterPolicy
 CDeadLetterPolicyBuilder
 CDefaultCryptoKeyReader
 CDeprecatedException
 CEncryptionKeyInfo
 CFileLoggerFactory
 CKeySharedPolicy
 CKeyValue
 CLogger
 CLoggerFactory
 CMessage
 CMessageBatch
 CMessageBuilder
 CMessageId
 CMessageIdBuilder
 CMessageRoutingPolicy
 COauth2Flow
 COauth2TokenResult
 CProducer
 CProducerConfiguration
 CProducerInterceptor
 CReader
 CReaderConfiguration
 CSchemaInfo
 CTableView
 CTableViewConfiguration
 CTopicMetadata
 CTypedMessage
 CTypedMessageBuilder
 CTypedMessageBuilder< std::string >
 Cpulsar_consumer_batch_receive_policy_t
 Cpulsar_consumer_config_dead_letter_policy_t
 Cpulsar_logger_t
+
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/bc_s.png b/static/api/cpp/3.5.x/bc_s.png new file mode 100644 index 000000000000..224b29aa9847 Binary files /dev/null and b/static/api/cpp/3.5.x/bc_s.png differ diff --git a/static/api/cpp/3.5.x/bc_sd.png b/static/api/cpp/3.5.x/bc_sd.png new file mode 100644 index 000000000000..31ca888dc710 Binary files /dev/null and b/static/api/cpp/3.5.x/bc_sd.png differ diff --git a/static/api/cpp/3.5.x/c_2_authentication_8h_source.html b/static/api/cpp/3.5.x/c_2_authentication_8h_source.html new file mode 100644 index 000000000000..5cdfb90d6499 --- /dev/null +++ b/static/api/cpp/3.5.x/c_2_authentication_8h_source.html @@ -0,0 +1,126 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/c/authentication.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
authentication.h
+
+
+
1
+
20#pragma once
+
21
+
22#include <pulsar/defines.h>
+
23
+
24#ifdef __cplusplus
+
25extern "C" {
+
26#endif
+
27
+
28typedef struct _pulsar_authentication pulsar_authentication_t;
+
29
+
30typedef char *(*token_supplier)(void *);
+
31
+
32PULSAR_PUBLIC pulsar_authentication_t *pulsar_authentication_create(const char *dynamicLibPath,
+
33 const char *authParamsString);
+
34
+
35PULSAR_PUBLIC pulsar_authentication_t *pulsar_authentication_tls_create(const char *certificatePath,
+
36 const char *privateKeyPath);
+
37
+
38PULSAR_PUBLIC pulsar_authentication_t *pulsar_authentication_token_create(const char *token);
+
39PULSAR_PUBLIC pulsar_authentication_t *pulsar_authentication_token_create_with_supplier(
+
40 token_supplier tokenSupplier, void *ctx);
+
41
+
42PULSAR_PUBLIC pulsar_authentication_t *pulsar_authentication_basic_create(const char *username,
+
43 const char *password);
+
44
+
45PULSAR_PUBLIC pulsar_authentication_t *pulsar_authentication_athenz_create(const char *authParamsString);
+
46
+
47PULSAR_PUBLIC pulsar_authentication_t *pulsar_authentication_oauth2_create(const char *authParamsString);
+
48
+
49PULSAR_PUBLIC void pulsar_authentication_free(pulsar_authentication_t *authentication);
+
50
+
51#ifdef __cplusplus
+
52}
+
53#endif
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/c_2_client_8h_source.html b/static/api/cpp/3.5.x/c_2_client_8h_source.html new file mode 100644 index 000000000000..228c2529f282 --- /dev/null +++ b/static/api/cpp/3.5.x/c_2_client_8h_source.html @@ -0,0 +1,206 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/c/client.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
client.h
+
+
+
1
+
20#pragma once
+
21
+
22#include <pulsar/c/client_configuration.h>
+
23#include <pulsar/c/consumer.h>
+
24#include <pulsar/c/consumer_configuration.h>
+
25#include <pulsar/c/message.h>
+
26#include <pulsar/c/message_id.h>
+
27#include <pulsar/c/producer.h>
+
28#include <pulsar/c/producer_configuration.h>
+
29#include <pulsar/c/reader.h>
+
30#include <pulsar/c/reader_configuration.h>
+
31#include <pulsar/c/result.h>
+
32#include <pulsar/c/string_list.h>
+
33#include <pulsar/c/table_view.h>
+
34#include <pulsar/c/table_view_configuration.h>
+
35#include <pulsar/defines.h>
+
36
+
37#ifdef __cplusplus
+
38extern "C" {
+
39#endif
+
40
+
41typedef struct _pulsar_client pulsar_client_t;
+
42typedef struct _pulsar_producer pulsar_producer_t;
+
43typedef struct _pulsar_string_list pulsar_string_list_t;
+
44
+
45typedef struct _pulsar_client_configuration pulsar_client_configuration_t;
+
46typedef struct _pulsar_producer_configuration pulsar_producer_configuration_t;
+
47
+
48typedef void (*pulsar_create_producer_callback)(pulsar_result result, pulsar_producer_t *producer, void *ctx);
+
49
+
50typedef void (*pulsar_subscribe_callback)(pulsar_result result, pulsar_consumer_t *consumer, void *ctx);
+
51typedef void (*pulsar_reader_callback)(pulsar_result result, pulsar_reader_t *reader, void *ctx);
+
52typedef void (*pulsar_table_view_callback)(pulsar_result result, pulsar_table_view_t *tableView, void *ctx);
+
53typedef void (*pulsar_get_partitions_callback)(pulsar_result result, pulsar_string_list_t *partitions,
+
54 void *ctx);
+
55
+
56typedef void (*pulsar_close_callback)(pulsar_result result, void *ctx);
+
57
+
65PULSAR_PUBLIC pulsar_client_t *pulsar_client_create(const char *serviceUrl,
+
66 const pulsar_client_configuration_t *clientConfiguration);
+
67
+
78PULSAR_PUBLIC pulsar_result pulsar_client_create_producer(pulsar_client_t *client, const char *topic,
+
79 const pulsar_producer_configuration_t *conf,
+
80 pulsar_producer_t **producer);
+
81
+
82PULSAR_PUBLIC void pulsar_client_create_producer_async(pulsar_client_t *client, const char *topic,
+
83 const pulsar_producer_configuration_t *conf,
+
84 pulsar_create_producer_callback callback, void *ctx);
+
85
+
86PULSAR_PUBLIC pulsar_result pulsar_client_subscribe(pulsar_client_t *client, const char *topic,
+
87 const char *subscriptionName,
+
88 const pulsar_consumer_configuration_t *conf,
+
89 pulsar_consumer_t **consumer);
+
90
+
91PULSAR_PUBLIC void pulsar_client_subscribe_async(pulsar_client_t *client, const char *topic,
+
92 const char *subscriptionName,
+
93 const pulsar_consumer_configuration_t *conf,
+
94 pulsar_subscribe_callback callback, void *ctx);
+
95
+
108PULSAR_PUBLIC pulsar_result pulsar_client_subscribe_multi_topics(pulsar_client_t *client, const char **topics,
+
109 int topicsCount,
+
110 const char *subscriptionName,
+
111 const pulsar_consumer_configuration_t *conf,
+
112 pulsar_consumer_t **consumer);
+
113
+
114PULSAR_PUBLIC void pulsar_client_subscribe_multi_topics_async(pulsar_client_t *client, const char **topics,
+
115 int topicsCount, const char *subscriptionName,
+
116 const pulsar_consumer_configuration_t *conf,
+
117 pulsar_subscribe_callback callback, void *ctx);
+
118
+
130PULSAR_PUBLIC pulsar_result pulsar_client_subscribe_pattern(pulsar_client_t *client, const char *topicPattern,
+
131 const char *subscriptionName,
+
132 const pulsar_consumer_configuration_t *conf,
+
133 pulsar_consumer_t **consumer);
+
134
+
135PULSAR_PUBLIC void pulsar_client_subscribe_pattern_async(pulsar_client_t *client, const char *topicPattern,
+
136 const char *subscriptionName,
+
137 const pulsar_consumer_configuration_t *conf,
+
138 pulsar_subscribe_callback callback, void *ctx);
+
139
+
169PULSAR_PUBLIC pulsar_result pulsar_client_create_reader(pulsar_client_t *client, const char *topic,
+
170 const pulsar_message_id_t *startMessageId,
+
171 pulsar_reader_configuration_t *conf,
+
172 pulsar_reader_t **reader);
+
173
+
174PULSAR_PUBLIC void pulsar_client_create_reader_async(pulsar_client_t *client, const char *topic,
+
175 const pulsar_message_id_t *startMessageId,
+
176 pulsar_reader_configuration_t *conf,
+
177 pulsar_reader_callback callback, void *ctx);
+
209PULSAR_PUBLIC pulsar_result pulsar_client_create_table_view(pulsar_client_t *client, const char *topic,
+
210 pulsar_table_view_configuration_t *conf,
+
211 pulsar_table_view_t **c_tableView);
+
212
+
223PULSAR_PUBLIC void pulsar_client_create_table_view_async(pulsar_client_t *client, const char *topic,
+
224 pulsar_table_view_configuration_t *conf,
+
225 pulsar_table_view_callback callback, void *ctx);
+
226
+
227PULSAR_PUBLIC pulsar_result pulsar_client_get_topic_partitions(pulsar_client_t *client, const char *topic,
+
228 pulsar_string_list_t **partitions);
+
229
+
230PULSAR_PUBLIC void pulsar_client_get_topic_partitions_async(pulsar_client_t *client, const char *topic,
+
231 pulsar_get_partitions_callback callback,
+
232 void *ctx);
+
233
+
234PULSAR_PUBLIC pulsar_result pulsar_client_close(pulsar_client_t *client);
+
235
+
236PULSAR_PUBLIC void pulsar_client_close_async(pulsar_client_t *client, pulsar_close_callback callback,
+
237 void *ctx);
+
238
+
239PULSAR_PUBLIC void pulsar_client_free(pulsar_client_t *client);
+
240
+
241#ifdef __cplusplus
+
242}
+
243#endif
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/c_2_consumer_8h_source.html b/static/api/cpp/3.5.x/c_2_consumer_8h_source.html new file mode 100644 index 000000000000..58f6513c36ae --- /dev/null +++ b/static/api/cpp/3.5.x/c_2_consumer_8h_source.html @@ -0,0 +1,209 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/c/consumer.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
consumer.h
+
+
+
1
+
19#pragma once
+
20
+
21#include <pulsar/defines.h>
+
22
+
23#ifdef __cplusplus
+
24extern "C" {
+
25#endif
+
26
+
27#include <pulsar/c/message.h>
+
28#include <pulsar/c/messages.h>
+
29#include <pulsar/c/result.h>
+
30#include <stdint.h>
+
31
+
32typedef struct _pulsar_consumer pulsar_consumer_t;
+
33
+
34typedef void (*pulsar_result_callback)(pulsar_result, void *);
+
35
+
36typedef void (*pulsar_receive_callback)(pulsar_result result, pulsar_message_t *msg, void *ctx);
+
37
+
38typedef void (*pulsar_batch_receive_callback)(pulsar_result result, pulsar_messages_t *msgs, void *ctx);
+
39
+
43PULSAR_PUBLIC const char *pulsar_consumer_get_topic(pulsar_consumer_t *consumer);
+
44
+
48PULSAR_PUBLIC const char *pulsar_consumer_get_subscription_name(pulsar_consumer_t *consumer);
+
49
+
63PULSAR_PUBLIC pulsar_result pulsar_consumer_unsubscribe(pulsar_consumer_t *consumer);
+
64
+
76PULSAR_PUBLIC void pulsar_consumer_unsubscribe_async(pulsar_consumer_t *consumer,
+
77 pulsar_result_callback callback, void *ctx);
+
78
+
89PULSAR_PUBLIC pulsar_result pulsar_consumer_receive(pulsar_consumer_t *consumer, pulsar_message_t **msg);
+
90
+
99PULSAR_PUBLIC pulsar_result pulsar_consumer_receive_with_timeout(pulsar_consumer_t *consumer,
+
100 pulsar_message_t **msg, int timeoutMs);
+
101
+
110PULSAR_PUBLIC void pulsar_consumer_receive_async(pulsar_consumer_t *consumer,
+
111 pulsar_receive_callback callback, void *ctx);
+
112
+
121PULSAR_PUBLIC pulsar_result pulsar_consumer_batch_receive(pulsar_consumer_t *consumer,
+
122 pulsar_messages_t **msgs);
+
123
+
132PULSAR_PUBLIC void pulsar_consumer_batch_receive_async(pulsar_consumer_t *consumer,
+
133 pulsar_batch_receive_callback callback, void *ctx);
+
134
+
146PULSAR_PUBLIC pulsar_result pulsar_consumer_acknowledge(pulsar_consumer_t *consumer,
+
147 pulsar_message_t *message);
+
148
+
149PULSAR_PUBLIC pulsar_result pulsar_consumer_acknowledge_id(pulsar_consumer_t *consumer,
+
150 pulsar_message_id_t *messageId);
+
151
+
161PULSAR_PUBLIC void pulsar_consumer_acknowledge_async(pulsar_consumer_t *consumer, pulsar_message_t *message,
+
162 pulsar_result_callback callback, void *ctx);
+
163
+
164PULSAR_PUBLIC void pulsar_consumer_acknowledge_async_id(pulsar_consumer_t *consumer,
+
165 pulsar_message_id_t *messageId,
+
166 pulsar_result_callback callback, void *ctx);
+
167
+
185PULSAR_PUBLIC pulsar_result pulsar_consumer_acknowledge_cumulative(pulsar_consumer_t *consumer,
+
186 pulsar_message_t *message);
+
187
+
188PULSAR_PUBLIC pulsar_result pulsar_consumer_acknowledge_cumulative_id(pulsar_consumer_t *consumer,
+
189 pulsar_message_id_t *messageId);
+
190
+
201PULSAR_PUBLIC void pulsar_consumer_acknowledge_cumulative_async(pulsar_consumer_t *consumer,
+
202 pulsar_message_t *message,
+
203 pulsar_result_callback callback, void *ctx);
+
204
+
205PULSAR_PUBLIC void pulsar_consumer_acknowledge_cumulative_async_id(pulsar_consumer_t *consumer,
+
206 pulsar_message_id_t *messageId,
+
207 pulsar_result_callback callback,
+
208 void *ctx);
+
209
+
222PULSAR_PUBLIC void pulsar_consumer_negative_acknowledge(pulsar_consumer_t *consumer,
+
223 pulsar_message_t *message);
+
224
+
237PULSAR_PUBLIC void pulsar_consumer_negative_acknowledge_id(pulsar_consumer_t *consumer,
+
238 pulsar_message_id_t *messageId);
+
239
+
240PULSAR_PUBLIC pulsar_result pulsar_consumer_close(pulsar_consumer_t *consumer);
+
241
+
242PULSAR_PUBLIC void pulsar_consumer_close_async(pulsar_consumer_t *consumer, pulsar_result_callback callback,
+
243 void *ctx);
+
244
+
245PULSAR_PUBLIC void pulsar_consumer_free(pulsar_consumer_t *consumer);
+
246
+
247/*
+
248 * Pause receiving messages via the messageListener, till resumeMessageListener() is called.
+
249 */
+
250PULSAR_PUBLIC pulsar_result pulsar_consumer_pause_message_listener(pulsar_consumer_t *consumer);
+
251
+
252/*
+
253 * Resume receiving the messages via the messageListener.
+
254 * Asynchronously receive all the messages enqueued from time pauseMessageListener() was called.
+
255 */
+
256PULSAR_PUBLIC pulsar_result resume_message_listener(pulsar_consumer_t *consumer);
+
257
+
267PULSAR_PUBLIC void pulsar_consumer_redeliver_unacknowledged_messages(pulsar_consumer_t *consumer);
+
268
+
278PULSAR_PUBLIC void pulsar_consumer_seek_async(pulsar_consumer_t *consumer, pulsar_message_id_t *messageId,
+
279 pulsar_result_callback callback, void *ctx);
+
280
+
289PULSAR_PUBLIC pulsar_result pulsar_consumer_seek(pulsar_consumer_t *consumer, pulsar_message_id_t *messageId);
+
290
+
300PULSAR_PUBLIC void pulsar_consumer_seek_by_timestamp_async(pulsar_consumer_t *consumer, uint64_t timestamp,
+
301 pulsar_result_callback callback, void *ctx);
+
302
+
311PULSAR_PUBLIC pulsar_result pulsar_consumer_seek_by_timestamp(pulsar_consumer_t *consumer,
+
312 uint64_t timestamp);
+
313
+
314PULSAR_PUBLIC int pulsar_consumer_is_connected(pulsar_consumer_t *consumer);
+
315
+
316PULSAR_PUBLIC pulsar_result pulsar_consumer_get_last_message_id(pulsar_consumer_t *consumer,
+
317 pulsar_message_id_t *messageId);
+
318
+
319#ifdef __cplusplus
+
320}
+
321#endif
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/c_2_message_8h_source.html b/static/api/cpp/3.5.x/c_2_message_8h_source.html new file mode 100644 index 000000000000..70b11ef2ac27 --- /dev/null +++ b/static/api/cpp/3.5.x/c_2_message_8h_source.html @@ -0,0 +1,172 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/c/message.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
message.h
+
+
+
1
+
20#pragma once
+
21
+
22#ifdef __cplusplus
+
23extern "C" {
+
24#endif
+
25
+
26#include <pulsar/defines.h>
+
27#include <stddef.h>
+
28#include <stdint.h>
+
29
+
30#include "string_map.h"
+
31
+
32typedef struct _pulsar_message pulsar_message_t;
+
33typedef struct _pulsar_message_id pulsar_message_id_t;
+
34
+
35PULSAR_PUBLIC pulsar_message_t *pulsar_message_create();
+
44PULSAR_PUBLIC void pulsar_message_copy(const pulsar_message_t *from, pulsar_message_t *to);
+
45PULSAR_PUBLIC void pulsar_message_free(pulsar_message_t *message);
+
46
+
48
+
49PULSAR_PUBLIC void pulsar_message_set_content(pulsar_message_t *message, const void *data, size_t size);
+
50
+
56PULSAR_PUBLIC void pulsar_message_set_allocated_content(pulsar_message_t *message, void *data, size_t size);
+
57
+
58PULSAR_PUBLIC void pulsar_message_set_property(pulsar_message_t *message, const char *name,
+
59 const char *value);
+
60
+
65PULSAR_PUBLIC void pulsar_message_set_partition_key(pulsar_message_t *message, const char *partitionKey);
+
66
+
71PULSAR_PUBLIC void pulsar_message_set_ordering_key(pulsar_message_t *message, const char *orderingKey);
+
72
+
76PULSAR_PUBLIC void pulsar_message_set_event_timestamp(pulsar_message_t *message, uint64_t eventTimestamp);
+
77
+
93PULSAR_PUBLIC void pulsar_message_set_sequence_id(pulsar_message_t *message, int64_t sequenceId);
+
94
+
100PULSAR_PUBLIC void pulsar_message_set_deliver_after(pulsar_message_t *message, uint64_t delayMillis);
+
101
+
108PULSAR_PUBLIC void pulsar_message_set_deliver_at(pulsar_message_t *message, uint64_t deliveryTimestampMillis);
+
109
+
120PULSAR_PUBLIC void pulsar_message_set_replication_clusters(pulsar_message_t *message, const char **clusters,
+
121 size_t size);
+
122
+
128PULSAR_PUBLIC void pulsar_message_disable_replication(pulsar_message_t *message, int flag);
+
129
+
131
+
138PULSAR_PUBLIC pulsar_string_map_t *pulsar_message_get_properties(pulsar_message_t *message);
+
139
+
147PULSAR_PUBLIC int pulsar_message_has_property(pulsar_message_t *message, const char *name);
+
148
+
155PULSAR_PUBLIC const char *pulsar_message_get_property(pulsar_message_t *message, const char *name);
+
156
+
163PULSAR_PUBLIC const void *pulsar_message_get_data(pulsar_message_t *message);
+
164
+
170PULSAR_PUBLIC uint32_t pulsar_message_get_length(pulsar_message_t *message);
+
171
+
181PULSAR_PUBLIC pulsar_message_id_t *pulsar_message_get_message_id(pulsar_message_t *message);
+
182
+
187PULSAR_PUBLIC const char *pulsar_message_get_partitionKey(pulsar_message_t *message);
+
188PULSAR_PUBLIC int pulsar_message_has_partition_key(pulsar_message_t *message);
+
189
+
194PULSAR_PUBLIC const char *pulsar_message_get_orderingKey(pulsar_message_t *message);
+
195PULSAR_PUBLIC int pulsar_message_has_ordering_key(pulsar_message_t *message);
+
196
+
201PULSAR_PUBLIC uint64_t pulsar_message_get_publish_timestamp(pulsar_message_t *message);
+
202
+
206PULSAR_PUBLIC uint64_t pulsar_message_get_event_timestamp(pulsar_message_t *message);
+
207
+
208PULSAR_PUBLIC const char *pulsar_message_get_topic_name(pulsar_message_t *message);
+
209
+
210PULSAR_PUBLIC int pulsar_message_get_redelivery_count(pulsar_message_t *message);
+
211
+
212PULSAR_PUBLIC int pulsar_message_has_schema_version(pulsar_message_t *message);
+
213
+
214PULSAR_PUBLIC const char *pulsar_message_get_schemaVersion(pulsar_message_t *message);
+
215
+
216PULSAR_PUBLIC void pulsar_message_set_schema_version(pulsar_message_t *message, const char *schemaVersion);
+
217
+
218#ifdef __cplusplus
+
219}
+
220#endif
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/c_2_producer_8h_source.html b/static/api/cpp/3.5.x/c_2_producer_8h_source.html new file mode 100644 index 000000000000..ab4345cd71f2 --- /dev/null +++ b/static/api/cpp/3.5.x/c_2_producer_8h_source.html @@ -0,0 +1,138 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/c/producer.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
producer.h
+
+
+
1
+
20#pragma once
+
21
+
22#ifdef __cplusplus
+
23extern "C" {
+
24#endif
+
25
+
26#include <pulsar/c/message.h>
+
27#include <pulsar/c/result.h>
+
28#include <pulsar/defines.h>
+
29#include <stdint.h>
+
30
+
31typedef struct _pulsar_producer pulsar_producer_t;
+
32
+
33typedef void (*pulsar_send_callback)(pulsar_result, pulsar_message_id_t *msgId, void *ctx);
+
34typedef void (*pulsar_close_callback)(pulsar_result, void *ctx);
+
35typedef void (*pulsar_flush_callback)(pulsar_result, void *ctx);
+
36
+
40PULSAR_PUBLIC const char *pulsar_producer_get_topic(pulsar_producer_t *producer);
+
41
+
45PULSAR_PUBLIC const char *pulsar_producer_get_producer_name(pulsar_producer_t *producer);
+
46
+
63PULSAR_PUBLIC pulsar_result pulsar_producer_send(pulsar_producer_t *producer, pulsar_message_t *msg);
+
64
+
79PULSAR_PUBLIC void pulsar_producer_send_async(pulsar_producer_t *producer, pulsar_message_t *msg,
+
80 pulsar_send_callback callback, void *ctx);
+
81
+
94PULSAR_PUBLIC int64_t pulsar_producer_get_last_sequence_id(pulsar_producer_t *producer);
+
95
+
105PULSAR_PUBLIC pulsar_result pulsar_producer_close(pulsar_producer_t *producer);
+
106
+
114PULSAR_PUBLIC void pulsar_producer_close_async(pulsar_producer_t *producer, pulsar_close_callback callback,
+
115 void *ctx);
+
116
+
117// Flush all the messages buffered in the client and wait until all messages have been successfully persisted.
+
118PULSAR_PUBLIC pulsar_result pulsar_producer_flush(pulsar_producer_t *producer);
+
119
+
120PULSAR_PUBLIC void pulsar_producer_flush_async(pulsar_producer_t *producer, pulsar_flush_callback callback,
+
121 void *ctx);
+
122
+
123PULSAR_PUBLIC void pulsar_producer_free(pulsar_producer_t *producer);
+
124
+
125PULSAR_PUBLIC int pulsar_producer_is_connected(pulsar_producer_t *producer);
+
126
+
127#ifdef __cplusplus
+
128}
+
129#endif
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/c_2_reader_8h_source.html b/static/api/cpp/3.5.x/c_2_reader_8h_source.html new file mode 100644 index 000000000000..2fdccfae8eb4 --- /dev/null +++ b/static/api/cpp/3.5.x/c_2_reader_8h_source.html @@ -0,0 +1,137 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/c/reader.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
reader.h
+
+
+
1
+
19#pragma once
+
20
+
21#include <pulsar/c/message.h>
+
22#include <pulsar/c/result.h>
+
23#include <pulsar/defines.h>
+
24
+
25#ifdef __cplusplus
+
26extern "C" {
+
27#endif
+
28
+
29typedef struct _pulsar_reader pulsar_reader_t;
+
30
+
31typedef void (*pulsar_result_callback)(pulsar_result, void *);
+
32
+
36PULSAR_PUBLIC const char *pulsar_reader_get_topic(pulsar_reader_t *reader);
+
37
+
48PULSAR_PUBLIC pulsar_result pulsar_reader_read_next(pulsar_reader_t *reader, pulsar_message_t **msg);
+
49
+
59PULSAR_PUBLIC pulsar_result pulsar_reader_read_next_with_timeout(pulsar_reader_t *reader,
+
60 pulsar_message_t **msg, int timeoutMs);
+
61
+
71PULSAR_PUBLIC void pulsar_reader_seek_async(pulsar_reader_t *reader, pulsar_message_id_t *messageId,
+
72 pulsar_result_callback callback, void *ctx);
+
73
+
82PULSAR_PUBLIC pulsar_result pulsar_reader_seek(pulsar_reader_t *reader, pulsar_message_id_t *messageId);
+
83
+
93PULSAR_PUBLIC void pulsar_reader_seek_by_timestamp_async(pulsar_reader_t *reader, uint64_t timestamp,
+
94 pulsar_result_callback callback, void *ctx);
+
95
+
104PULSAR_PUBLIC pulsar_result pulsar_reader_seek_by_timestamp(pulsar_reader_t *reader, uint64_t timestamp);
+
105
+
106PULSAR_PUBLIC pulsar_result pulsar_reader_close(pulsar_reader_t *reader);
+
107
+
108PULSAR_PUBLIC void pulsar_reader_close_async(pulsar_reader_t *reader, pulsar_result_callback callback,
+
109 void *ctx);
+
110
+
111PULSAR_PUBLIC void pulsar_reader_free(pulsar_reader_t *reader);
+
112
+
113PULSAR_PUBLIC pulsar_result pulsar_reader_has_message_available(pulsar_reader_t *reader, int *available);
+
114
+
115PULSAR_PUBLIC int pulsar_reader_is_connected(pulsar_reader_t *reader);
+
116
+
117#ifdef __cplusplus
+
118}
+
119#endif
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/c_2_result_8h_source.html b/static/api/cpp/3.5.x/c_2_result_8h_source.html new file mode 100644 index 000000000000..864acfe5d20d --- /dev/null +++ b/static/api/cpp/3.5.x/c_2_result_8h_source.html @@ -0,0 +1,167 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/c/result.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
result.h
+
+
+
1
+
20#pragma once
+
21
+
22#include <pulsar/defines.h>
+
23
+
24#ifdef __cplusplus
+
25extern "C" {
+
26#endif
+
27
+
28typedef enum
+
29{
+
30 pulsar_result_Ok,
+
31
+
32 pulsar_result_UnknownError,
+
33
+
34 pulsar_result_InvalidConfiguration,
+
35
+
36 pulsar_result_Timeout,
+
37 pulsar_result_LookupError,
+
38 pulsar_result_ConnectError,
+
39 pulsar_result_ReadError,
+
40
+
41 pulsar_result_AuthenticationError,
+
42 pulsar_result_AuthorizationError,
+
43 pulsar_result_ErrorGettingAuthenticationData,
+
44
+
45 pulsar_result_BrokerMetadataError,
+
46 pulsar_result_BrokerPersistenceError,
+
47 pulsar_result_ChecksumError,
+
48
+
49 pulsar_result_ConsumerBusy,
+
50 pulsar_result_NotConnected,
+
51 pulsar_result_AlreadyClosed,
+
52
+
53 pulsar_result_InvalidMessage,
+
54
+
55 pulsar_result_ConsumerNotInitialized,
+
56 pulsar_result_ProducerNotInitialized,
+
57 pulsar_result_ProducerBusy,
+
58 pulsar_result_TooManyLookupRequestException,
+
59
+
60 pulsar_result_InvalidTopicName,
+
61 pulsar_result_InvalidUrl,
+
63 pulsar_result_ServiceUnitNotReady,
+
66 pulsar_result_OperationNotSupported,
+
67 pulsar_result_ProducerBlockedQuotaExceededError,
+
68 pulsar_result_ProducerBlockedQuotaExceededException,
+
69 pulsar_result_ProducerQueueIsFull,
+
70 pulsar_result_MessageTooBig,
+
71 pulsar_result_TopicNotFound,
+
72 pulsar_result_SubscriptionNotFound,
+
73 pulsar_result_ConsumerNotFound,
+
74 pulsar_result_UnsupportedVersionError,
+
76 pulsar_result_TopicTerminated,
+
77 pulsar_result_CryptoError,
+
78
+
79 pulsar_result_IncompatibleSchema,
+
80 pulsar_result_ConsumerAssignError,
+
83 pulsar_result_CumulativeAcknowledgementNotAllowedError,
+
86 pulsar_result_TransactionCoordinatorNotFoundError,
+
87 pulsar_result_InvalidTxnStatusError,
+
88 pulsar_result_NotAllowedError,
+
89 pulsar_result_TransactionConflict,
+
90 pulsar_result_TransactionNotFound,
+
91 pulsar_result_ProducerFenced,
+
92
+
93 pulsar_result_MemoryBufferIsFull,
+
94 pulsar_result_Interrupted,
+
95} pulsar_result;
+
96
+
97// Return string representation of result code
+
98PULSAR_PUBLIC const char *pulsar_result_str(pulsar_result result);
+
99
+
100#ifdef __cplusplus
+
101}
+
102#endif
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classes.html b/static/api/cpp/3.5.x/classes.html new file mode 100644 index 000000000000..7dd17680facb --- /dev/null +++ b/static/api/cpp/3.5.x/classes.html @@ -0,0 +1,127 @@ + + + + + + + +pulsar-client-cpp: Class Index + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Class Index
+
+
+
A | B | C | D | E | F | K | L | M | O | P | R | S | T
+
+
+
A
+
AuthAthenz (pulsar)
AuthBasic (pulsar)
Authentication (pulsar)
AuthenticationDataProvider (pulsar)
AuthFactory (pulsar)
AuthOauth2 (pulsar)
AuthTls (pulsar)
AuthToken (pulsar)
+
+
B
+
BatchReceivePolicy (pulsar)
BrokerConsumerStats (pulsar)
+
+
C
+
CachedToken (pulsar)
Client (pulsar)
ClientConfiguration (pulsar)
ConsoleLoggerFactory (pulsar)
Consumer (pulsar)
ConsumerConfiguration (pulsar)
ConsumerEventListener (pulsar)
ConsumerInterceptor (pulsar)
CryptoKeyReader (pulsar)
+
+
D
+
DeadLetterPolicy (pulsar)
DeadLetterPolicyBuilder (pulsar)
DefaultCryptoKeyReader (pulsar)
DeprecatedException (pulsar)
+
+
E
+
EncryptionKeyInfo (pulsar)
+
+
F
+
FileLoggerFactory (pulsar)
+
+
K
+
KeySharedPolicy (pulsar)
KeyValue (pulsar)
+
+
L
+
Logger (pulsar)
LoggerFactory (pulsar)
+
+
M
+
Message (pulsar)
MessageBatch (pulsar)
MessageBuilder (pulsar)
MessageId (pulsar)
MessageIdBuilder (pulsar)
MessageRoutingPolicy (pulsar)
+
+
O
+
Oauth2Flow (pulsar)
Oauth2TokenResult (pulsar)
+
+
P
+
Producer (pulsar)
ProducerConfiguration (pulsar)
ProducerInterceptor (pulsar)
pulsar_consumer_batch_receive_policy_t
pulsar_consumer_config_dead_letter_policy_t
pulsar_logger_t
+
+
R
+
Reader (pulsar)
ReaderConfiguration (pulsar)
+
+
S
+
SchemaInfo (pulsar)
+
+
T
+
TableView (pulsar)
TableViewConfiguration (pulsar)
TopicMetadata (pulsar)
TypedMessage (pulsar)
TypedMessageBuilder (pulsar)
TypedMessageBuilder< std::string > (pulsar)
+
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_auth_athenz-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_auth_athenz-members.html new file mode 100644 index 000000000000..61377a887773 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_auth_athenz-members.html @@ -0,0 +1,99 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::AuthAthenz Member List
+
+
+ +

This is the complete list of members for pulsar::AuthAthenz, including all inherited members.

+ + + + + + + + + + + +
AuthAthenz(AuthenticationDataPtr &) (defined in pulsar::AuthAthenz)pulsar::AuthAthenz
authData_ (defined in pulsar::Authentication)pulsar::Authenticationprotected
Authentication() (defined in pulsar::Authentication)pulsar::Authenticationprotected
create(ParamMap &params)pulsar::AuthAthenzstatic
create(const std::string &authParamsString)pulsar::AuthAthenzstatic
getAuthData(AuthenticationDataPtr &authDataAthenz)pulsar::AuthAthenzvirtual
getAuthMethodName() constpulsar::AuthAthenzvirtual
parseDefaultFormatAuthParams(const std::string &authParamsString)pulsar::Authenticationstatic
~AuthAthenz() (defined in pulsar::AuthAthenz)pulsar::AuthAthenz
~Authentication() (defined in pulsar::Authentication)pulsar::Authenticationvirtual
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_auth_athenz.html b/static/api/cpp/3.5.x/classpulsar_1_1_auth_athenz.html new file mode 100644 index 000000000000..e4579d1a4d0b --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_auth_athenz.html @@ -0,0 +1,262 @@ + + + + + + + +pulsar-client-cpp: pulsar::AuthAthenz Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +Static Public Member Functions | +List of all members
+
pulsar::AuthAthenz Class Reference
+
+
+ +

#include <Authentication.h>

+
+Inheritance diagram for pulsar::AuthAthenz:
+
+
+ + +pulsar::Authentication + +
+ + + + + + + + +

+Public Member Functions

+ AuthAthenz (AuthenticationDataPtr &)
 
const std::string getAuthMethodName () const
 
Result getAuthData (AuthenticationDataPtr &authDataAthenz)
 
+ + + + + + + + +

+Static Public Member Functions

static AuthenticationPtr create (ParamMap &params)
 
static AuthenticationPtr create (const std::string &authParamsString)
 
- Static Public Member Functions inherited from pulsar::Authentication
static ParamMap parseDefaultFormatAuthParams (const std::string &authParamsString)
 
+ + + + +

+Additional Inherited Members

- Protected Attributes inherited from pulsar::Authentication
+AuthenticationDataPtr authData_
 
+

Detailed Description

+

Athenz implementation of Pulsar client authentication

+

Member Function Documentation

+ +

◆ create() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + +
static AuthenticationPtr pulsar::AuthAthenz::create (const std::string & authParamsString)
+ 		+static
+
+

Create an AuthAthenz with an authentication parameter string

+
See also
Authentication::parseDefaultFormatAuthParams
+ +
+
+ +

◆ create() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + +
static AuthenticationPtr pulsar::AuthAthenz::create (ParamMap & params)
+ 		+static
+
+

Create an AuthAthenz with a ParamMap

+

The required parameter keys are “tenantDomain”, “tenantService”, “providerDomain”, “privateKey”, and “ztsUrl”

+
Parameters
+ + +
paramsthe key-value to construct ZTS client
+
+
+
See also
http://pulsar.apache.org/docs/en/security-athenz/
+ +
+
+ +

◆ getAuthData()

+ +
+
+ + + + + +
+ + + + + + + + +
Result pulsar::AuthAthenz::getAuthData (AuthenticationDataPtr & authDataAthenz)
+ 		+virtual
+
+

Get AuthenticationData from the current instance

+
Parameters
+ + +
[out]authDataAthenzthe shared pointer of AuthenticationData. The content of AuthenticationData is changed to the internal data of the current instance.
+
+
+
Returns
ResultOk
+ +

Reimplemented from pulsar::Authentication.

+ +
+
+ +

◆ getAuthMethodName()

+ +
+
+ + + + + +
+ + + + + + + +
const std::string pulsar::AuthAthenz::getAuthMethodName () const
+ 		+virtual
+
+
Returns
“athenz”
+ +

Implements pulsar::Authentication.

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_auth_athenz.png b/static/api/cpp/3.5.x/classpulsar_1_1_auth_athenz.png new file mode 100644 index 000000000000..78bae3fc3543 Binary files /dev/null and b/static/api/cpp/3.5.x/classpulsar_1_1_auth_athenz.png differ diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_auth_basic-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_auth_basic-members.html new file mode 100644 index 000000000000..ea4ea0328a57 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_auth_basic-members.html @@ -0,0 +1,101 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::AuthBasic Member List
+
+
+ +

This is the complete list of members for pulsar::AuthBasic, including all inherited members.

+ + + + + + + + + + + + + +
AuthBasic(AuthenticationDataPtr &) (defined in pulsar::AuthBasic)pulsar::AuthBasicexplicit
authData_ (defined in pulsar::Authentication)pulsar::Authenticationprotected
Authentication() (defined in pulsar::Authentication)pulsar::Authenticationprotected
create(ParamMap &params)pulsar::AuthBasicstatic
create(const std::string &authParamsString)pulsar::AuthBasicstatic
create(const std::string &username, const std::string &password)pulsar::AuthBasicstatic
create(const std::string &username, const std::string &password, const std::string &method)pulsar::AuthBasicstatic
getAuthData(AuthenticationDataPtr &authDataBasic) overridepulsar::AuthBasicvirtual
getAuthMethodName() const overridepulsar::AuthBasicvirtual
parseDefaultFormatAuthParams(const std::string &authParamsString)pulsar::Authenticationstatic
~AuthBasic() override (defined in pulsar::AuthBasic)pulsar::AuthBasic
~Authentication() (defined in pulsar::Authentication)pulsar::Authenticationvirtual
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_auth_basic.html b/static/api/cpp/3.5.x/classpulsar_1_1_auth_basic.html new file mode 100644 index 000000000000..ab4718d1174b --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_auth_basic.html @@ -0,0 +1,344 @@ + + + + + + + +pulsar-client-cpp: pulsar::AuthBasic Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +Static Public Member Functions | +List of all members
+
pulsar::AuthBasic Class Reference
+
+
+ +

#include <Authentication.h>

+
+Inheritance diagram for pulsar::AuthBasic:
+
+
+ + +pulsar::Authentication + +
+ + + + + + + + +

+Public Member Functions

+ AuthBasic (AuthenticationDataPtr &)
 
const std::string getAuthMethodName () const override
 
Result getAuthData (AuthenticationDataPtr &authDataBasic) override
 
+ + + + + + + + + + + + +

+Static Public Member Functions

static AuthenticationPtr create (ParamMap &params)
 
static AuthenticationPtr create (const std::string &authParamsString)
 
static AuthenticationPtr create (const std::string &username, const std::string &password)
 
static AuthenticationPtr create (const std::string &username, const std::string &password, const std::string &method)
 
- Static Public Member Functions inherited from pulsar::Authentication
static ParamMap parseDefaultFormatAuthParams (const std::string &authParamsString)
 
+ + + + +

+Additional Inherited Members

- Protected Attributes inherited from pulsar::Authentication
+AuthenticationDataPtr authData_
 
+

Detailed Description

+

Basic based implementation of Pulsar client authentication

+

Member Function Documentation

+ +

◆ create() [1/4]

+ +
+
+ + + + + +
+ + + + + + + + +
static AuthenticationPtr pulsar::AuthBasic::create (const std::string & authParamsString)
+ 		+static
+
+

Create an AuthBasic with an authentication parameter string

+
Parameters
+ + +
authParamsStringthe JSON format string: {"username": "admin", "password": "123456"}
+
+
+ +
+
+ +

◆ create() [2/4]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
static AuthenticationPtr pulsar::AuthBasic::create (const std::string & username,
const std::string & password 
)
+ 		+static
+
+

Create an AuthBasic with the required parameters

+ +
+
+ +

◆ create() [3/4]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
static AuthenticationPtr pulsar::AuthBasic::create (const std::string & username,
const std::string & password,
const std::string & method 
)
+ 		+static
+
+

Create an AuthBasic with the required parameters

+ +
+
+ +

◆ create() [4/4]

+ +
+
+ + + + + +
+ + + + + + + + +
static AuthenticationPtr pulsar::AuthBasic::create (ParamMap & params)
+ 		+static
+
+

Create an AuthBasic with a ParamMap

+

It is equal to create(params[“username”], params[“password”])

See also
create(const std::string&, const std::string&)
+ +
+
+ +

◆ getAuthData()

+ +
+
+ + + + + +
+ + + + + + + + +
Result pulsar::AuthBasic::getAuthData (AuthenticationDataPtr & authDataBasic)
+ 		+overridevirtual
+
+

Get AuthenticationData from the current instance

+
Parameters
+ + +
[out]authDataBasicthe shared pointer of AuthenticationData. The content of AuthenticationData is changed to the internal data of the current instance.
+
+
+
Returns
ResultOk
+ +

Reimplemented from pulsar::Authentication.

+ +
+
+ +

◆ getAuthMethodName()

+ +
+
+ + + + + +
+ + + + + + + +
const std::string pulsar::AuthBasic::getAuthMethodName () const
+ 		+overridevirtual
+
+
Returns
“basic”
+ +

Implements pulsar::Authentication.

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_auth_basic.png b/static/api/cpp/3.5.x/classpulsar_1_1_auth_basic.png new file mode 100644 index 000000000000..ef930f966ea4 Binary files /dev/null and b/static/api/cpp/3.5.x/classpulsar_1_1_auth_basic.png differ diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_auth_factory-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_auth_factory-members.html new file mode 100644 index 000000000000..4799fda2e7d3 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_auth_factory-members.html @@ -0,0 +1,96 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::AuthFactory Member List
+
+
+ +

This is the complete list of members for pulsar::AuthFactory, including all inherited members.

+ + + + + + + + +
create(const std::string &pluginNameOrDynamicLibPath)pulsar::AuthFactorystatic
create(const std::string &pluginNameOrDynamicLibPath, const std::string &authParamsString)pulsar::AuthFactorystatic
create(const std::string &pluginNameOrDynamicLibPath, ParamMap &params)pulsar::AuthFactorystatic
Disabled() (defined in pulsar::AuthFactory)pulsar::AuthFactorystatic
isShutdownHookRegistered_ (defined in pulsar::AuthFactory)pulsar::AuthFactoryprotectedstatic
loadedLibrariesHandles_ (defined in pulsar::AuthFactory)pulsar::AuthFactoryprotectedstatic
release_handles() (defined in pulsar::AuthFactory)pulsar::AuthFactoryprotectedstatic
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_auth_factory.html b/static/api/cpp/3.5.x/classpulsar_1_1_auth_factory.html new file mode 100644 index 000000000000..8903d1519adc --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_auth_factory.html @@ -0,0 +1,246 @@ + + + + + + + +pulsar-client-cpp: pulsar::AuthFactory Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Static Public Member Functions | +Static Protected Member Functions | +Static Protected Attributes | +List of all members
+
pulsar::AuthFactory Class Reference
+
+
+ +

#include <Authentication.h>

+ + + + + + + + + + +

+Static Public Member Functions

+static AuthenticationPtr Disabled ()
 
static AuthenticationPtr create (const std::string &pluginNameOrDynamicLibPath)
 
static AuthenticationPtr create (const std::string &pluginNameOrDynamicLibPath, const std::string &authParamsString)
 
static AuthenticationPtr create (const std::string &pluginNameOrDynamicLibPath, ParamMap &params)
 
+ + + +

+Static Protected Member Functions

+static void release_handles ()
 
+ + + + + +

+Static Protected Attributes

+static bool isShutdownHookRegistered_
 
+static std::vector< void * > loadedLibrariesHandles_
 
+

Detailed Description

+

AuthFactory is used to create instances of Authentication class when configuring a Client instance. It loads the authentication from an external plugin.

+

To use authentication methods that are internally supported, you should use AuthTls::create("my-cert.pem", "my-private.key") or similar.

+

Member Function Documentation

+ +

◆ create() [1/3]

+ +
+
+ + + + + +
+ + + + + + + + +
static AuthenticationPtr pulsar::AuthFactory::create (const std::string & pluginNameOrDynamicLibPath)
+ 		+static
+
+

Create an AuthenticationPtr with an empty ParamMap

+
See also
create(const std::string&, const ParamMap&)
+ +
+
+ +

◆ create() [2/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
static AuthenticationPtr pulsar::AuthFactory::create (const std::string & pluginNameOrDynamicLibPath,
const std::string & authParamsString 
)
+ 		+static
+
+

Create an AuthenticationPtr with a ParamMap that is converted from authParamsString

+
See also
Authentication::parseDefaultFormatAuthParams
+
+create(const std::string&, const ParamMap&)
+ +
+
+ +

◆ create() [3/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
static AuthenticationPtr pulsar::AuthFactory::create (const std::string & pluginNameOrDynamicLibPath,
ParamMap & params 
)
+ 		+static
+
+

Create an AuthenticationPtr

+

When the first parameter represents the plugin name, the type of authentication can be one of the following:

    +
  • AuthTls (if the plugin name is “tls”)
    • +
  • AuthToken (if the plugin name is “token” or “org.apache.pulsar.client.impl.auth.AuthenticationToken”)
    • +
  • AuthAthenz (if the plugin name is “athenz” or “org.apache.pulsar.client.impl.auth.AuthenticationAthenz”)
    • +
  • AuthOauth2 (if the plugin name is “oauth2token” or “org.apache.pulsar.client.impl.auth.oauth2.AuthenticationOAuth2”)
    • +
+
Parameters
+ + + +
pluginNameOrDynamicLibPaththe plugin name or the path or a dynamic library that contains the implementation of Authentication
paramsthe ParamMap that is passed to Authentication::create method
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_auth_oauth2-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_auth_oauth2-members.html new file mode 100644 index 000000000000..297855d586f0 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_auth_oauth2-members.html @@ -0,0 +1,99 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::AuthOauth2 Member List
+
+
+ +

This is the complete list of members for pulsar::AuthOauth2, including all inherited members.

+ + + + + + + + + + + +
authData_ (defined in pulsar::Authentication)pulsar::Authenticationprotected
Authentication() (defined in pulsar::Authentication)pulsar::Authenticationprotected
AuthOauth2(ParamMap &params) (defined in pulsar::AuthOauth2)pulsar::AuthOauth2
create(ParamMap &params)pulsar::AuthOauth2static
create(const std::string &authParamsString)pulsar::AuthOauth2static
getAuthData(AuthenticationDataPtr &authDataOauth2)pulsar::AuthOauth2virtual
getAuthMethodName() constpulsar::AuthOauth2virtual
parseDefaultFormatAuthParams(const std::string &authParamsString)pulsar::Authenticationstatic
~Authentication() (defined in pulsar::Authentication)pulsar::Authenticationvirtual
~AuthOauth2() (defined in pulsar::AuthOauth2)pulsar::AuthOauth2
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_auth_oauth2.html b/static/api/cpp/3.5.x/classpulsar_1_1_auth_oauth2.html new file mode 100644 index 000000000000..f011936dc239 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_auth_oauth2.html @@ -0,0 +1,267 @@ + + + + + + + +pulsar-client-cpp: pulsar::AuthOauth2 Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +Static Public Member Functions | +List of all members
+
pulsar::AuthOauth2 Class Reference
+
+
+ +

#include <Authentication.h>

+
+Inheritance diagram for pulsar::AuthOauth2:
+
+
+ + +pulsar::Authentication + +
+ + + + + + + + +

+Public Member Functions

+ AuthOauth2 (ParamMap &params)
 
const std::string getAuthMethodName () const
 
Result getAuthData (AuthenticationDataPtr &authDataOauth2)
 
+ + + + + + + + +

+Static Public Member Functions

static AuthenticationPtr create (ParamMap &params)
 
static AuthenticationPtr create (const std::string &authParamsString)
 
- Static Public Member Functions inherited from pulsar::Authentication
static ParamMap parseDefaultFormatAuthParams (const std::string &authParamsString)
 
+ + + + +

+Additional Inherited Members

- Protected Attributes inherited from pulsar::Authentication
+AuthenticationDataPtr authData_
 
+

Detailed Description

+

Oauth2 based implementation of Pulsar client authentication. Passed in parameter would be like:

"type": "client_credentials",
+
"issuer_url": "https://accounts.google.com",
+
"client_id": "d9ZyX97q1ef8Cr81WHVC4hFQ64vSlDK3",
+
"client_secret": "on1uJ...k6F6R",
+
"audience": "https://broker.example.com"
+

If passed in as std::string, it should be in Json format.

+

Member Function Documentation

+ +

◆ create() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + +
static AuthenticationPtr pulsar::AuthOauth2::create (const std::string & authParamsString)
+ 		+static
+
+

Create an AuthOauth2 with an authentication parameter string

+
See also
Authentication::parseDefaultFormatAuthParams
+ +
+
+ +

◆ create() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + +
static AuthenticationPtr pulsar::AuthOauth2::create (ParamMap & params)
+ 		+static
+
+

Create an AuthOauth2 with a ParamMap

+

The required parameter keys are “issuer_url”, “private_key”, and “audience”

+
Parameters
+ + +
parametersthe key-value to create OAuth 2.0 client credentials
+
+
+
See also
http://pulsar.apache.org/docs/en/security-oauth2/#client-credentials
+ +
+
+ +

◆ getAuthData()

+ +
+
+ + + + + +
+ + + + + + + + +
Result pulsar::AuthOauth2::getAuthData (AuthenticationDataPtr & authDataOauth2)
+ 		+virtual
+
+

Get AuthenticationData from the current instance

+
Parameters
+ + +
[out]authDataOauth2the shared pointer of AuthenticationData. The content of AuthenticationData is changed to the internal data of the current instance.
+
+
+
Returns
ResultOk or ResultAuthenticationError if authentication failed
+ +

Reimplemented from pulsar::Authentication.

+ +
+
+ +

◆ getAuthMethodName()

+ +
+
+ + + + + +
+ + + + + + + +
const std::string pulsar::AuthOauth2::getAuthMethodName () const
+ 		+virtual
+
+
Returns
“token”
+ +

Implements pulsar::Authentication.

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_auth_oauth2.png b/static/api/cpp/3.5.x/classpulsar_1_1_auth_oauth2.png new file mode 100644 index 000000000000..bad9e773fa4e Binary files /dev/null and b/static/api/cpp/3.5.x/classpulsar_1_1_auth_oauth2.png differ diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_auth_tls-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_auth_tls-members.html new file mode 100644 index 000000000000..50f352ef8eb0 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_auth_tls-members.html @@ -0,0 +1,100 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::AuthTls Member List
+
+
+ +

This is the complete list of members for pulsar::AuthTls, including all inherited members.

+ + + + + + + + + + + + +
authData_ (defined in pulsar::Authentication)pulsar::Authenticationprotected
Authentication() (defined in pulsar::Authentication)pulsar::Authenticationprotected
AuthTls(AuthenticationDataPtr &) (defined in pulsar::AuthTls)pulsar::AuthTls
create(ParamMap &params)pulsar::AuthTlsstatic
create(const std::string &authParamsString)pulsar::AuthTlsstatic
create(const std::string &certificatePath, const std::string &privateKeyPath)pulsar::AuthTlsstatic
getAuthData(AuthenticationDataPtr &authDataTls)pulsar::AuthTlsvirtual
getAuthMethodName() constpulsar::AuthTlsvirtual
parseDefaultFormatAuthParams(const std::string &authParamsString)pulsar::Authenticationstatic
~Authentication() (defined in pulsar::Authentication)pulsar::Authenticationvirtual
~AuthTls() (defined in pulsar::AuthTls)pulsar::AuthTls
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_auth_tls.html b/static/api/cpp/3.5.x/classpulsar_1_1_auth_tls.html new file mode 100644 index 000000000000..112a03871983 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_auth_tls.html @@ -0,0 +1,301 @@ + + + + + + + +pulsar-client-cpp: pulsar::AuthTls Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +Static Public Member Functions | +List of all members
+
pulsar::AuthTls Class Reference
+
+
+ +

#include <Authentication.h>

+
+Inheritance diagram for pulsar::AuthTls:
+
+
+ + +pulsar::Authentication + +
+ + + + + + + + +

+Public Member Functions

+ AuthTls (AuthenticationDataPtr &)
 
const std::string getAuthMethodName () const
 
Result getAuthData (AuthenticationDataPtr &authDataTls)
 
+ + + + + + + + + + +

+Static Public Member Functions

static AuthenticationPtr create (ParamMap &params)
 
static AuthenticationPtr create (const std::string &authParamsString)
 
static AuthenticationPtr create (const std::string &certificatePath, const std::string &privateKeyPath)
 
- Static Public Member Functions inherited from pulsar::Authentication
static ParamMap parseDefaultFormatAuthParams (const std::string &authParamsString)
 
+ + + + +

+Additional Inherited Members

- Protected Attributes inherited from pulsar::Authentication
+AuthenticationDataPtr authData_
 
+

Detailed Description

+

TLS implementation of Pulsar client authentication

+

Member Function Documentation

+ +

◆ create() [1/3]

+ +
+
+ + + + + +
+ + + + + + + + +
static AuthenticationPtr pulsar::AuthTls::create (const std::string & authParamsString)
+ 		+static
+
+

Create an AuthTls with an authentication parameter string

+
See also
Authentication::parseDefaultFormatAuthParams
+ +
+
+ +

◆ create() [2/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
static AuthenticationPtr pulsar::AuthTls::create (const std::string & certificatePath,
const std::string & privateKeyPath 
)
+ 		+static
+
+

Create an AuthTls with the required parameters

+
Parameters
+ + + +
certificatePaththe file path for a client certificate
privateKeyPaththe file path for a client private key
+
+
+ +
+
+ +

◆ create() [3/3]

+ +
+
+ + + + + +
+ + + + + + + + +
static AuthenticationPtr pulsar::AuthTls::create (ParamMap & params)
+ 		+static
+
+

Create an AuthTls with a ParamMap

+

It is equal to create(params[“tlsCertFile”], params[“tlsKeyFile”])

See also
create(const std::string&, const std::string&)
+ +
+
+ +

◆ getAuthData()

+ +
+
+ + + + + +
+ + + + + + + + +
Result pulsar::AuthTls::getAuthData (AuthenticationDataPtr & authDataTls)
+ 		+virtual
+
+

Get AuthenticationData from the current instance

+
Parameters
+ + +
[out]authDataTlsthe shared pointer of AuthenticationData. The content of AuthenticationData is changed to the internal data of the current instance.
+
+
+
Returns
ResultOk
+ +

Reimplemented from pulsar::Authentication.

+ +
+
+ +

◆ getAuthMethodName()

+ +
+
+ + + + + +
+ + + + + + + +
const std::string pulsar::AuthTls::getAuthMethodName () const
+ 		+virtual
+
+
Returns
“tls”
+ +

Implements pulsar::Authentication.

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_auth_tls.png b/static/api/cpp/3.5.x/classpulsar_1_1_auth_tls.png new file mode 100644 index 000000000000..0c6cda88c423 Binary files /dev/null and b/static/api/cpp/3.5.x/classpulsar_1_1_auth_tls.png differ diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_auth_token-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_auth_token-members.html new file mode 100644 index 000000000000..0f8ade41ed3b --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_auth_token-members.html @@ -0,0 +1,101 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::AuthToken Member List
+
+
+ +

This is the complete list of members for pulsar::AuthToken, including all inherited members.

+ + + + + + + + + + + + + +
authData_ (defined in pulsar::Authentication)pulsar::Authenticationprotected
Authentication() (defined in pulsar::Authentication)pulsar::Authenticationprotected
AuthToken(AuthenticationDataPtr &) (defined in pulsar::AuthToken)pulsar::AuthToken
create(ParamMap &params)pulsar::AuthTokenstatic
create(const std::string &authParamsString)pulsar::AuthTokenstatic
create(const TokenSupplier &tokenSupplier)pulsar::AuthTokenstatic
createWithToken(const std::string &token)pulsar::AuthTokenstatic
getAuthData(AuthenticationDataPtr &authDataToken)pulsar::AuthTokenvirtual
getAuthMethodName() constpulsar::AuthTokenvirtual
parseDefaultFormatAuthParams(const std::string &authParamsString)pulsar::Authenticationstatic
~Authentication() (defined in pulsar::Authentication)pulsar::Authenticationvirtual
~AuthToken() (defined in pulsar::AuthToken)pulsar::AuthToken
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_auth_token.html b/static/api/cpp/3.5.x/classpulsar_1_1_auth_token.html new file mode 100644 index 000000000000..733aae58d4df --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_auth_token.html @@ -0,0 +1,334 @@ + + + + + + + +pulsar-client-cpp: pulsar::AuthToken Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +Static Public Member Functions | +List of all members
+
pulsar::AuthToken Class Reference
+
+
+ +

#include <Authentication.h>

+
+Inheritance diagram for pulsar::AuthToken:
+
+
+ + +pulsar::Authentication + +
+ + + + + + + + +

+Public Member Functions

+ AuthToken (AuthenticationDataPtr &)
 
const std::string getAuthMethodName () const
 
Result getAuthData (AuthenticationDataPtr &authDataToken)
 
+ + + + + + + + + + + + +

+Static Public Member Functions

static AuthenticationPtr create (ParamMap &params)
 
static AuthenticationPtr create (const std::string &authParamsString)
 
static AuthenticationPtr createWithToken (const std::string &token)
 
static AuthenticationPtr create (const TokenSupplier &tokenSupplier)
 
- Static Public Member Functions inherited from pulsar::Authentication
static ParamMap parseDefaultFormatAuthParams (const std::string &authParamsString)
 
+ + + + +

+Additional Inherited Members

- Protected Attributes inherited from pulsar::Authentication
+AuthenticationDataPtr authData_
 
+

Detailed Description

+

Token based implementation of Pulsar client authentication

+

Member Function Documentation

+ +

◆ create() [1/3]

+ +
+
+ + + + + +
+ + + + + + + + +
static AuthenticationPtr pulsar::AuthToken::create (const std::string & authParamsString)
+ 		+static
+
+

Create an AuthToken with an authentication parameter string

+
See also
Authentication::parseDefaultFormatAuthParams
+ +
+
+ +

◆ create() [2/3]

+ +
+
+ + + + + +
+ + + + + + + + +
static AuthenticationPtr pulsar::AuthToken::create (const TokenSupplier & tokenSupplier)
+ 		+static
+
+

Create an authentication provider for token based authentication

+
Parameters
+ + +
tokenSuppliera supplier of the client auth token
+
+
+ +
+
+ +

◆ create() [3/3]

+ +
+
+ + + + + +
+ + + + + + + + +
static AuthenticationPtr pulsar::AuthToken::create (ParamMap & params)
+ 		+static
+
+

Create an AuthToken with a ParamMap

+
Parameters
+ + +
parametersit must contain a key-value, where key means how to get the token and value means the token source
+
+
+

If the key is “token”, the value is the token

+

If the key is “file”, the value is the file that contains the token

+

If the key is “env”, the value is the environment variable whose value is the token

+

Otherwise, a std::runtime_error error is thrown.

See also
create(const std::string& authParamsString)
+ +
+
+ +

◆ createWithToken()

+ +
+
+ + + + + +
+ + + + + + + + +
static AuthenticationPtr pulsar::AuthToken::createWithToken (const std::string & token)
+ 		+static
+
+

Create an authentication provider for token based authentication

+
Parameters
+ + +
tokena string containing the auth token
+
+
+ +
+
+ +

◆ getAuthData()

+ +
+
+ + + + + +
+ + + + + + + + +
Result pulsar::AuthToken::getAuthData (AuthenticationDataPtr & authDataToken)
+ 		+virtual
+
+

Get AuthenticationData from the current instance

+
Parameters
+ + +
[out]authDataTokenthe shared pointer of AuthenticationData. The content of AuthenticationData is changed to the internal data of the current instance.
+
+
+
Returns
ResultOk
+ +

Reimplemented from pulsar::Authentication.

+ +
+
+ +

◆ getAuthMethodName()

+ +
+
+ + + + + +
+ + + + + + + +
const std::string pulsar::AuthToken::getAuthMethodName () const
+ 		+virtual
+
+
Returns
“token”
+ +

Implements pulsar::Authentication.

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_auth_token.png b/static/api/cpp/3.5.x/classpulsar_1_1_auth_token.png new file mode 100644 index 000000000000..90c63e70f819 Binary files /dev/null and b/static/api/cpp/3.5.x/classpulsar_1_1_auth_token.png differ diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_authentication-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_authentication-members.html new file mode 100644 index 000000000000..1d83b81af75d --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_authentication-members.html @@ -0,0 +1,96 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::Authentication Member List
+
+
+ +

This is the complete list of members for pulsar::Authentication, including all inherited members.

+ + + + + + + + +
authData_ (defined in pulsar::Authentication)pulsar::Authenticationprotected
Authentication() (defined in pulsar::Authentication)pulsar::Authenticationprotected
ClientConfiguration (defined in pulsar::Authentication)pulsar::Authenticationfriend
getAuthData(AuthenticationDataPtr &authDataContent)pulsar::Authenticationinlinevirtual
getAuthMethodName() const =0pulsar::Authenticationpure virtual
parseDefaultFormatAuthParams(const std::string &authParamsString)pulsar::Authenticationstatic
~Authentication() (defined in pulsar::Authentication)pulsar::Authenticationvirtual
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_authentication.html b/static/api/cpp/3.5.x/classpulsar_1_1_authentication.html new file mode 100644 index 000000000000..328ec7ae3306 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_authentication.html @@ -0,0 +1,234 @@ + + + + + + + +pulsar-client-cpp: pulsar::Authentication Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +Static Public Member Functions | +Protected Attributes | +Friends | +List of all members
+
pulsar::Authentication Class Referenceabstract
+
+
+
+Inheritance diagram for pulsar::Authentication:
+
+
+ + +pulsar::AuthAthenz +pulsar::AuthBasic +pulsar::AuthOauth2 +pulsar::AuthTls +pulsar::AuthToken + +
+ + + + + + +

+Public Member Functions

virtual const std::string getAuthMethodName () const =0
 
virtual Result getAuthData (AuthenticationDataPtr &authDataContent)
 
+ + + +

+Static Public Member Functions

static ParamMap parseDefaultFormatAuthParams (const std::string &authParamsString)
 
+ + + +

+Protected Attributes

+AuthenticationDataPtr authData_
 
+ + + +

+Friends

+class ClientConfiguration
 
+

Member Function Documentation

+ +

◆ getAuthData()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual Result pulsar::Authentication::getAuthData (AuthenticationDataPtr & authDataContent)
+ 		+inlinevirtual
+
+

Get AuthenticationData from the current instance

+
Parameters
+ + +
[out]authDataContentthe shared pointer of AuthenticationData. The content of AuthenticationData is changed to the internal data of the current instance.
+
+
+
Returns
ResultOk or ResultAuthenticationError if authentication failed
+ +

Reimplemented in pulsar::AuthAthenz, pulsar::AuthBasic, pulsar::AuthOauth2, pulsar::AuthTls, and pulsar::AuthToken.

+ +
+
+ +

◆ getAuthMethodName()

+ +
+
+ + + + + +
+ + + + + + + +
virtual const std::string pulsar::Authentication::getAuthMethodName () const
+ 		+pure virtual
+
+
Returns
the authentication method name supported by this provider
+ +

Implemented in pulsar::AuthTls, pulsar::AuthToken, pulsar::AuthAthenz, pulsar::AuthOauth2, and pulsar::AuthBasic.

+ +
+
+ +

◆ parseDefaultFormatAuthParams()

+ +
+
+ + + + + +
+ + + + + + + + +
static ParamMap pulsar::Authentication::parseDefaultFormatAuthParams (const std::string & authParamsString)
+ 		+static
+
+

Parse the authentication parameter string to a map whose key and value are both strings

+

The parameter string can have multiple lines. The format of each line is a comma-separated “key:value” string.

+

For example, “k1:v1,k2:v2” is parsed to two key-value pairs (k1, v1) and (k2, v2).

+
Parameters
+ + +
authParamsStringthe authentication parameter string to be parsed
+
+
+
Returns
the parsed map whose key and value are both strings
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_authentication.png b/static/api/cpp/3.5.x/classpulsar_1_1_authentication.png new file mode 100644 index 000000000000..473d79086f18 Binary files /dev/null and b/static/api/cpp/3.5.x/classpulsar_1_1_authentication.png differ diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_authentication_data_provider-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_authentication_data_provider-members.html new file mode 100644 index 000000000000..818af16cfc18 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_authentication_data_provider-members.html @@ -0,0 +1,99 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::AuthenticationDataProvider Member List
+
+
+ +

This is the complete list of members for pulsar::AuthenticationDataProvider, including all inherited members.

+ + + + + + + + + + + +
AuthenticationDataProvider() (defined in pulsar::AuthenticationDataProvider)pulsar::AuthenticationDataProviderprotected
getCommandData()pulsar::AuthenticationDataProvidervirtual
getHttpAuthType()pulsar::AuthenticationDataProvidervirtual
getHttpHeaders()pulsar::AuthenticationDataProvidervirtual
getTlsCertificates()pulsar::AuthenticationDataProvidervirtual
getTlsPrivateKey()pulsar::AuthenticationDataProvidervirtual
hasDataForHttp()pulsar::AuthenticationDataProvidervirtual
hasDataForTls()pulsar::AuthenticationDataProvidervirtual
hasDataFromCommand()pulsar::AuthenticationDataProvidervirtual
~AuthenticationDataProvider() (defined in pulsar::AuthenticationDataProvider)pulsar::AuthenticationDataProvidervirtual
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_authentication_data_provider.html b/static/api/cpp/3.5.x/classpulsar_1_1_authentication_data_provider.html new file mode 100644 index 000000000000..f254374680d3 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_authentication_data_provider.html @@ -0,0 +1,321 @@ + + + + + + + +pulsar-client-cpp: pulsar::AuthenticationDataProvider Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +List of all members
+
pulsar::AuthenticationDataProvider Class Reference
+
+
+ + + + + + + + + + + + + + + + + + +

+Public Member Functions

virtual bool hasDataForTls ()
 
virtual std::string getTlsCertificates ()
 
virtual std::string getTlsPrivateKey ()
 
virtual bool hasDataForHttp ()
 
virtual std::string getHttpAuthType ()
 
virtual std::string getHttpHeaders ()
 
virtual bool hasDataFromCommand ()
 
virtual std::string getCommandData ()
 
+

Member Function Documentation

+ +

◆ getCommandData()

+ +
+
+ + + + + +
+ + + + + + + +
virtual std::string pulsar::AuthenticationDataProvider::getCommandData ()
+ 		+virtual
+
+
Returns
authentication data which is stored in a command
+ +
+
+ +

◆ getHttpAuthType()

+ +
+
+ + + + + +
+ + + + + + + +
virtual std::string pulsar::AuthenticationDataProvider::getHttpAuthType ()
+ 		+virtual
+
+
Returns
an authentication scheme or “none” if the request is not authenticated
+ +
+
+ +

◆ getHttpHeaders()

+ +
+
+ + + + + +
+ + + + + + + +
virtual std::string pulsar::AuthenticationDataProvider::getHttpHeaders ()
+ 		+virtual
+
+
Returns
the string of HTTP header or “none” if the request is not authenticated
+ +
+
+ +

◆ getTlsCertificates()

+ +
+
+ + + + + +
+ + + + + + + +
virtual std::string pulsar::AuthenticationDataProvider::getTlsCertificates ()
+ 		+virtual
+
+
Returns
a client certificate chain or “none” if the data is not available
+ +
+
+ +

◆ getTlsPrivateKey()

+ +
+
+ + + + + +
+ + + + + + + +
virtual std::string pulsar::AuthenticationDataProvider::getTlsPrivateKey ()
+ 		+virtual
+
+
Returns
a private key for the client certificate or “none” if the data is not available
+ +
+
+ +

◆ hasDataForHttp()

+ +
+
+ + + + + +
+ + + + + + + +
virtual bool pulsar::AuthenticationDataProvider::hasDataForHttp ()
+ 		+virtual
+
+
Returns
true if this authentication data contains data for HTTP
+ +
+
+ +

◆ hasDataForTls()

+ +
+
+ + + + + +
+ + + + + + + +
virtual bool pulsar::AuthenticationDataProvider::hasDataForTls ()
+ 		+virtual
+
+
Returns
true if the authentication data contains data for TLS
+ +
+
+ +

◆ hasDataFromCommand()

+ +
+
+ + + + + +
+ + + + + + + +
virtual bool pulsar::AuthenticationDataProvider::hasDataFromCommand ()
+ 		+virtual
+
+
Returns
true if authentication data contains data from Pulsar protocol
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_batch_receive_policy-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_batch_receive_policy-members.html new file mode 100644 index 000000000000..176ac9337a3f --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_batch_receive_policy-members.html @@ -0,0 +1,94 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::BatchReceivePolicy Member List
+
+
+ +

This is the complete list of members for pulsar::BatchReceivePolicy, including all inherited members.

+ + + + + + +
BatchReceivePolicy()pulsar::BatchReceivePolicy
BatchReceivePolicy(int maxNumMessage, long maxNumBytes, long timeoutMs)pulsar::BatchReceivePolicy
getMaxNumBytes() constpulsar::BatchReceivePolicy
getMaxNumMessages() constpulsar::BatchReceivePolicy
getTimeoutMs() constpulsar::BatchReceivePolicy
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_batch_receive_policy.html b/static/api/cpp/3.5.x/classpulsar_1_1_batch_receive_policy.html new file mode 100644 index 000000000000..13ecc4aa0644 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_batch_receive_policy.html @@ -0,0 +1,238 @@ + + + + + + + +pulsar-client-cpp: pulsar::BatchReceivePolicy Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +List of all members
+
pulsar::BatchReceivePolicy Class Reference
+
+
+ +

#include <BatchReceivePolicy.h>

+ + + + + + + + + + + + +

+Public Member Functions

 BatchReceivePolicy ()
 
 BatchReceivePolicy (int maxNumMessage, long maxNumBytes, long timeoutMs)
 
long getTimeoutMs () const
 
int getMaxNumMessages () const
 
long getMaxNumBytes () const
 
+

Detailed Description

+

Configuration for message batch receive Consumer#batchReceive() Consumer#batchReceiveAsync().

+

Batch receive policy can limit the number and bytes of messages in a single batch, and can specify a timeout for waiting for enough messages for this batch.

+

A batch receive action is completed as long as any one of the conditions (the batch has enough number or size of messages, or the waiting timeout is passed) are met.

+

Examples: 1.If set maxNumMessages = 10, maxSizeOfMessages = 1MB and without timeout, it means Consumer#batchReceive() will always wait until there is enough messages. 2.If set maxNumberOfMessages = 0, maxNumBytes = 0 and timeout = 100ms, it means Consumer#batchReceive() will wait for 100ms no matter whether there are enough messages.

+

Note: Must specify messages limitation(maxNumMessages, maxNumBytes) or wait timeout. Otherwise, Messages ingest Message will never end.

+
Since
2.4.1
+

Constructor & Destructor Documentation

+ +

◆ BatchReceivePolicy() [1/2]

+ +
+
+ + + + + + + +
pulsar::BatchReceivePolicy::BatchReceivePolicy ()
+
+

Default value: {maxNumMessage: -1, maxNumBytes: 10 * 1024 * 1024, timeoutMs: 100}

+ +
+
+ +

◆ BatchReceivePolicy() [2/2]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
pulsar::BatchReceivePolicy::BatchReceivePolicy (int maxNumMessage,
long maxNumBytes,
long timeoutMs 
)
+
+
Parameters
+ + + + +
maxNumMessageMax num message, a non-positive value means no limit.
maxNumBytesMax num bytes, a non-positive value means no limit.
timeoutMsThe receive timeout, a non-positive value means no limit.
+
+
+
Exceptions
+ + +
std::invalid_argumentif all arguments are non-positive
+
+
+ +
+
+

Member Function Documentation

+ +

◆ getMaxNumBytes()

+ +
+
+ + + + + + + +
long pulsar::BatchReceivePolicy::getMaxNumBytes () const
+
+

Get max num bytes.

Returns
+ +
+
+ +

◆ getMaxNumMessages()

+ +
+
+ + + + + + + +
int pulsar::BatchReceivePolicy::getMaxNumMessages () const
+
+

Get the maximum number of messages.

Returns
+ +
+
+ +

◆ getTimeoutMs()

+ +
+
+ + + + + + + +
long pulsar::BatchReceivePolicy::getTimeoutMs () const
+
+

Get max time out ms.

+
Returns
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_broker_consumer_stats-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_broker_consumer_stats-members.html new file mode 100644 index 000000000000..7de9fadae5b4 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_broker_consumer_stats-members.html @@ -0,0 +1,108 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::BrokerConsumerStats Member List
+
+
+ +

This is the complete list of members for pulsar::BrokerConsumerStats, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + +
BrokerConsumerStats()=default (defined in pulsar::BrokerConsumerStats)pulsar::BrokerConsumerStats
BrokerConsumerStats(std::shared_ptr< BrokerConsumerStatsImplBase > impl) (defined in pulsar::BrokerConsumerStats)pulsar::BrokerConsumerStatsexplicit
getAddress() constpulsar::BrokerConsumerStatsvirtual
getAvailablePermits() constpulsar::BrokerConsumerStatsvirtual
getConnectedSince() constpulsar::BrokerConsumerStatsvirtual
getConsumerName() constpulsar::BrokerConsumerStatsvirtual
getImpl() constpulsar::BrokerConsumerStats
getMsgBacklog() constpulsar::BrokerConsumerStatsvirtual
getMsgRateExpired() constpulsar::BrokerConsumerStatsvirtual
getMsgRateOut() constpulsar::BrokerConsumerStatsvirtual
getMsgRateRedeliver() constpulsar::BrokerConsumerStatsvirtual
getMsgThroughputOut() constpulsar::BrokerConsumerStatsvirtual
getType() constpulsar::BrokerConsumerStatsvirtual
getUnackedMessages() constpulsar::BrokerConsumerStatsvirtual
isBlockedConsumerOnUnackedMsgs() constpulsar::BrokerConsumerStatsvirtual
isValid() constpulsar::BrokerConsumerStatsvirtual
operator<< (defined in pulsar::BrokerConsumerStats)pulsar::BrokerConsumerStatsfriend
PulsarWrapper (defined in pulsar::BrokerConsumerStats)pulsar::BrokerConsumerStatsfriend
~BrokerConsumerStats()=default (defined in pulsar::BrokerConsumerStats)pulsar::BrokerConsumerStatsvirtual
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_broker_consumer_stats.html b/static/api/cpp/3.5.x/classpulsar_1_1_broker_consumer_stats.html new file mode 100644 index 000000000000..01cff3c0692f --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_broker_consumer_stats.html @@ -0,0 +1,495 @@ + + + + + + + +pulsar-client-cpp: pulsar::BrokerConsumerStats Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +Friends | +List of all members
+
pulsar::BrokerConsumerStats Class Reference
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ BrokerConsumerStats (std::shared_ptr< BrokerConsumerStatsImplBase > impl)
 
virtual bool isValid () const
 
virtual double getMsgRateOut () const
 
virtual double getMsgThroughputOut () const
 
virtual double getMsgRateRedeliver () const
 
virtual const std::string getConsumerName () const
 
virtual uint64_t getAvailablePermits () const
 
virtual uint64_t getUnackedMessages () const
 
virtual bool isBlockedConsumerOnUnackedMsgs () const
 
virtual const std::string getAddress () const
 
virtual const std::string getConnectedSince () const
 
virtual const ConsumerType getType () const
 
virtual double getMsgRateExpired () const
 
virtual uint64_t getMsgBacklog () const
 
std::shared_ptr< BrokerConsumerStatsImplBase > getImpl () const
 
+ + + + + +

+Friends

+class PulsarWrapper
 
+PULSAR_PUBLIC std::ostream & operator<< (std::ostream &os, const BrokerConsumerStats &obj)
 
+

Member Function Documentation

+ +

◆ getAddress()

+ +
+
+ + + + + +
+ + + + + + + +
virtual const std::string pulsar::BrokerConsumerStats::getAddress () const
+ 		+virtual
+
+

Returns the Address of this consumer

+ +
+
+ +

◆ getAvailablePermits()

+ +
+
+ + + + + +
+ + + + + + + +
virtual uint64_t pulsar::BrokerConsumerStats::getAvailablePermits () const
+ 		+virtual
+
+

Returns the Number of available message permits for the consumer

+ +
+
+ +

◆ getConnectedSince()

+ +
+
+ + + + + +
+ + + + + + + +
virtual const std::string pulsar::BrokerConsumerStats::getConnectedSince () const
+ 		+virtual
+
+

Returns the Timestamp of connection

+ +
+
+ +

◆ getConsumerName()

+ +
+
+ + + + + +
+ + + + + + + +
virtual const std::string pulsar::BrokerConsumerStats::getConsumerName () const
+ 		+virtual
+
+

Returns the Name of the consumer

+ +
+
+ +

◆ getImpl()

+ +
+
+ + + + + + + +
std::shared_ptr< BrokerConsumerStatsImplBase > pulsar::BrokerConsumerStats::getImpl () const
+
+
Deprecated:
+ +
+
+ +

◆ getMsgBacklog()

+ +
+
+ + + + + +
+ + + + + + + +
virtual uint64_t pulsar::BrokerConsumerStats::getMsgBacklog () const
+ 		+virtual
+
+

Returns the Number of messages in the subscription backlog

+ +
+
+ +

◆ getMsgRateExpired()

+ +
+
+ + + + + +
+ + + + + + + +
virtual double pulsar::BrokerConsumerStats::getMsgRateExpired () const
+ 		+virtual
+
+

Returns the rate of messages expired on this subscription. msg/s

+ +
+
+ +

◆ getMsgRateOut()

+ +
+
+ + + + + +
+ + + + + + + +
virtual double pulsar::BrokerConsumerStats::getMsgRateOut () const
+ 		+virtual
+
+

Returns the rate of messages delivered to the consumer. msg/s

+ +
+
+ +

◆ getMsgRateRedeliver()

+ +
+
+ + + + + +
+ + + + + + + +
virtual double pulsar::BrokerConsumerStats::getMsgRateRedeliver () const
+ 		+virtual
+
+

Returns the rate of messages redelivered by this consumer. msg/s

+ +
+
+ +

◆ getMsgThroughputOut()

+ +
+
+ + + + + +
+ + + + + + + +
virtual double pulsar::BrokerConsumerStats::getMsgThroughputOut () const
+ 		+virtual
+
+

Returns the throughput delivered to the consumer. bytes/s

+ +
+
+ +

◆ getType()

+ +
+
+ + + + + +
+ + + + + + + +
virtual const ConsumerType pulsar::BrokerConsumerStats::getType () const
+ 		+virtual
+
+

Returns Whether this subscription is Exclusive or Shared or Failover

+ +
+
+ +

◆ getUnackedMessages()

+ +
+
+ + + + + +
+ + + + + + + +
virtual uint64_t pulsar::BrokerConsumerStats::getUnackedMessages () const
+ 		+virtual
+
+

Returns the Number of unacknowledged messages for the consumer

+ +
+
+ +

◆ isBlockedConsumerOnUnackedMsgs()

+ +
+
+ + + + + +
+ + + + + + + +
virtual bool pulsar::BrokerConsumerStats::isBlockedConsumerOnUnackedMsgs () const
+ 		+virtual
+
+

Returns true if the consumer is blocked due to unacked messages.
+

+ +
+
+ +

◆ isValid()

+ +
+
+ + + + + +
+ + + + + + + +
virtual bool pulsar::BrokerConsumerStats::isValid () const
+ 		+virtual
+
+

Returns true if the Stats are still valid

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_cached_token-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_cached_token-members.html new file mode 100644 index 000000000000..12d557b2c1c4 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_cached_token-members.html @@ -0,0 +1,93 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::CachedToken Member List
+
+
+ +

This is the complete list of members for pulsar::CachedToken, including all inherited members.

+ + + + + +
CachedToken() (defined in pulsar::CachedToken)pulsar::CachedTokenprotected
getAuthData()=0pulsar::CachedTokenpure virtual
isExpired()=0pulsar::CachedTokenpure virtual
~CachedToken() (defined in pulsar::CachedToken)pulsar::CachedTokenvirtual
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_cached_token.html b/static/api/cpp/3.5.x/classpulsar_1_1_cached_token.html new file mode 100644 index 000000000000..db7235df98e1 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_cached_token.html @@ -0,0 +1,154 @@ + + + + + + + +pulsar-client-cpp: pulsar::CachedToken Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +List of all members
+
pulsar::CachedToken Class Referenceabstract
+
+
+ + + + + + +

+Public Member Functions

virtual bool isExpired ()=0
 
virtual AuthenticationDataPtr getAuthData ()=0
 
+

Member Function Documentation

+ +

◆ getAuthData()

+ +
+
+ + + + + +
+ + + + + + + +
virtual AuthenticationDataPtr pulsar::CachedToken::getAuthData ()
+ 		+pure virtual
+
+

Get AuthenticationData from the current instance

+
Returns
ResultOk or ResultAuthenticationError if authentication failed
+ +
+
+ +

◆ isExpired()

+ +
+
+ + + + + +
+ + + + + + + +
virtual bool pulsar::CachedToken::isExpired ()
+ 		+pure virtual
+
+
Returns
true if the token has expired
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_client-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_client-members.html new file mode 100644 index 000000000000..20a21d0e93b3 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_client-members.html @@ -0,0 +1,121 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::Client Member List
+
+
+ +

This is the complete list of members for pulsar::Client, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Client(const std::string &serviceUrl)pulsar::Client
Client(const std::string &serviceUrl, const ClientConfiguration &clientConfiguration)pulsar::Client
close()pulsar::Client
closeAsync(CloseCallback callback)pulsar::Client
createProducer(const std::string &topic, Producer &producer)pulsar::Client
createProducer(const std::string &topic, const ProducerConfiguration &conf, Producer &producer)pulsar::Client
createProducerAsync(const std::string &topic, CreateProducerCallback callback)pulsar::Client
createProducerAsync(const std::string &topic, ProducerConfiguration conf, CreateProducerCallback callback)pulsar::Client
createReader(const std::string &topic, const MessageId &startMessageId, const ReaderConfiguration &conf, Reader &reader)pulsar::Client
createReaderAsync(const std::string &topic, const MessageId &startMessageId, const ReaderConfiguration &conf, ReaderCallback callback)pulsar::Client
createTableView(const std::string &topic, const TableViewConfiguration &conf, TableView &tableView)pulsar::Client
createTableViewAsync(const std::string &topic, const TableViewConfiguration &conf, TableViewCallback callBack)pulsar::Client
getNumberOfConsumers()pulsar::Client
getNumberOfProducers()pulsar::Client
getPartitionsForTopic(const std::string &topic, std::vector< std::string > &partitions)pulsar::Client
getPartitionsForTopicAsync(const std::string &topic, GetPartitionsCallback callback)pulsar::Client
getSchemaInfoAsync(const std::string &topic, int64_t version, std::function< void(Result, const SchemaInfo &)> callback)pulsar::Client
PulsarFriend (defined in pulsar::Client)pulsar::Clientfriend
PulsarWrapper (defined in pulsar::Client)pulsar::Clientfriend
shutdown()pulsar::Client
subscribe(const std::string &topic, const std::string &subscriptionName, Consumer &consumer)pulsar::Client
subscribe(const std::string &topic, const std::string &subscriptionName, const ConsumerConfiguration &conf, Consumer &consumer)pulsar::Client
subscribe(const std::vector< std::string > &topics, const std::string &subscriptionName, Consumer &consumer)pulsar::Client
subscribe(const std::vector< std::string > &topics, const std::string &subscriptionName, const ConsumerConfiguration &conf, Consumer &consumer)pulsar::Client
subscribeAsync(const std::string &topic, const std::string &subscriptionName, SubscribeCallback callback)pulsar::Client
subscribeAsync(const std::string &topic, const std::string &subscriptionName, const ConsumerConfiguration &conf, SubscribeCallback callback)pulsar::Client
subscribeAsync(const std::vector< std::string > &topics, const std::string &subscriptionName, SubscribeCallback callback)pulsar::Client
subscribeAsync(const std::vector< std::string > &topics, const std::string &subscriptionName, const ConsumerConfiguration &conf, SubscribeCallback callback)pulsar::Client
subscribeWithRegex(const std::string &regexPattern, const std::string &subscriptionName, Consumer &consumer)pulsar::Client
subscribeWithRegex(const std::string &regexPattern, const std::string &subscriptionName, const ConsumerConfiguration &conf, Consumer &consumer)pulsar::Client
subscribeWithRegexAsync(const std::string &regexPattern, const std::string &subscriptionName, SubscribeCallback callback)pulsar::Client
subscribeWithRegexAsync(const std::string &regexPattern, const std::string &subscriptionName, const ConsumerConfiguration &conf, SubscribeCallback callback)pulsar::Client
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_client.html b/static/api/cpp/3.5.x/classpulsar_1_1_client.html new file mode 100644 index 000000000000..5746b6e68bd2 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_client.html @@ -0,0 +1,1368 @@ + + + + + + + +pulsar-client-cpp: pulsar::Client Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+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 &subscriptionName, Consumer &consumer)
 
Result subscribe (const std::string &topic, const std::string &subscriptionName, const ConsumerConfiguration &conf, Consumer &consumer)
 
void subscribeAsync (const std::string &topic, const std::string &subscriptionName, SubscribeCallback callback)
 
void subscribeAsync (const std::string &topic, const std::string &subscriptionName, const ConsumerConfiguration &conf, SubscribeCallback callback)
 
Result subscribe (const std::vector< std::string > &topics, const std::string &subscriptionName, Consumer &consumer)
 
Result subscribe (const std::vector< std::string > &topics, const std::string &subscriptionName, const ConsumerConfiguration &conf, Consumer &consumer)
 
void subscribeAsync (const std::vector< std::string > &topics, const std::string &subscriptionName, SubscribeCallback callback)
 
void subscribeAsync (const std::vector< std::string > &topics, const std::string &subscriptionName, const ConsumerConfiguration &conf, SubscribeCallback callback)
 
Result subscribeWithRegex (const std::string &regexPattern, const std::string &subscriptionName, Consumer &consumer)
 
Result subscribeWithRegex (const std::string &regexPattern, const std::string &subscriptionName, const ConsumerConfiguration &conf, Consumer &consumer)
 
void subscribeWithRegexAsync (const std::string &regexPattern, const std::string &subscriptionName, SubscribeCallback callback)
 
void subscribeWithRegexAsync (const std::string &regexPattern, const std::string &subscriptionName, const ConsumerConfiguration &conf, SubscribeCallback callback)
 
Result createReader (const std::string &topic, const MessageId &startMessageId, const ReaderConfiguration &conf, Reader &reader)
 
void createReaderAsync (const std::string &topic, const MessageId &startMessageId, const ReaderConfiguration &conf, ReaderCallback callback)
 
Result createTableView (const std::string &topic, const TableViewConfiguration &conf, TableView &tableView)
 
void createTableViewAsync (const std::string &topic, const TableViewConfiguration &conf, TableViewCallback callBack)
 
Result getPartitionsForTopic (const std::string &topic, std::vector< std::string > &partitions)
 
void getPartitionsForTopicAsync (const std::string &topic, GetPartitionsCallback callback)
 
Result close ()
 
void closeAsync (CloseCallback callback)
 
void shutdown ()
 
uint64_t getNumberOfProducers ()
 Get the number of alive producers on the current client.
 
uint64_t getNumberOfConsumers ()
 Get the number of alive consumers on the current client.
 
void getSchemaInfoAsync (const std::string &topic, int64_t version, std::function< void(Result, const SchemaInfo &)> callback)
 
+ + + + + +

+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)
+
+
+
Exceptions
+ + +
std::invalid_argumentif serviceUrl is invalid
+
+
+ +
+
+ +

◆ 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
+
+
+
Exceptions
+ + +
std::invalid_argumentif serviceUrl is invalid
+
+
+ +
+
+

Member Function Documentation

+ +

◆ close()

+ +
+
+ + + + + + + +
Result pulsar::Client::close ()
+
+
Returns
+ +
+
+ +

◆ closeAsync()

+ +
+
+ + + + + + + + +
void pulsar::Client::closeAsync (CloseCallback callback)
+
+

Asynchronously close the Pulsar client and release all resources.

+

All producers, consumers, and readers are orderly closed. The client waits until all pending write requests are persisted.

+
Parameters
+ + +
callbackthe callback that is triggered when the Pulsar client is asynchronously closed successfully or not
+
+
+ +
+
+ +

◆ createProducer() [1/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
+ +
+
+ +

◆ createProducer() [2/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
+ +
+
+ +

◆ createProducerAsync() [1/2]

+ +
+
+ + + + + + + + + + + + + + + + + + +
void pulsar::Client::createProducerAsync (const std::string & topic,
CreateProducerCallback callback 
)
+
+

Asynchronously create a producer with the default ProducerConfiguration for publishing on a specific topic

+
Parameters
+ + + + +
topicthe name of the topic where to produce
callbackthe callback that is triggered when the producer is created successfully or not
callbackCallback function that is invoked when the operation is completed
+
+
+ +
+
+ +

◆ createProducerAsync() [2/2]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void pulsar::Client::createProducerAsync (const std::string & topic,
ProducerConfiguration conf,
CreateProducerCallback callback 
)
+
+

Asynchronously create a producer with the customized ProducerConfiguration for publishing on a specific topic

+
Parameters
+ + + +
topicthe name of the topic where to produce
confthe customized ProducerConfiguration
+
+
+ +
+
+ +

◆ createReader()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Result pulsar::Client::createReader (const std::string & topic,
const MessageId & startMessageId,
const ReaderConfiguration & conf,
Reader & reader 
)
+
+

Create a topic reader with given ReaderConfiguration for reading messages from the specified topic.

+

The Reader provides a low-level abstraction that allows for manual positioning in the topic, without using a subscription. Reader can only work on non-partitioned topics.

+

The initial reader positioning is done by specifying a message id. The options are:

    +
  • +MessageId.earliest : Start reading from the earliest message available in the topic
    • +
  • +MessageId.latest : Start reading from the end topic, only getting messages published after the reader was created
    • +
  • +MessageId : When passing a particular message id, the reader will position itself on that specific position. The first message to be read will be the message next to the specified messageId.
    • +
+
Parameters
+ + + + +
topicThe name of the topic where to read
startMessageIdThe message id where the reader will position itself. The first message returned will be the one after the specified startMessageId
confThe ReaderConfiguration object
+
+
+
Returns
The Reader object
+ +
+
+ +

◆ createReaderAsync()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void pulsar::Client::createReaderAsync (const std::string & topic,
const MessageId & startMessageId,
const ReaderConfiguration & conf,
ReaderCallback callback 
)
+
+

Asynchronously create a topic reader with the customized ReaderConfiguration for reading messages from the specified topic.

+

The Reader provides a low-level abstraction that allows for manual positioning in the topic, without using a subscription. The reader can only work on non-partitioned topics.

+

The initial reader positioning is done by specifying a message ID. The options are as below:

    +
  • +MessageId.earliest : start reading from the earliest message available in the topic
    • +
  • +MessageId.latest : start reading from the latest topic, only getting messages published after the reader was created
    • +
  • +MessageId : when passing a particular message ID, the reader positions itself on that is the message next to the specified messageId.
    • +
+
Parameters
+ + + + +
topicthe name of the topic where to read
startMessageIdthe message ID where the reader positions itself. The first message returned is the one after the specified startMessageId
confthe ReaderConfiguration object
+
+
+
Returns
the Reader object
+ +
+
+ +

◆ createTableView()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
Result pulsar::Client::createTableView (const std::string & topic,
const TableViewConfiguration & conf,
TableView & tableView 
)
+
+

Create a table view with given TableViewConfiguration for specified topic.

+

The TableView provides a key-value map view of a compacted topic. Messages without keys will be ignored.

+
Parameters
+ + + + +
topicThe name of the topic.
confThe TableViewConfiguration object
tableViewThe TableView object
+
+
+
Returns
Returned when the TableView is successfully linked to the topic and the map is built from a message that already exists
+ +
+
+ +

◆ createTableViewAsync()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void pulsar::Client::createTableViewAsync (const std::string & topic,
const TableViewConfiguration & conf,
TableViewCallback callBack 
)
+
+

Async create a table view with given TableViewConfiguration for specified topic.

+

The TableView provides a key-value map view of a compacted topic. Messages without keys will be ignored.

+
Parameters
+ + + + +
topicThe name of the topic.
confThe TableViewConfiguration object
callBackThe callback that is triggered when the TableView is successfully linked to the topic and the map is built from a message that already exists
+
+
+ +
+
+ +

◆ getNumberOfConsumers()

+ +
+
+ + + + + + + +
uint64_t pulsar::Client::getNumberOfConsumers ()
+
+ +

Get the number of alive consumers on the current client.

+
Returns
The number of alive consumers on the current client.
+ +
+
+ +

◆ getNumberOfProducers()

+ +
+
+ + + + + + + +
uint64_t pulsar::Client::getNumberOfProducers ()
+
+ +

Get the number of alive producers on the current client.

+
Returns
The number of alive producers on the current client.
+ +
+
+ +

◆ getPartitionsForTopic()

+ +
+
+ + + + + + + + + + + + + + + + + + +
Result pulsar::Client::getPartitionsForTopic (const std::string & topic,
std::vector< std::string > & partitions 
)
+
+

Get the list of partitions for a given topic.

+

If the topic is partitioned, this will return a list of partition names. If the topic is not partitioned, the returned list will contain the topic name itself.

+

This can be used to discover the partitions and create Reader, Consumer or Producer instances directly on a particular partition.

+
Parameters
+ + +
topicthe topic name
+
+
+
Since
2.3.0
+ +
+
+ +

◆ getPartitionsForTopicAsync()

+ +
+
+ + + + + + + + + + + + + + + + + + +
void pulsar::Client::getPartitionsForTopicAsync (const std::string & topic,
GetPartitionsCallback callback 
)
+
+

Get the list of partitions for a given topic in asynchronous mode.

+

If the topic is partitioned, this will return a list of partition names. If the topic is not partitioned, the returned list will contain the topic name itself.

+

This can be used to discover the partitions and create Reader, Consumer or Producer instances directly on a particular partition.

+
Parameters
+ + + +
topicthe topic name
callbackthe callback that will be invoked when the list of partitions is available
+
+
+
Since
2.3.0
+ +
+
+ +

◆ getSchemaInfoAsync()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void pulsar::Client::getSchemaInfoAsync (const std::string & topic,
int64_t version,
std::function< void(Result, const SchemaInfo &)> callback 
)
+
+

Asynchronously get the SchemaInfo of a topic and a specific version.

+

@topic the topic name

Version
the schema version, see Message::getLongSchemaVersion @callback the callback that is triggered when the SchemaInfo is retrieved successfully or not
+ +
+
+ +

◆ shutdown()

+ +
+
+ + + + + + + +
void pulsar::Client::shutdown ()
+
+

Perform immediate shutdown of Pulsar client.

+

Release all resources and close all producer, consumer, and readers without waiting for ongoing operations to complete.

+ +
+
+ +

◆ subscribe() [1/4]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Result pulsar::Client::subscribe (const std::string & topic,
const std::string & subscriptionName,
const ConsumerConfiguration & conf,
Consumer & consumer 
)
+
+

Subscribe to a given topic and subscription combination with the customized ConsumerConfiguration

+
Parameters
+ + + + +
topicthe topic name
subscriptionNamethe subscription name
[out]consumerthe consumer instance to be returned
+
+
+
Returns
ResultOk if it subscribes to the topic successfully
+ +
+
+ +

◆ subscribe() [2/4]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
Result pulsar::Client::subscribe (const std::string & topic,
const std::string & subscriptionName,
Consumer & consumer 
)
+
+

Subscribe to a given topic and subscription combination with the default ConsumerConfiguration

+
Parameters
+ + + + +
topicthe topic name
subscriptionNamethe subscription name
[out]consumerthe consumer instance to be returned
+
+
+
Returns
ResultOk if it subscribes to the topic successfully
+ +
+
+ +

◆ subscribe() [3/4]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Result pulsar::Client::subscribe (const std::vector< std::string > & topics,
const std::string & subscriptionName,
const ConsumerConfiguration & conf,
Consumer & consumer 
)
+
+

Subscribe to multiple topics with the customized ConsumerConfiguration under the same namespace

+
Parameters
+ + + + + +
topicsa list of topic names to subscribe to
subscriptionNamethe subscription name
confthe customized ConsumerConfiguration
[out]consumerthe consumer instance to be returned
+
+
+ +
+
+ +

◆ subscribe() [4/4]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
Result pulsar::Client::subscribe (const std::vector< std::string > & topics,
const std::string & subscriptionName,
Consumer & consumer 
)
+
+

Subscribe to multiple topics under the same namespace.

+
Parameters
+ + + + +
topicsa list of topic names to subscribe to
subscriptionNamethe subscription name
[out]consumerthe consumer instance to be returned
+
+
+ +
+
+ +

◆ subscribeAsync() [1/4]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void pulsar::Client::subscribeAsync (const std::string & topic,
const std::string & subscriptionName,
const ConsumerConfiguration & conf,
SubscribeCallback callback 
)
+
+

Asynchronously subscribe to a given topic and subscription combination with the customized ConsumerConfiguration

+
Parameters
+ + + + + +
topicthe topic name
subscriptionNamethe subscription name
confthe customized ConsumerConfiguration
callbackthe callback that is triggered when a given topic and subscription combination with the customized ConsumerConfiguration are asynchronously subscribed successfully or not
+
+
+ +
+
+ +

◆ subscribeAsync() [2/4]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void pulsar::Client::subscribeAsync (const std::string & topic,
const std::string & subscriptionName,
SubscribeCallback callback 
)
+
+

Asynchronously subscribe to a given topic and subscription combination with the default ConsumerConfiguration

+
Parameters
+ + + + +
topicthe topic name
subscriptionNamethe subscription name
callbackthe callback that is triggered when a given topic and subscription combination with the default ConsumerConfiguration are asynchronously subscribed successfully or not
+
+
+ +
+
+ +

◆ subscribeAsync() [3/4]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void pulsar::Client::subscribeAsync (const std::vector< std::string > & topics,
const std::string & subscriptionName,
const ConsumerConfiguration & conf,
SubscribeCallback callback 
)
+
+

Asynchronously subscribe to a list of topics and subscription combination using the customized ConsumerConfiguration

+
Parameters
+ + + + + +
topicsthe topic list
subscriptionNamethe subscription name
confthe customized ConsumerConfiguration
callbackthe callback that is triggered when a list of topics and subscription combination using the customized ConsumerConfiguration are asynchronously subscribed successfully or not
+
+
+ +
+
+ +

◆ subscribeAsync() [4/4]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void pulsar::Client::subscribeAsync (const std::vector< std::string > & topics,
const std::string & subscriptionName,
SubscribeCallback callback 
)
+
+

Asynchronously subscribe to a list of topics and subscription combination using the default ConsumerConfiguration

+
Parameters
+ + + + +
topicsthe topic list
subscriptionNamethe subscription name
callbackthe callback that is triggered when a list of topics and subscription combination using the default ConsumerConfiguration are asynchronously subscribed successfully or not
+
+
+ +
+
+ +

◆ subscribeWithRegex() [1/2]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Result pulsar::Client::subscribeWithRegex (const std::string & regexPattern,
const std::string & subscriptionName,
const ConsumerConfiguration & conf,
Consumer & consumer 
)
+
+

Subscribe to multiple topics (which match given regexPatterns) with the customized ConsumerConfiguration under the same namespace

+ +
+
+ +

◆ subscribeWithRegex() [2/2]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
Result pulsar::Client::subscribeWithRegex (const std::string & regexPattern,
const std::string & subscriptionName,
Consumer & consumer 
)
+
+

Subscribe to multiple topics, which match given regexPattern, under the same namespace.

+ +
+
+ +

◆ subscribeWithRegexAsync() [1/2]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void pulsar::Client::subscribeWithRegexAsync (const std::string & regexPattern,
const std::string & subscriptionName,
const ConsumerConfiguration & conf,
SubscribeCallback callback 
)
+
+

Asynchronously subscribe to multiple topics (which match given regexPatterns) with the customized ConsumerConfiguration under the same namespace

+
Parameters
+ + + + + +
regexPatternthe regular expression for topics pattern
subscriptionNamethe subscription name
confthe ConsumerConfiguration
callbackthe callback that is triggered when multiple topics with the customized ConsumerConfiguration under the same namespace are asynchronously subscribed successfully or not
+
+
+ +
+
+ +

◆ subscribeWithRegexAsync() [2/2]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void pulsar::Client::subscribeWithRegexAsync (const std::string & regexPattern,
const std::string & subscriptionName,
SubscribeCallback callback 
)
+
+

Asynchronously subscribe to multiple topics (which match given regexPatterns) with the default ConsumerConfiguration under the same namespace

+
See also
subscribeWithRegexAsync(const std::string&, const std::string&, const ConsumerConfiguration&, +SubscribeCallback)
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_client_configuration-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_client_configuration-members.html new file mode 100644 index 000000000000..d03d06ed6217 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_client_configuration-members.html @@ -0,0 +1,142 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::ClientConfiguration Member List
+
+
+ +

This is the complete list of members for pulsar::ClientConfiguration, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ClientConfiguration() (defined in pulsar::ClientConfiguration)pulsar::ClientConfiguration
ClientConfiguration(const ClientConfiguration &) (defined in pulsar::ClientConfiguration)pulsar::ClientConfiguration
ClientImpl (defined in pulsar::ClientConfiguration)pulsar::ClientConfigurationfriend
getAuth() constpulsar::ClientConfiguration
getConcurrentLookupRequest() constpulsar::ClientConfiguration
getConnectionsPerBroker() constpulsar::ClientConfiguration
getConnectionTimeout() constpulsar::ClientConfiguration
getInitialBackoffIntervalMs() constpulsar::ClientConfiguration
getIOThreads() constpulsar::ClientConfiguration
getListenerName() constpulsar::ClientConfiguration
getMaxBackoffIntervalMs() constpulsar::ClientConfiguration
getMaxLookupRedirects() constpulsar::ClientConfiguration
getMemoryLimit() constpulsar::ClientConfiguration
getMessageListenerThreads() constpulsar::ClientConfiguration
getOperationTimeoutSeconds() constpulsar::ClientConfiguration
getPartitionsUpdateInterval() constpulsar::ClientConfiguration
getProxyProtocol() const (defined in pulsar::ClientConfiguration)pulsar::ClientConfiguration
getProxyServiceUrl() const (defined in pulsar::ClientConfiguration)pulsar::ClientConfiguration
getStatsIntervalInSeconds() constpulsar::ClientConfiguration
getTlsCertificateFilePath() constpulsar::ClientConfiguration
getTlsPrivateKeyFilePath() constpulsar::ClientConfiguration
getTlsTrustCertsFilePath() constpulsar::ClientConfiguration
isTlsAllowInsecureConnection() constpulsar::ClientConfiguration
isUseTls() constpulsar::ClientConfiguration
isValidateHostName() constpulsar::ClientConfiguration
operator=(const ClientConfiguration &) (defined in pulsar::ClientConfiguration)pulsar::ClientConfiguration
ProxyProtocol enum name (defined in pulsar::ClientConfiguration)pulsar::ClientConfiguration
PulsarWrapper (defined in pulsar::ClientConfiguration)pulsar::ClientConfigurationfriend
setAuth(const AuthenticationPtr &authentication)pulsar::ClientConfiguration
setConcurrentLookupRequest(int concurrentLookupRequest)pulsar::ClientConfiguration
setConnectionsPerBroker(int connectionsPerBroker)pulsar::ClientConfiguration
setConnectionTimeout(int timeoutMs)pulsar::ClientConfiguration
setInitialBackoffIntervalMs(int initialBackoffIntervalMs)pulsar::ClientConfiguration
setIOThreads(int threads)pulsar::ClientConfiguration
setListenerName(const std::string &listenerName)pulsar::ClientConfiguration
setLogger(LoggerFactory *loggerFactory)pulsar::ClientConfiguration
setMaxBackoffIntervalMs(int maxBackoffIntervalMs)pulsar::ClientConfiguration
setMaxLookupRedirects(int maxLookupRedirects)pulsar::ClientConfiguration
setMemoryLimit(uint64_t memoryLimitBytes)pulsar::ClientConfiguration
setMessageListenerThreads(int threads)pulsar::ClientConfiguration
setOperationTimeoutSeconds(int timeout)pulsar::ClientConfiguration
setPartititionsUpdateInterval(unsigned int intervalInSeconds)pulsar::ClientConfiguration
setProxyProtocol(ProxyProtocol proxyProtocol)pulsar::ClientConfiguration
setProxyServiceUrl(const std::string &proxyServiceUrl)pulsar::ClientConfiguration
setStatsIntervalInSeconds(const unsigned int &)pulsar::ClientConfiguration
setTlsAllowInsecureConnection(bool allowInsecure)pulsar::ClientConfiguration
setTlsCertificateFilePath(const std::string &tlsCertificateFilePath)pulsar::ClientConfiguration
setTlsPrivateKeyFilePath(const std::string &tlsKeyFilePath)pulsar::ClientConfiguration
setTlsTrustCertsFilePath(const std::string &tlsTrustCertsFilePath)pulsar::ClientConfiguration
setUseTls(bool useTls)pulsar::ClientConfiguration
setValidateHostName(bool validateHostName)pulsar::ClientConfiguration
SNI enum value (defined in pulsar::ClientConfiguration)pulsar::ClientConfiguration
~ClientConfiguration() (defined in pulsar::ClientConfiguration)pulsar::ClientConfiguration
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_client_configuration.html b/static/api/cpp/3.5.x/classpulsar_1_1_client_configuration.html new file mode 100644 index 000000000000..43de2dcb0022 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_client_configuration.html @@ -0,0 +1,1151 @@ + + + + + + + +pulsar-client-cpp: pulsar::ClientConfiguration Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Types | +Public Member Functions | +Friends | +List of all members
+
pulsar::ClientConfiguration Class Reference
+
+
+ + + + +

+Public Types

enum  ProxyProtocol { SNI = 0 + }
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ ClientConfiguration (const ClientConfiguration &)
 
+ClientConfiguration & operator= (const ClientConfiguration &)
 
ClientConfiguration & setMemoryLimit (uint64_t memoryLimitBytes)
 
uint64_t getMemoryLimit () const
 
ClientConfiguration & setConnectionsPerBroker (int connectionsPerBroker)
 
int getConnectionsPerBroker () const
 
ClientConfiguration & setAuth (const AuthenticationPtr &authentication)
 
Authentication & getAuth () const
 
ClientConfiguration & setOperationTimeoutSeconds (int timeout)
 
int getOperationTimeoutSeconds () const
 
ClientConfiguration & setIOThreads (int threads)
 
int getIOThreads () const
 
ClientConfiguration & setMessageListenerThreads (int threads)
 
int getMessageListenerThreads () const
 
ClientConfiguration & setConcurrentLookupRequest (int concurrentLookupRequest)
 
int getConcurrentLookupRequest () const
 
ClientConfiguration & setMaxLookupRedirects (int maxLookupRedirects)
 
int getMaxLookupRedirects () const
 
ClientConfiguration & setInitialBackoffIntervalMs (int initialBackoffIntervalMs)
 
int getInitialBackoffIntervalMs () const
 
ClientConfiguration & setMaxBackoffIntervalMs (int maxBackoffIntervalMs)
 
int getMaxBackoffIntervalMs () const
 
ClientConfiguration & setLogger (LoggerFactory *loggerFactory)
 
ClientConfiguration & setUseTls (bool useTls)
 
bool isUseTls () const
 
ClientConfiguration & setTlsPrivateKeyFilePath (const std::string &tlsKeyFilePath)
 
const std::string & getTlsPrivateKeyFilePath () const
 
ClientConfiguration & setTlsCertificateFilePath (const std::string &tlsCertificateFilePath)
 
const std::string & getTlsCertificateFilePath () const
 
ClientConfiguration & setTlsTrustCertsFilePath (const std::string &tlsTrustCertsFilePath)
 
const std::string & getTlsTrustCertsFilePath () const
 
ClientConfiguration & setTlsAllowInsecureConnection (bool allowInsecure)
 
bool isTlsAllowInsecureConnection () const
 
ClientConfiguration & setValidateHostName (bool validateHostName)
 
bool isValidateHostName () const
 
ClientConfiguration & setListenerName (const std::string &listenerName)
 
const std::string & getListenerName () const
 
ClientConfiguration & setStatsIntervalInSeconds (const unsigned int &)
 
const unsigned int & getStatsIntervalInSeconds () const
 
ClientConfiguration & setPartititionsUpdateInterval (unsigned int intervalInSeconds)
 
unsigned int getPartitionsUpdateInterval () const
 
ClientConfiguration & setConnectionTimeout (int timeoutMs)
 
ClientConfiguration & setProxyServiceUrl (const std::string &proxyServiceUrl)
 
+const std::string & getProxyServiceUrl () const
 
ClientConfiguration & setProxyProtocol (ProxyProtocol proxyProtocol)
 
+ProxyProtocol getProxyProtocol () const
 
int getConnectionTimeout () const
 
+ + + + + +

+Friends

+class ClientImpl
 
+class PulsarWrapper
 
+

Member Function Documentation

+ +

◆ getAuth()

+ +
+
+ + + + + + + +
Authentication & pulsar::ClientConfiguration::getAuth () const
+
+
Returns
the authentication data
+ +
+
+ +

◆ getConcurrentLookupRequest()

+ +
+
+ + + + + + + +
int pulsar::ClientConfiguration::getConcurrentLookupRequest () const
+
+
Returns
Get configured total allowed concurrent lookup-request.
+ +
+
+ +

◆ getConnectionsPerBroker()

+ +
+
+ + + + + + + +
int pulsar::ClientConfiguration::getConnectionsPerBroker () const
+
+
Returns
the max number of connection that the client library will open to a single broker
+ +
+
+ +

◆ getConnectionTimeout()

+ +
+
+ + + + + + + +
int pulsar::ClientConfiguration::getConnectionTimeout () const
+
+

The getter associated with setConnectionTimeout().

+ +
+
+ +

◆ getInitialBackoffIntervalMs()

+ +
+
+ + + + + + + +
int pulsar::ClientConfiguration::getInitialBackoffIntervalMs () const
+
+
Returns
Get initial backoff interval in milliseconds.
+ +
+
+ +

◆ getIOThreads()

+ +
+
+ + + + + + + +
int pulsar::ClientConfiguration::getIOThreads () const
+
+
Returns
the number of IO threads to use
+ +
+
+ +

◆ getListenerName()

+ +
+
+ + + + + + + +
const std::string & pulsar::ClientConfiguration::getListenerName () const
+
+
Returns
the listener name for the broker
+ +
+
+ +

◆ getMaxBackoffIntervalMs()

+ +
+
+ + + + + + + +
int pulsar::ClientConfiguration::getMaxBackoffIntervalMs () const
+
+
Returns
Get max backoff interval in milliseconds.
+ +
+
+ +

◆ getMaxLookupRedirects()

+ +
+
+ + + + + + + +
int pulsar::ClientConfiguration::getMaxLookupRedirects () const
+
+
Returns
Get configured total allowed lookup redirecting.
+ +
+
+ +

◆ getMemoryLimit()

+ +
+
+ + + + + + + +
uint64_t pulsar::ClientConfiguration::getMemoryLimit () const
+
+
Returns
the client memory limit in bytes
+ +
+
+ +

◆ getMessageListenerThreads()

+ +
+
+ + + + + + + +
int pulsar::ClientConfiguration::getMessageListenerThreads () const
+
+
Returns
the number of IO threads to use
+ +
+
+ +

◆ getOperationTimeoutSeconds()

+ +
+
+ + + + + + + +
int pulsar::ClientConfiguration::getOperationTimeoutSeconds () const
+
+
Returns
the client operations timeout in seconds
+ +
+
+ +

◆ getPartitionsUpdateInterval()

+ +
+
+ + + + + + + +
unsigned int pulsar::ClientConfiguration::getPartitionsUpdateInterval () const
+
+

Get partitions update interval in seconds.

+ +
+
+ +

◆ getStatsIntervalInSeconds()

+ +
+
+ + + + + + + +
const unsigned int & pulsar::ClientConfiguration::getStatsIntervalInSeconds () const
+
+
Returns
the stats interval configured for the client
+ +
+
+ +

◆ getTlsCertificateFilePath()

+ +
+
+ + + + + + + +
const std::string & pulsar::ClientConfiguration::getTlsCertificateFilePath () const
+
+
Returns
the path to the TLS certificate file
+ +
+
+ +

◆ getTlsPrivateKeyFilePath()

+ +
+
+ + + + + + + +
const std::string & pulsar::ClientConfiguration::getTlsPrivateKeyFilePath () const
+
+
Returns
the path to the TLS private key file
+ +
+
+ +

◆ getTlsTrustCertsFilePath()

+ +
+
+ + + + + + + +
const std::string & pulsar::ClientConfiguration::getTlsTrustCertsFilePath () const
+
+
Returns
the path to the trusted TLS certificate file
+ +
+
+ +

◆ isTlsAllowInsecureConnection()

+ +
+
+ + + + + + + +
bool pulsar::ClientConfiguration::isTlsAllowInsecureConnection () const
+
+
Returns
whether the Pulsar client accepts untrusted TLS certificates from brokers
+ +
+
+ +

◆ isUseTls()

+ +
+
+ + + + + + + +
bool pulsar::ClientConfiguration::isUseTls () const
+
+
Returns
whether the TLS encryption is used on the connections
+ +
+
+ +

◆ isValidateHostName()

+ +
+
+ + + + + + + +
bool pulsar::ClientConfiguration::isValidateHostName () const
+
+
Returns
true if the TLS hostname verification is enabled
+ +
+
+ +

◆ setAuth()

+ +
+
+ + + + + + + + +
ClientConfiguration & pulsar::ClientConfiguration::setAuth (const AuthenticationPtr & authentication)
+
+

Set the authentication method to be used with the broker

+
Parameters
+ + +
authenticationthe authentication data to use
+
+
+ +
+
+ +

◆ setConcurrentLookupRequest()

+ +
+
+ + + + + + + + +
ClientConfiguration & pulsar::ClientConfiguration::setConcurrentLookupRequest (int concurrentLookupRequest)
+
+

Number of concurrent lookup-requests allowed on each broker-connection to prevent overload on broker. (default: 50000) It should be configured with higher value only in case of it requires to produce/subscribe on thousands of topic using created PulsarClient

+
Parameters
+ + +
concurrentLookupRequest
+
+
+ +
+
+ +

◆ setConnectionsPerBroker()

+ +
+
+ + + + + + + + +
ClientConfiguration & pulsar::ClientConfiguration::setConnectionsPerBroker (int connectionsPerBroker)
+
+

Sets the max number of connection that the client library will open to a single broker. By default, the connection pool will use a single connection for all the producers and consumers. Increasing this parameter may improve throughput when using many producers over a high latency connection.

+
Parameters
+ + +
connectionsPerBrokermax number of connections per broker (needs to be greater than 0)
+
+
+ +
+
+ +

◆ setConnectionTimeout()

+ +
+
+ + + + + + + + +
ClientConfiguration & pulsar::ClientConfiguration::setConnectionTimeout (int timeoutMs)
+
+

Set the duration of time to wait for a connection to a broker to be established. If the duration passes without a response from the broker, the connection attempt is dropped.

+

Default: 10000

+
Parameters
+ + +
timeoutMsthe duration in milliseconds
+
+
+
Returns
+ +
+
+ +

◆ setInitialBackoffIntervalMs()

+ +
+
+ + + + + + + + +
ClientConfiguration & pulsar::ClientConfiguration::setInitialBackoffIntervalMs (int initialBackoffIntervalMs)
+
+

Initial backoff interval in milliseconds. (default: 100)

+
Parameters
+ + +
initialBackoffIntervalMs
+
+
+ +
+
+ +

◆ setIOThreads()

+ +
+
+ + + + + + + + +
ClientConfiguration & pulsar::ClientConfiguration::setIOThreads (int threads)
+
+

Set the number of IO threads to be used by the Pulsar client. Default is 1 thread.

+
Parameters
+ + +
threadsnumber of threads
+
+
+ +
+
+ +

◆ setListenerName()

+ +
+
+ + + + + + + + +
ClientConfiguration & pulsar::ClientConfiguration::setListenerName (const std::string & listenerName)
+
+

Configure the listener name that the broker returns the corresponding advertisedListener.

+
Parameters
+ + +
namethe listener name
+
+
+ +
+
+ +

◆ setLogger()

+ +
+
+ + + + + + + + +
ClientConfiguration & pulsar::ClientConfiguration::setLogger (LoggerFactory * loggerFactory)
+
+

Configure a custom logger backend to route of Pulsar client library to a different logger implementation.

+

By default, log messages are printed on standard output.

+

When passed in, the configuration takes ownership of the loggerFactory object. The logger factory can only be set once per process. Any subsequent calls to set the logger factory will have no effect, though the logger factory object will be cleaned up.

+ +
+
+ +

◆ setMaxBackoffIntervalMs()

+ +
+
+ + + + + + + + +
ClientConfiguration & pulsar::ClientConfiguration::setMaxBackoffIntervalMs (int maxBackoffIntervalMs)
+
+

Max backoff interval in milliseconds. (default: 60000)

+
Parameters
+ + +
maxBackoffIntervalMs
+
+
+ +
+
+ +

◆ setMaxLookupRedirects()

+ +
+
+ + + + + + + + +
ClientConfiguration & pulsar::ClientConfiguration::setMaxLookupRedirects (int maxLookupRedirects)
+
+

Max number of lookup redirection allowed on each look request to prevent overload on broker. (default: 20)

+
Parameters
+ + +
maxLookupRedirects
+
+
+ +
+
+ +

◆ setMemoryLimit()

+ +
+
+ + + + + + + + +
ClientConfiguration & pulsar::ClientConfiguration::setMemoryLimit (uint64_t memoryLimitBytes)
+
+

Configure a limit on the amount of memory that will be allocated by this client instance. Setting this to 0 will disable the limit. By default this is disabled.

+
Parameters
+ + +
memoryLimitBytesthe memory limit
+
+
+ +
+
+ +

◆ setMessageListenerThreads()

+ +
+
+ + + + + + + + +
ClientConfiguration & pulsar::ClientConfiguration::setMessageListenerThreads (int threads)
+
+

Set the number of threads to be used by the Pulsar client when delivering messages through message listener. Default is 1 thread per Pulsar client.

+

If using more than 1 thread, messages for distinct MessageListener will be delivered in different threads, however a single MessageListener will always be assigned to the same thread.

+
Parameters
+ + +
threadsnumber of threads
+
+
+ +
+
+ +

◆ setOperationTimeoutSeconds()

+ +
+
+ + + + + + + + +
ClientConfiguration & pulsar::ClientConfiguration::setOperationTimeoutSeconds (int timeout)
+
+

Set timeout on client operations (subscribe, create producer, close, unsubscribe) Default is 30 seconds.

+
Parameters
+ + +
timeoutthe timeout after which the operation will be considered as failed
+
+
+ +
+
+ +

◆ setPartititionsUpdateInterval()

+ +
+
+ + + + + + + + +
ClientConfiguration & pulsar::ClientConfiguration::setPartititionsUpdateInterval (unsigned int intervalInSeconds)
+
+

Set partitions update interval in seconds. If a partitioned topic is produced or subscribed and intervalInSeconds is not 0, every intervalInSeconds seconds the partition number will be retrieved by sending lookup requests. If partition number has been increased, more producer/consumer of increased partitions will be created. Default is 60 seconds.

+
Parameters
+ + +
intervalInSecondsthe seconds between two lookup request for partitioned topic's metadata
+
+
+ +
+
+ +

◆ setProxyProtocol()

+ +
+
+ + + + + + + + +
ClientConfiguration & pulsar::ClientConfiguration::setProxyProtocol (ProxyProtocol proxyProtocol)
+
+

Set appropriate proxy-protocol along with proxy-service url. Currently Pulsar supports SNI proxy routing.

+

SNI routing: https://docs.trafficserver.apache.org/en/latest/admin-guide/layer-4-routing.en.html#sni-routing.

+
Parameters
+ + +
proxyProtocolpossible options (SNI)
+
+
+
Returns
+ +
+
+ +

◆ setProxyServiceUrl()

+ +
+
+ + + + + + + + +
ClientConfiguration & pulsar::ClientConfiguration::setProxyServiceUrl (const std::string & proxyServiceUrl)
+
+

Set proxy-service url when client would like to connect to broker via proxy. Client must configure both proxyServiceUrl and appropriate proxyProtocol.

+

Example: pulsar+ssl://ats-proxy.example.com:4443

+
Parameters
+ + +
proxyServiceUrlproxy url to connect with broker
+
+
+
Returns
+ +
+
+ +

◆ setStatsIntervalInSeconds()

+ +
+
+ + + + + + + + +
ClientConfiguration & pulsar::ClientConfiguration::setStatsIntervalInSeconds (const unsigned int & )
+
+

Initialize stats interval in seconds. Stats are printed and reset after every statsIntervalInSeconds.

+

Default: 600

+

Set to 0 means disabling stats collection.

+ +
+
+ +

◆ setTlsAllowInsecureConnection()

+ +
+
+ + + + + + + + +
ClientConfiguration & pulsar::ClientConfiguration::setTlsAllowInsecureConnection (bool allowInsecure)
+
+

Configure whether the Pulsar client accepts untrusted TLS certificates from brokers.

+

The default value is false.

+
Parameters
+ + +
tlsAllowInsecureConnection
+
+
+ +
+
+ +

◆ setTlsCertificateFilePath()

+ +
+
+ + + + + + + + +
ClientConfiguration & pulsar::ClientConfiguration::setTlsCertificateFilePath (const std::string & tlsCertificateFilePath)
+
+

Set the path to the TLS certificate file.

+
Parameters
+ + +
tlsCertificateFilePath
+
+
+ +
+
+ +

◆ setTlsPrivateKeyFilePath()

+ +
+
+ + + + + + + + +
ClientConfiguration & pulsar::ClientConfiguration::setTlsPrivateKeyFilePath (const std::string & tlsKeyFilePath)
+
+

Set the path to the TLS private key file.

+
Parameters
+ + +
tlsPrivateKeyFilePath
+
+
+ +
+
+ +

◆ setTlsTrustCertsFilePath()

+ +
+
+ + + + + + + + +
ClientConfiguration & pulsar::ClientConfiguration::setTlsTrustCertsFilePath (const std::string & tlsTrustCertsFilePath)
+
+

Set the path to the trusted TLS certificate file.

+
Parameters
+ + +
tlsTrustCertsFilePath
+
+
+ +
+
+ +

◆ setUseTls()

+ +
+
+ + + + + + + + +
ClientConfiguration & pulsar::ClientConfiguration::setUseTls (bool useTls)
+
+

Configure whether to use the TLS encryption on the connections.

+

The default value is false.

+
Parameters
+ + +
useTls
+
+
+ +
+
+ +

◆ setValidateHostName()

+ +
+
+ + + + + + + + +
ClientConfiguration & pulsar::ClientConfiguration::setValidateHostName (bool validateHostName)
+
+

Configure whether it allows validating hostname verification when a client connects to a broker over TLS.

+

It validates the incoming x509 certificate and matches the provided hostname (CN/SAN) with the expected broker's hostname. It follows the server identity hostname verification in RFC 2818.

+

The default value is false.

+
See also
RFC 2818.
+
Parameters
+ + +
validateHostNamewhether to enable the TLS hostname verification
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_console_logger_factory-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_console_logger_factory-members.html new file mode 100644 index 000000000000..9f8bfbaac857 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_console_logger_factory-members.html @@ -0,0 +1,93 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::ConsoleLoggerFactory Member List
+
+
+ +

This is the complete list of members for pulsar::ConsoleLoggerFactory, including all inherited members.

+ + + + + +
ConsoleLoggerFactory(Logger::Level level=Logger::LEVEL_INFO) (defined in pulsar::ConsoleLoggerFactory)pulsar::ConsoleLoggerFactoryexplicit
getLogger(const std::string &fileName) overridepulsar::ConsoleLoggerFactoryvirtual
~ConsoleLoggerFactory() (defined in pulsar::ConsoleLoggerFactory)pulsar::ConsoleLoggerFactory
~LoggerFactory() (defined in pulsar::LoggerFactory)pulsar::LoggerFactoryinlinevirtual
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_console_logger_factory.html b/static/api/cpp/3.5.x/classpulsar_1_1_console_logger_factory.html new file mode 100644 index 000000000000..0e2632d8989b --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_console_logger_factory.html @@ -0,0 +1,165 @@ + + + + + + + +pulsar-client-cpp: pulsar::ConsoleLoggerFactory Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +List of all members
+
pulsar::ConsoleLoggerFactory Class Reference
+
+
+ +

#include <ConsoleLoggerFactory.h>

+
+Inheritance diagram for pulsar::ConsoleLoggerFactory:
+
+
+ + +pulsar::LoggerFactory + +
+ + + + + + +

+Public Member Functions

+ ConsoleLoggerFactory (Logger::Level level=Logger::LEVEL_INFO)
 
Logger * getLogger (const std::string &fileName) override
 
+

Detailed Description

+

The default LoggerFactory of Client if USE_LOG4CXX macro was not defined during compilation.

+

The log format is "yyyy-MM-dd HH:mm:ss,SSS Z <level> <thread-id> <file>:<line> | <msg>", like

+
2021-03-24 17:35:46,571 +0800 INFO [0x10a951e00] ConnectionPool:85 | Created connection for ...
+

It uses std::cout to prints logs to standard output. You can use this factory class to change your log level simply.

+
++
+
#include <pulsar/ConsoleLoggerFactory.h>
+
+
ClientConfiguration conf;
+
conf.setLogger(new ConsoleLoggerFactory(Logger::LEVEL_DEBUG));
+
Client client("pulsar://localhost:6650", conf);
+
pulsar::ClientConfiguration
Definition ClientConfiguration.h:29
+
pulsar::ClientConfiguration::setLogger
ClientConfiguration & setLogger(LoggerFactory *loggerFactory)
+
pulsar::Client
Definition Client.h:49
+
pulsar::ConsoleLoggerFactory
Definition ConsoleLoggerFactory.h:49
+

Member Function Documentation

+ +

◆ getLogger()

+ +
+
+ + + + + +
+ + + + + + + + +
Logger * pulsar::ConsoleLoggerFactory::getLogger (const std::string & fileName)
+ 		+overridevirtual
+
+

Create a Logger that is created from the filename

+
Parameters
+ + +
fileNamethe filename that is used to construct the Logger
+
+
+
Returns
a pointer to the created Logger instance
+
Note
the pointer must be allocated with the new keyword in C++
+ +

Implements pulsar::LoggerFactory.

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_console_logger_factory.png b/static/api/cpp/3.5.x/classpulsar_1_1_console_logger_factory.png new file mode 100644 index 000000000000..66c2e2a28d09 Binary files /dev/null and b/static/api/cpp/3.5.x/classpulsar_1_1_console_logger_factory.png differ diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_consumer-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_consumer-members.html new file mode 100644 index 000000000000..e11d7b405186 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_consumer-members.html @@ -0,0 +1,136 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::Consumer Member List
+
+
+ +

This is the complete list of members for pulsar::Consumer, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
acknowledge(const Message &message)pulsar::Consumer
acknowledge(const MessageId &messageId)pulsar::Consumer
acknowledge(const MessageIdList &messageIdList)pulsar::Consumer
acknowledgeAsync(const Message &message, ResultCallback callback)pulsar::Consumer
acknowledgeAsync(const MessageId &messageId, ResultCallback callback)pulsar::Consumer
acknowledgeAsync(const MessageIdList &messageIdList, ResultCallback callback)pulsar::Consumer
acknowledgeCumulative(const Message &message)pulsar::Consumer
acknowledgeCumulative(const MessageId &messageId)pulsar::Consumer
acknowledgeCumulativeAsync(const Message &message, ResultCallback callback)pulsar::Consumer
acknowledgeCumulativeAsync(const MessageId &messageId, ResultCallback callback)pulsar::Consumer
batchReceive(Messages &msgs)pulsar::Consumer
batchReceiveAsync(BatchReceiveCallback callback)pulsar::Consumer
ClientImpl (defined in pulsar::Consumer)pulsar::Consumerfriend
close()pulsar::Consumer
closeAsync(ResultCallback callback)pulsar::Consumer
Consumer()pulsar::Consumer
ConsumerImpl (defined in pulsar::Consumer)pulsar::Consumerfriend
ConsumerTest (defined in pulsar::Consumer)pulsar::Consumerfriend
getBrokerConsumerStats(BrokerConsumerStats &brokerConsumerStats)pulsar::Consumer
getBrokerConsumerStatsAsync(BrokerConsumerStatsCallback callback)pulsar::Consumer
getConsumerName() constpulsar::Consumer
getLastMessageId(MessageId &messageId)pulsar::Consumer
getLastMessageIdAsync(GetLastMessageIdCallback callback)pulsar::Consumer
getSubscriptionName() constpulsar::Consumer
getTopic() constpulsar::Consumer
isConnected() constpulsar::Consumer
MultiTopicsConsumerImpl (defined in pulsar::Consumer)pulsar::Consumerfriend
negativeAcknowledge(const Message &message)pulsar::Consumer
negativeAcknowledge(const MessageId &messageId)pulsar::Consumer
pauseMessageListener()pulsar::Consumer
PulsarFriend (defined in pulsar::Consumer)pulsar::Consumerfriend
PulsarWrapper (defined in pulsar::Consumer)pulsar::Consumerfriend
receive(Message &msg)pulsar::Consumer
receive(TypedMessage< T > &msg, typename TypedMessage< T >::Decoder decoder) (defined in pulsar::Consumer)pulsar::Consumerinline
receive(Message &msg, int timeoutMs)pulsar::Consumer
receive(TypedMessage< T > &msg, int timeoutMs, typename TypedMessage< T >::Decoder decoder) (defined in pulsar::Consumer)pulsar::Consumerinline
receiveAsync(ReceiveCallback callback)pulsar::Consumer
receiveAsync(std::function< void(Result result, const TypedMessage< T > &)> callback, typename TypedMessage< T >::Decoder decoder) (defined in pulsar::Consumer)pulsar::Consumerinline
redeliverUnacknowledgedMessages()pulsar::Consumer
resumeMessageListener()pulsar::Consumer
seek(const MessageId &messageId)pulsar::Consumer
seek(uint64_t timestamp)pulsar::Consumer
seekAsync(const MessageId &messageId, ResultCallback callback)pulsar::Consumervirtual
seekAsync(uint64_t timestamp, ResultCallback callback)pulsar::Consumervirtual
unsubscribe()pulsar::Consumer
unsubscribeAsync(ResultCallback callback)pulsar::Consumer
~Consumer()=default (defined in pulsar::Consumer)pulsar::Consumervirtual
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_consumer.html b/static/api/cpp/3.5.x/classpulsar_1_1_consumer.html new file mode 100644 index 000000000000..b89970361b1a --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_consumer.html @@ -0,0 +1,1225 @@ + + + + + + + +pulsar-client-cpp: pulsar::Consumer Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +Friends | +List of all members
+
pulsar::Consumer Class Reference
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 Consumer ()
 
const std::string & getTopic () const
 
const std::string & getSubscriptionName () const
 
const std::string & getConsumerName () const
 
Result unsubscribe ()
 
void unsubscribeAsync (ResultCallback callback)
 
Result receive (Message &msg)
 
+template<typename T >
Result receive (TypedMessage< T > &msg, typename TypedMessage< T >::Decoder decoder)
 
Result receive (Message &msg, int timeoutMs)
 
+template<typename T >
Result receive (TypedMessage< T > &msg, int timeoutMs, typename TypedMessage< T >::Decoder decoder)
 
void receiveAsync (ReceiveCallback callback)
 
+template<typename T >
void receiveAsync (std::function< void(Result result, const TypedMessage< T > &)> callback, typename TypedMessage< T >::Decoder decoder)
 
Result batchReceive (Messages &msgs)
 
void batchReceiveAsync (BatchReceiveCallback callback)
 
Result acknowledge (const Message &message)
 
Result acknowledge (const MessageId &messageId)
 
Result acknowledge (const MessageIdList &messageIdList)
 
void acknowledgeAsync (const Message &message, ResultCallback callback)
 
void acknowledgeAsync (const MessageId &messageId, ResultCallback callback)
 
void acknowledgeAsync (const MessageIdList &messageIdList, ResultCallback callback)
 
Result acknowledgeCumulative (const Message &message)
 
Result acknowledgeCumulative (const MessageId &messageId)
 
void acknowledgeCumulativeAsync (const Message &message, ResultCallback callback)
 
void acknowledgeCumulativeAsync (const MessageId &messageId, ResultCallback callback)
 
void negativeAcknowledge (const Message &message)
 
void negativeAcknowledge (const MessageId &messageId)
 
Result close ()
 
void closeAsync (ResultCallback callback)
 
Result pauseMessageListener ()
 
Result resumeMessageListener ()
 
void redeliverUnacknowledgedMessages ()
 
Result getBrokerConsumerStats (BrokerConsumerStats &brokerConsumerStats)
 
void getBrokerConsumerStatsAsync (BrokerConsumerStatsCallback callback)
 
Result seek (const MessageId &messageId)
 
Result seek (uint64_t timestamp)
 
virtual void seekAsync (const MessageId &messageId, ResultCallback callback)
 
virtual void seekAsync (uint64_t timestamp, ResultCallback callback)
 
bool isConnected () const
 
void getLastMessageIdAsync (GetLastMessageIdCallback callback)
 
Result getLastMessageId (MessageId &messageId)
 
+ + + + + + + + + + + + + +

+Friends

+class PulsarFriend
 
+class PulsarWrapper
 
+class MultiTopicsConsumerImpl
 
+class ConsumerImpl
 
+class ClientImpl
 
+class ConsumerTest
 
+

Constructor & Destructor Documentation

+ +

◆ Consumer()

+ +
+
+ + + + + + + +
pulsar::Consumer::Consumer ()
+
+

Construct an uninitialized consumer object

+ +
+
+

Member Function Documentation

+ +

◆ acknowledge() [1/3]

+ +
+
+ + + + + + + + +
Result pulsar::Consumer::acknowledge (const Message & message)
+
+

Acknowledge the reception of a single message.

+

This method will block until an acknowledgement is sent to the broker. After that, the message will not be re-delivered to this consumer.

+
See also
asyncAcknowledge
+
Parameters
+ + +
messagethe message to acknowledge
+
+
+
Returns
ResultOk if the message was successfully acknowledged
+
+ResultError if there was a failure
+ +
+
+ +

◆ acknowledge() [2/3]

+ +
+
+ + + + + + + + +
Result pulsar::Consumer::acknowledge (const MessageId & messageId)
+
+

Acknowledge the reception of a single message.

+

This method is blocked until an acknowledgement is sent to the broker. After that, the message is not re-delivered to the consumer.

+
See also
asyncAcknowledge
+
Parameters
+ + +
messageIdthe MessageId to acknowledge
+
+
+
Returns
ResultOk if the messageId is successfully acknowledged
+ +
+
+ +

◆ acknowledge() [3/3]

+ +
+
+ + + + + + + + +
Result pulsar::Consumer::acknowledge (const MessageIdList & messageIdList)
+
+

Acknowledge the consumption of a list of message.

Parameters
+ + +
messageIdList
+
+
+ +
+
+ +

◆ acknowledgeAsync() [1/3]

+ +
+
+ + + + + + + + + + + + + + + + + + +
void pulsar::Consumer::acknowledgeAsync (const Message & message,
ResultCallback callback 
)
+
+

Asynchronously acknowledge the reception of a single message.

+

This method will initiate the operation and return immediately. The provided callback will be triggered when the operation is complete.

+
Parameters
+ + + +
messagethe message to acknowledge
callbackcallback that will be triggered when the message has been acknowledged
+
+
+ +
+
+ +

◆ acknowledgeAsync() [2/3]

+ +
+
+ + + + + + + + + + + + + + + + + + +
void pulsar::Consumer::acknowledgeAsync (const MessageId & messageId,
ResultCallback callback 
)
+
+

Asynchronously acknowledge the reception of a single message.

+

This method initiates the operation and returns the result immediately. The provided callback is triggered when the operation is completed.

+
Parameters
+ + + +
messageIdthe messageId to acknowledge
callbackthe callback that is triggered when the message has been acknowledged or not
+
+
+ +
+
+ +

◆ acknowledgeAsync() [3/3]

+ +
+
+ + + + + + + + + + + + + + + + + + +
void pulsar::Consumer::acknowledgeAsync (const MessageIdList & messageIdList,
ResultCallback callback 
)
+
+

Asynchronously acknowledge the consumption of a list of message.

Parameters
+ + + +
messageIdList
callbackthe callback that is triggered when the message has been acknowledged or not
+
+
+
Returns
+ +
+
+ +

◆ acknowledgeCumulative() [1/2]

+ +
+
+ + + + + + + + +
Result pulsar::Consumer::acknowledgeCumulative (const Message & message)
+
+

Acknowledge the reception of all the messages in the stream up to (and including) the provided message.

+

This method will block until an acknowledgement is sent to the broker. After that, the messages will not be re-delivered to this consumer.

+

Cumulative acknowledge cannot be used when the consumer type is set to ConsumerShared.

+

It's equivalent to calling asyncAcknowledgeCumulative(const Message&, ResultCallback) and waiting for the callback to be triggered.

+
Parameters
+ + +
messagethe last message in the stream to acknowledge
+
+
+
Returns
ResultOk if the message was successfully acknowledged. All previously delivered messages for this topic are also acknowledged.
+
+ResultError if there was a failure
+ +
+
+ +

◆ acknowledgeCumulative() [2/2]

+ +
+
+ + + + + + + + +
Result pulsar::Consumer::acknowledgeCumulative (const MessageId & messageId)
+
+

Acknowledge the reception of all the messages in the stream up to (and including) the provided message.

+

This method is blocked until an acknowledgement is sent to the broker. After that, the message is not re-delivered to this consumer.

+

Cumulative acknowledge cannot be used when the consumer type is set to ConsumerShared.

+

It is equivalent to calling the asyncAcknowledgeCumulative(const Message&, ResultCallback) method and waiting for the callback to be triggered.

+
Parameters
+ + +
messageIdthe last messageId in the stream to acknowledge
+
+
+
Returns
ResultOk if the message is successfully acknowledged. All previously delivered messages for this topic are also acknowledged.
+ +
+
+ +

◆ acknowledgeCumulativeAsync() [1/2]

+ +
+
+ + + + + + + + + + + + + + + + + + +
void pulsar::Consumer::acknowledgeCumulativeAsync (const Message & message,
ResultCallback callback 
)
+
+

Asynchronously acknowledge the reception of all the messages in the stream up to (and including) the provided message.

+

This method will initiate the operation and return immediately. The provided callback will be triggered when the operation is complete.

+
Parameters
+ + + +
messagethe message to acknowledge
callbackcallback that will be triggered when the message has been acknowledged
+
+
+ +
+
+ +

◆ acknowledgeCumulativeAsync() [2/2]

+ +
+
+ + + + + + + + + + + + + + + + + + +
void pulsar::Consumer::acknowledgeCumulativeAsync (const MessageId & messageId,
ResultCallback callback 
)
+
+

Asynchronously acknowledge the reception of all the messages in the stream up to (and including) the provided message.

+

This method initiates the operation and returns the result immediately. The provided callback is triggered when the operation is completed.

+
Parameters
+ + + +
messageIdthe messageId to acknowledge
callbackthe callback that is triggered when the message has been acknowledged or not
+
+
+ +
+
+ +

◆ batchReceive()

+ +
+
+ + + + + + + + +
Result pulsar::Consumer::batchReceive (Messages & msgs)
+
+

Batch receiving messages.

+

This calls blocks until has enough messages or wait timeout, more details to see BatchReceivePolicy.

+
Parameters
+ + +
msgsa non-const reference where the received messages will be copied
+
+
+
Returns
ResultOk when a message is received
+
+ResultInvalidConfiguration if a message listener had been set in the configuration
+ +
+
+ +

◆ batchReceiveAsync()

+ +
+
+ + + + + + + + +
void pulsar::Consumer::batchReceiveAsync (BatchReceiveCallback callback)
+
+

Async Batch receiving messages.

+

Retrieves a message when it will be available and completes callback with received message.

+

batchReceiveAsync() should be called subsequently once callback gets completed with received message. Else it creates backlog of receive requests in the application.

+
Parameters
+ + +
BatchReceiveCallbackwill be completed when messages are available.
+
+
+ +
+
+ +

◆ close()

+ +
+
+ + + + + + + +
Result pulsar::Consumer::close ()
+
+

Close the consumer and stop the broker to push more messages

+ +
+
+ +

◆ closeAsync()

+ +
+
+ + + + + + + + +
void pulsar::Consumer::closeAsync (ResultCallback callback)
+
+

Asynchronously close the consumer and stop the broker to push more messages

+ +
+
+ +

◆ getBrokerConsumerStats()

+ +
+
+ + + + + + + + +
Result pulsar::Consumer::getBrokerConsumerStats (BrokerConsumerStats & brokerConsumerStats)
+
+

Gets Consumer Stats from broker. The stats are cached for 30 seconds, if a call is made before the stats returned by the previous call expires then cached data will be returned. BrokerConsumerStats::isValid() function can be used to check if the stats are still valid.

+
Parameters
+ + +
brokerConsumerStats- if the function returns ResultOk, this object will contain consumer stats
+
+
+
Note
This is a blocking call with timeout of thirty seconds.
+ +
+
+ +

◆ getBrokerConsumerStatsAsync()

+ +
+
+ + + + + + + + +
void pulsar::Consumer::getBrokerConsumerStatsAsync (BrokerConsumerStatsCallback callback)
+
+

Asynchronous call to gets Consumer Stats from broker. The stats are cached for 30 seconds, if a call is made before the stats returned by the previous call expires then cached data will be returned. BrokerConsumerStats::isValid() function can be used to check if the stats are still valid.

+
Parameters
+ + +
callback- callback function to get the brokerConsumerStats, if result is ResultOk then the brokerConsumerStats will be populated
+
+
+ +
+
+ +

◆ getConsumerName()

+ +
+
+ + + + + + + +
const std::string & pulsar::Consumer::getConsumerName () const
+
+
Returns
the consumer name
+ +
+
+ +

◆ getLastMessageId()

+ +
+
+ + + + + + + + +
Result pulsar::Consumer::getLastMessageId (MessageId & messageId)
+
+

Get an ID of the last available message or a message ID with -1 as an entryId if the topic is empty.

+ +
+
+ +

◆ getLastMessageIdAsync()

+ +
+
+ + + + + + + + +
void pulsar::Consumer::getLastMessageIdAsync (GetLastMessageIdCallback callback)
+
+

Asynchronously get an ID of the last available message or a message ID with -1 as an entryId if the topic is empty.

+ +
+
+ +

◆ getSubscriptionName()

+ +
+
+ + + + + + + +
const std::string & pulsar::Consumer::getSubscriptionName () const
+
+
Returns
the subscription name
+ +
+
+ +

◆ getTopic()

+ +
+
+ + + + + + + +
const std::string & pulsar::Consumer::getTopic () const
+
+
Returns
the topic this consumer is subscribed to
+ +
+
+ +

◆ isConnected()

+ +
+
+ + + + + + + +
bool pulsar::Consumer::isConnected () const
+
+
Returns
Whether the consumer is currently connected to the broker
+ +
+
+ +

◆ negativeAcknowledge() [1/2]

+ +
+
+ + + + + + + + +
void pulsar::Consumer::negativeAcknowledge (const Message & message)
+
+

Acknowledge the failure to process a single message.

+

When a message is "negatively acked" it will be marked for redelivery after some fixed delay. The delay is configurable when constructing the consumer with ConsumerConfiguration#setNegativeAckRedeliveryDelayMs.

+

This call is not blocking.

+

Example of usage: 


+while (true) {
+    Message msg;
+    consumer.receive(msg);
+
+    try {
+         // Process message...
+
+         consumer.acknowledge(msg);
+    } catch (Throwable t) {
+         log.warn("Failed to process message");
+         consumer.negativeAcknowledge(msg);
+    }
+}
+
Parameters
+ + +
messageThe Message to be acknowledged
+
+
+ +
+
+ +

◆ negativeAcknowledge() [2/2]

+ +
+
+ + + + + + + + +
void pulsar::Consumer::negativeAcknowledge (const MessageId & messageId)
+
+

Acknowledge the failure to process a single message.

+

When a message is "negatively acked" it will be marked for redelivery after some fixed delay. The delay is configurable when constructing the consumer with ConsumerConfiguration#setNegativeAckRedeliveryDelayMs.

+

This call is not blocking.

+

Example of usage: 


+while (true) {
+    Message msg;
+    consumer.receive(msg);
+
+    try {
+         // Process message...
+
+         consumer.acknowledge(msg);
+    } catch (Throwable t) {
+         log.warn("Failed to process message");
+         consumer.negativeAcknowledge(msg);
+    }
+}
+
Parameters
+ + +
messageIdThe MessageId to be acknowledged
+
+
+ +
+
+ +

◆ pauseMessageListener()

+ +
+
+ + + + + + + +
Result pulsar::Consumer::pauseMessageListener ()
+
+

Pause receiving messages via the messageListener, till resumeMessageListener() is called.

+ +
+
+ +

◆ receive() [1/2]

+ +
+
+ + + + + + + + +
Result pulsar::Consumer::receive (Message & msg)
+
+

Receive a single message.

+

If a message is not immediately available, this method will block until a new message is available.

+
Parameters
+ + +
msga non-const reference where the received message will be copied
+
+
+
Returns
ResultOk when a message is received
+
+ResultInvalidConfiguration if a message listener had been set in the configuration
+ +
+
+ +

◆ receive() [2/2]

+ +
+
+ + + + + + + + + + + + + + + + + + +
Result pulsar::Consumer::receive (Message & msg,
int timeoutMs 
)
+
+
Parameters
+ + + +
msga non-const reference where the received message will be copied
timeoutMsthe receive timeout in milliseconds
+
+
+
Returns
ResultOk if a message was received
+
+ResultTimeout if the receive timeout was triggered
+
+ResultInvalidConfiguration if a message listener had been set in the configuration
+ +
+
+ +

◆ receiveAsync()

+ +
+
+ + + + + + + + +
void pulsar::Consumer::receiveAsync (ReceiveCallback callback)
+
+

Receive a single message

+

Retrieves a message when it will be available and completes callback with received message.

+

receiveAsync() should be called subsequently once callback gets completed with received message. Else it creates backlog of receive requests in the application.

+
Parameters
+ + +
ReceiveCallbackwill be completed when message is available
+
+
+ +
+
+ +

◆ redeliverUnacknowledgedMessages()

+ +
+
+ + + + + + + +
void pulsar::Consumer::redeliverUnacknowledgedMessages ()
+
+

Redelivers all the unacknowledged messages. In Failover mode, the request is ignored if the consumer is not active for the given topic. In Shared mode, the consumers messages to be redelivered are distributed across all the connected consumers. This is a non blocking call and doesn't throw an exception. In case the connection breaks, the messages are redelivered after reconnect.

+ +
+
+ +

◆ resumeMessageListener()

+ +
+
+ + + + + + + +
Result pulsar::Consumer::resumeMessageListener ()
+
+

Resume receiving the messages via the messageListener. Asynchronously receive all the messages enqueued from time pauseMessageListener() was called.

+ +
+
+ +

◆ seek() [1/2]

+ +
+
+ + + + + + + + +
Result pulsar::Consumer::seek (const MessageId & messageId)
+
+

Reset the subscription associated with this consumer to a specific message id. The message id can either be a specific message or represent the first or last messages in the topic.

+

Note: this operation can only be done on non-partitioned topics. For these, one can rather perform the seek() on the individual partitions.

+
Parameters
+ + +
messageIdthe message id where to reposition the subscription
+
+
+ +
+
+ +

◆ seek() [2/2]

+ +
+
+ + + + + + + + +
Result pulsar::Consumer::seek (uint64_t timestamp)
+
+

Reset the subscription associated with this consumer to a specific message publish time.

+
Parameters
+ + +
timestampthe message publish time where to reposition the subscription
+
+
+ +
+
+ +

◆ seekAsync() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
virtual void pulsar::Consumer::seekAsync (const MessageId & messageId,
ResultCallback callback 
)
+ 		+virtual
+
+

Asynchronously reset the subscription associated with this consumer to a specific message id. The message id can either be a specific message or represent the first or last messages in the topic.

+

Note: this operation can only be done on non-partitioned topics. For these, one can rather perform the seek() on the individual partitions.

+
Parameters
+ + +
messageIdthe message id where to reposition the subscription
+
+
+ +
+
+ +

◆ seekAsync() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
virtual void pulsar::Consumer::seekAsync (uint64_t timestamp,
ResultCallback callback 
)
+ 		+virtual
+
+

Asynchronously reset the subscription associated with this consumer to a specific message publish time.

+
Parameters
+ + +
timestampthe message publish time where to reposition the subscription
+
+
+ +
+
+ +

◆ unsubscribe()

+ +
+
+ + + + + + + +
Result pulsar::Consumer::unsubscribe ()
+
+

Unsubscribe the current consumer from the topic.

+

This method will block until the operation is completed. Once the consumer is unsubscribed, no more messages will be received and subsequent new messages will not be retained for this consumer.

+

This consumer object cannot be reused.

+
See also
asyncUnsubscribe
+
Returns
Result::ResultOk if the unsubscribe operation completed successfully
+
+Result::ResultError if the unsubscribe operation failed
+ +
+
+ +

◆ unsubscribeAsync()

+ +
+
+ + + + + + + + +
void pulsar::Consumer::unsubscribeAsync (ResultCallback callback)
+
+

Asynchronously unsubscribe the current consumer from the topic.

+

This method will block until the operation is completed. Once the consumer is unsubscribed, no more messages will be received and subsequent new messages will not be retained for this consumer.

+

This consumer object cannot be reused.

+
Parameters
+ + +
callbackthe callback to get notified when the operation is complete
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_consumer_configuration-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_consumer_configuration-members.html new file mode 100644 index 000000000000..1793ff480220 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_consumer_configuration-members.html @@ -0,0 +1,169 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::ConsumerConfiguration Member List
+
+
+ +

This is the complete list of members for pulsar::ConsumerConfiguration, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
clone() constpulsar::ConsumerConfiguration
ConsumerConfiguration() (defined in pulsar::ConsumerConfiguration)pulsar::ConsumerConfiguration
ConsumerConfiguration(const ConsumerConfiguration &) (defined in pulsar::ConsumerConfiguration)pulsar::ConsumerConfiguration
getAckGroupingMaxSize() constpulsar::ConsumerConfiguration
getAckGroupingTimeMs() constpulsar::ConsumerConfiguration
getBatchReceivePolicy() constpulsar::ConsumerConfiguration
getBrokerConsumerStatsCacheTimeInMs() constpulsar::ConsumerConfiguration
getConsumerEventListener() constpulsar::ConsumerConfiguration
getConsumerName() constpulsar::ConsumerConfiguration
getConsumerType() constpulsar::ConsumerConfiguration
getCryptoFailureAction() constpulsar::ConsumerConfiguration
getCryptoKeyReader() constpulsar::ConsumerConfiguration
getDeadLetterPolicy() constpulsar::ConsumerConfiguration
getExpireTimeOfIncompleteChunkedMessageMs() constpulsar::ConsumerConfiguration
getInterceptors() const (defined in pulsar::ConsumerConfiguration)pulsar::ConsumerConfiguration
getKeySharedPolicy() constpulsar::ConsumerConfiguration
getMaxPendingChunkedMessage() constpulsar::ConsumerConfiguration
getMaxTotalReceiverQueueSizeAcrossPartitions() constpulsar::ConsumerConfiguration
getMessageListener() constpulsar::ConsumerConfiguration
getNegativeAckRedeliveryDelayMs() constpulsar::ConsumerConfiguration
getPatternAutoDiscoveryPeriod() constpulsar::ConsumerConfiguration
getPriorityLevel() constpulsar::ConsumerConfiguration
getProperties() constpulsar::ConsumerConfiguration
getProperty(const std::string &name) constpulsar::ConsumerConfiguration
getReceiverQueueSize() constpulsar::ConsumerConfiguration
getRegexSubscriptionMode() constpulsar::ConsumerConfiguration
getSchema() constpulsar::ConsumerConfiguration
getSubscriptionInitialPosition() constpulsar::ConsumerConfiguration
getSubscriptionProperties() constpulsar::ConsumerConfiguration
getTickDurationInMs() constpulsar::ConsumerConfiguration
getUnAckedMessagesTimeoutMs() constpulsar::ConsumerConfiguration
hasConsumerEventListener() constpulsar::ConsumerConfiguration
hasMessageListener() constpulsar::ConsumerConfiguration
hasProperty(const std::string &name) constpulsar::ConsumerConfiguration
intercept(const std::vector< ConsumerInterceptorPtr > &interceptors)pulsar::ConsumerConfiguration
isAckReceiptEnabled() constpulsar::ConsumerConfiguration
isAutoAckOldestChunkedMessageOnQueueFull() constpulsar::ConsumerConfiguration
isBatchIndexAckEnabled() constpulsar::ConsumerConfiguration
isEncryptionEnabled() constpulsar::ConsumerConfiguration
isReadCompacted() constpulsar::ConsumerConfiguration
isReplicateSubscriptionStateEnabled() constpulsar::ConsumerConfiguration
isStartMessageIdInclusive() constpulsar::ConsumerConfiguration
operator=(const ConsumerConfiguration &) (defined in pulsar::ConsumerConfiguration)pulsar::ConsumerConfiguration
PulsarFriend (defined in pulsar::ConsumerConfiguration)pulsar::ConsumerConfigurationfriend
PulsarWrapper (defined in pulsar::ConsumerConfiguration)pulsar::ConsumerConfigurationfriend
setAckGroupingMaxSize(long maxGroupingSize)pulsar::ConsumerConfiguration
setAckGroupingTimeMs(long ackGroupingMillis)pulsar::ConsumerConfiguration
setAckReceiptEnabled(bool ackReceiptEnabled)pulsar::ConsumerConfiguration
setAutoAckOldestChunkedMessageOnQueueFull(bool autoAckOldestChunkedMessageOnQueueFull)pulsar::ConsumerConfiguration
setBatchIndexAckEnabled(bool enabled)pulsar::ConsumerConfiguration
setBatchReceivePolicy(const BatchReceivePolicy &batchReceivePolicy)pulsar::ConsumerConfiguration
setBrokerConsumerStatsCacheTimeInMs(const long cacheTimeInMs)pulsar::ConsumerConfiguration
setConsumerEventListener(ConsumerEventListenerPtr eventListener)pulsar::ConsumerConfiguration
setConsumerName(const std::string &consumerName)pulsar::ConsumerConfiguration
setConsumerType(ConsumerType consumerType)pulsar::ConsumerConfiguration
setCryptoFailureAction(ConsumerCryptoFailureAction action)pulsar::ConsumerConfiguration
setCryptoKeyReader(CryptoKeyReaderPtr cryptoKeyReader)pulsar::ConsumerConfiguration
setDeadLetterPolicy(const DeadLetterPolicy &deadLetterPolicy)pulsar::ConsumerConfiguration
setExpireTimeOfIncompleteChunkedMessageMs(long expireTimeOfIncompleteChunkedMessageMs)pulsar::ConsumerConfiguration
setKeySharedPolicy(KeySharedPolicy keySharedPolicy)pulsar::ConsumerConfiguration
setMaxPendingChunkedMessage(size_t maxPendingChunkedMessage)pulsar::ConsumerConfiguration
setMaxTotalReceiverQueueSizeAcrossPartitions(int maxTotalReceiverQueueSizeAcrossPartitions)pulsar::ConsumerConfiguration
setMessageListener(MessageListener messageListener)pulsar::ConsumerConfiguration
setNegativeAckRedeliveryDelayMs(long redeliveryDelayMillis)pulsar::ConsumerConfiguration
setPatternAutoDiscoveryPeriod(int periodInSeconds)pulsar::ConsumerConfiguration
setPriorityLevel(int priorityLevel)pulsar::ConsumerConfiguration
setProperties(const std::map< std::string, std::string > &properties)pulsar::ConsumerConfiguration
setProperty(const std::string &name, const std::string &value)pulsar::ConsumerConfiguration
setReadCompacted(bool compacted)pulsar::ConsumerConfiguration
setReceiverQueueSize(int size)pulsar::ConsumerConfiguration
setRegexSubscriptionMode(RegexSubscriptionMode regexSubscriptionMode)pulsar::ConsumerConfiguration
setReplicateSubscriptionStateEnabled(bool enabled)pulsar::ConsumerConfiguration
setSchema(const SchemaInfo &schemaInfo)pulsar::ConsumerConfiguration
setStartMessageIdInclusive(bool startMessageIdInclusive)pulsar::ConsumerConfiguration
setSubscriptionInitialPosition(InitialPosition subscriptionInitialPosition)pulsar::ConsumerConfiguration
setSubscriptionProperties(const std::map< std::string, std::string > &subscriptionProperties)pulsar::ConsumerConfiguration
setTickDurationInMs(const uint64_t milliSeconds)pulsar::ConsumerConfiguration
setTypedMessageListener(std::function< void(Consumer &, const TypedMessage< T > &)> listener, typename TypedMessage< T >::Decoder decoder) (defined in pulsar::ConsumerConfiguration)pulsar::ConsumerConfigurationinline
setUnAckedMessagesTimeoutMs(const uint64_t milliSeconds)pulsar::ConsumerConfiguration
~ConsumerConfiguration() (defined in pulsar::ConsumerConfiguration)pulsar::ConsumerConfiguration
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_consumer_configuration.html b/static/api/cpp/3.5.x/classpulsar_1_1_consumer_configuration.html new file mode 100644 index 000000000000..9836b45392d4 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_consumer_configuration.html @@ -0,0 +1,1840 @@ + + + + + + + +pulsar-client-cpp: pulsar::ConsumerConfiguration Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +Friends | +List of all members
+
pulsar::ConsumerConfiguration Class Reference
+
+
+ +

#include <ConsumerConfiguration.h>

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ ConsumerConfiguration (const ConsumerConfiguration &)
 
+ConsumerConfiguration & operator= (const ConsumerConfiguration &)
 
ConsumerConfiguration clone () const
 
ConsumerConfiguration & setSchema (const SchemaInfo &schemaInfo)
 
const SchemaInfo & getSchema () const
 
ConsumerConfiguration & setConsumerType (ConsumerType consumerType)
 
ConsumerType getConsumerType () const
 
ConsumerConfiguration & setKeySharedPolicy (KeySharedPolicy keySharedPolicy)
 
KeySharedPolicy getKeySharedPolicy () const
 
ConsumerConfiguration & setMessageListener (MessageListener messageListener)
 
+template<typename T >
ConsumerConfiguration & setTypedMessageListener (std::function< void(Consumer &, const TypedMessage< T > &)> listener, typename TypedMessage< T >::Decoder decoder)
 
MessageListener getMessageListener () const
 
bool hasMessageListener () const
 
ConsumerConfiguration & setConsumerEventListener (ConsumerEventListenerPtr eventListener)
 
ConsumerEventListenerPtr getConsumerEventListener () const
 
bool hasConsumerEventListener () const
 
void setReceiverQueueSize (int size)
 
int getReceiverQueueSize () const
 
void setMaxTotalReceiverQueueSizeAcrossPartitions (int maxTotalReceiverQueueSizeAcrossPartitions)
 
int getMaxTotalReceiverQueueSizeAcrossPartitions () const
 
void setConsumerName (const std::string &consumerName)
 
const std::string & getConsumerName () const
 
void setUnAckedMessagesTimeoutMs (const uint64_t milliSeconds)
 
long getUnAckedMessagesTimeoutMs () const
 
void setTickDurationInMs (const uint64_t milliSeconds)
 
long getTickDurationInMs () const
 
void setNegativeAckRedeliveryDelayMs (long redeliveryDelayMillis)
 
long getNegativeAckRedeliveryDelayMs () const
 
void setAckGroupingTimeMs (long ackGroupingMillis)
 
long getAckGroupingTimeMs () const
 
void setAckGroupingMaxSize (long maxGroupingSize)
 
long getAckGroupingMaxSize () const
 
void setBrokerConsumerStatsCacheTimeInMs (const long cacheTimeInMs)
 
long getBrokerConsumerStatsCacheTimeInMs () const
 
bool isEncryptionEnabled () const
 
const CryptoKeyReaderPtr getCryptoKeyReader () const
 
ConsumerConfiguration & setCryptoKeyReader (CryptoKeyReaderPtr cryptoKeyReader)
 
ConsumerCryptoFailureAction getCryptoFailureAction () const
 
ConsumerConfiguration & setCryptoFailureAction (ConsumerCryptoFailureAction action)
 
bool isReadCompacted () const
 
void setReadCompacted (bool compacted)
 
void setPatternAutoDiscoveryPeriod (int periodInSeconds)
 
int getPatternAutoDiscoveryPeriod () const
 
ConsumerConfiguration & setRegexSubscriptionMode (RegexSubscriptionMode regexSubscriptionMode)
 
RegexSubscriptionMode getRegexSubscriptionMode () const
 
void setSubscriptionInitialPosition (InitialPosition subscriptionInitialPosition)
 
InitialPosition getSubscriptionInitialPosition () const
 
void setBatchReceivePolicy (const BatchReceivePolicy &batchReceivePolicy)
 
const BatchReceivePolicy & getBatchReceivePolicy () const
 
void setDeadLetterPolicy (const DeadLetterPolicy &deadLetterPolicy)
 
const DeadLetterPolicy & getDeadLetterPolicy () const
 
void setReplicateSubscriptionStateEnabled (bool enabled)
 
bool isReplicateSubscriptionStateEnabled () const
 
bool hasProperty (const std::string &name) const
 
const std::string & getProperty (const std::string &name) const
 
std::map< std::string, std::string > & getProperties () const
 
ConsumerConfiguration & setProperty (const std::string &name, const std::string &value)
 
ConsumerConfiguration & setProperties (const std::map< std::string, std::string > &properties)
 
std::map< std::string, std::string > & getSubscriptionProperties () const
 
ConsumerConfiguration & setSubscriptionProperties (const std::map< std::string, std::string > &subscriptionProperties)
 
ConsumerConfiguration & setPriorityLevel (int priorityLevel)
 
int getPriorityLevel () const
 
ConsumerConfiguration & setMaxPendingChunkedMessage (size_t maxPendingChunkedMessage)
 
size_t getMaxPendingChunkedMessage () const
 
ConsumerConfiguration & setAutoAckOldestChunkedMessageOnQueueFull (bool autoAckOldestChunkedMessageOnQueueFull)
 
bool isAutoAckOldestChunkedMessageOnQueueFull () const
 
ConsumerConfiguration & setExpireTimeOfIncompleteChunkedMessageMs (long expireTimeOfIncompleteChunkedMessageMs)
 
long getExpireTimeOfIncompleteChunkedMessageMs () const
 
ConsumerConfiguration & setStartMessageIdInclusive (bool startMessageIdInclusive)
 
bool isStartMessageIdInclusive () const
 
ConsumerConfiguration & setBatchIndexAckEnabled (bool enabled)
 
bool isBatchIndexAckEnabled () const
 
ConsumerConfiguration & intercept (const std::vector< ConsumerInterceptorPtr > &interceptors)
 
+const std::vector< ConsumerInterceptorPtr > & getInterceptors () const
 
ConsumerConfiguration & setAckReceiptEnabled (bool ackReceiptEnabled)
 
bool isAckReceiptEnabled () const
 
+ + + + + +

+Friends

+class PulsarWrapper
 
+class PulsarFriend
 
+

Detailed Description

+

Class specifying the configuration of a consumer.

+

Member Function Documentation

+ +

◆ clone()

+ +
+
+ + + + + + + +
ConsumerConfiguration pulsar::ConsumerConfiguration::clone () const
+
+

Create a new instance of ConsumerConfiguration with the same initial settings as the current one.

+ +
+
+ +

◆ getAckGroupingMaxSize()

+ +
+
+ + + + + + + +
long pulsar::ConsumerConfiguration::getAckGroupingMaxSize () const
+
+

Get max number of grouped messages within one grouping time window.

+
Returns
max number of grouped messages within one grouping time window.
+ +
+
+ +

◆ getAckGroupingTimeMs()

+ +
+
+ + + + + + + +
long pulsar::ConsumerConfiguration::getAckGroupingTimeMs () const
+
+

Get grouping time window in milliseconds.

+
Returns
grouping time window in milliseconds.
+ +
+
+ +

◆ getBatchReceivePolicy()

+ +
+
+ + + + + + + +
const BatchReceivePolicy & pulsar::ConsumerConfiguration::getBatchReceivePolicy () const
+
+

Get batch receive policy.

+
Returns
batch receive policy
+ +
+
+ +

◆ getBrokerConsumerStatsCacheTimeInMs()

+ +
+
+ + + + + + + +
long pulsar::ConsumerConfiguration::getBrokerConsumerStatsCacheTimeInMs () const
+
+
Returns
the configured timeout in milliseconds caching BrokerConsumerStats.
+ +
+
+ +

◆ getConsumerEventListener()

+ +
+
+ + + + + + + +
ConsumerEventListenerPtr pulsar::ConsumerConfiguration::getConsumerEventListener () const
+
+
Returns
the consumer event listener
+ +
+
+ +

◆ getConsumerName()

+ +
+
+ + + + + + + +
const std::string & pulsar::ConsumerConfiguration::getConsumerName () const
+
+
Returns
the consumer name
+ +
+
+ +

◆ getConsumerType()

+ +
+
+ + + + + + + +
ConsumerType pulsar::ConsumerConfiguration::getConsumerType () const
+
+
Returns
the consumer type
+ +
+
+ +

◆ getCryptoFailureAction()

+ +
+
+ + + + + + + +
ConsumerCryptoFailureAction pulsar::ConsumerConfiguration::getCryptoFailureAction () const
+
+
Returns
the ConsumerCryptoFailureAction
+ +
+
+ +

◆ getCryptoKeyReader()

+ +
+
+ + + + + + + +
const CryptoKeyReaderPtr pulsar::ConsumerConfiguration::getCryptoKeyReader () const
+
+
Returns
the shared pointer to CryptoKeyReader.
+ +
+
+ +

◆ getDeadLetterPolicy()

+ +
+
+ + + + + + + +
const DeadLetterPolicy & pulsar::ConsumerConfiguration::getDeadLetterPolicy () const
+
+

Get dead letter policy.

+
Returns
dead letter policy
+ +
+
+ +

◆ getExpireTimeOfIncompleteChunkedMessageMs()

+ +
+
+ + + + + + + +
long pulsar::ConsumerConfiguration::getExpireTimeOfIncompleteChunkedMessageMs () const
+
+

Get the expire time of incomplete chunked message in milliseconds

+
Returns
the expire time of incomplete chunked message in milliseconds
+ +
+
+ +

◆ getKeySharedPolicy()

+ +
+
+ + + + + + + +
KeySharedPolicy pulsar::ConsumerConfiguration::getKeySharedPolicy () const
+
+
Returns
the KeyShared subscription policy
+ +
+
+ +

◆ getMaxPendingChunkedMessage()

+ +
+
+ + + + + + + +
size_t pulsar::ConsumerConfiguration::getMaxPendingChunkedMessage () const
+
+

The associated getter of setMaxPendingChunkedMessage

+ +
+
+ +

◆ getMaxTotalReceiverQueueSizeAcrossPartitions()

+ +
+
+ + + + + + + +
int pulsar::ConsumerConfiguration::getMaxTotalReceiverQueueSizeAcrossPartitions () const
+
+
Returns
the configured max total receiver queue size across partitions
+ +
+
+ +

◆ getMessageListener()

+ +
+
+ + + + + + + +
MessageListener pulsar::ConsumerConfiguration::getMessageListener () const
+
+
Returns
the message listener
+ +
+
+ +

◆ getNegativeAckRedeliveryDelayMs()

+ +
+
+ + + + + + + +
long pulsar::ConsumerConfiguration::getNegativeAckRedeliveryDelayMs () const
+
+

Get the configured delay to wait before re-delivering messages that have failed to be process.

+
Returns
redelivery delay for failed messages
+ +
+
+ +

◆ getPatternAutoDiscoveryPeriod()

+ +
+
+ + + + + + + +
int pulsar::ConsumerConfiguration::getPatternAutoDiscoveryPeriod () const
+
+
Returns
the time duration for the PatternMultiTopicsConsumer performs a pattern auto discovery
+ +
+
+ +

◆ getPriorityLevel()

+ +
+
+ + + + + + + +
int pulsar::ConsumerConfiguration::getPriorityLevel () const
+
+
Returns
the configured priority for the consumer
+ +
+
+ +

◆ getProperties()

+ +
+
+ + + + + + + +
std::map< std::string, std::string > & pulsar::ConsumerConfiguration::getProperties () const
+
+

Get all the properties attached to this producer.

+ +
+
+ +

◆ getProperty()

+ +
+
+ + + + + + + + +
const std::string & pulsar::ConsumerConfiguration::getProperty (const std::string & name) const
+
+

Get the value of a specific property

+
Parameters
+ + +
namethe name of the property
+
+
+
Returns
the value of the property or null if the property was not defined
+ +
+
+ +

◆ getReceiverQueueSize()

+ +
+
+ + + + + + + +
int pulsar::ConsumerConfiguration::getReceiverQueueSize () const
+
+
Returns
the receiver queue size
+ +
+
+ +

◆ getRegexSubscriptionMode()

+ +
+
+ + + + + + + +
RegexSubscriptionMode pulsar::ConsumerConfiguration::getRegexSubscriptionMode () const
+
+
Returns
the regex subscription mode for the pattern consumer.
+ +
+
+ +

◆ getSchema()

+ +
+
+ + + + + + + +
const SchemaInfo & pulsar::ConsumerConfiguration::getSchema () const
+
+
Returns
the schema information declared for this consumer
+ +
+
+ +

◆ getSubscriptionInitialPosition()

+ +
+
+ + + + + + + +
InitialPosition pulsar::ConsumerConfiguration::getSubscriptionInitialPosition () const
+
+
Returns
the configured InitialPosition for the consumer
+ +
+
+ +

◆ getSubscriptionProperties()

+ +
+
+ + + + + + + +
std::map< std::string, std::string > & pulsar::ConsumerConfiguration::getSubscriptionProperties () const
+
+

Get all the subscription properties attached to this subscription.

+ +
+
+ +

◆ getTickDurationInMs()

+ +
+
+ + + + + + + +
long pulsar::ConsumerConfiguration::getTickDurationInMs () const
+
+
Returns
the tick duration time (in milliseconds)
+ +
+
+ +

◆ getUnAckedMessagesTimeoutMs()

+ +
+
+ + + + + + + +
long pulsar::ConsumerConfiguration::getUnAckedMessagesTimeoutMs () const
+
+
Returns
the configured timeout in milliseconds for unacked messages.
+ +
+
+ +

◆ hasConsumerEventListener()

+ +
+
+ + + + + + + +
bool pulsar::ConsumerConfiguration::hasConsumerEventListener () const
+
+
Returns
true if the consumer event listener has been set
+ +
+
+ +

◆ hasMessageListener()

+ +
+
+ + + + + + + +
bool pulsar::ConsumerConfiguration::hasMessageListener () const
+
+
Returns
true if the message listener has been set
+ +
+
+ +

◆ hasProperty()

+ +
+
+ + + + + + + + +
bool pulsar::ConsumerConfiguration::hasProperty (const std::string & name) const
+
+

Check whether the message has a specific property attached.

+
Parameters
+ + +
namethe name of the property to check
+
+
+
Returns
true if the message has the specified property
+
+false if the property is not defined
+ +
+
+ +

◆ intercept()

+ +
+
+ + + + + + + + +
ConsumerConfiguration & pulsar::ConsumerConfiguration::intercept (const std::vector< ConsumerInterceptorPtr > & interceptors)
+
+

Intercept the consumer

+
Parameters
+ + +
interceptorsthe list of interceptors to intercept the consumer
+
+
+
Returns
Consumer Configuration
+ +
+
+ +

◆ isAckReceiptEnabled()

+ +
+
+ + + + + + + +
bool pulsar::ConsumerConfiguration::isAckReceiptEnabled () const
+
+

The associated getter of setAckReceiptEnabled.

+ +
+
+ +

◆ isAutoAckOldestChunkedMessageOnQueueFull()

+ +
+
+ + + + + + + +
bool pulsar::ConsumerConfiguration::isAutoAckOldestChunkedMessageOnQueueFull () const
+
+

The associated getter of setAutoAckOldestChunkedMessageOnQueueFull

+ +
+
+ +

◆ isBatchIndexAckEnabled()

+ +
+
+ + + + + + + +
bool pulsar::ConsumerConfiguration::isBatchIndexAckEnabled () const
+
+

The associated getter of setBatchingEnabled

+ +
+
+ +

◆ isEncryptionEnabled()

+ +
+
+ + + + + + + +
bool pulsar::ConsumerConfiguration::isEncryptionEnabled () const
+
+
Returns
true if encryption keys are added
+ +
+
+ +

◆ isReadCompacted()

+ +
+
+ + + + + + + +
bool pulsar::ConsumerConfiguration::isReadCompacted () const
+
+
Returns
true if readCompacted is enabled
+ +
+
+ +

◆ isReplicateSubscriptionStateEnabled()

+ +
+
+ + + + + + + +
bool pulsar::ConsumerConfiguration::isReplicateSubscriptionStateEnabled () const
+
+
Returns
whether the subscription status should be replicated
+ +
+
+ +

◆ isStartMessageIdInclusive()

+ +
+
+ + + + + + + +
bool pulsar::ConsumerConfiguration::isStartMessageIdInclusive () const
+
+

The associated getter of setStartMessageIdInclusive

+ +
+
+ +

◆ setAckGroupingMaxSize()

+ +
+
+ + + + + + + + +
void pulsar::ConsumerConfiguration::setAckGroupingMaxSize (long maxGroupingSize)
+
+

Set max number of grouped messages within one grouping time window. If it's set to a non-positive value, number of grouped messages is not limited. Default is 1000.

+
Parameters
+ + +
maxGroupingSizemax number of grouped messages with in one grouping time window.
+
+
+ +
+
+ +

◆ setAckGroupingTimeMs()

+ +
+
+ + + + + + + + +
void pulsar::ConsumerConfiguration::setAckGroupingTimeMs (long ackGroupingMillis)
+
+

Set time window in milliseconds for grouping message ACK requests. An ACK request is not sent to broker until the time window reaches its end, or the number of grouped messages reaches limit. Default is 100 milliseconds. If it's set to a non-positive value, ACK requests will be directly sent to broker without grouping.

+
Parameters
+ + +
ackGroupMillistime of ACK grouping window in milliseconds.
+
+
+ +
+
+ +

◆ setAckReceiptEnabled()

+ +
+
+ + + + + + + + +
ConsumerConfiguration & pulsar::ConsumerConfiguration::setAckReceiptEnabled (bool ackReceiptEnabled)
+
+

Whether to receive the ACK receipt from broker.

+

By default, when Consumer::acknowledge is called, it won't wait until the corresponding response from broker. After it's enabled, the acknowledge method will return a Result that indicates if the acknowledgment succeeded.

+

Default: false

+ +
+
+ +

◆ setAutoAckOldestChunkedMessageOnQueueFull()

+ +
+
+ + + + + + + + +
ConsumerConfiguration & pulsar::ConsumerConfiguration::setAutoAckOldestChunkedMessageOnQueueFull (bool autoAckOldestChunkedMessageOnQueueFull)
+
+

Buffering large number of outstanding uncompleted chunked messages can create memory pressure and it can be guarded by providing the maxPendingChunkedMessage threshold. See setMaxPendingChunkedMessage. Once, consumer reaches this threshold, it drops the outstanding unchunked-messages by silently acking if autoAckOldestChunkedMessageOnQueueFull is true else it marks them for redelivery.

+

Default: false

+
Parameters
+ + +
autoAckOldestChunkedMessageOnQueueFullwhether to ack the discarded chunked message
+
+
+ +
+
+ +

◆ setBatchIndexAckEnabled()

+ +
+
+ + + + + + + + +
ConsumerConfiguration & pulsar::ConsumerConfiguration::setBatchIndexAckEnabled (bool enabled)
+
+

Enable the batch index acknowledgment.

+

It should be noted that this option can only work when the broker side also enables the batch index acknowledgment. See the acknowledgmentAtBatchIndexLevelEnabled config in broker.conf.

+

Default: false

+
Parameters
+ + +
enabledwhether to enable the batch index acknowledgment
+
+
+ +
+
+ +

◆ setBatchReceivePolicy()

+ +
+
+ + + + + + + + +
void pulsar::ConsumerConfiguration::setBatchReceivePolicy (const BatchReceivePolicy & batchReceivePolicy)
+
+

Set batch receive policy.

+
Parameters
+ + +
batchReceivePolicythe default is {maxNumMessage: -1, maxNumBytes: 10 * 1024 * 1024, timeoutMs: 100}
+
+
+ +
+
+ +

◆ setBrokerConsumerStatsCacheTimeInMs()

+ +
+
+ + + + + + + + +
void pulsar::ConsumerConfiguration::setBrokerConsumerStatsCacheTimeInMs (const long cacheTimeInMs)
+
+

Set the time duration for which the broker side consumer stats will be cached in the client.

+

Default: 30000, which means 30 seconds.

+
Parameters
+ + +
cacheTimeInMsin milliseconds
+
+
+ +
+
+ +

◆ setConsumerEventListener()

+ +
+
+ + + + + + + + +
ConsumerConfiguration & pulsar::ConsumerConfiguration::setConsumerEventListener (ConsumerEventListenerPtr eventListener)
+
+

A event listener enables your application to react the consumer state change event (active or inactive).

+ +
+
+ +

◆ setConsumerName()

+ +
+
+ + + + + + + + +
void pulsar::ConsumerConfiguration::setConsumerName (const std::string & consumerName)
+
+

Set the consumer name.

+
Parameters
+ + +
consumerName
+
+
+ +
+
+ +

◆ setConsumerType()

+ +
+
+ + + + + + + + +
ConsumerConfiguration & pulsar::ConsumerConfiguration::setConsumerType (ConsumerType consumerType)
+
+

Specify the consumer type. The consumer type enables specifying the type of subscription. In Exclusive subscription, only a single consumer is allowed to attach to the subscription. Other consumers will get an error message. In Shared subscription, multiple consumers will be able to use the same subscription name and the messages will be dispatched in a round robin fashion. In Failover subscription, a primary-failover subscription model allows for multiple consumers to attach to a single subscription, though only one of them will be “master” at a given time. Only the primary consumer will receive messages. When the primary consumer gets disconnected, one among the failover consumers will be promoted to primary and will start getting messages.

+ +
+
+ +

◆ setCryptoFailureAction()

+ +
+
+ + + + + + + + +
ConsumerConfiguration & pulsar::ConsumerConfiguration::setCryptoFailureAction (ConsumerCryptoFailureAction action)
+
+

Set the ConsumerCryptoFailureAction.

+ +
+
+ +

◆ setCryptoKeyReader()

+ +
+
+ + + + + + + + +
ConsumerConfiguration & pulsar::ConsumerConfiguration::setCryptoKeyReader (CryptoKeyReaderPtr cryptoKeyReader)
+
+

Set the shared pointer to CryptoKeyReader.

+
Parameters
+ + +
theshared pointer to CryptoKeyReader
+
+
+ +
+
+ +

◆ setDeadLetterPolicy()

+ +
+
+ + + + + + + + +
void pulsar::ConsumerConfiguration::setDeadLetterPolicy (const DeadLetterPolicy & deadLetterPolicy)
+
+

Set dead letter policy for consumer

+

By default, some messages are redelivered many times, even to the extent that they can never be stopped. By using the dead letter mechanism, messages have the max redelivery count, when they exceeding the maximum number of redeliveries. Messages are sent to dead letter topics and acknowledged automatically.

+

You can enable the dead letter mechanism by setting the dead letter policy. Example:

+
+* DeadLetterPolicy dlqPolicy = DeadLetterPolicyBuilder()
+                      .maxRedeliverCount(10)
+                      .build();
+

Default dead letter topic name is {TopicName}-{Subscription}-DLQ. To set a custom dead letter topic name 

+DeadLetterPolicy dlqPolicy = DeadLetterPolicyBuilder()
+                      .deadLetterTopic("dlq-topic")
+                      .maxRedeliverCount(10)
+                      .initialSubscriptionName("init-sub-name")
+                      .build();
+
Parameters
+ + +
deadLetterPolicyDefault value is empty
+
+
+ +
+
+ +

◆ setExpireTimeOfIncompleteChunkedMessageMs()

+ +
+
+ + + + + + + + +
ConsumerConfiguration & pulsar::ConsumerConfiguration::setExpireTimeOfIncompleteChunkedMessageMs (long expireTimeOfIncompleteChunkedMessageMs)
+
+

If producer fails to publish all the chunks of a message then consumer can expire incomplete chunks if consumer won't be able to receive all chunks in expire times. Use value 0 to disable this feature.

+

Default: 60000, which means 1 minutes

+
Parameters
+ + +
expireTimeOfIncompleteChunkedMessageMsexpire time in milliseconds
+
+
+
Returns
Consumer Configuration
+ +
+
+ +

◆ setKeySharedPolicy()

+ +
+
+ + + + + + + + +
ConsumerConfiguration & pulsar::ConsumerConfiguration::setKeySharedPolicy (KeySharedPolicy keySharedPolicy)
+
+

Set KeyShared subscription policy for consumer.

+

By default, KeyShared subscription use auto split hash range to maintain consumers. If you want to set a different KeyShared policy, you can set by following example:

+
Parameters
+ + +
keySharedPolicyThe KeySharedPolicy want to specify
+
+
+ +
+
+ +

◆ setMaxPendingChunkedMessage()

+ +
+
+ + + + + + + + +
ConsumerConfiguration & pulsar::ConsumerConfiguration::setMaxPendingChunkedMessage (size_t maxPendingChunkedMessage)
+
+

Consumer buffers chunk messages into memory until it receives all the chunks of the original message. While consuming chunk-messages, chunks from same message might not be contiguous in the stream and they might be mixed with other messages' chunks. so, consumer has to maintain multiple buffers to manage chunks coming from different messages. This mainly happens when multiple publishers are publishing messages on the topic concurrently or publisher failed to publish all chunks of the messages.

+

eg: M1-C1, M2-C1, M1-C2, M2-C2 Here, Messages M1-C1 and M1-C2 belong to original message M1, M2-C1 and M2-C2 belong to M2 message.

+

Buffering large number of outstanding uncompleted chunked messages can create memory pressure and it can be guarded by providing this maxPendingChunkedMessage threshold. Once, consumer reaches this threshold, it drops the outstanding unchunked-messages by silently acking or asking broker to redeliver later by marking it unacked. See setAutoAckOldestChunkedMessageOnQueueFull.

+

If it's zero, the pending chunked messages will not be limited.

+

Default: 10

+
Parameters
+ + +
maxPendingChunkedMessagethe number of max pending chunked messages
+
+
+ +
+
+ +

◆ setMaxTotalReceiverQueueSizeAcrossPartitions()

+ +
+
+ + + + + + + + +
void pulsar::ConsumerConfiguration::setMaxTotalReceiverQueueSizeAcrossPartitions (int maxTotalReceiverQueueSizeAcrossPartitions)
+
+

Set the max total receiver queue size across partitons.

+

This setting is used to reduce the receiver queue size for individual partitions setReceiverQueueSize(int) if the total exceeds this value (default: 50000).

+
Parameters
+ + +
maxTotalReceiverQueueSizeAcrossPartitions
+
+
+ +
+
+ +

◆ setMessageListener()

+ +
+
+ + + + + + + + +
ConsumerConfiguration & pulsar::ConsumerConfiguration::setMessageListener (MessageListener messageListener)
+
+

A message listener enables your application to configure how to process and acknowledge messages delivered. A listener will be called in order for every message received.

+ +
+
+ +

◆ setNegativeAckRedeliveryDelayMs()

+ +
+
+ + + + + + + + +
void pulsar::ConsumerConfiguration::setNegativeAckRedeliveryDelayMs (long redeliveryDelayMillis)
+
+

Set the delay to wait before re-delivering messages that have failed to be process.

+

When application uses Consumer#negativeAcknowledge(Message), the failed message will be redelivered after a fixed timeout. The default is 1 min.

+
Parameters
+ + + +
redeliveryDelayredelivery delay for failed messages
timeUnitunit in which the timeout is provided.
+
+
+
Returns
the consumer builder instance
+ +
+
+ +

◆ setPatternAutoDiscoveryPeriod()

+ +
+
+ + + + + + + + +
void pulsar::ConsumerConfiguration::setPatternAutoDiscoveryPeriod (int periodInSeconds)
+
+

Set the time duration in minutes, for which the PatternMultiTopicsConsumer will do a pattern auto discovery. The default value is 60 seconds. less than 0 will disable auto discovery.

+
Parameters
+ + +
periodInSecondsperiod in seconds to do an auto discovery
+
+
+ +
+
+ +

◆ setPriorityLevel()

+ +
+
+ + + + + + + + +
ConsumerConfiguration & pulsar::ConsumerConfiguration::setPriorityLevel (int priorityLevel)
+
+

Set the Priority Level for consumer (0 is the default value and means the highest priority).

+
Parameters
+ + +
priorityLevelthe priority of this consumer
+
+
+
Returns
the ConsumerConfiguration instance
+ +
+
+ +

◆ setProperties()

+ +
+
+ + + + + + + + +
ConsumerConfiguration & pulsar::ConsumerConfiguration::setProperties (const std::map< std::string, std::string > & properties)
+
+

Add all the properties in the provided map

+ +
+
+ +

◆ setProperty()

+ +
+
+ + + + + + + + + + + + + + + + + + +
ConsumerConfiguration & pulsar::ConsumerConfiguration::setProperty (const std::string & name,
const std::string & value 
)
+
+

Sets a new property on a message.

Parameters
+ + + +
namethe name of the property
valuethe associated value
+
+
+ +
+
+ +

◆ setReadCompacted()

+ +
+
+ + + + + + + + +
void pulsar::ConsumerConfiguration::setReadCompacted (bool compacted)
+
+

If enabled, the consumer reads messages from the compacted topics rather than reading the full message backlog of the topic. This means that if the topic has been compacted, the consumer only sees the latest value for each key in the topic, up until the point in the topic message backlog that has been compacted. Beyond that point, message is sent as normal.

+

readCompacted can only be enabled subscriptions to persistent topics, which have a single active consumer (for example, failure or exclusive subscriptions). Attempting to enable it on subscriptions to a non-persistent topics or on a shared subscription leads to the subscription call failure.

+
Parameters
+ + +
readCompactedwhether to read from the compacted topic
+
+
+ +
+
+ +

◆ setReceiverQueueSize()

+ +
+
+ + + + + + + + +
void pulsar::ConsumerConfiguration::setReceiverQueueSize (int size)
+
+

Sets the size of the consumer receive queue.

+

The consumer receive queue controls how many messages can be accumulated by the consumer before the application calls receive(). Using a higher value may potentially increase the consumer throughput at the expense of bigger memory utilization.

+

Setting the consumer queue size to 0 decreases the throughput of the consumer by disabling pre-fetching of messages. This approach improves the message distribution on shared subscription by pushing messages only to the consumers that are ready to process them. Neither receive with timeout nor partitioned topics can be used if the consumer queue size is 0. The receive() function call should not be interrupted when the consumer queue size is 0.

+

The default value is 1000 messages and it is appropriate for the most use cases.

+
Parameters
+ + +
sizethe new receiver queue size value
+
+
+ +
+
+ +

◆ setRegexSubscriptionMode()

+ +
+
+ + + + + + + + +
ConsumerConfiguration & pulsar::ConsumerConfiguration::setRegexSubscriptionMode (RegexSubscriptionMode regexSubscriptionMode)
+
+

Determines which topics this consumer should be subscribed to - Persistent, Non-Persistent, or AllTopics. Only used with pattern subscriptions.

+
Parameters
+ + +
regexSubscriptionModeThe default value is PersistentOnly.
+
+
+ +
+
+ +

◆ setReplicateSubscriptionStateEnabled()

+ +
+
+ + + + + + + + +
void pulsar::ConsumerConfiguration::setReplicateSubscriptionStateEnabled (bool enabled)
+
+

Set whether the subscription status should be replicated. The default value is false.

+
Parameters
+ + +
replicateSubscriptionStatewhether the subscription status should be replicated
+
+
+ +
+
+ +

◆ setSchema()

+ +
+
+ + + + + + + + +
ConsumerConfiguration & pulsar::ConsumerConfiguration::setSchema (const SchemaInfo & schemaInfo)
+
+

Declare the schema of the data that this consumer will be accepting.

+

The schema will be checked against the schema of the topic, and the consumer creation will fail if it's not compatible.

+
Parameters
+ + +
schemaInfothe schema definition object
+
+
+ +
+
+ +

◆ setStartMessageIdInclusive()

+ +
+
+ + + + + + + + +
ConsumerConfiguration & pulsar::ConsumerConfiguration::setStartMessageIdInclusive (bool startMessageIdInclusive)
+
+

Set the consumer to include the given position of any reset operation like Consumer::seek.

+

Default: false

+
Parameters
+ + +
startMessageIdInclusivewhether to include the reset position
+
+
+ +
+
+ +

◆ setSubscriptionInitialPosition()

+ +
+
+ + + + + + + + +
void pulsar::ConsumerConfiguration::setSubscriptionInitialPosition (InitialPosition subscriptionInitialPosition)
+
+

The default value is InitialPositionLatest.

+
Parameters
+ + +
subscriptionInitialPositionthe initial position at which to set the cursor when subscribing to the topic for the first time
+
+
+ +
+
+ +

◆ setSubscriptionProperties()

+ +
+
+ + + + + + + + +
ConsumerConfiguration & pulsar::ConsumerConfiguration::setSubscriptionProperties (const std::map< std::string, std::string > & subscriptionProperties)
+
+

Sets a new subscription properties for this subscription. Notice: SubscriptionProperties are immutable, and consumers under the same subscription will fail to create a subscription if they use different properties.

+
Parameters
+ + +
subscriptionPropertiesall the subscription properties in the provided map
+
+
+ +
+
+ +

◆ setTickDurationInMs()

+ +
+
+ + + + + + + + +
void pulsar::ConsumerConfiguration::setTickDurationInMs (const uint64_t milliSeconds)
+
+

Set the tick duration time that defines the granularity of the ack-timeout redelivery (in milliseconds).

+

The default value is 1000, which means 1 second.

+

Using a higher tick time reduces the memory overhead to track messages when the ack-timeout is set to a bigger value.

+
Parameters
+ + +
milliSecondsthe tick duration time (in milliseconds)
+
+
+ +
+
+ +

◆ setUnAckedMessagesTimeoutMs()

+ +
+
+ + + + + + + + +
void pulsar::ConsumerConfiguration::setUnAckedMessagesTimeoutMs (const uint64_t milliSeconds)
+
+

Set the timeout in milliseconds for unacknowledged messages, the timeout needs to be greater than 10 seconds. An Exception is thrown if the given value is less than 10000 (10 seconds). If a successful acknowledgement is not sent within the timeout all the unacknowledged messages are redelivered.

+

Default: 0, which means the the tracker for unacknowledged messages is disabled.

+
Parameters
+ + +
timeoutin milliseconds
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_consumer_event_listener-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_consumer_event_listener-members.html new file mode 100644 index 000000000000..27a59526ab10 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_consumer_event_listener-members.html @@ -0,0 +1,92 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::ConsumerEventListener Member List
+
+
+ +

This is the complete list of members for pulsar::ConsumerEventListener, including all inherited members.

+ + + + +
becameActive(Consumer consumer, int partitionId)=0pulsar::ConsumerEventListenerpure virtual
becameInactive(Consumer consumer, int partitionId)=0pulsar::ConsumerEventListenerpure virtual
~ConsumerEventListener() (defined in pulsar::ConsumerEventListener)pulsar::ConsumerEventListenerinlinevirtual
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_consumer_event_listener.html b/static/api/cpp/3.5.x/classpulsar_1_1_consumer_event_listener.html new file mode 100644 index 000000000000..41bdc69fa775 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_consumer_event_listener.html @@ -0,0 +1,193 @@ + + + + + + + +pulsar-client-cpp: pulsar::ConsumerEventListener Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +List of all members
+
pulsar::ConsumerEventListener Class Referenceabstract
+
+
+ + + + + + + + +

+Public Member Functions

virtual void becameActive (Consumer consumer, int partitionId)=0
 Notified when the consumer group is changed, and the consumer becomes active.
 
virtual void becameInactive (Consumer consumer, int partitionId)=0
 Notified when the consumer group is changed, and the consumer is still inactive or becomes inactive.
 
+

Member Function Documentation

+ +

◆ becameActive()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
virtual void pulsar::ConsumerEventListener::becameActive (Consumer consumer,
int partitionId 
)
+ 		+pure virtual
+
+ +

Notified when the consumer group is changed, and the consumer becomes active.

+
Parameters
+ + + +
consumerthe consumer that originated the event
partitionIdthe id of the partition that beconmes active.
+
+
+ +
+
+ +

◆ becameInactive()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
virtual void pulsar::ConsumerEventListener::becameInactive (Consumer consumer,
int partitionId 
)
+ 		+pure virtual
+
+ +

Notified when the consumer group is changed, and the consumer is still inactive or becomes inactive.

+
Parameters
+ + + +
consumerthe consumer that originated the event
partitionIdthe id of the partition that is still inactive or becomes inactive.
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_consumer_interceptor-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_consumer_interceptor-members.html new file mode 100644 index 000000000000..fca1ec34323c --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_consumer_interceptor-members.html @@ -0,0 +1,95 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::ConsumerInterceptor Member List
+
+
+ +

This is the complete list of members for pulsar::ConsumerInterceptor, including all inherited members.

+ + + + + + + +
beforeConsume(const Consumer &consumer, const Message &message)=0pulsar::ConsumerInterceptorpure virtual
close()pulsar::ConsumerInterceptorinlinevirtual
onAcknowledge(const Consumer &consumer, Result result, const MessageId &messageID)=0pulsar::ConsumerInterceptorpure virtual
onAcknowledgeCumulative(const Consumer &consumer, Result result, const MessageId &messageID)=0pulsar::ConsumerInterceptorpure virtual
onNegativeAcksSend(const Consumer &consumer, const std::set< MessageId > &messageIds)=0pulsar::ConsumerInterceptorpure virtual
~ConsumerInterceptor() (defined in pulsar::ConsumerInterceptor)pulsar::ConsumerInterceptorinlinevirtual
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_consumer_interceptor.html b/static/api/cpp/3.5.x/classpulsar_1_1_consumer_interceptor.html new file mode 100644 index 000000000000..9faad82ccde4 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_consumer_interceptor.html @@ -0,0 +1,336 @@ + + + + + + + +pulsar-client-cpp: pulsar::ConsumerInterceptor Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +List of all members
+
pulsar::ConsumerInterceptor Class Referenceabstract
+
+
+ +

#include <ConsumerInterceptor.h>

+ + + + + + + + + + + + +

+Public Member Functions

virtual void close ()
 
virtual Message beforeConsume (const Consumer &consumer, const Message &message)=0
 
virtual void onAcknowledge (const Consumer &consumer, Result result, const MessageId &messageID)=0
 
virtual void onAcknowledgeCumulative (const Consumer &consumer, Result result, const MessageId &messageID)=0
 
virtual void onNegativeAcksSend (const Consumer &consumer, const std::set< MessageId > &messageIds)=0
 
+

Detailed Description

+

A plugin interface that allows you to intercept (and possibly mutate) messages received by the consumer.

+

A primary use case is to hook into consumer applications for custom monitoring, logging, etc.

+

Exceptions thrown by interceptor methods will be caught, logged, but not propagated further.

+

Member Function Documentation

+ +

◆ beforeConsume()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
virtual Message pulsar::ConsumerInterceptor::beforeConsume (const Consumer & consumer,
const Message & message 
)
+ 		+pure virtual
+
+

This is called just before the message is consumed.

+

This method is allowed to modify message, in which case the new message will be returned.

+

Any exception thrown by this method will be caught by the caller, logged, but not propagated to client.

+

Since the consumer may run multiple interceptors, a particular interceptor's beforeConsume callback will be called in the order. The first interceptor in the list gets the consumed message, the following interceptor will be passed the message returned by the previous interceptor, and so on. Since interceptors are allowed to modify message, interceptors may potentially get the messages already modified by other interceptors. However building a pipeline of mutable interceptors that depend on the output of the previous interceptor is discouraged, because of potential side-effects caused by interceptors potentially failing to modify the message and throwing an exception. if one of interceptors in the list throws an exception from beforeConsume, the exception is caught, logged, and the next interceptor is called with the message returned by the last successful interceptor in the list, or otherwise the original consumed message.

+
Parameters
+ + + +
consumerthe consumer which contains the interceptor
messagethe message to be consumed by the client
+
+
+
Returns
message that is either modified by the interceptor or same message passed into the method.
+ +
+
+ +

◆ close()

+ +
+
+ + + + + +
+ + + + + + + +
virtual void pulsar::ConsumerInterceptor::close ()
+ 		+inlinevirtual
+
+

Close the interceptor

+ +
+
+ +

◆ onAcknowledge()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
virtual void pulsar::ConsumerInterceptor::onAcknowledge (const Consumer & consumer,
Result result,
const MessageId & messageID 
)
+ 		+pure virtual
+
+

This is called before consumer sends the acknowledgment to the broker.

+

Any exception thrown by this method will be ignored by the caller.

+
Parameters
+ + + + +
consumerthe consumer which contains the interceptor
resultthe result of the acknowledgement
messageIDthe message id to be acknowledged
+
+
+ +
+
+ +

◆ onAcknowledgeCumulative()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
virtual void pulsar::ConsumerInterceptor::onAcknowledgeCumulative (const Consumer & consumer,
Result result,
const MessageId & messageID 
)
+ 		+pure virtual
+
+

This is called before consumer sends the cumulative acknowledgment to the broker.

+

Any exception thrown by this method will be ignored by the caller.

+
Parameters
+ + + + +
consumerthe consumer which contains the interceptor
resultthe result of the cumulative acknowledgement
messageIDthe message id to be acknowledged cumulatively
+
+
+ +
+
+ +

◆ onNegativeAcksSend()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
virtual void pulsar::ConsumerInterceptor::onNegativeAcksSend (const Consumer & consumer,
const std::set< MessageId > & messageIds 
)
+ 		+pure virtual
+
+

This method will be called when a redelivery from a negative acknowledge occurs.

+

Any exception thrown by this method will be ignored by the caller.

+
Parameters
+ + + +
consumerthe consumer which contains the interceptor
messageIdsthe set of message ids to negative ack
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_crypto_key_reader-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_crypto_key_reader-members.html new file mode 100644 index 000000000000..341a931c279b --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_crypto_key_reader-members.html @@ -0,0 +1,93 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::CryptoKeyReader Member List
+
+
+ +

This is the complete list of members for pulsar::CryptoKeyReader, including all inherited members.

+ + + + + +
CryptoKeyReader() (defined in pulsar::CryptoKeyReader)pulsar::CryptoKeyReader
getPrivateKey(const std::string &keyName, std::map< std::string, std::string > &metadata, EncryptionKeyInfo &encKeyInfo) const =0pulsar::CryptoKeyReaderpure virtual
getPublicKey(const std::string &keyName, std::map< std::string, std::string > &metadata, EncryptionKeyInfo &encKeyInfo) const =0pulsar::CryptoKeyReaderpure virtual
~CryptoKeyReader() (defined in pulsar::CryptoKeyReader)pulsar::CryptoKeyReadervirtual
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_crypto_key_reader.html b/static/api/cpp/3.5.x/classpulsar_1_1_crypto_key_reader.html new file mode 100644 index 000000000000..a37f78eea49c --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_crypto_key_reader.html @@ -0,0 +1,222 @@ + + + + + + + +pulsar-client-cpp: pulsar::CryptoKeyReader Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +List of all members
+
pulsar::CryptoKeyReader Class Referenceabstract
+
+
+ +

#include <CryptoKeyReader.h>

+
+Inheritance diagram for pulsar::CryptoKeyReader:
+
+
+ + +pulsar::DefaultCryptoKeyReader + +
+ + + + + + +

+Public Member Functions

virtual Result getPublicKey (const std::string &keyName, std::map< std::string, std::string > &metadata, EncryptionKeyInfo &encKeyInfo) const =0
 
virtual Result getPrivateKey (const std::string &keyName, std::map< std::string, std::string > &metadata, EncryptionKeyInfo &encKeyInfo) const =0
 
+

Detailed Description

+

The abstract class that abstracts the access to a key store

+

Member Function Documentation

+ +

◆ getPrivateKey()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
virtual Result pulsar::CryptoKeyReader::getPrivateKey (const std::string & keyName,
std::map< std::string, std::string > & metadata,
EncryptionKeyInfo & encKeyInfo 
) const
+ 		+pure virtual
+
+
Parameters
+ + + + +
keyNameUnique name to identify the key
metadataAdditional information needed to identify the key
encKeyInfoupdated with details about the private key
+
+
+
Returns
Result ResultOk is returned for success
+ +

Implemented in pulsar::DefaultCryptoKeyReader.

+ +
+
+ +

◆ getPublicKey()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
virtual Result pulsar::CryptoKeyReader::getPublicKey (const std::string & keyName,
std::map< std::string, std::string > & metadata,
EncryptionKeyInfo & encKeyInfo 
) const
+ 		+pure virtual
+
+

Return the encryption key corresponding to the key name in the argument

+

This method should be implemented to return the EncryptionKeyInfo. This method will be called at the time of producer creation as well as consumer receiving messages. Hence, application should not make any blocking calls within the implementation.

+
Parameters
+ + + + +
keyNameUnique name to identify the key
metadataAdditional information needed to identify the key
encKeyInfoupdated with details about the public key
+
+
+
Returns
Result ResultOk is returned for success
+ +

Implemented in pulsar::DefaultCryptoKeyReader.

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_crypto_key_reader.png b/static/api/cpp/3.5.x/classpulsar_1_1_crypto_key_reader.png new file mode 100644 index 000000000000..4e960a182a2f Binary files /dev/null and b/static/api/cpp/3.5.x/classpulsar_1_1_crypto_key_reader.png differ diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_dead_letter_policy-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_dead_letter_policy-members.html new file mode 100644 index 000000000000..78e8c1872c64 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_dead_letter_policy-members.html @@ -0,0 +1,94 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::DeadLetterPolicy Member List
+
+
+ +

This is the complete list of members for pulsar::DeadLetterPolicy, including all inherited members.

+ + + + + + +
DeadLetterPolicy() (defined in pulsar::DeadLetterPolicy)pulsar::DeadLetterPolicy
DeadLetterPolicyBuilder (defined in pulsar::DeadLetterPolicy)pulsar::DeadLetterPolicyfriend
getDeadLetterTopic() constpulsar::DeadLetterPolicy
getInitialSubscriptionName() constpulsar::DeadLetterPolicy
getMaxRedeliverCount() constpulsar::DeadLetterPolicy
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_dead_letter_policy.html b/static/api/cpp/3.5.x/classpulsar_1_1_dead_letter_policy.html new file mode 100644 index 000000000000..5afef20ef92e --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_dead_letter_policy.html @@ -0,0 +1,172 @@ + + + + + + + +pulsar-client-cpp: pulsar::DeadLetterPolicy Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +Friends | +List of all members
+
pulsar::DeadLetterPolicy Class Reference
+
+
+ +

#include <DeadLetterPolicy.h>

+ + + + + + + + +

+Public Member Functions

const std::string & getDeadLetterTopic () const
 
int getMaxRedeliverCount () const
 
const std::string & getInitialSubscriptionName () const
 
+ + + +

+Friends

+class DeadLetterPolicyBuilder
 
+

Detailed Description

+

Configuration for the "dead letter queue" feature in consumer.

+

see @DeadLetterPolicyBuilder

+

Member Function Documentation

+ +

◆ getDeadLetterTopic()

+ +
+
+ + + + + + + +
const std::string & pulsar::DeadLetterPolicy::getDeadLetterTopic () const
+
+

Get dead letter topic

+
Returns
+ +
+
+ +

◆ getInitialSubscriptionName()

+ +
+
+ + + + + + + +
const std::string & pulsar::DeadLetterPolicy::getInitialSubscriptionName () const
+
+

Get initial subscription name

+
Returns
+ +
+
+ +

◆ getMaxRedeliverCount()

+ +
+
+ + + + + + + +
int pulsar::DeadLetterPolicy::getMaxRedeliverCount () const
+
+

Get max redeliver count

+
Returns
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_dead_letter_policy_builder-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_dead_letter_policy_builder-members.html new file mode 100644 index 000000000000..f723bc2e1740 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_dead_letter_policy_builder-members.html @@ -0,0 +1,94 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::DeadLetterPolicyBuilder Member List
+
+
+ +

This is the complete list of members for pulsar::DeadLetterPolicyBuilder, including all inherited members.

+ + + + + + +
build()pulsar::DeadLetterPolicyBuilder
DeadLetterPolicyBuilder() (defined in pulsar::DeadLetterPolicyBuilder)pulsar::DeadLetterPolicyBuilder
deadLetterTopic(const std::string &deadLetterTopic)pulsar::DeadLetterPolicyBuilder
initialSubscriptionName(const std::string &initialSubscriptionName)pulsar::DeadLetterPolicyBuilder
maxRedeliverCount(int maxRedeliverCount)pulsar::DeadLetterPolicyBuilder
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_dead_letter_policy_builder.html b/static/api/cpp/3.5.x/classpulsar_1_1_dead_letter_policy_builder.html new file mode 100644 index 000000000000..eac4e6865d54 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_dead_letter_policy_builder.html @@ -0,0 +1,223 @@ + + + + + + + +pulsar-client-cpp: pulsar::DeadLetterPolicyBuilder Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +List of all members
+
pulsar::DeadLetterPolicyBuilder Class Reference
+
+
+ +

#include <DeadLetterPolicyBuilder.h>

+ + + + + + + + + + +

+Public Member Functions

DeadLetterPolicyBuilder & deadLetterTopic (const std::string &deadLetterTopic)
 
DeadLetterPolicyBuilder & maxRedeliverCount (int maxRedeliverCount)
 
DeadLetterPolicyBuilder & initialSubscriptionName (const std::string &initialSubscriptionName)
 
DeadLetterPolicy build ()
 
+

Detailed Description

+

The builder to build a DeadLetterPolicyBuilder

+

Example of building DeadLetterPolicy:

+
++
+
DeadLetterPolicy dlqPolicy = DeadLetterPolicyBuilder()
+
.deadLetterTopic("dlq-topic")
+
.maxRedeliverCount(10)
+
.initialSubscriptionName("init-sub-name")
+
.build();
+
pulsar::DeadLetterPolicyBuilder
Definition DeadLetterPolicyBuilder.h:44
+ +
pulsar::DeadLetterPolicyBuilder::deadLetterTopic
DeadLetterPolicyBuilder & deadLetterTopic(const std::string &deadLetterTopic)
+
pulsar::DeadLetterPolicyBuilder::initialSubscriptionName
DeadLetterPolicyBuilder & initialSubscriptionName(const std::string &initialSubscriptionName)
+
pulsar::DeadLetterPolicyBuilder::maxRedeliverCount
DeadLetterPolicyBuilder & maxRedeliverCount(int maxRedeliverCount)
+
pulsar::DeadLetterPolicy
Definition DeadLetterPolicy.h:36
+

Member Function Documentation

+ +

◆ build()

+ +
+
+ + + + + + + +
DeadLetterPolicy pulsar::DeadLetterPolicyBuilder::build ()
+
+

Build DeadLetterPolicy.

+
Returns
+ +
+
+ +

◆ deadLetterTopic()

+ +
+
+ + + + + + + + +
DeadLetterPolicyBuilder & pulsar::DeadLetterPolicyBuilder::deadLetterTopic (const std::string & deadLetterTopic)
+
+

Set dead letter topic.

+
Parameters
+ + +
deadLetterTopicName of the dead topic where the failing messages are sent. The default value is: sourceTopicName + "-" + subscriptionName + "-DLQ"
+
+
+
Returns
+ +
+
+ +

◆ initialSubscriptionName()

+ +
+
+ + + + + + + + +
DeadLetterPolicyBuilder & pulsar::DeadLetterPolicyBuilder::initialSubscriptionName (const std::string & initialSubscriptionName)
+
+

Set initial subscription name

+
Parameters
+ + +
initialSubscriptionNameName of the initial subscription name of the dead letter topic. If this field is not set, the initial subscription for the dead letter topic is not created. If this field is set but the broker's allowAutoSubscriptionCreation is disabled, the DLQ producer fails to be created.
+
+
+
Returns
+ +
+
+ +

◆ maxRedeliverCount()

+ +
+
+ + + + + + + + +
DeadLetterPolicyBuilder & pulsar::DeadLetterPolicyBuilder::maxRedeliverCount (int maxRedeliverCount)
+
+

Set max redeliver count

+
Parameters
+ + +
maxRedeliverCountMaximum number of times that a message is redelivered before being sent to the dead letter queue.
    +
  • The maxRedeliverCount must be greater than 0.
    • +
  • The default value is {INT_MAX} (DLQ is not enabled)
    • +
+
+
+
+
Returns
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_default_crypto_key_reader-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_default_crypto_key_reader-members.html new file mode 100644 index 000000000000..25a2b9a23aab --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_default_crypto_key_reader-members.html @@ -0,0 +1,96 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::DefaultCryptoKeyReader Member List
+
+
+ +

This is the complete list of members for pulsar::DefaultCryptoKeyReader, including all inherited members.

+ + + + + + + + +
create(const std::string &publicKeyPath, const std::string &privateKeyPath) (defined in pulsar::DefaultCryptoKeyReader)pulsar::DefaultCryptoKeyReaderstatic
CryptoKeyReader() (defined in pulsar::CryptoKeyReader)pulsar::CryptoKeyReader
DefaultCryptoKeyReader(const std::string &publicKeyPath, const std::string &privateKeyPath)pulsar::DefaultCryptoKeyReader
getPrivateKey(const std::string &keyName, std::map< std::string, std::string > &metadata, EncryptionKeyInfo &encKeyInfo) constpulsar::DefaultCryptoKeyReadervirtual
getPublicKey(const std::string &keyName, std::map< std::string, std::string > &metadata, EncryptionKeyInfo &encKeyInfo) constpulsar::DefaultCryptoKeyReadervirtual
~CryptoKeyReader() (defined in pulsar::CryptoKeyReader)pulsar::CryptoKeyReadervirtual
~DefaultCryptoKeyReader() (defined in pulsar::DefaultCryptoKeyReader)pulsar::DefaultCryptoKeyReader
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_default_crypto_key_reader.html b/static/api/cpp/3.5.x/classpulsar_1_1_default_crypto_key_reader.html new file mode 100644 index 000000000000..2de31472fac0 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_default_crypto_key_reader.html @@ -0,0 +1,267 @@ + + + + + + + +pulsar-client-cpp: pulsar::DefaultCryptoKeyReader Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +Static Public Member Functions | +List of all members
+
pulsar::DefaultCryptoKeyReader Class Reference
+
+
+
+Inheritance diagram for pulsar::DefaultCryptoKeyReader:
+
+
+ + +pulsar::CryptoKeyReader + +
+ + + + + + + + +

+Public Member Functions

 DefaultCryptoKeyReader (const std::string &publicKeyPath, const std::string &privateKeyPath)
 
Result getPublicKey (const std::string &keyName, std::map< std::string, std::string > &metadata, EncryptionKeyInfo &encKeyInfo) const
 
Result getPrivateKey (const std::string &keyName, std::map< std::string, std::string > &metadata, EncryptionKeyInfo &encKeyInfo) const
 
+ + + +

+Static Public Member Functions

+static CryptoKeyReaderPtr create (const std::string &publicKeyPath, const std::string &privateKeyPath)
 
+

Constructor & Destructor Documentation

+ +

◆ DefaultCryptoKeyReader()

+ +
+
+ + + + + + + + + + + + + + + + + + +
pulsar::DefaultCryptoKeyReader::DefaultCryptoKeyReader (const std::string & publicKeyPath,
const std::string & privateKeyPath 
)
+
+

The constructor of CryptoKeyReader

+

Configure the key reader to be used to decrypt the message payloads

+
Parameters
+ + + +
publicKeyPaththe path to the public key
privateKeyPaththe path to the private key
+
+
+
Since
2.8.0
+ +
+
+

Member Function Documentation

+ +

◆ getPrivateKey()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
Result pulsar::DefaultCryptoKeyReader::getPrivateKey (const std::string & keyName,
std::map< std::string, std::string > & metadata,
EncryptionKeyInfo & encKeyInfo 
) const
+ 		+virtual
+
+

Return the encryption key corresponding to the key name in the argument.

+
Parameters
+ + + + +
[in]keyNamethe unique name to identify the key
[in]metadatathe additional information needed to identify the key
[out]encKeyInfothe EncryptionKeyInfo with details about the private key
+
+
+
Returns
ResultOk
+ +

Implements pulsar::CryptoKeyReader.

+ +
+
+ +

◆ getPublicKey()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
Result pulsar::DefaultCryptoKeyReader::getPublicKey (const std::string & keyName,
std::map< std::string, std::string > & metadata,
EncryptionKeyInfo & encKeyInfo 
) const
+ 		+virtual
+
+

Return the encryption key corresponding to the key name in the argument.

+

This method should be implemented to return the EncryptionKeyInfo. This method is called when creating producers as well as allowing consumers to receive messages. Consequently, the application should not make any blocking calls within the implementation.

+
Parameters
+ + + + +
[in]keyNamethe unique name to identify the key
[in]metadatathe additional information needed to identify the key
[out]encKeyInfothe EncryptionKeyInfo with details about the public key
+
+
+
Returns
ResultOk
+ +

Implements pulsar::CryptoKeyReader.

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_default_crypto_key_reader.png b/static/api/cpp/3.5.x/classpulsar_1_1_default_crypto_key_reader.png new file mode 100644 index 000000000000..3310f6463ecb Binary files /dev/null and b/static/api/cpp/3.5.x/classpulsar_1_1_default_crypto_key_reader.png differ diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_deprecated_exception-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_deprecated_exception-members.html new file mode 100644 index 000000000000..c5e50cb58ec4 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_deprecated_exception-members.html @@ -0,0 +1,90 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::DeprecatedException Member List
+
+
+ +

This is the complete list of members for pulsar::DeprecatedException, including all inherited members.

+ + +
DeprecatedException(const std::string &__arg) (defined in pulsar::DeprecatedException)pulsar::DeprecatedExceptionexplicit
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_deprecated_exception.html b/static/api/cpp/3.5.x/classpulsar_1_1_deprecated_exception.html new file mode 100644 index 000000000000..eb56c9f08e8d --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_deprecated_exception.html @@ -0,0 +1,105 @@ + + + + + + + +pulsar-client-cpp: pulsar::DeprecatedException Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +List of all members
+
pulsar::DeprecatedException Class Reference
+
+
+
+Inheritance diagram for pulsar::DeprecatedException:
+
+
+ +
+ + + + +

+Public Member Functions

+ DeprecatedException (const std::string &__arg)
 
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_deprecated_exception.png b/static/api/cpp/3.5.x/classpulsar_1_1_deprecated_exception.png new file mode 100644 index 000000000000..9c05ab423a49 Binary files /dev/null and b/static/api/cpp/3.5.x/classpulsar_1_1_deprecated_exception.png differ diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_encryption_key_info-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_encryption_key_info-members.html new file mode 100644 index 000000000000..d59b5bca5b46 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_encryption_key_info-members.html @@ -0,0 +1,97 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::EncryptionKeyInfo Member List
+
+
+ +

This is the complete list of members for pulsar::EncryptionKeyInfo, including all inherited members.

+ + + + + + + + + +
EncryptionKeyInfo() (defined in pulsar::EncryptionKeyInfo)pulsar::EncryptionKeyInfo
EncryptionKeyInfo(std::string key, StringMap &metadata)pulsar::EncryptionKeyInfo
getKey()pulsar::EncryptionKeyInfo
getMetadata(void)pulsar::EncryptionKeyInfo
PulsarWrapper (defined in pulsar::EncryptionKeyInfo)pulsar::EncryptionKeyInfofriend
setKey(std::string key)pulsar::EncryptionKeyInfo
setMetadata(StringMap &metadata)pulsar::EncryptionKeyInfo
StringMap typedef (defined in pulsar::EncryptionKeyInfo)pulsar::EncryptionKeyInfo
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_encryption_key_info.html b/static/api/cpp/3.5.x/classpulsar_1_1_encryption_key_info.html new file mode 100644 index 000000000000..493a5dbe005f --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_encryption_key_info.html @@ -0,0 +1,238 @@ + + + + + + + +pulsar-client-cpp: pulsar::EncryptionKeyInfo Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Types | +Public Member Functions | +Friends | +List of all members
+
pulsar::EncryptionKeyInfo Class Reference
+
+
+ + + + +

+Public Types

+typedef std::map< std::string, std::string > StringMap
 
+ + + + + + + + + + + +

+Public Member Functions

 EncryptionKeyInfo (std::string key, StringMap &metadata)
 
std::string & getKey ()
 
void setKey (std::string key)
 
StringMap & getMetadata (void)
 
void setMetadata (StringMap &metadata)
 
+ + + +

+Friends

+class PulsarWrapper
 
+

Constructor & Destructor Documentation

+ +

◆ EncryptionKeyInfo()

+ +
+
+ + + + + + + + + + + + + + + + + + +
pulsar::EncryptionKeyInfo::EncryptionKeyInfo (std::string key,
StringMap & metadata 
)
+
+

EncryptionKeyInfo contains the encryption key and corresponding metadata which contains additional information about the key, such as version and timestamp.

+ +
+
+

Member Function Documentation

+ +

◆ getKey()

+ +
+
+ + + + + + + +
std::string & pulsar::EncryptionKeyInfo::getKey ()
+
+
Returns
the key of the message
+ +
+
+ +

◆ getMetadata()

+ +
+
+ + + + + + + + +
StringMap & pulsar::EncryptionKeyInfo::getMetadata (void )
+
+
Returns
the metadata information
+ +
+
+ +

◆ setKey()

+ +
+
+ + + + + + + + +
void pulsar::EncryptionKeyInfo::setKey (std::string key)
+
+

Set the key of the message for routing policy

+
Parameters
+ + +
Keythe key of the message for routing policy
+
+
+ +
+
+ +

◆ setMetadata()

+ +
+
+ + + + + + + + +
void pulsar::EncryptionKeyInfo::setMetadata (StringMap & metadata)
+
+

Set metadata information

+
Parameters
+ + +
Metadatathe information of metadata
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_file_logger_factory-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_file_logger_factory-members.html new file mode 100644 index 000000000000..f6bb07098e1e --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_file_logger_factory-members.html @@ -0,0 +1,93 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::FileLoggerFactory Member List
+
+
+ +

This is the complete list of members for pulsar::FileLoggerFactory, including all inherited members.

+ + + + + +
FileLoggerFactory(Logger::Level level, const std::string &logFilePath)pulsar::FileLoggerFactory
getLogger(const std::string &filename) overridepulsar::FileLoggerFactoryvirtual
~FileLoggerFactory() (defined in pulsar::FileLoggerFactory)pulsar::FileLoggerFactory
~LoggerFactory() (defined in pulsar::LoggerFactory)pulsar::LoggerFactoryinlinevirtual
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_file_logger_factory.html b/static/api/cpp/3.5.x/classpulsar_1_1_file_logger_factory.html new file mode 100644 index 000000000000..4d421fb556aa --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_file_logger_factory.html @@ -0,0 +1,201 @@ + + + + + + + +pulsar-client-cpp: pulsar::FileLoggerFactory Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +List of all members
+
pulsar::FileLoggerFactory Class Reference
+
+
+ +

#include <FileLoggerFactory.h>

+
+Inheritance diagram for pulsar::FileLoggerFactory:
+
+
+ + +pulsar::LoggerFactory + +
+ + + + + + +

+Public Member Functions

 FileLoggerFactory (Logger::Level level, const std::string &logFilePath)
 
pulsar::Logger * getLogger (const std::string &filename) override
 
+

Detailed Description

+

A logger factory that is appending logs to a single file.

+

The log format is "yyyy-MM-dd HH:mm:ss,SSS Z <level> <thread-id> <file>:<line> | <msg>", like

+
2021-03-24 17:35:46,571 +0800 INFO [0x10a951e00] ConnectionPool:85 | Created connection for ...
+

Example:

+
++
+
#include <pulsar/FileLoggerFactory.h>
+
+
ClientConfiguration conf;
+
conf.setLogger(new FileLoggerFactory(Logger::LEVEL_DEBUG, "pulsar-client-cpp.log"));
+
Client client("pulsar://localhost:6650", conf);
+
pulsar::ClientConfiguration
Definition ClientConfiguration.h:29
+
pulsar::ClientConfiguration::setLogger
ClientConfiguration & setLogger(LoggerFactory *loggerFactory)
+
pulsar::Client
Definition Client.h:49
+
pulsar::FileLoggerFactory
Definition FileLoggerFactory.h:47
+

Constructor & Destructor Documentation

+ +

◆ FileLoggerFactory()

+ +
+
+ + + + + + + + + + + + + + + + + + +
pulsar::FileLoggerFactory::FileLoggerFactory (Logger::Level level,
const std::string & logFilePath 
)
+
+

Create a FileLoggerFactory instance.

+
Parameters
+ + + +
levelthe log level
logFilePaththe log file's path
+
+
+ +
+
+

Member Function Documentation

+ +

◆ getLogger()

+ +
+
+ + + + + +
+ + + + + + + + +
pulsar::Logger * pulsar::FileLoggerFactory::getLogger (const std::string & fileName)
+ 		+overridevirtual
+
+

Create a Logger that is created from the filename

+
Parameters
+ + +
fileNamethe filename that is used to construct the Logger
+
+
+
Returns
a pointer to the created Logger instance
+
Note
the pointer must be allocated with the new keyword in C++
+ +

Implements pulsar::LoggerFactory.

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_file_logger_factory.png b/static/api/cpp/3.5.x/classpulsar_1_1_file_logger_factory.png new file mode 100644 index 000000000000..5fb08d9ffe76 Binary files /dev/null and b/static/api/cpp/3.5.x/classpulsar_1_1_file_logger_factory.png differ diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_key_shared_policy-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_key_shared_policy-members.html new file mode 100644 index 000000000000..98a443c931b6 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_key_shared_policy-members.html @@ -0,0 +1,101 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::KeySharedPolicy Member List
+
+
+ +

This is the complete list of members for pulsar::KeySharedPolicy, including all inherited members.

+ + + + + + + + + + + + + +
clone() constpulsar::KeySharedPolicy
getKeySharedMode() constpulsar::KeySharedPolicy
getStickyRanges() constpulsar::KeySharedPolicy
isAllowOutOfOrderDelivery() constpulsar::KeySharedPolicy
KeySharedPolicy() (defined in pulsar::KeySharedPolicy)pulsar::KeySharedPolicy
KeySharedPolicy(const KeySharedPolicy &) (defined in pulsar::KeySharedPolicy)pulsar::KeySharedPolicy
operator=(const KeySharedPolicy &) (defined in pulsar::KeySharedPolicy)pulsar::KeySharedPolicy
setAllowOutOfOrderDelivery(bool allowOutOfOrderDelivery)pulsar::KeySharedPolicy
setKeySharedMode(KeySharedMode keySharedMode)pulsar::KeySharedPolicy
setStickyRanges(std::initializer_list< StickyRange > ranges)pulsar::KeySharedPolicy
setStickyRanges(const StickyRanges &ranges)pulsar::KeySharedPolicy
~KeySharedPolicy() (defined in pulsar::KeySharedPolicy)pulsar::KeySharedPolicy
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_key_shared_policy.html b/static/api/cpp/3.5.x/classpulsar_1_1_key_shared_policy.html new file mode 100644 index 000000000000..6cee85087fe3 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_key_shared_policy.html @@ -0,0 +1,292 @@ + + + + + + + +pulsar-client-cpp: pulsar::KeySharedPolicy Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +List of all members
+
pulsar::KeySharedPolicy Class Reference
+
+
+ + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ KeySharedPolicy (const KeySharedPolicy &)
 
+KeySharedPolicy & operator= (const KeySharedPolicy &)
 
KeySharedPolicy clone () const
 
KeySharedPolicy & setKeySharedMode (KeySharedMode keySharedMode)
 
KeySharedMode getKeySharedMode () const
 
KeySharedPolicy & setAllowOutOfOrderDelivery (bool allowOutOfOrderDelivery)
 
bool isAllowOutOfOrderDelivery () const
 
KeySharedPolicy & setStickyRanges (std::initializer_list< StickyRange > ranges)
 
KeySharedPolicy & setStickyRanges (const StickyRanges &ranges)
 
StickyRanges getStickyRanges () const
 
+

Member Function Documentation

+ +

◆ clone()

+ +
+
+ + + + + + + +
KeySharedPolicy pulsar::KeySharedPolicy::clone () const
+
+

Create a new instance of KeySharedPolicy with the same initial settings as the current one.

+ +
+
+ +

◆ getKeySharedMode()

+ +
+
+ + + + + + + +
KeySharedMode pulsar::KeySharedPolicy::getKeySharedMode () const
+
+
Returns
the KeySharedMode of KeyShared subscription
+ +
+
+ +

◆ getStickyRanges()

+ +
+
+ + + + + + + +
StickyRanges pulsar::KeySharedPolicy::getStickyRanges () const
+
+
Returns
ranges used with sticky mode
+ +
+
+ +

◆ isAllowOutOfOrderDelivery()

+ +
+
+ + + + + + + +
bool pulsar::KeySharedPolicy::isAllowOutOfOrderDelivery () const
+
+
Returns
true if out of order delivery is enabled
+ +
+
+ +

◆ setAllowOutOfOrderDelivery()

+ +
+
+ + + + + + + + +
KeySharedPolicy & pulsar::KeySharedPolicy::setAllowOutOfOrderDelivery (bool allowOutOfOrderDelivery)
+
+

If it is enabled, it relaxes the ordering requirement and allows the broker to send out-of-order messages in case of failures. This makes it faster for new consumers to join without being stalled by an existing slow consumer.

+

In this case, a single consumer still receives all keys, but they may come in different orders.

+
Parameters
+ + +
allowOutOfOrderDeliverywhether to allow for out of order delivery
+
+
+ +
+
+ +

◆ setKeySharedMode()

+ +
+
+ + + + + + + + +
KeySharedPolicy & pulsar::KeySharedPolicy::setKeySharedMode (KeySharedMode keySharedMode)
+
+

Configure the KeyShared mode of KeyShared subscription

+
Parameters
+ + +
KeySharedmode
+
+
+
See also
KeySharedMode
+ +
+
+ +

◆ setStickyRanges() [1/2]

+ +
+
+ + + + + + + + +
KeySharedPolicy & pulsar::KeySharedPolicy::setStickyRanges (const StickyRanges & ranges)
+
+
Parameters
+ + +
rangesused with sticky mode
+
+
+ +
+
+ +

◆ setStickyRanges() [2/2]

+ +
+
+ + + + + + + + +
KeySharedPolicy & pulsar::KeySharedPolicy::setStickyRanges (std::initializer_list< StickyRange > ranges)
+
+
Parameters
+ + +
rangesused with sticky mode
+
+
+
Deprecated:
use the function that takes StickyRanges instead of std::initializer_list
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_key_value-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_key_value-members.html new file mode 100644 index 000000000000..aee68e1fd41e --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_key_value-members.html @@ -0,0 +1,96 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::KeyValue Member List
+
+
+ +

This is the complete list of members for pulsar::KeyValue, including all inherited members.

+ + + + + + + + +
getKey() constpulsar::KeyValue
getValue() constpulsar::KeyValue
getValueAsString() constpulsar::KeyValue
getValueLength() constpulsar::KeyValue
KeyValue(std::string &&key, std::string &&value)pulsar::KeyValue
Message (defined in pulsar::KeyValue)pulsar::KeyValuefriend
MessageBuilder (defined in pulsar::KeyValue)pulsar::KeyValuefriend
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_key_value.html b/static/api/cpp/3.5.x/classpulsar_1_1_key_value.html new file mode 100644 index 000000000000..006a40c310dc --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_key_value.html @@ -0,0 +1,235 @@ + + + + + + + +pulsar-client-cpp: pulsar::KeyValue Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +Friends | +List of all members
+
pulsar::KeyValue Class Reference
+
+
+ +

#include <KeyValue.h>

+ + + + + + + + + + + + +

+Public Member Functions

 KeyValue (std::string &&key, std::string &&value)
 
std::string getKey () const
 
const void * getValue () const
 
size_t getValueLength () const
 
std::string getValueAsString () const
 
+ + + + + +

+Friends

+class Message
 
+class MessageBuilder
 
+

Detailed Description

+

Use to when the user uses key value schema.

+

Constructor & Destructor Documentation

+ +

◆ KeyValue()

+ +
+
+ + + + + + + + + + + + + + + + + + +
pulsar::KeyValue::KeyValue (std::string && key,
std::string && value 
)
+
+

Constructor key value, according to keyValueEncodingType, whether key and value be encoded together.

+
Parameters
+ + + + +
keykey data.
valuevalue data.
keyValueEncodingTypekey value encoding type.
+
+
+ +
+
+

Member Function Documentation

+ +

◆ getKey()

+ +
+
+ + + + + + + +
std::string pulsar::KeyValue::getKey () const
+
+

Get the key of KeyValue.

+
Returns
character stream for key
+ +
+
+ +

◆ getValue()

+ +
+
+ + + + + + + +
const void * pulsar::KeyValue::getValue () const
+
+

Get the value of the KeyValue.

+
Returns
the pointer to the KeyValue value
+ +
+
+ +

◆ getValueAsString()

+ +
+
+ + + + + + + +
std::string pulsar::KeyValue::getValueAsString () const
+
+

Get string representation of the KeyValue value.

+
Returns
the string representation of the KeyValue value
+ +
+
+ +

◆ getValueLength()

+ +
+
+ + + + + + + +
size_t pulsar::KeyValue::getValueLength () const
+
+

Get the value length of the keyValue.

+
Returns
the length of the KeyValue value
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_logger-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_logger-members.html new file mode 100644 index 000000000000..5a2cb9a9dc7f --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_logger-members.html @@ -0,0 +1,97 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::Logger Member List
+
+
+ +

This is the complete list of members for pulsar::Logger, including all inherited members.

+ + + + + + + + + +
isEnabled(Level level)=0pulsar::Loggerpure virtual
Level enum name (defined in pulsar::Logger)pulsar::Logger
LEVEL_DEBUG enum value (defined in pulsar::Logger)pulsar::Logger
LEVEL_ERROR enum value (defined in pulsar::Logger)pulsar::Logger
LEVEL_INFO enum value (defined in pulsar::Logger)pulsar::Logger
LEVEL_WARN enum value (defined in pulsar::Logger)pulsar::Logger
log(Level level, int line, const std::string &message)=0pulsar::Loggerpure virtual
~Logger() (defined in pulsar::Logger)pulsar::Loggerinlinevirtual
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_logger.html b/static/api/cpp/3.5.x/classpulsar_1_1_logger.html new file mode 100644 index 000000000000..22f41f571cff --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_logger.html @@ -0,0 +1,196 @@ + + + + + + + +pulsar-client-cpp: pulsar::Logger Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Types | +Public Member Functions | +List of all members
+
pulsar::Logger Class Referenceabstract
+
+
+ + + + +

+Public Types

enum  Level { LEVEL_DEBUG = 0 +, LEVEL_INFO = 1 +, LEVEL_WARN = 2 +, LEVEL_ERROR = 3 + }
 
+ + + + + +

+Public Member Functions

virtual bool isEnabled (Level level)=0
 
virtual void log (Level level, int line, const std::string &message)=0
 
+

Member Function Documentation

+ +

◆ isEnabled()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual bool pulsar::Logger::isEnabled (Level level)
+ 		+pure virtual
+
+

Check whether the log level is enabled

+
Parameters
+ + +
levelthe Logger::Level
+
+
+
Returns
true if log is enabled
+ +
+
+ +

◆ log()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
virtual void pulsar::Logger::log (Level level,
int line,
const std::string & message 
)
+ 		+pure virtual
+
+

Log the message with related metadata

+
Parameters
+ + + + +
levelthe Logger::Level
linethe line number of this log
messagethe message to log
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_logger_factory-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_logger_factory-members.html new file mode 100644 index 000000000000..9591b7874ca6 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_logger_factory-members.html @@ -0,0 +1,91 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::LoggerFactory Member List
+
+
+ +

This is the complete list of members for pulsar::LoggerFactory, including all inherited members.

+ + + +
getLogger(const std::string &fileName)=0pulsar::LoggerFactorypure virtual
~LoggerFactory() (defined in pulsar::LoggerFactory)pulsar::LoggerFactoryinlinevirtual
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_logger_factory.html b/static/api/cpp/3.5.x/classpulsar_1_1_logger_factory.html new file mode 100644 index 000000000000..72da2930b02e --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_logger_factory.html @@ -0,0 +1,146 @@ + + + + + + + +pulsar-client-cpp: pulsar::LoggerFactory Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +List of all members
+
pulsar::LoggerFactory Class Referenceabstract
+
+
+
+Inheritance diagram for pulsar::LoggerFactory:
+
+
+ + +pulsar::ConsoleLoggerFactory +pulsar::FileLoggerFactory + +
+ + + + +

+Public Member Functions

virtual Logger * getLogger (const std::string &fileName)=0
 
+

Member Function Documentation

+ +

◆ getLogger()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual Logger * pulsar::LoggerFactory::getLogger (const std::string & fileName)
+ 		+pure virtual
+
+

Create a Logger that is created from the filename

+
Parameters
+ + +
fileNamethe filename that is used to construct the Logger
+
+
+
Returns
a pointer to the created Logger instance
+
Note
the pointer must be allocated with the new keyword in C++
+ +

Implemented in pulsar::ConsoleLoggerFactory, and pulsar::FileLoggerFactory.

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_logger_factory.png b/static/api/cpp/3.5.x/classpulsar_1_1_logger_factory.png new file mode 100644 index 000000000000..caf009dedfd3 Binary files /dev/null and b/static/api/cpp/3.5.x/classpulsar_1_1_logger_factory.png differ diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_message-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_message-members.html new file mode 100644 index 000000000000..435df31b851a --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_message-members.html @@ -0,0 +1,132 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::Message Member List
+
+
+ +

This is the complete list of members for pulsar::Message, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
BatchAcknowledgementTracker (defined in pulsar::Message)pulsar::Messagefriend
BatchMessageContainerBase (defined in pulsar::Message)pulsar::Messagefriend
Commands (defined in pulsar::Message)pulsar::Messagefriend
ConsumerImpl (defined in pulsar::Message)pulsar::Messagefriend
getData() constpulsar::Message
getDataAsString() constpulsar::Message
getEventTimestamp() constpulsar::Message
getIndex() constpulsar::Message
getKeyValueData() constpulsar::Message
getLength() constpulsar::Message
getLongSchemaVersion() constpulsar::Message
getMessageId() constpulsar::Message
getOrderingKey() constpulsar::Message
getPartitionKey() constpulsar::Message
getProperties() constpulsar::Message
getProperty(const std::string &name) constpulsar::Message
getPublishTimestamp() constpulsar::Message
getRedeliveryCount() constpulsar::Message
getSchemaVersion() constpulsar::Message
getTopicName() constpulsar::Message
hasOrderingKey() constpulsar::Message
hasPartitionKey() constpulsar::Message
hasProperty(const std::string &name) constpulsar::Message
hasSchemaVersion() constpulsar::Message
impl_ (defined in pulsar::Message)pulsar::Messageprotected
Message() (defined in pulsar::Message)pulsar::Message
Message(MessageImplPtr &impl) (defined in pulsar::Message)pulsar::Messageprotected
Message(const MessageId &messageId, proto::BrokerEntryMetadata &brokerEntryMetadata, proto::MessageMetadata &metadata, SharedBuffer &payload) (defined in pulsar::Message)pulsar::Messageprotected
Message(const MessageId &messageId, proto::BrokerEntryMetadata &brokerEntryMetadata, proto::MessageMetadata &metadata, SharedBuffer &payload, proto::SingleMessageMetadata &singleMetadata, const std::shared_ptr< std::string > &topicName)pulsar::Messageprotected
MessageBatch (defined in pulsar::Message)pulsar::Messagefriend
MessageBuilder (defined in pulsar::Message)pulsar::Messagefriend
MessageImplPtr typedef (defined in pulsar::Message)pulsar::Messageprotected
MultiTopicsConsumerImpl (defined in pulsar::Message)pulsar::Messagefriend
operator<< (defined in pulsar::Message)pulsar::Messagefriend
operator<< (defined in pulsar::Message)pulsar::Messagefriend
operator==(const Message &msg) const (defined in pulsar::Message)pulsar::Message
OpSendMsg (defined in pulsar::Message)pulsar::Messagefriend
PartitionedProducerImpl (defined in pulsar::Message)pulsar::Messagefriend
ProducerImpl (defined in pulsar::Message)pulsar::Messagefriend
PulsarFriend (defined in pulsar::Message)pulsar::Messagefriend
PulsarWrapper (defined in pulsar::Message)pulsar::Messagefriend
setMessageId(const MessageId &messageId) constpulsar::Message
StringMap typedef (defined in pulsar::Message)pulsar::Message
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_message.html b/static/api/cpp/3.5.x/classpulsar_1_1_message.html new file mode 100644 index 000000000000..ec02ddf2d49c --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_message.html @@ -0,0 +1,640 @@ + + + + + + + +pulsar-client-cpp: pulsar::Message Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Types | +Public Member Functions | +Protected Types | +Protected Member Functions | +Protected Attributes | +Friends | +List of all members
+
pulsar::Message Class Reference
+
+
+
+Inheritance diagram for pulsar::Message:
+
+
+ + +pulsar::TypedMessage< T > + +
+ + + + +

+Public Types

+typedef std::map< std::string, std::string > StringMap
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

const StringMap & getProperties () const
 
bool hasProperty (const std::string &name) const
 
const std::string & getProperty (const std::string &name) const
 
const void * getData () const
 
std::size_t getLength () const
 
std::string getDataAsString () const
 
KeyValue getKeyValueData () const
 
const MessageId & getMessageId () const
 
void setMessageId (const MessageId &messageId) const
 
int64_t getIndex () const
 
const std::string & getPartitionKey () const
 
bool hasPartitionKey () const
 
const std::string & getOrderingKey () const
 
bool hasOrderingKey () const
 
uint64_t getPublishTimestamp () const
 
uint64_t getEventTimestamp () const
 
const std::string & getTopicName () const
 
const int getRedeliveryCount () const
 
bool hasSchemaVersion () const
 
int64_t getLongSchemaVersion () const
 
const std::string & getSchemaVersion () const
 
+bool operator== (const Message &msg) const
 
+ + + +

+Protected Types

+typedef std::shared_ptr< MessageImpl > MessageImplPtr
 
+ + + + + + + + +

+Protected Member Functions

+ Message (MessageImplPtr &impl)
 
+ Message (const MessageId &messageId, proto::BrokerEntryMetadata &brokerEntryMetadata, proto::MessageMetadata &metadata, SharedBuffer &payload)
 
+ Message (const MessageId &messageId, proto::BrokerEntryMetadata &brokerEntryMetadata, proto::MessageMetadata &metadata, SharedBuffer &payload, proto::SingleMessageMetadata &singleMetadata, const std::shared_ptr< std::string > &topicName)
 Used for Batch Messages.
 
+ + + +

+Protected Attributes

+MessageImplPtr impl_
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Friends

+class PartitionedProducerImpl
 
+class MultiTopicsConsumerImpl
 
+class MessageBuilder
 
+class ConsumerImpl
 
+class ProducerImpl
 
+class Commands
 
+class BatchMessageContainerBase
 
+class BatchAcknowledgementTracker
 
+class PulsarWrapper
 
+class MessageBatch
 
+struct OpSendMsg
 
+class PulsarFriend
 
+PULSAR_PUBLIC std::ostream & operator<< (std::ostream &s, const StringMap &map)
 
+PULSAR_PUBLIC std::ostream & operator<< (std::ostream &s, const Message &msg)
 
+

Member Function Documentation

+ +

◆ getData()

+ +
+
+ + + + + + + +
const void * pulsar::Message::getData () const
+
+

Get the content of the message

+
Returns
the pointer to the message payload
+ +
+
+ +

◆ getDataAsString()

+ +
+
+ + + + + + + +
std::string pulsar::Message::getDataAsString () const
+
+

Get string representation of the message

+
Returns
the string representation of the message payload
+

NOTE: For MSVC with debug mode, return a thread local std::string object to avoid memory allocation across DLLs and applications, which could lead to a crash.

+ +
+
+ +

◆ getEventTimestamp()

+ +
+
+ + + + + + + +
uint64_t pulsar::Message::getEventTimestamp () const
+
+

Get the event timestamp associated with this message. It is set by the client producer.

+ +
+
+ +

◆ getIndex()

+ +
+
+ + + + + + + +
int64_t pulsar::Message::getIndex () const
+
+

Get the index of this message, if it doesn't exist, return -1

Returns
+ +
+
+ +

◆ getKeyValueData()

+ +
+
+ + + + + + + +
KeyValue pulsar::Message::getKeyValueData () const
+
+

Get key value message.

+
Returns
key value message.
+ +
+
+ +

◆ getLength()

+ +
+
+ + + + + + + +
std::size_t pulsar::Message::getLength () const
+
+

Get the length of the message

+
Returns
the length of the message payload
+ +
+
+ +

◆ getLongSchemaVersion()

+ +
+
+ + + + + + + +
int64_t pulsar::Message::getLongSchemaVersion () const
+
+

Get the schema version.

+
Returns
the the schema version on success or -1 if the message does not have the schema version
+ +
+
+ +

◆ getMessageId()

+ +
+
+ + + + + + + +
const MessageId & pulsar::Message::getMessageId () const
+
+

Get the unique message ID associated with this message.

+

The message id can be used to univocally refer to a message without having to keep the entire payload in memory.

+

Only messages received from the consumer will have a message id assigned.

+ +
+
+ +

◆ getOrderingKey()

+ +
+
+ + + + + + + +
const std::string & pulsar::Message::getOrderingKey () const
+
+

Get the ordering key of the message

+
Returns
the ordering key of the message
+ +
+
+ +

◆ getPartitionKey()

+ +
+
+ + + + + + + +
const std::string & pulsar::Message::getPartitionKey () const
+
+

Get the partition key for this message

Returns
key string that is hashed to determine message's topic partition
+ +
+
+ +

◆ getProperties()

+ +
+
+ + + + + + + +
const StringMap & pulsar::Message::getProperties () const
+
+

Return the properties attached to the message. Properties are application defined key/value pairs that will be attached to the message

+
Returns
an unmodifiable view of the properties map
+ +
+
+ +

◆ getProperty()

+ +
+
+ + + + + + + + +
const std::string & pulsar::Message::getProperty (const std::string & name) const
+
+

Get the value of a specific property

+
Parameters
+ + +
namethe name of the property
+
+
+
Returns
the value of the property or null if the property was not defined
+ +
+
+ +

◆ getPublishTimestamp()

+ +
+
+ + + + + + + +
uint64_t pulsar::Message::getPublishTimestamp () const
+
+

Get the UTC based timestamp in milliseconds referring to when the message was published by the client producer

+ +
+
+ +

◆ getRedeliveryCount()

+ +
+
+ + + + + + + +
const int pulsar::Message::getRedeliveryCount () const
+
+

Get the redelivery count for this message

+ +
+
+ +

◆ getSchemaVersion()

+ +
+
+ + + + + + + +
const std::string & pulsar::Message::getSchemaVersion () const
+
+

Get the schema version of the raw bytes.

+ +
+
+ +

◆ getTopicName()

+ +
+
+ + + + + + + +
const std::string & pulsar::Message::getTopicName () const
+
+

Get the topic Name from which this message originated from

+ +
+
+ +

◆ hasOrderingKey()

+ +
+
+ + + + + + + +
bool pulsar::Message::hasOrderingKey () const
+
+

Check whether the message has a ordering key

+
Returns
true if the ordering key was set while creating the message false if the ordering key was not set while creating the message
+ +
+
+ +

◆ hasPartitionKey()

+ +
+
+ + + + + + + +
bool pulsar::Message::hasPartitionKey () const
+
+
Returns
true if the message has a partition key
+ +
+
+ +

◆ hasProperty()

+ +
+
+ + + + + + + + +
bool pulsar::Message::hasProperty (const std::string & name) const
+
+

Check whether the message has a specific property attached.

+
Parameters
+ + +
namethe name of the property to check
+
+
+
Returns
true if the message has the specified property
+
+false if the property is not defined
+ +
+
+ +

◆ hasSchemaVersion()

+ +
+
+ + + + + + + +
bool pulsar::Message::hasSchemaVersion () const
+
+

Check if schema version exists

+ +
+
+ +

◆ setMessageId()

+ +
+
+ + + + + + + + +
void pulsar::Message::setMessageId (const MessageId & messageId) const
+
+

Set the unique message ID.

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_message.png b/static/api/cpp/3.5.x/classpulsar_1_1_message.png new file mode 100644 index 000000000000..14ceea56b3a3 Binary files /dev/null and b/static/api/cpp/3.5.x/classpulsar_1_1_message.png differ diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_message_batch-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_message_batch-members.html new file mode 100644 index 000000000000..7befd39354c6 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_message_batch-members.html @@ -0,0 +1,94 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::MessageBatch Member List
+
+
+ +

This is the complete list of members for pulsar::MessageBatch, including all inherited members.

+ + + + + + +
MessageBatch() (defined in pulsar::MessageBatch)pulsar::MessageBatch
messages() (defined in pulsar::MessageBatch)pulsar::MessageBatch
parseFrom(const std::string &payload, uint32_t batchSize) (defined in pulsar::MessageBatch)pulsar::MessageBatch
parseFrom(const SharedBuffer &payload, uint32_t batchSize) (defined in pulsar::MessageBatch)pulsar::MessageBatch
withMessageId(const MessageId &messageId) (defined in pulsar::MessageBatch)pulsar::MessageBatch
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_message_batch.html b/static/api/cpp/3.5.x/classpulsar_1_1_message_batch.html new file mode 100644 index 000000000000..c498a6187bf7 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_message_batch.html @@ -0,0 +1,108 @@ + + + + + + + +pulsar-client-cpp: pulsar::MessageBatch Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +List of all members
+
pulsar::MessageBatch Class Reference
+
+
+ + + + + + + + + + +

+Public Member Functions

+MessageBatch & withMessageId (const MessageId &messageId)
 
+MessageBatch & parseFrom (const std::string &payload, uint32_t batchSize)
 
+MessageBatch & parseFrom (const SharedBuffer &payload, uint32_t batchSize)
 
+const std::vector< Message > & messages ()
 
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_message_builder-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_message_builder-members.html new file mode 100644 index 000000000000..7f9aeb40c1a3 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_message_builder-members.html @@ -0,0 +1,111 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::MessageBuilder Member List
+
+
+ +

This is the complete list of members for pulsar::MessageBuilder, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + +
build()pulsar::MessageBuilder
create()pulsar::MessageBuilder
data() const (defined in pulsar::MessageBuilder)pulsar::MessageBuilderprotected
disableReplication(bool flag)pulsar::MessageBuilder
MessageBuilder() (defined in pulsar::MessageBuilder)pulsar::MessageBuilder
PulsarWrapper (defined in pulsar::MessageBuilder)pulsar::MessageBuilderfriend
setAllocatedContent(void *data, size_t size)pulsar::MessageBuilder
setContent(const void *data, size_t size)pulsar::MessageBuilder
setContent(const std::string &data)pulsar::MessageBuilder
setContent(std::string &&data)pulsar::MessageBuilder
setContent(const KeyValue &data)pulsar::MessageBuilder
setDeliverAfter(const std::chrono::milliseconds delay)pulsar::MessageBuilder
setDeliverAt(uint64_t deliveryTimestamp)pulsar::MessageBuilder
setEventTimestamp(uint64_t eventTimestamp)pulsar::MessageBuilder
setOrderingKey(const std::string &orderingKey)pulsar::MessageBuilder
setPartitionKey(const std::string &partitionKey)pulsar::MessageBuilder
setProperties(const StringMap &properties)pulsar::MessageBuilder
setProperty(const std::string &name, const std::string &value)pulsar::MessageBuilder
setReplicationClusters(const std::vector< std::string > &clusters)pulsar::MessageBuilder
setSequenceId(int64_t sequenceId)pulsar::MessageBuilder
size() const (defined in pulsar::MessageBuilder)pulsar::MessageBuilderprotected
StringMap typedef (defined in pulsar::MessageBuilder)pulsar::MessageBuilder
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_message_builder.html b/static/api/cpp/3.5.x/classpulsar_1_1_message_builder.html new file mode 100644 index 000000000000..1e8959151fe5 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_message_builder.html @@ -0,0 +1,590 @@ + + + + + + + +pulsar-client-cpp: pulsar::MessageBuilder Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Types | +Public Member Functions | +Protected Member Functions | +Friends | +List of all members
+
pulsar::MessageBuilder Class Reference
+
+
+
+Inheritance diagram for pulsar::MessageBuilder:
+
+
+ + +pulsar::TypedMessageBuilder< T > +pulsar::TypedMessageBuilder< std::string > + +
+ + + + +

+Public Types

+typedef std::map< std::string, std::string > StringMap
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

Message build ()
 
MessageBuilder & setContent (const void *data, size_t size)
 
MessageBuilder & setContent (const std::string &data)
 
MessageBuilder & setContent (std::string &&data)
 
MessageBuilder & setContent (const KeyValue &data)
 
MessageBuilder & setAllocatedContent (void *data, size_t size)
 
MessageBuilder & setProperty (const std::string &name, const std::string &value)
 
MessageBuilder & setProperties (const StringMap &properties)
 
MessageBuilder & setPartitionKey (const std::string &partitionKey)
 
MessageBuilder & setOrderingKey (const std::string &orderingKey)
 
MessageBuilder & setDeliverAfter (const std::chrono::milliseconds delay)
 
MessageBuilder & setDeliverAt (uint64_t deliveryTimestamp)
 
MessageBuilder & setEventTimestamp (uint64_t eventTimestamp)
 
MessageBuilder & setSequenceId (int64_t sequenceId)
 
MessageBuilder & setReplicationClusters (const std::vector< std::string > &clusters)
 
MessageBuilder & disableReplication (bool flag)
 
MessageBuilder & create ()
 
+ + + + + +

+Protected Member Functions

+const char * data () const
 
+std::size_t size () const
 
+ + + +

+Friends

+class PulsarWrapper
 
+

Member Function Documentation

+ +

◆ build()

+ +
+
+ + + + + + + +
Message pulsar::MessageBuilder::build ()
+
+

Finalize the immutable message

+ +
+
+ +

◆ create()

+ +
+
+ + + + + + + +
MessageBuilder & pulsar::MessageBuilder::create ()
+
+

create a empty message, with no properties or data

+ +
+
+ +

◆ disableReplication()

+ +
+
+ + + + + + + + +
MessageBuilder & pulsar::MessageBuilder::disableReplication (bool flag)
+
+

Do not replicate this message

Parameters
+ + +
flagif true, disable replication, otherwise use default replication
+
+
+ +
+
+ +

◆ setAllocatedContent()

+ +
+
+ + + + + + + + + + + + + + + + + + +
MessageBuilder & pulsar::MessageBuilder::setAllocatedContent (void * data,
size_t size 
)
+
+

Set content of the message to a buffer already allocated by the caller. No copies of this buffer will be made. The caller is responsible to ensure the memory buffer is valid until the message has been persisted (or an error is returned).

+ +
+
+ +

◆ setContent() [1/4]

+ +
+
+ + + + + + + + +
MessageBuilder & pulsar::MessageBuilder::setContent (const KeyValue & data)
+
+

Set the key value content of the message

+
Parameters
+ + +
datathe content of the key value.
+
+
+ +
+
+ +

◆ setContent() [2/4]

+ +
+
+ + + + + + + + +
MessageBuilder & pulsar::MessageBuilder::setContent (const std::string & data)
+
+

Set the content of the message

+
Parameters
+ + +
datathe content of the message.
+
+
+
See also
setContent(const void*, size_t)
+ +
+
+ +

◆ setContent() [3/4]

+ +
+
+ + + + + + + + + + + + + + + + + + +
MessageBuilder & pulsar::MessageBuilder::setContent (const void * data,
size_t size 
)
+
+

Set content of the message. The given data is copied into message.

+ +
+
+ +

◆ setContent() [4/4]

+ +
+
+ + + + + + + + +
MessageBuilder & pulsar::MessageBuilder::setContent (std::string && data)
+
+

Set the content of the message

+
Parameters
+ + +
datathe content of the message. The given data is moved into message.
+
+
+ +
+
+ +

◆ setDeliverAfter()

+ +
+
+ + + + + + + + +
MessageBuilder & pulsar::MessageBuilder::setDeliverAfter (const std::chrono::milliseconds delay)
+
+

Specify a delay for the delivery of the messages.

+
Parameters
+ + +
delaythe delay in milliseconds
+
+
+ +
+
+ +

◆ setDeliverAt()

+ +
+
+ + + + + + + + +
MessageBuilder & pulsar::MessageBuilder::setDeliverAt (uint64_t deliveryTimestamp)
+
+

Specify the this message should not be delivered earlier than the specified timestamp.

+
Parameters
+ + +
deliveryTimestampUTC based timestamp in milliseconds
+
+
+ +
+
+ +

◆ setEventTimestamp()

+ +
+
+ + + + + + + + +
MessageBuilder & pulsar::MessageBuilder::setEventTimestamp (uint64_t eventTimestamp)
+
+

Set the event timestamp for the message.

+ +
+
+ +

◆ setOrderingKey()

+ +
+
+ + + + + + + + +
MessageBuilder & pulsar::MessageBuilder::setOrderingKey (const std::string & orderingKey)
+
+

set ordering key used for key_shared subscriptions

Parameters
+ + +
theordering key for the message
+
+
+ +
+
+ +

◆ setPartitionKey()

+ +
+
+ + + + + + + + +
MessageBuilder & pulsar::MessageBuilder::setPartitionKey (const std::string & partitionKey)
+
+

set partition key for message routing and topic compaction

Parameters
+ + +
hashof this key is used to determine message's topic partition
+
+
+ +
+
+ +

◆ setProperties()

+ +
+
+ + + + + + + + +
MessageBuilder & pulsar::MessageBuilder::setProperties (const StringMap & properties)
+
+

Add all the properties in the provided map

+ +
+
+ +

◆ setProperty()

+ +
+
+ + + + + + + + + + + + + + + + + + +
MessageBuilder & pulsar::MessageBuilder::setProperty (const std::string & name,
const std::string & value 
)
+
+

Sets a new property on a message.

Parameters
+ + + +
namethe name of the property
valuethe associated value
+
+
+ +
+
+ +

◆ setReplicationClusters()

+ +
+
+ + + + + + + + +
MessageBuilder & pulsar::MessageBuilder::setReplicationClusters (const std::vector< std::string > & clusters)
+
+

override namespace replication clusters. note that it is the caller's responsibility to provide valid cluster names, and that all clusters have been previously configured as topics.

+

given an empty list, the message will replicate per the namespace configuration.

+
Parameters
+ + +
clusterswhere to send this message.
+
+
+ +
+
+ +

◆ setSequenceId()

+ +
+
+ + + + + + + + +
MessageBuilder & pulsar::MessageBuilder::setSequenceId (int64_t sequenceId)
+
+

Specify a custom sequence id for the message being published.

+

The sequence id can be used for deduplication purposes and it needs to follow these rules:

    +
  1. +sequenceId >= 0
    2. +
  2. +Sequence id for a message needs to be greater than sequence id for earlier messages: sequenceId(N+1) > sequenceId(N)
    3. +
  3. +It's not necessary for sequence ids to be consecutive. There can be holes between messages. Eg. the sequenceId could represent an offset or a cumulative size.
    4. +
+
Parameters
+ + +
sequenceIdthe sequence id to assign to the current message
+
+
+
Since
1.20.0
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_message_builder.png b/static/api/cpp/3.5.x/classpulsar_1_1_message_builder.png new file mode 100644 index 000000000000..d2d75a0c9321 Binary files /dev/null and b/static/api/cpp/3.5.x/classpulsar_1_1_message_builder.png differ diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_message_id-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_message_id-members.html new file mode 100644 index 000000000000..7b220ef16fd4 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_message_id-members.html @@ -0,0 +1,124 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::MessageId Member List
+
+
+ +

This is the complete list of members for pulsar::MessageId, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
BatchAcknowledgementTracker (defined in pulsar::MessageId)pulsar::MessageIdfriend
batchIndex() const (defined in pulsar::MessageId)pulsar::MessageId
batchSize() const (defined in pulsar::MessageId)pulsar::MessageId
ChunkMessageIdImpl (defined in pulsar::MessageId)pulsar::MessageIdfriend
Commands (defined in pulsar::MessageId)pulsar::MessageIdfriend
ConsumerImpl (defined in pulsar::MessageId)pulsar::MessageIdfriend
deserialize(const std::string &serializedMessageId)pulsar::MessageIdstatic
earliest()pulsar::MessageIdstatic
entryId() const (defined in pulsar::MessageId)pulsar::MessageId
getTopicName() constpulsar::MessageId
latest()pulsar::MessageIdstatic
ledgerId() const (defined in pulsar::MessageId)pulsar::MessageId
Message (defined in pulsar::MessageId)pulsar::MessageIdfriend
MessageId() (defined in pulsar::MessageId)pulsar::MessageId
MessageId(int32_t partition, int64_t ledgerId, int64_t entryId, int32_t batchIndex)pulsar::MessageIdexplicit
MessageIdBuilder (defined in pulsar::MessageId)pulsar::MessageIdfriend
MessageImpl (defined in pulsar::MessageId)pulsar::MessageIdfriend
MultiTopicsConsumerImpl (defined in pulsar::MessageId)pulsar::MessageIdfriend
NegativeAcksTracker (defined in pulsar::MessageId)pulsar::MessageIdfriend
operator!=(const MessageId &other) const (defined in pulsar::MessageId)pulsar::MessageId
operator<(const MessageId &other) const (defined in pulsar::MessageId)pulsar::MessageId
operator<< (defined in pulsar::MessageId)pulsar::MessageIdfriend
operator<=(const MessageId &other) const (defined in pulsar::MessageId)pulsar::MessageId
operator=(const MessageId &) (defined in pulsar::MessageId)pulsar::MessageId
operator==(const MessageId &other) const (defined in pulsar::MessageId)pulsar::MessageId
operator>(const MessageId &other) const (defined in pulsar::MessageId)pulsar::MessageId
operator>=(const MessageId &other) const (defined in pulsar::MessageId)pulsar::MessageId
partition() const (defined in pulsar::MessageId)pulsar::MessageId
PartitionedProducerImpl (defined in pulsar::MessageId)pulsar::MessageIdfriend
PulsarFriend (defined in pulsar::MessageId)pulsar::MessageIdfriend
PulsarWrapper (defined in pulsar::MessageId)pulsar::MessageIdfriend
ReaderImpl (defined in pulsar::MessageId)pulsar::MessageIdfriend
serialize(std::string &result) constpulsar::MessageId
setTopicName(const std::string &topicName)pulsar::MessageId
UnAckedMessageTrackerEnabled (defined in pulsar::MessageId)pulsar::MessageIdfriend
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_message_id.html b/static/api/cpp/3.5.x/classpulsar_1_1_message_id.html new file mode 100644 index 000000000000..abe4f57b22a9 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_message_id.html @@ -0,0 +1,397 @@ + + + + + + + +pulsar-client-cpp: pulsar::MessageId Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +Static Public Member Functions | +Friends | +List of all members
+
pulsar::MessageId Class Reference
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+MessageId & operator= (const MessageId &)
 
 MessageId (int32_t partition, int64_t ledgerId, int64_t entryId, int32_t batchIndex)
 
void serialize (std::string &result) const
 
const std::string & getTopicName () const
 
void setTopicName (const std::string &topicName)
 
+bool operator< (const MessageId &other) const
 
+bool operator<= (const MessageId &other) const
 
+bool operator> (const MessageId &other) const
 
+bool operator>= (const MessageId &other) const
 
+bool operator== (const MessageId &other) const
 
+bool operator!= (const MessageId &other) const
 
+int64_t ledgerId () const
 
+int64_t entryId () const
 
+int32_t batchIndex () const
 
+int32_t partition () const
 
+int32_t batchSize () const
 
+ + + + + + + +

+Static Public Member Functions

static const MessageId & earliest ()
 
static const MessageId & latest ()
 
static MessageId deserialize (const std::string &serializedMessageId)
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Friends

+class ConsumerImpl
 
+class ReaderImpl
 
+class Message
 
+class MessageImpl
 
+class Commands
 
+class PartitionedProducerImpl
 
+class MultiTopicsConsumerImpl
 
+class UnAckedMessageTrackerEnabled
 
+class BatchAcknowledgementTracker
 
+class PulsarWrapper
 
+class PulsarFriend
 
+class NegativeAcksTracker
 
+class MessageIdBuilder
 
+class ChunkMessageIdImpl
 
+PULSAR_PUBLIC std::ostream & operator<< (std::ostream &s, const MessageId &messageId)
 
+

Constructor & Destructor Documentation

+ +

◆ MessageId()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
pulsar::MessageId::MessageId (int32_t partition,
int64_t ledgerId,
int64_t entryId,
int32_t batchIndex 
)
+ 		+explicit
+
+
Deprecated:
+

Construct the MessageId

+

NOTE: This API still exists for backward compatibility, use MessageIdBuilder instead.

+
Parameters
+ + + + + +
partitionthe partition number of a topic
ledgerIdthe ledger id
entryIdthe entry id
batchIndexthe batch index of a single message in a batch
+
+
+ +
+
+

Member Function Documentation

+ +

◆ deserialize()

+ +
+
+ + + + + +
+ + + + + + + + +
static MessageId pulsar::MessageId::deserialize (const std::string & serializedMessageId)
+ 		+static
+
+

Deserialize a message id from a binary string

+ +
+
+ +

◆ earliest()

+ +
+
+ + + + + +
+ + + + + + + +
static const MessageId & pulsar::MessageId::earliest ()
+ 		+static
+
+

MessageId representing the "earliest" or "oldest available" message stored in the topic

+ +
+
+ +

◆ getTopicName()

+ +
+
+ + + + + + + +
const std::string & pulsar::MessageId::getTopicName () const
+
+

Get the topic Name from which this message originated from

+
Returns
the topic name or an empty string if there is no topic name
+ +
+
+ +

◆ latest()

+ +
+
+ + + + + +
+ + + + + + + +
static const MessageId & pulsar::MessageId::latest ()
+ 		+static
+
+

MessageId representing the "latest" or "last published" message in the topic

+ +
+
+ +

◆ serialize()

+ +
+
+ + + + + + + + +
void pulsar::MessageId::serialize (std::string & result) const
+
+

Serialize the message id into a binary string for storing

+ +
+
+ +

◆ setTopicName()

+ +
+
+ + + + + + + + +
void pulsar::MessageId::setTopicName (const std::string & topicName)
+
+

Set the topicName

Deprecated:
This method will be eventually removed
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_message_id_builder-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_message_id_builder-members.html new file mode 100644 index 000000000000..97822306c48a --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_message_id_builder-members.html @@ -0,0 +1,98 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::MessageIdBuilder Member List
+
+
+ +

This is the complete list of members for pulsar::MessageIdBuilder, including all inherited members.

+ + + + + + + + + + +
batchIndex(int32_t batchIndex)pulsar::MessageIdBuilder
batchSize(int32_t batchSize)pulsar::MessageIdBuilder
build() constpulsar::MessageIdBuilder
entryId(int64_t entryId)pulsar::MessageIdBuilder
from(const MessageId &messageId)pulsar::MessageIdBuilderstatic
from(const proto::MessageIdData &messageIdData)pulsar::MessageIdBuilderstatic
ledgerId(int64_t ledgerId)pulsar::MessageIdBuilder
MessageIdBuilder() (defined in pulsar::MessageIdBuilder)pulsar::MessageIdBuilderexplicit
partition(int32_t partition)pulsar::MessageIdBuilder
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_message_id_builder.html b/static/api/cpp/3.5.x/classpulsar_1_1_message_id_builder.html new file mode 100644 index 000000000000..dc8ea33d84cb --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_message_id_builder.html @@ -0,0 +1,316 @@ + + + + + + + +pulsar-client-cpp: pulsar::MessageIdBuilder Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +Static Public Member Functions | +List of all members
+
pulsar::MessageIdBuilder Class Reference
+
+
+ +

#include <MessageIdBuilder.h>

+ + + + + + + + + + + + + + +

+Public Member Functions

MessageId build () const
 
MessageIdBuilder & ledgerId (int64_t ledgerId)
 
MessageIdBuilder & entryId (int64_t entryId)
 
MessageIdBuilder & partition (int32_t partition)
 
MessageIdBuilder & batchIndex (int32_t batchIndex)
 
MessageIdBuilder & batchSize (int32_t batchSize)
 
+ + + + + +

+Static Public Member Functions

static MessageIdBuilder from (const MessageId &messageId)
 
static MessageIdBuilder from (const proto::MessageIdData &messageIdData)
 
+

Detailed Description

+

The builder to build a MessageId.

+

Example of building a single MessageId:

+
++
+
MessageId msgId = MessageIdBuilder()
+
.ledgerId(0L)
+
.entryId(0L)
+
.build();
+
pulsar::MessageIdBuilder
Definition MessageIdBuilder.h:54
+
pulsar::MessageIdBuilder::build
MessageId build() const
+
pulsar::MessageIdBuilder::ledgerId
MessageIdBuilder & ledgerId(int64_t ledgerId)
+
pulsar::MessageIdBuilder::entryId
MessageIdBuilder & entryId(int64_t entryId)
+
pulsar::MessageId
Definition MessageId.h:34
+

Example of building a batched MessageId:

+
++
+
MessageId msgId = MessageIdBuilder()
+
.ledgerId(0L)
+
.entryId(0L)
+
.batchIndex(0)
+
.batchSize(2)
+
.build();
+
pulsar::MessageIdBuilder::batchSize
MessageIdBuilder & batchSize(int32_t batchSize)
+
pulsar::MessageIdBuilder::batchIndex
MessageIdBuilder & batchIndex(int32_t batchIndex)
+

Member Function Documentation

+ +

◆ batchIndex()

+ +
+
+ + + + + + + + +
MessageIdBuilder & pulsar::MessageIdBuilder::batchIndex (int32_t batchIndex)
+
+

Set the batch index.

+

Default: -1

+ +
+
+ +

◆ batchSize()

+ +
+
+ + + + + + + + +
MessageIdBuilder & pulsar::MessageIdBuilder::batchSize (int32_t batchSize)
+
+

Set the batch size.

+

Default: 0

+ +
+
+ +

◆ build()

+ +
+
+ + + + + + + +
MessageId pulsar::MessageIdBuilder::build () const
+
+

Build a MessageId.

+ +
+
+ +

◆ entryId()

+ +
+
+ + + + + + + + +
MessageIdBuilder & pulsar::MessageIdBuilder::entryId (int64_t entryId)
+
+

Set the entry ID field.

+

Default: -1L

+ +
+
+ +

◆ from() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + +
static MessageIdBuilder pulsar::MessageIdBuilder::from (const MessageId & messageId)
+ 		+static
+
+

Create an instance that copies the data from messageId.

+ +
+
+ +

◆ from() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + +
static MessageIdBuilder pulsar::MessageIdBuilder::from (const proto::MessageIdData & messageIdData)
+ 		+static
+
+

Create an instance from the proto::MessageIdData instance.

+
Note
It's an internal API that converts the MessageIdData defined by PulsarApi.proto
+
See also
https://github.com/apache/pulsar-client-cpp/blob/main/proto/PulsarApi.proto
+ +
+
+ +

◆ ledgerId()

+ +
+
+ + + + + + + + +
MessageIdBuilder & pulsar::MessageIdBuilder::ledgerId (int64_t ledgerId)
+
+

Set the ledger ID field.

+

Default: -1L

+ +
+
+ +

◆ partition()

+ +
+
+ + + + + + + + +
MessageIdBuilder & pulsar::MessageIdBuilder::partition (int32_t partition)
+
+

Set the partition index.

+

Default: -1

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_message_routing_policy-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_message_routing_policy-members.html new file mode 100644 index 000000000000..8679562bd1e5 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_message_routing_policy-members.html @@ -0,0 +1,92 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::MessageRoutingPolicy Member List
+
+
+ +

This is the complete list of members for pulsar::MessageRoutingPolicy, including all inherited members.

+ + + + +
getPartition(const Message &msg)pulsar::MessageRoutingPolicyinlinevirtual
getPartition(const Message &msg, const TopicMetadata &topicMetadata)pulsar::MessageRoutingPolicyinlinevirtual
~MessageRoutingPolicy() (defined in pulsar::MessageRoutingPolicy)pulsar::MessageRoutingPolicyinlinevirtual
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_message_routing_policy.html b/static/api/cpp/3.5.x/classpulsar_1_1_message_routing_policy.html new file mode 100644 index 000000000000..db6d499afe15 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_message_routing_policy.html @@ -0,0 +1,173 @@ + + + + + + + +pulsar-client-cpp: pulsar::MessageRoutingPolicy Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +List of all members
+
pulsar::MessageRoutingPolicy Class Reference
+
+
+ + + + + + +

+Public Member Functions

virtual int getPartition (const Message &msg)
 
virtual int getPartition (const Message &msg, const TopicMetadata &topicMetadata)
 
+

Member Function Documentation

+ +

◆ getPartition() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + +
virtual int pulsar::MessageRoutingPolicy::getPartition (const Message & msg)
+ 		+inlinevirtual
+
+
Deprecated:
Use int getPartition(const Message& msg, const TopicMetadata& topicMetadata)
+ +
+
+ +

◆ getPartition() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
virtual int pulsar::MessageRoutingPolicy::getPartition (const Message & msg,
const TopicMetadata & topicMetadata 
)
+ 		+inlinevirtual
+
+

Choose the partition from the message and topic metadata

+
Parameters
+ + + +
messagethe Message
topicMetadatathe TopicMetadata that contains the partition number
+
+
+
Returns
the partition number
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_oauth2_flow-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_oauth2_flow-members.html new file mode 100644 index 000000000000..d95c0a5f3ce1 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_oauth2_flow-members.html @@ -0,0 +1,94 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::Oauth2Flow Member List
+
+
+ +

This is the complete list of members for pulsar::Oauth2Flow, including all inherited members.

+ + + + + + +
authenticate()=0pulsar::Oauth2Flowpure virtual
close()=0pulsar::Oauth2Flowpure virtual
initialize()=0pulsar::Oauth2Flowpure virtual
Oauth2Flow() (defined in pulsar::Oauth2Flow)pulsar::Oauth2Flowprotected
~Oauth2Flow() (defined in pulsar::Oauth2Flow)pulsar::Oauth2Flowvirtual
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_oauth2_flow.html b/static/api/cpp/3.5.x/classpulsar_1_1_oauth2_flow.html new file mode 100644 index 000000000000..5548a9254746 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_oauth2_flow.html @@ -0,0 +1,181 @@ + + + + + + + +pulsar-client-cpp: pulsar::Oauth2Flow Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +List of all members
+
pulsar::Oauth2Flow Class Referenceabstract
+
+
+ + + + + + + + +

+Public Member Functions

virtual void initialize ()=0
 
virtual Oauth2TokenResultPtr authenticate ()=0
 
virtual void close ()=0
 
+

Member Function Documentation

+ +

◆ authenticate()

+ +
+
+ + + + + +
+ + + + + + + +
virtual Oauth2TokenResultPtr pulsar::Oauth2Flow::authenticate ()
+ 		+pure virtual
+
+

Acquires an access token from the OAuth 2.0 authorization server.

Returns
a token result including an access token.
+ +
+
+ +

◆ close()

+ +
+
+ + + + + +
+ + + + + + + +
virtual void pulsar::Oauth2Flow::close ()
+ 		+pure virtual
+
+

Closes the authorization flow.

+ +
+
+ +

◆ initialize()

+ +
+
+ + + + + +
+ + + + + + + +
virtual void pulsar::Oauth2Flow::initialize ()
+ 		+pure virtual
+
+

Initializes the authorization flow.

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_oauth2_token_result-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_oauth2_token_result-members.html new file mode 100644 index 000000000000..8584a0038368 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_oauth2_token_result-members.html @@ -0,0 +1,100 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::Oauth2TokenResult Member List
+
+
+ +

This is the complete list of members for pulsar::Oauth2TokenResult, including all inherited members.

+ + + + + + + + + + + + +
getAccessToken() constpulsar::Oauth2TokenResult
getExpiresIn() constpulsar::Oauth2TokenResult
getIdToken() constpulsar::Oauth2TokenResult
getRefreshToken() constpulsar::Oauth2TokenResult
Oauth2TokenResult() (defined in pulsar::Oauth2TokenResult)pulsar::Oauth2TokenResult
setAccessToken(const std::string &accessToken)pulsar::Oauth2TokenResult
setExpiresIn(const int64_t expiresIn)pulsar::Oauth2TokenResult
setIdToken(const std::string &idToken)pulsar::Oauth2TokenResult
setRefreshToken(const std::string &refreshToken)pulsar::Oauth2TokenResult
undefined_expiration enum value (defined in pulsar::Oauth2TokenResult)pulsar::Oauth2TokenResult
~Oauth2TokenResult() (defined in pulsar::Oauth2TokenResult)pulsar::Oauth2TokenResult
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_oauth2_token_result.html b/static/api/cpp/3.5.x/classpulsar_1_1_oauth2_token_result.html new file mode 100644 index 000000000000..aba97cd5402b --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_oauth2_token_result.html @@ -0,0 +1,292 @@ + + + + + + + +pulsar-client-cpp: pulsar::Oauth2TokenResult Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Types | +Public Member Functions | +List of all members
+
pulsar::Oauth2TokenResult Class Reference
+
+
+ + + + +

+Public Types

enum  { undefined_expiration = -1 + }
 
+ + + + + + + + + + + + + + + + + +

+Public Member Functions

Oauth2TokenResult & setAccessToken (const std::string &accessToken)
 
Oauth2TokenResult & setIdToken (const std::string &idToken)
 
Oauth2TokenResult & setRefreshToken (const std::string &refreshToken)
 
Oauth2TokenResult & setExpiresIn (const int64_t expiresIn)
 
const std::string & getAccessToken () const
 
const std::string & getIdToken () const
 
const std::string & getRefreshToken () const
 
int64_t getExpiresIn () const
 
+

Member Function Documentation

+ +

◆ getAccessToken()

+ +
+
+ + + + + + + +
const std::string & pulsar::Oauth2TokenResult::getAccessToken () const
+
+
Returns
the access token string
+ +
+
+ +

◆ getExpiresIn()

+ +
+
+ + + + + + + +
int64_t pulsar::Oauth2TokenResult::getExpiresIn () const
+
+
Returns
the token lifetime in milliseconds
+ +
+
+ +

◆ getIdToken()

+ +
+
+ + + + + + + +
const std::string & pulsar::Oauth2TokenResult::getIdToken () const
+
+
Returns
the ID token
+ +
+
+ +

◆ getRefreshToken()

+ +
+
+ + + + + + + +
const std::string & pulsar::Oauth2TokenResult::getRefreshToken () const
+
+
Returns
the refresh token which can be used to obtain new access tokens using the same authorization grant or null for none
+ +
+
+ +

◆ setAccessToken()

+ +
+
+ + + + + + + + +
Oauth2TokenResult & pulsar::Oauth2TokenResult::setAccessToken (const std::string & accessToken)
+
+

Set the access token string

+
Parameters
+ + +
accessTokenthe access token string
+
+
+ +
+
+ +

◆ setExpiresIn()

+ +
+
+ + + + + + + + +
Oauth2TokenResult & pulsar::Oauth2TokenResult::setExpiresIn (const int64_t expiresIn)
+
+

Set the token lifetime

+
Parameters
+ + +
expiresInthe token lifetime
+
+
+ +
+
+ +

◆ setIdToken()

+ +
+
+ + + + + + + + +
Oauth2TokenResult & pulsar::Oauth2TokenResult::setIdToken (const std::string & idToken)
+
+

Set the ID token

+
Parameters
+ + +
idTokenthe ID token
+
+
+ +
+
+ +

◆ setRefreshToken()

+ +
+
+ + + + + + + + +
Oauth2TokenResult & pulsar::Oauth2TokenResult::setRefreshToken (const std::string & refreshToken)
+
+

Set the refresh token which can be used to obtain new access tokens using the same authorization grant or null for none

+
Parameters
+ + +
refreshTokenthe refresh token
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_producer-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_producer-members.html new file mode 100644 index 000000000000..e6d2ea3092a8 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_producer-members.html @@ -0,0 +1,106 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::Producer Member List
+
+
+ +

This is the complete list of members for pulsar::Producer, including all inherited members.

+ + + + + + + + + + + + + + + + + + +
ClientImpl (defined in pulsar::Producer)pulsar::Producerfriend
close()pulsar::Producer
closeAsync(CloseCallback callback)pulsar::Producer
flush()pulsar::Producer
flushAsync(FlushCallback callback)pulsar::Producer
getLastSequenceId() constpulsar::Producer
getProducerName() constpulsar::Producer
getSchemaVersion() constpulsar::Producer
getTopic() constpulsar::Producer
isConnected() constpulsar::Producer
Producer()pulsar::Producer
ProducerImpl (defined in pulsar::Producer)pulsar::Producerfriend
PulsarFriend (defined in pulsar::Producer)pulsar::Producerfriend
PulsarWrapper (defined in pulsar::Producer)pulsar::Producerfriend
send(const Message &msg)pulsar::Producer
send(const Message &msg, MessageId &messageId)pulsar::Producer
sendAsync(const Message &msg, SendCallback callback)pulsar::Producer
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_producer.html b/static/api/cpp/3.5.x/classpulsar_1_1_producer.html new file mode 100644 index 000000000000..e5f8cb421c9b --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_producer.html @@ -0,0 +1,438 @@ + + + + + + + +pulsar-client-cpp: pulsar::Producer Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +Friends | +List of all members
+
pulsar::Producer Class Reference
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 Producer ()
 
const std::string & getTopic () const
 
const std::string & getProducerName () const
 
Result send (const Message &msg)
 
Result send (const Message &msg, MessageId &messageId)
 
void sendAsync (const Message &msg, SendCallback callback)
 
Result flush ()
 
void flushAsync (FlushCallback callback)
 
int64_t getLastSequenceId () const
 
const std::string & getSchemaVersion () const
 
Result close ()
 
void closeAsync (CloseCallback callback)
 
bool isConnected () const
 
+ + + + + + + + + +

+Friends

+class ClientImpl
 
+class PulsarFriend
 
+class PulsarWrapper
 
+class ProducerImpl
 
+

Constructor & Destructor Documentation

+ +

◆ Producer()

+ +
+
+ + + + + + + +
pulsar::Producer::Producer ()
+
+

Construct an uninitialized Producer.

+ +
+
+

Member Function Documentation

+ +

◆ close()

+ +
+
+ + + + + + + +
Result pulsar::Producer::close ()
+
+

Close the producer and release resources allocated.

+

No more writes will be accepted from this producer. Waits until all pending write requests are persisted. In case of errors, pending writes will not be retried.

+
Returns
an error code to indicate the success or failure
+ +
+
+ +

◆ closeAsync()

+ +
+
+ + + + + + + + +
void pulsar::Producer::closeAsync (CloseCallback callback)
+
+

Close the producer and release resources allocated.

+

No more writes will be accepted from this producer. The provided callback will be triggered when all pending write requests are persisted. In case of errors, pending writes will not be retried.

+ +
+
+ +

◆ flush()

+ +
+
+ + + + + + + +
Result pulsar::Producer::flush ()
+
+

Flush all the messages buffered in the client and wait until all messages have been successfully persisted.

+ +
+
+ +

◆ flushAsync()

+ +
+
+ + + + + + + + +
void pulsar::Producer::flushAsync (FlushCallback callback)
+
+

Flush all the messages buffered in the client and wait until all messages have been successfully persisted.

+ +
+
+ +

◆ getLastSequenceId()

+ +
+
+ + + + + + + +
int64_t pulsar::Producer::getLastSequenceId () const
+
+

Get the last sequence id that was published by this producer.

+

This represent either the automatically assigned or custom sequence id (set on the MessageBuilder) that was published and acknowledged by the broker.

+

After recreating a producer with the same producer name, this will return the last message that was published in the previous producer session, or -1 if there no message was ever published.

+
Returns
the last sequence id published by this producer
+ +
+
+ +

◆ getProducerName()

+ +
+
+ + + + + + + +
const std::string & pulsar::Producer::getProducerName () const
+
+
Returns
the producer name which could have been assigned by the system or specified by the client
+ +
+
+ +

◆ getSchemaVersion()

+ +
+
+ + + + + + + +
const std::string & pulsar::Producer::getSchemaVersion () const
+
+

Return an identifier for the schema version that this producer was created with.

+

When the producer is created, if a schema info was passed, the broker will determine the version of the passed schema. This identifier should be treated as an opaque identifier. In particular, even though this is represented as a string, the version might not be ascii printable.

+ +
+
+ +

◆ getTopic()

+ +
+
+ + + + + + + +
const std::string & pulsar::Producer::getTopic () const
+
+
Returns
the topic to which producer is publishing to
+ +
+
+ +

◆ isConnected()

+ +
+
+ + + + + + + +
bool pulsar::Producer::isConnected () const
+
+
Returns
Whether the producer is currently connected to the broker
+ +
+
+ +

◆ send() [1/2]

+ +
+
+ + + + + + + + +
Result pulsar::Producer::send (const Message & msg)
+
+
Deprecated:
It's the same with send(const Message& msg, MessageId& messageId) except that MessageId will be stored in msg though msg is const.
+ +
+
+ +

◆ send() [2/2]

+ +
+
+ + + + + + + + + + + + + + + + + + +
Result pulsar::Producer::send (const Message & msg,
MessageId & messageId 
)
+
+

Publish a message on the topic associated with this Producer and get the associated MessageId.

+

This method will block until the message will be accepted and persisted by the broker. In case of errors, the client library will try to automatically recover and use a different broker.

+

If it wasn't possible to successfully publish the message within the sendTimeout, an error will be returned.

+

This method is equivalent to asyncSend() and wait until the callback is triggered.

+
Parameters
+ + + +
[in]msgmessage to publish
[out]messageIdthe message id assigned to the published message
+
+
+
Returns
ResultOk if the message was published successfully
+
+ResultTimeout if message was not sent successfully in ProducerConfiguration::getSendTimeout
+
+ResultProducerQueueIsFull if the outgoing messsage queue is full when ProducerConfiguration::getBlockIfQueueFull was false
+
+ResultMessageTooBig if message size is bigger than the maximum message size
+
+ResultAlreadyClosed if Producer was already closed when message was sent
+
+ResultCryptoError if ProducerConfiguration::isEncryptionEnabled returns true but the message was failed to encrypt
+
+ResultInvalidMessage if message's invalid, it's usually caused by resending the same Message
+ +
+
+ +

◆ sendAsync()

+ +
+
+ + + + + + + + + + + + + + + + + + +
void pulsar::Producer::sendAsync (const Message & msg,
SendCallback callback 
)
+
+

Asynchronously publish a message on the topic associated with this Producer.

+

This method will initiate the publish operation and return immediately. The provided callback will be triggered when the message has been be accepted and persisted by the broker. In case of errors, the client library will try to automatically recover and use a different broker.

+

If it wasn't possible to successfully publish the message within the sendTimeout, the callback will be triggered with a Result::WriteError code.

+
Parameters
+ + + +
msgmessage to publish
callbackthe callback to get notification of the completion
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_producer_configuration-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_producer_configuration-members.html new file mode 100644 index 000000000000..c21a4e743051 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_producer_configuration-members.html @@ -0,0 +1,164 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::ProducerConfiguration Member List
+
+
+ +

This is the complete list of members for pulsar::ProducerConfiguration, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
addEncryptionKey(std::string key)pulsar::ProducerConfiguration
BatchingType enum namepulsar::ProducerConfiguration
BoostHash enum value (defined in pulsar::ProducerConfiguration)pulsar::ProducerConfiguration
ConsumerImpl (defined in pulsar::ProducerConfiguration)pulsar::ProducerConfigurationfriend
CustomPartition enum value (defined in pulsar::ProducerConfiguration)pulsar::ProducerConfiguration
DefaultBatching enum valuepulsar::ProducerConfiguration
Exclusive enum valuepulsar::ProducerConfiguration
ExclusiveWithFencing enum valuepulsar::ProducerConfiguration
getAccessMode() constpulsar::ProducerConfiguration
getBatchingEnabled() constpulsar::ProducerConfiguration
getBatchingMaxAllowedSizeInBytes() constpulsar::ProducerConfiguration
getBatchingMaxMessages() constpulsar::ProducerConfiguration
getBatchingMaxPublishDelayMs() constpulsar::ProducerConfiguration
getBatchingType() constpulsar::ProducerConfiguration
getBlockIfQueueFull() constpulsar::ProducerConfiguration
getCompressionType() constpulsar::ProducerConfiguration
getCryptoFailureAction() constpulsar::ProducerConfiguration
getCryptoKeyReader() constpulsar::ProducerConfiguration
getEncryptionKeys() constpulsar::ProducerConfiguration
getHashingScheme() constpulsar::ProducerConfiguration
getInitialSequenceId() constpulsar::ProducerConfiguration
getInterceptors() const (defined in pulsar::ProducerConfiguration)pulsar::ProducerConfiguration
getLazyStartPartitionedProducers() constpulsar::ProducerConfiguration
getMaxPendingMessages() constpulsar::ProducerConfiguration
getMaxPendingMessagesAcrossPartitions() constpulsar::ProducerConfiguration
getMessageRouterPtr() constpulsar::ProducerConfiguration
getPartitionsRoutingMode() constpulsar::ProducerConfiguration
getProducerName() constpulsar::ProducerConfiguration
getProperties() constpulsar::ProducerConfiguration
getProperty(const std::string &name) constpulsar::ProducerConfiguration
getSchema() constpulsar::ProducerConfiguration
getSendTimeout() constpulsar::ProducerConfiguration
HashingScheme enum name (defined in pulsar::ProducerConfiguration)pulsar::ProducerConfiguration
hasProperty(const std::string &name) constpulsar::ProducerConfiguration
intercept(const std::vector< ProducerInterceptorPtr > &interceptors) (defined in pulsar::ProducerConfiguration)pulsar::ProducerConfiguration
isChunkingEnabled() constpulsar::ProducerConfiguration
isEncryptionEnabled() constpulsar::ProducerConfiguration
JavaStringHash enum value (defined in pulsar::ProducerConfiguration)pulsar::ProducerConfiguration
KeyBasedBatching enum valuepulsar::ProducerConfiguration
Murmur3_32Hash enum value (defined in pulsar::ProducerConfiguration)pulsar::ProducerConfiguration
operator=(const ProducerConfiguration &) (defined in pulsar::ProducerConfiguration)pulsar::ProducerConfiguration
PartitionsRoutingMode enum name (defined in pulsar::ProducerConfiguration)pulsar::ProducerConfiguration
ProducerAccessMode enum namepulsar::ProducerConfiguration
ProducerConfiguration() (defined in pulsar::ProducerConfiguration)pulsar::ProducerConfiguration
ProducerConfiguration(const ProducerConfiguration &) (defined in pulsar::ProducerConfiguration)pulsar::ProducerConfiguration
ProducerImpl (defined in pulsar::ProducerConfiguration)pulsar::ProducerConfigurationfriend
PulsarWrapper (defined in pulsar::ProducerConfiguration)pulsar::ProducerConfigurationfriend
RoundRobinDistribution enum value (defined in pulsar::ProducerConfiguration)pulsar::ProducerConfiguration
setAccessMode(const ProducerAccessMode &accessMode)pulsar::ProducerConfiguration
setBatchingEnabled(const bool &batchingEnabled)pulsar::ProducerConfiguration
setBatchingMaxAllowedSizeInBytes(const unsigned long &batchingMaxAllowedSizeInBytes)pulsar::ProducerConfiguration
setBatchingMaxMessages(const unsigned int &batchingMaxMessages)pulsar::ProducerConfiguration
setBatchingMaxPublishDelayMs(const unsigned long &batchingMaxPublishDelayMs)pulsar::ProducerConfiguration
setBatchingType(BatchingType batchingType)pulsar::ProducerConfiguration
setBlockIfQueueFull(bool)pulsar::ProducerConfiguration
setChunkingEnabled(bool chunkingEnabled)pulsar::ProducerConfiguration
setCompressionType(CompressionType compressionType)pulsar::ProducerConfiguration
setCryptoFailureAction(ProducerCryptoFailureAction action)pulsar::ProducerConfiguration
setCryptoKeyReader(CryptoKeyReaderPtr cryptoKeyReader)pulsar::ProducerConfiguration
setHashingScheme(const HashingScheme &scheme)pulsar::ProducerConfiguration
setInitialSequenceId(int64_t initialSequenceId)pulsar::ProducerConfiguration
setLazyStartPartitionedProducers(bool)pulsar::ProducerConfiguration
setMaxPendingMessages(int maxPendingMessages)pulsar::ProducerConfiguration
setMaxPendingMessagesAcrossPartitions(int maxPendingMessagesAcrossPartitions)pulsar::ProducerConfiguration
setMessageRouter(const MessageRoutingPolicyPtr &router)pulsar::ProducerConfiguration
setPartitionsRoutingMode(const PartitionsRoutingMode &mode)pulsar::ProducerConfiguration
setProducerName(const std::string &producerName)pulsar::ProducerConfiguration
setProperties(const std::map< std::string, std::string > &properties)pulsar::ProducerConfiguration
setProperty(const std::string &name, const std::string &value)pulsar::ProducerConfiguration
setSchema(const SchemaInfo &schemaInfo)pulsar::ProducerConfiguration
setSendTimeout(int sendTimeoutMs)pulsar::ProducerConfiguration
Shared enum valuepulsar::ProducerConfiguration
UseSinglePartition enum value (defined in pulsar::ProducerConfiguration)pulsar::ProducerConfiguration
WaitForExclusive enum valuepulsar::ProducerConfiguration
~ProducerConfiguration() (defined in pulsar::ProducerConfiguration)pulsar::ProducerConfiguration
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_producer_configuration.html b/static/api/cpp/3.5.x/classpulsar_1_1_producer_configuration.html new file mode 100644 index 000000000000..5bc627993ae4 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_producer_configuration.html @@ -0,0 +1,1417 @@ + + + + + + + +pulsar-client-cpp: pulsar::ProducerConfiguration Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Types | +Public Member Functions | +Friends | +List of all members
+
pulsar::ProducerConfiguration Class Reference
+
+
+ +

#include <ProducerConfiguration.h>

+ + + + + + + + + + +

+Public Types

enum  PartitionsRoutingMode { UseSinglePartition +, RoundRobinDistribution +, CustomPartition + }
 
enum  HashingScheme { Murmur3_32Hash +, BoostHash +, JavaStringHash + }
 
enum  BatchingType { DefaultBatching +, KeyBasedBatching + }
 
enum  ProducerAccessMode { Shared = 0 +, Exclusive = 1 +, WaitForExclusive = 2 +, ExclusiveWithFencing = 3 + }
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ ProducerConfiguration (const ProducerConfiguration &)
 
+ProducerConfiguration & operator= (const ProducerConfiguration &)
 
ProducerConfiguration & setProducerName (const std::string &producerName)
 
const std::string & getProducerName () const
 
ProducerConfiguration & setSchema (const SchemaInfo &schemaInfo)
 
const SchemaInfo & getSchema () const
 
ProducerConfiguration & setSendTimeout (int sendTimeoutMs)
 
int getSendTimeout () const
 
ProducerConfiguration & setInitialSequenceId (int64_t initialSequenceId)
 
int64_t getInitialSequenceId () const
 
ProducerConfiguration & setCompressionType (CompressionType compressionType)
 
CompressionType getCompressionType () const
 
ProducerConfiguration & setMaxPendingMessages (int maxPendingMessages)
 
int getMaxPendingMessages () const
 
ProducerConfiguration & setMaxPendingMessagesAcrossPartitions (int maxPendingMessagesAcrossPartitions)
 
int getMaxPendingMessagesAcrossPartitions () const
 
ProducerConfiguration & setPartitionsRoutingMode (const PartitionsRoutingMode &mode)
 
PartitionsRoutingMode getPartitionsRoutingMode () const
 
ProducerConfiguration & setMessageRouter (const MessageRoutingPolicyPtr &router)
 
const MessageRoutingPolicyPtr & getMessageRouterPtr () const
 
ProducerConfiguration & setHashingScheme (const HashingScheme &scheme)
 
HashingScheme getHashingScheme () const
 
ProducerConfiguration & setLazyStartPartitionedProducers (bool)
 
bool getLazyStartPartitionedProducers () const
 
ProducerConfiguration & setBlockIfQueueFull (bool)
 
bool getBlockIfQueueFull () const
 
ProducerConfiguration & setBatchingEnabled (const bool &batchingEnabled)
 
const bool & getBatchingEnabled () const
 
ProducerConfiguration & setBatchingMaxMessages (const unsigned int &batchingMaxMessages)
 
const unsigned int & getBatchingMaxMessages () const
 
ProducerConfiguration & setBatchingMaxAllowedSizeInBytes (const unsigned long &batchingMaxAllowedSizeInBytes)
 
const unsigned long & getBatchingMaxAllowedSizeInBytes () const
 
ProducerConfiguration & setBatchingMaxPublishDelayMs (const unsigned long &batchingMaxPublishDelayMs)
 
const unsigned long & getBatchingMaxPublishDelayMs () const
 
ProducerConfiguration & setBatchingType (BatchingType batchingType)
 
BatchingType getBatchingType () const
 
const CryptoKeyReaderPtr getCryptoKeyReader () const
 
ProducerConfiguration & setCryptoKeyReader (CryptoKeyReaderPtr cryptoKeyReader)
 
ProducerCryptoFailureAction getCryptoFailureAction () const
 
ProducerConfiguration & setCryptoFailureAction (ProducerCryptoFailureAction action)
 
const std::set< std::string > & getEncryptionKeys () const
 
bool isEncryptionEnabled () const
 
ProducerConfiguration & addEncryptionKey (std::string key)
 
bool hasProperty (const std::string &name) const
 
const std::string & getProperty (const std::string &name) const
 
std::map< std::string, std::string > & getProperties () const
 
ProducerConfiguration & setProperty (const std::string &name, const std::string &value)
 
ProducerConfiguration & setProperties (const std::map< std::string, std::string > &properties)
 
ProducerConfiguration & setChunkingEnabled (bool chunkingEnabled)
 
bool isChunkingEnabled () const
 
ProducerConfiguration & setAccessMode (const ProducerAccessMode &accessMode)
 
ProducerAccessMode getAccessMode () const
 
+ProducerConfiguration & intercept (const std::vector< ProducerInterceptorPtr > &interceptors)
 
+const std::vector< ProducerInterceptorPtr > & getInterceptors () const
 
+ + + + + + + +

+Friends

+class PulsarWrapper
 
+class ConsumerImpl
 
+class ProducerImpl
 
+

Detailed Description

+

Class that holds the configuration for a producer

+

Member Enumeration Documentation

+ +

◆ BatchingType

+ +
+
+ + + + +
enum pulsar::ProducerConfiguration::BatchingType
+
+ + + +
Enumerator
DefaultBatching 

Default batching.

+

incoming single messages: (k1, v1), (k2, v1), (k3, v1), (k1, v2), (k2, v2), (k3, v2), (k1, v3), (k2, v3), (k3, v3)

+

batched into single batch message: [(k1, v1), (k2, v1), (k3, v1), (k1, v2), (k2, v2), (k3, v2), (k1, v3), (k2, v3), (k3, v3)]

+
KeyBasedBatching 

Key based batching.

+

incoming single messages: (k1, v1), (k2, v1), (k3, v1), (k1, v2), (k2, v2), (k3, v2), (k1, v3), (k2, v3), (k3, v3)

+

batched into single batch message: [(k1, v1), (k1, v2), (k1, v3)], [(k2, v1), (k2, v2), (k2, v3)], [(k3, v1), (k3, v2), (k3, v3)]

+
+ +
+
+ +

◆ ProducerAccessMode

+ +
+
+ + + + +
enum pulsar::ProducerConfiguration::ProducerAccessMode
+
+ + + + + +
Enumerator
Shared 

By default multiple producers can publish on a topic.

+
Exclusive 

Require exclusive access for producer. Fail immediately if there's already a producer connected.

+
WaitForExclusive 

Producer creation is pending until it can acquire exclusive access.

+
ExclusiveWithFencing 

Acquire exclusive access for the producer. Any existing producer will be removed and invalidated immediately.

+
+ +
+
+

Member Function Documentation

+ +

◆ addEncryptionKey()

+ +
+
+ + + + + + + + +
ProducerConfiguration & pulsar::ProducerConfiguration::addEncryptionKey (std::string key)
+
+

Add public encryption key, used by producer to encrypt the data key.

+

At the time of producer creation, Pulsar client checks if there are keys added to encryptionKeys. If keys are found, a callback getKey(String keyName) is invoked against each key to load the values of the key. Application should implement this callback to return the key in pkcs8 format. If compression is enabled, message is encrypted after compression. If batch messaging is enabled, the batched message is encrypted.

+

@key the encryption key to add

Returns
the ProducerConfiguration self
+ +
+
+ +

◆ getAccessMode()

+ +
+
+ + + + + + + +
ProducerAccessMode pulsar::ProducerConfiguration::getAccessMode () const
+
+

Get the type of access mode that the producer requires on the topic.

+ +
+
+ +

◆ getBatchingEnabled()

+ +
+
+ + + + + + + +
const bool & pulsar::ProducerConfiguration::getBatchingEnabled () const
+
+

Return the flag whether automatic message batching is enabled or not for the producer.

+
Returns
true if automatic message batching is enabled. Otherwise it returns false.
+
Since
2.0.0
+ It is enabled by default.
+ +
+
+ +

◆ getBatchingMaxAllowedSizeInBytes()

+ +
+
+ + + + + + + +
const unsigned long & pulsar::ProducerConfiguration::getBatchingMaxAllowedSizeInBytes () const
+
+

The getter associated with setBatchingMaxAllowedSizeInBytes().

+ +
+
+ +

◆ getBatchingMaxMessages()

+ +
+
+ + + + + + + +
const unsigned int & pulsar::ProducerConfiguration::getBatchingMaxMessages () const
+
+

The getter associated with setBatchingMaxMessages().

+ +
+
+ +

◆ getBatchingMaxPublishDelayMs()

+ +
+
+ + + + + + + +
const unsigned long & pulsar::ProducerConfiguration::getBatchingMaxPublishDelayMs () const
+
+

The getter associated with setBatchingMaxPublishDelayMs().

+ +
+
+ +

◆ getBatchingType()

+ +
+
+ + + + + + + +
BatchingType pulsar::ProducerConfiguration::getBatchingType () const
+
+
Returns
batching type.
+
See also
BatchingType.
+ +
+
+ +

◆ getBlockIfQueueFull()

+ +
+
+ + + + + + + +
bool pulsar::ProducerConfiguration::getBlockIfQueueFull () const
+
+
Returns
whether Producer::send or Producer::sendAsync operations should block when the outgoing message queue is full. (Default: false)
+ +
+
+ +

◆ getCompressionType()

+ +
+
+ + + + + + + +
CompressionType pulsar::ProducerConfiguration::getCompressionType () const
+
+

The getter associated with setCompressionType().

+ +
+
+ +

◆ getCryptoFailureAction()

+ +
+
+ + + + + + + +
ProducerCryptoFailureAction pulsar::ProducerConfiguration::getCryptoFailureAction () const
+
+

The getter associated with setCryptoFailureAction().

+ +
+
+ +

◆ getCryptoKeyReader()

+ +
+
+ + + + + + + +
const CryptoKeyReaderPtr pulsar::ProducerConfiguration::getCryptoKeyReader () const
+
+

The getter associated with setCryptoKeyReader().

+ +
+
+ +

◆ getEncryptionKeys()

+ +
+
+ + + + + + + +
const std::set< std::string > & pulsar::ProducerConfiguration::getEncryptionKeys () const
+
+
Returns
all the encryption keys added
+ +
+
+ +

◆ getHashingScheme()

+ +
+
+ + + + + + + +
HashingScheme pulsar::ProducerConfiguration::getHashingScheme () const
+
+

The getter associated with setHashingScheme().

+ +
+
+ +

◆ getInitialSequenceId()

+ +
+
+ + + + + + + +
int64_t pulsar::ProducerConfiguration::getInitialSequenceId () const
+
+

The getter associated with setInitialSequenceId().

+ +
+
+ +

◆ getLazyStartPartitionedProducers()

+ +
+
+ + + + + + + +
bool pulsar::ProducerConfiguration::getLazyStartPartitionedProducers () const
+
+

The getter associated with setLazyStartPartitionedProducers()

+ +
+
+ +

◆ getMaxPendingMessages()

+ +
+
+ + + + + + + +
int pulsar::ProducerConfiguration::getMaxPendingMessages () const
+
+

The getter associated with setMaxPendingMessages().

+ +
+
+ +

◆ getMaxPendingMessagesAcrossPartitions()

+ +
+
+ + + + + + + +
int pulsar::ProducerConfiguration::getMaxPendingMessagesAcrossPartitions () const
+
+
Returns
the maximum number of pending messages allowed across all the partitions
+ +
+
+ +

◆ getMessageRouterPtr()

+ +
+
+ + + + + + + +
const MessageRoutingPolicyPtr & pulsar::ProducerConfiguration::getMessageRouterPtr () const
+
+

The getter associated with setMessageRouter().

+ +
+
+ +

◆ getPartitionsRoutingMode()

+ +
+
+ + + + + + + +
PartitionsRoutingMode pulsar::ProducerConfiguration::getPartitionsRoutingMode () const
+
+

The getter associated with setPartitionsRoutingMode().

+ +
+
+ +

◆ getProducerName()

+ +
+
+ + + + + + + +
const std::string & pulsar::ProducerConfiguration::getProducerName () const
+
+

The getter associated with setProducerName().

+ +
+
+ +

◆ getProperties()

+ +
+
+ + + + + + + +
std::map< std::string, std::string > & pulsar::ProducerConfiguration::getProperties () const
+
+

Get all the properties attached to this producer.

+ +
+
+ +

◆ getProperty()

+ +
+
+ + + + + + + + +
const std::string & pulsar::ProducerConfiguration::getProperty (const std::string & name) const
+
+

Get the value of a specific property

+
Parameters
+ + +
namethe name of the property
+
+
+
Returns
the value of the property or null if the property was not defined
+ +
+
+ +

◆ getSchema()

+ +
+
+ + + + + + + +
const SchemaInfo & pulsar::ProducerConfiguration::getSchema () const
+
+
Returns
the schema information declared for this producer
+ +
+
+ +

◆ getSendTimeout()

+ +
+
+ + + + + + + +
int pulsar::ProducerConfiguration::getSendTimeout () const
+
+

Get the send timeout is milliseconds.

+

If a message is not acknowledged by the server before the sendTimeout expires, an error will be reported.

+

If the timeout is zero, there will be no timeout.

+
Returns
the send timeout in milliseconds (Default: 30000)
+ +
+
+ +

◆ hasProperty()

+ +
+
+ + + + + + + + +
bool pulsar::ProducerConfiguration::hasProperty (const std::string & name) const
+
+

Check whether the producer has a specific property attached.

+
Parameters
+ + +
namethe name of the property to check
+
+
+
Returns
true if the message has the specified property
+
+false if the property is not defined
+ +
+
+ +

◆ isChunkingEnabled()

+ +
+
+ + + + + + + +
bool pulsar::ProducerConfiguration::isChunkingEnabled () const
+
+

The getter associated with setChunkingEnabled().

+ +
+
+ +

◆ isEncryptionEnabled()

+ +
+
+ + + + + + + +
bool pulsar::ProducerConfiguration::isEncryptionEnabled () const
+
+
Returns
true if encryption keys are added
+ +
+
+ +

◆ setAccessMode()

+ +
+
+ + + + + + + + +
ProducerConfiguration & pulsar::ProducerConfiguration::setAccessMode (const ProducerAccessMode & accessMode)
+
+

Set the type of access mode that the producer requires on the topic.

+
See also
ProducerAccessMode
+
Parameters
+ + +
accessModeThe type of access to the topic that the producer requires
+
+
+ +
+
+ +

◆ setBatchingEnabled()

+ +
+
+ + + + + + + + +
ProducerConfiguration & pulsar::ProducerConfiguration::setBatchingEnabled (const bool & batchingEnabled)
+
+

Control whether automatic batching of messages is enabled or not for the producer.

+

Default: true

+

When automatic batching is enabled, multiple calls to Producer::sendAsync can result in a single batch to be sent to the broker, leading to better throughput, especially when publishing small messages. If compression is enabled, messages are compressed at the batch level, leading to a much better compression ratio for similar headers or contents.

+

When the default batch delay is set to 10 ms and the default batch size is 1000 messages.

+
See also
ProducerConfiguration::setBatchingMaxPublishDelayMs
+ +
+
+ +

◆ setBatchingMaxAllowedSizeInBytes()

+ +
+
+ + + + + + + + +
ProducerConfiguration & pulsar::ProducerConfiguration::setBatchingMaxAllowedSizeInBytes (const unsigned long & batchingMaxAllowedSizeInBytes)
+
+

Set the max size of messages permitted in a batch. Default value: 128 KB. If you set this option to a value greater than 1, messages are queued until this threshold is reached or batch interval has elapsed.

+

All messages in a batch are published as a single batch message. The consumer is delivered individual messages in the batch in the same order they are enqueued.

+
Parameters
+ + +
batchingMaxAllowedSizeInBytes
+
+
+ +
+
+ +

◆ setBatchingMaxMessages()

+ +
+
+ + + + + + + + +
ProducerConfiguration & pulsar::ProducerConfiguration::setBatchingMaxMessages (const unsigned int & batchingMaxMessages)
+
+

Set the max number of messages permitted in a batch. Default value: 1000. If you set this option to a value greater than 1, messages are queued until this threshold is reached or batch interval has elapsed.

+

All messages in a batch are published as a single batch message. The consumer is delivered individual messages in the batch in the same order they are enqueued.

Parameters
+ + +
batchMessagesMaxMessagesPerBatchmax number of messages permitted in a batch
+
+
+
Returns
+ +
+
+ +

◆ setBatchingMaxPublishDelayMs()

+ +
+
+ + + + + + + + +
ProducerConfiguration & pulsar::ProducerConfiguration::setBatchingMaxPublishDelayMs (const unsigned long & batchingMaxPublishDelayMs)
+
+

Set the max time for message publish delay permitted in a batch. Default value: 10 ms.

+
Parameters
+ + +
batchingMaxPublishDelayMsmax time for message publish delay permitted in a batch.
+
+
+
Returns
+ +
+
+ +

◆ setBatchingType()

+ +
+
+ + + + + + + + +
ProducerConfiguration & pulsar::ProducerConfiguration::setBatchingType (BatchingType batchingType)
+
+

Default: DefaultBatching

+
See also
BatchingType
+ +
+
+ +

◆ setBlockIfQueueFull()

+ +
+
+ + + + + + + + +
ProducerConfiguration & pulsar::ProducerConfiguration::setBlockIfQueueFull (bool )
+
+

The setter associated with getBlockIfQueueFull()

+ +
+
+ +

◆ setChunkingEnabled()

+ +
+
+ + + + + + + + +
ProducerConfiguration & pulsar::ProducerConfiguration::setChunkingEnabled (bool chunkingEnabled)
+
+

If message size is higher than allowed max publish-payload size by broker then enableChunking helps producer to split message into multiple chunks and publish them to broker separately in order. So, it allows client to successfully publish large size of messages in pulsar.

+

Set it true to enable this feature. If so, you must disable batching (see setBatchingEnabled), otherwise the producer creation will fail.

+

There are some other recommendations when it's enabled:

    +
  1. This features is right now only supported for non-shared subscription and persistent-topic.
    2. +
  2. It's better to reduce setMaxPendingMessages to avoid producer accupying large amount of memory by buffered messages.
    3. +
  3. Set message-ttl on the namespace to cleanup chunked messages. Sometimes due to broker-restart or publish time, producer might fail to publish entire large message. So, consumer will not be able to consume and ack those messages.
    4. +
+

Default: false

+
Parameters
+ + +
chunkingEnabledwhether chunking is enabled
+
+
+
Returns
the ProducerConfiguration self
+ +
+
+ +

◆ setCompressionType()

+ +
+
+ + + + + + + + +
ProducerConfiguration & pulsar::ProducerConfiguration::setCompressionType (CompressionType compressionType)
+
+

Set the compression type for the producer.

+

By default, message payloads are not compressed. Supported compression types are:

+ +
+
+ +

◆ setCryptoFailureAction()

+ +
+
+ + + + + + + + +
ProducerConfiguration & pulsar::ProducerConfiguration::setCryptoFailureAction (ProducerCryptoFailureAction action)
+
+

Sets the ProducerCryptoFailureAction to the value specified.

+
Parameters
+ + +
actionthe action taken by the producer in case of encryption failures.
+
+
+
Returns
+ +
+
+ +

◆ setCryptoKeyReader()

+ +
+
+ + + + + + + + +
ProducerConfiguration & pulsar::ProducerConfiguration::setCryptoKeyReader (CryptoKeyReaderPtr cryptoKeyReader)
+
+

Set the shared pointer to CryptoKeyReader.

+
Parameters
+ + +
sharedpointer to CryptoKeyReader.
+
+
+
Returns
+ +
+
+ +

◆ setHashingScheme()

+ +
+
+ + + + + + + + +
ProducerConfiguration & pulsar::ProducerConfiguration::setHashingScheme (const HashingScheme & scheme)
+
+

Set the hashing scheme, which is a standard hashing function available when choosing the partition used for a particular message.

+

Default: HashingScheme::BoostHash

+

Standard hashing functions available are:

+
Parameters
+ + +
schemehashing scheme.
+
+
+
Returns
+ +
+
+ +

◆ setInitialSequenceId()

+ +
+
+ + + + + + + + +
ProducerConfiguration & pulsar::ProducerConfiguration::setInitialSequenceId (int64_t initialSequenceId)
+
+

Set the baseline of the sequence ID for messages published by the producer.

+

The first message uses (initialSequenceId + 1) as its sequence ID and subsequent messages are assigned incremental sequence IDs.

+

Default: -1, which means the first message's sequence ID is 0.

+
Parameters
+ + +
initialSequenceIdthe initial sequence ID for the producer.
+
+
+
Returns
+ +
+
+ +

◆ setLazyStartPartitionedProducers()

+ +
+
+ + + + + + + + +
ProducerConfiguration & pulsar::ProducerConfiguration::setLazyStartPartitionedProducers (bool )
+
+

This config affects producers of partitioned topics only. It controls whether producers register and connect immediately to the owner broker of each partition or start lazily on demand. The internal producer of one partition is always started eagerly, chosen by the routing policy, but the internal producers of any additional partitions are started on demand, upon receiving their first message. Using this mode can reduce the strain on brokers for topics with large numbers of partitions and when the SinglePartition routing policy is used without keyed messages. Because producer connection can be on demand, this can produce extra send latency for the first messages of a given partition.

Parameters
+ + +
true/falseas to whether to start partition producers lazily
+
+
+
Returns
+ +
+
+ +

◆ setMaxPendingMessages()

+ +
+
+ + + + + + + + +
ProducerConfiguration & pulsar::ProducerConfiguration::setMaxPendingMessages (int maxPendingMessages)
+
+

Set the max size of the queue holding the messages pending to receive an acknowledgment from the broker.

+

When the queue is full, by default, all calls to Producer::send and Producer::sendAsync would fail unless blockIfQueueFull is set to true. Use setBlockIfQueueFull to change the blocking behavior.

+

Default: 1000

+
Parameters
+ + +
maxPendingMessagesmax number of pending messages.
+
+
+
Returns
+ +
+
+ +

◆ setMaxPendingMessagesAcrossPartitions()

+ +
+
+ + + + + + + + +
ProducerConfiguration & pulsar::ProducerConfiguration::setMaxPendingMessagesAcrossPartitions (int maxPendingMessagesAcrossPartitions)
+
+

Set the number of max pending messages across all the partitions

+

This setting will be used to lower the max pending messages for each partition (setMaxPendingMessages(int)), if the total exceeds the configured value.

+

Default: 50000

+
Parameters
+ + +
maxPendingMessagesAcrossPartitions
+
+
+ +
+
+ +

◆ setMessageRouter()

+ +
+
+ + + + + + + + +
ProducerConfiguration & pulsar::ProducerConfiguration::setMessageRouter (const MessageRoutingPolicyPtr & router)
+
+

Set a custom message routing policy by passing an implementation of MessageRouter.

+
Parameters
+ + +
messageRoutermessage router.
+
+
+
Returns
+ +
+
+ +

◆ setPartitionsRoutingMode()

+ +
+
+ + + + + + + + +
ProducerConfiguration & pulsar::ProducerConfiguration::setPartitionsRoutingMode (const PartitionsRoutingMode & mode)
+
+

Set the message routing modes for partitioned topics.

+

Default: UseSinglePartition

+
Parameters
+ + +
PartitionsRoutingModepartition routing mode.
+
+
+
Returns
+ +
+
+ +

◆ setProducerName()

+ +
+
+ + + + + + + + +
ProducerConfiguration & pulsar::ProducerConfiguration::setProducerName (const std::string & producerName)
+
+

Set the producer name which could be assigned by the system or specified by the client.

+
Parameters
+ + +
producerNameproducer name.
+
+
+
Returns
+ +
+
+ +

◆ setProperties()

+ +
+
+ + + + + + + + +
ProducerConfiguration & pulsar::ProducerConfiguration::setProperties (const std::map< std::string, std::string > & properties)
+
+

Add all the properties in the provided map

+ +
+
+ +

◆ setProperty()

+ +
+
+ + + + + + + + + + + + + + + + + + +
ProducerConfiguration & pulsar::ProducerConfiguration::setProperty (const std::string & name,
const std::string & value 
)
+
+

Sets a new property on the producer

Parameters
+ + + +
namethe name of the property
valuethe associated value
+
+
+ +
+
+ +

◆ setSchema()

+ +
+
+ + + + + + + + +
ProducerConfiguration & pulsar::ProducerConfiguration::setSchema (const SchemaInfo & schemaInfo)
+
+

Declare the schema of the data that will be published by this producer.

+

The schema will be checked against the schema of the topic, and it will fail if it's not compatible, though the client library will not perform any validation that the actual message payload are conforming to the specified schema.

+

For all purposes, this

Parameters
+ + +
schemaInfo
+
+
+
Returns
+ +
+
+ +

◆ setSendTimeout()

+ +
+
+ + + + + + + + +
ProducerConfiguration & pulsar::ProducerConfiguration::setSendTimeout (int sendTimeoutMs)
+
+

The getter associated with getSendTimeout()

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_producer_interceptor-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_producer_interceptor-members.html new file mode 100644 index 000000000000..53d78e54ac16 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_producer_interceptor-members.html @@ -0,0 +1,94 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::ProducerInterceptor Member List
+
+
+ +

This is the complete list of members for pulsar::ProducerInterceptor, including all inherited members.

+ + + + + + +
beforeSend(const Producer &producer, const Message &message)=0pulsar::ProducerInterceptorpure virtual
close()pulsar::ProducerInterceptorinlinevirtual
onPartitionsChange(const std::string &topicName, int partitions)pulsar::ProducerInterceptorinlinevirtual
onSendAcknowledgement(const Producer &producer, Result result, const Message &message, const MessageId &messageID)=0pulsar::ProducerInterceptorpure virtual
~ProducerInterceptor() (defined in pulsar::ProducerInterceptor)pulsar::ProducerInterceptorinlinevirtual
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_producer_interceptor.html b/static/api/cpp/3.5.x/classpulsar_1_1_producer_interceptor.html new file mode 100644 index 000000000000..51615ee62fb8 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_producer_interceptor.html @@ -0,0 +1,289 @@ + + + + + + + +pulsar-client-cpp: pulsar::ProducerInterceptor Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +List of all members
+
pulsar::ProducerInterceptor Class Referenceabstract
+
+
+ +

#include <ProducerInterceptor.h>

+ + + + + + + + + + +

+Public Member Functions

virtual void close ()
 
virtual Message beforeSend (const Producer &producer, const Message &message)=0
 
virtual void onSendAcknowledgement (const Producer &producer, Result result, const Message &message, const MessageId &messageID)=0
 
virtual void onPartitionsChange (const std::string &topicName, int partitions)
 
+

Detailed Description

+

An interface that allows you to intercept (and possibly mutate) the messages received by the producer before they are published to the Pulsar brokers.

+

Exceptions thrown by ProducerInterceptor methods will be caught, logged, but not propagated further.

+

ProducerInterceptor callbacks may be called from multiple threads. Interceptor implementation must ensure thread-safety, if needed.

+

Member Function Documentation

+ +

◆ beforeSend()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
virtual Message pulsar::ProducerInterceptor::beforeSend (const Producer & producer,
const Message & message 
)
+ 		+pure virtual
+
+

This is called from Producer::send and Producer::sendAsync methods, before send the message to the brokers. This method is allowed to modify the record, in which case, the new record will be returned.

+

Any exception thrown by this method will be caught by the caller and logged, but not propagated further.

+

Since the producer may run multiple interceptors, a particular interceptor's #beforeSend(Producer, Message) callback will be called in the order specified by ProducerConfiguration::intercept().

+

The first interceptor in the list gets the message passed from the client, the following interceptor will be passed the message returned by the previous interceptor, and so on. Since interceptors are allowed to modify messages, interceptors may potentially get the message already modified by other interceptors. However, building a pipeline of mutable interceptors that depend on the output of the previous interceptor is discouraged, because of potential side-effects caused by interceptors potentially failing to modify the message and throwing an exception. If one of the interceptors in the list throws an exception from beforeSend(Message), the exception is caught, logged, and the next interceptor is called with the message returned by the last successful interceptor in the list, or otherwise the client.

+
Parameters
+ + + +
producerthe producer which contains the interceptor.
messagemessage to send.
+
+
+
Returns
the intercepted message.
+ +
+
+ +

◆ close()

+ +
+
+ + + + + +
+ + + + + + + +
virtual void pulsar::ProducerInterceptor::close ()
+ 		+inlinevirtual
+
+

Close the interceptor

+ +
+
+ +

◆ onPartitionsChange()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
virtual void pulsar::ProducerInterceptor::onPartitionsChange (const std::string & topicName,
int partitions 
)
+ 		+inlinevirtual
+
+

This method is called when partitions of the topic (partitioned-topic) changes.

+
Parameters
+ + + +
topicNametopic name
partitionsnew updated partitions
+
+
+ +
+
+ +

◆ onSendAcknowledgement()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
virtual void pulsar::ProducerInterceptor::onSendAcknowledgement (const Producer & producer,
Result result,
const Message & message,
const MessageId & messageID 
)
+ 		+pure virtual
+
+

This method is called when the message sent to the broker has been acknowledged, or when sending the message fails. This method is generally called just before the user callback is called.

+

Any exception thrown by this method will be ignored by the caller.

+

This method will generally execute in the background I/O thread, so the implementation should be reasonably fast. Otherwise, sending of messages from other threads could be delayed.

+
Parameters
+ + + + + +
producerthe producer which contains the interceptor.
resultthe result for sending messages, ResultOk indicates send has succeed.
messagethe message that application sends.
messageIDthe message id that assigned by the broker.
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_reader-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_reader-members.html new file mode 100644 index 000000000000..cd3a236ed544 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_reader-members.html @@ -0,0 +1,110 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::Reader Member List
+
+
+ +

This is the complete list of members for pulsar::Reader, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + +
close()pulsar::Reader
closeAsync(ResultCallback callback)pulsar::Reader
getLastMessageId(MessageId &messageId)pulsar::Reader
getLastMessageIdAsync(GetLastMessageIdCallback callback)pulsar::Reader
getTopic() constpulsar::Reader
hasMessageAvailable(bool &hasMessageAvailable)pulsar::Reader
hasMessageAvailableAsync(HasMessageAvailableCallback callback)pulsar::Reader
isConnected() constpulsar::Reader
PulsarFriend (defined in pulsar::Reader)pulsar::Readerfriend
PulsarWrapper (defined in pulsar::Reader)pulsar::Readerfriend
Reader()pulsar::Reader
ReaderImpl (defined in pulsar::Reader)pulsar::Readerfriend
ReaderTest (defined in pulsar::Reader)pulsar::Readerfriend
readNext(Message &msg)pulsar::Reader
readNext(Message &msg, int timeoutMs)pulsar::Reader
readNextAsync(ReadNextCallback callback)pulsar::Reader
seek(const MessageId &msgId)pulsar::Reader
seek(uint64_t timestamp)pulsar::Reader
seekAsync(const MessageId &msgId, ResultCallback callback)pulsar::Reader
seekAsync(uint64_t timestamp, ResultCallback callback)pulsar::Reader
TableViewImpl (defined in pulsar::Reader)pulsar::Readerfriend
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_reader.html b/static/api/cpp/3.5.x/classpulsar_1_1_reader.html new file mode 100644 index 000000000000..734e298ee8a3 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_reader.html @@ -0,0 +1,544 @@ + + + + + + + +pulsar-client-cpp: pulsar::Reader Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +Friends | +List of all members
+
pulsar::Reader Class Reference
+
+
+ +

#include <Reader.h>

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 Reader ()
 
const std::string & getTopic () const
 
Result readNext (Message &msg)
 
Result readNext (Message &msg, int timeoutMs)
 
void readNextAsync (ReadNextCallback callback)
 
Result close ()
 
void closeAsync (ResultCallback callback)
 
void hasMessageAvailableAsync (HasMessageAvailableCallback callback)
 
Result hasMessageAvailable (bool &hasMessageAvailable)
 
Result seek (const MessageId &msgId)
 
Result seek (uint64_t timestamp)
 
void seekAsync (const MessageId &msgId, ResultCallback callback)
 
void seekAsync (uint64_t timestamp, ResultCallback callback)
 
bool isConnected () const
 
void getLastMessageIdAsync (GetLastMessageIdCallback callback)
 
Result getLastMessageId (MessageId &messageId)
 
+ + + + + + + + + + + +

+Friends

+class PulsarFriend
 
+class PulsarWrapper
 
+class ReaderImpl
 
+class TableViewImpl
 
+class ReaderTest
 
+

Detailed Description

+

A Reader can be used to scan through all the messages currently available in a topic.

+

Constructor & Destructor Documentation

+ +

◆ Reader()

+ +
+
+ + + + + + + +
pulsar::Reader::Reader ()
+
+

Construct an uninitialized reader object

+ +
+
+

Member Function Documentation

+ +

◆ close()

+ +
+
+ + + + + + + +
Result pulsar::Reader::close ()
+
+

Close the reader and stop the broker to push more messages

+
Returns
ResultOk if the reader is closed successfully
+ +
+
+ +

◆ closeAsync()

+ +
+
+ + + + + + + + +
void pulsar::Reader::closeAsync (ResultCallback callback)
+
+

Asynchronously close the reader and stop the broker to push more messages

+
Parameters
+ + +
callbackthe callback that is triggered when the reader is closed
+
+
+ +
+
+ +

◆ getLastMessageId()

+ +
+
+ + + + + + + + +
Result pulsar::Reader::getLastMessageId (MessageId & messageId)
+
+

Get an ID of the last available message or a message ID with -1 as an entryId if the topic is empty.

+ +
+
+ +

◆ getLastMessageIdAsync()

+ +
+
+ + + + + + + + +
void pulsar::Reader::getLastMessageIdAsync (GetLastMessageIdCallback callback)
+
+

Asynchronously get an ID of the last available message or a message ID with -1 as an entryId if the topic is empty.

+ +
+
+ +

◆ getTopic()

+ +
+
+ + + + + + + +
const std::string & pulsar::Reader::getTopic () const
+
+
Returns
the topic this reader is reading from
+ +
+
+ +

◆ hasMessageAvailable()

+ +
+
+ + + + + + + + +
Result pulsar::Reader::hasMessageAvailable (bool & hasMessageAvailable)
+
+

Check if there is any message available to read from the current position.

+ +
+
+ +

◆ hasMessageAvailableAsync()

+ +
+
+ + + + + + + + +
void pulsar::Reader::hasMessageAvailableAsync (HasMessageAvailableCallback callback)
+
+

Asynchronously check if there is any message available to read from the current position.

+ +
+
+ +

◆ isConnected()

+ +
+
+ + + + + + + +
bool pulsar::Reader::isConnected () const
+
+
Returns
Whether the reader is currently connected to the broker
+ +
+
+ +

◆ readNext() [1/2]

+ +
+
+ + + + + + + + +
Result pulsar::Reader::readNext (Message & msg)
+
+

Read a single message.

+

If a message is not immediately available, this method will block until a new message is available.

+
Parameters
+ + +
msga non-const reference where the received message will be copied
+
+
+
Returns
ResultOk when a message is received
+
+ResultInvalidConfiguration if a message listener had been set in the configuration
+ +
+
+ +

◆ readNext() [2/2]

+ +
+
+ + + + + + + + + + + + + + + + + + +
Result pulsar::Reader::readNext (Message & msg,
int timeoutMs 
)
+
+

Read a single message

+
Parameters
+ + + +
msga non-const reference where the received message will be copied
timeoutMsthe receive timeout in milliseconds
+
+
+
Returns
ResultOk if a message was received
+
+ResultTimeout if the receive timeout was triggered
+
+ResultInvalidConfiguration if a message listener had been set in the configuration
+ +
+
+ +

◆ readNextAsync()

+ +
+
+ + + + + + + + +
void pulsar::Reader::readNextAsync (ReadNextCallback callback)
+
+

Read asynchronously the next message in the topic.

+
Parameters
+ + +
callback
+
+
+ +
+
+ +

◆ seek() [1/2]

+ +
+
+ + + + + + + + +
Result pulsar::Reader::seek (const MessageId & msgId)
+
+

Reset the this reader to a specific message id. The message id can either be a specific message or represent the first or last messages in the topic.

+

Note: this operation can only be done on non-partitioned topics. For these, one can rather perform the seek() on the individual partitions.

+
Parameters
+ + +
messageIdthe message id where to reposition the subscription
+
+
+ +
+
+ +

◆ seek() [2/2]

+ +
+
+ + + + + + + + +
Result pulsar::Reader::seek (uint64_t timestamp)
+
+

Reset this reader to a specific message publish time.

+
Parameters
+ + +
timestampthe message publish time where to reposition the subscription
+
+
+ +
+
+ +

◆ seekAsync() [1/2]

+ +
+
+ + + + + + + + + + + + + + + + + + +
void pulsar::Reader::seekAsync (const MessageId & msgId,
ResultCallback callback 
)
+
+

Asynchronously reset this reader to a specific message id. The message id can either be a specific message or represent the first or last messages in the topic.

+

Note: this operation can only be done on non-partitioned topics. For these, one can rather perform the seek() on the individual partitions.

+
Parameters
+ + +
messageIdthe message id where to reposition the subscription
+
+
+ +
+
+ +

◆ seekAsync() [2/2]

+ +
+
+ + + + + + + + + + + + + + + + + + +
void pulsar::Reader::seekAsync (uint64_t timestamp,
ResultCallback callback 
)
+
+

Asynchronously reset this reader to a specific message publish time.

+
Parameters
+ + +
timestampthe message publish time where to reposition the subscription
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_reader_configuration-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_reader_configuration-members.html new file mode 100644 index 000000000000..0dd6cccd8f5b --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_reader_configuration-members.html @@ -0,0 +1,128 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::ReaderConfiguration Member List
+
+
+ +

This is the complete list of members for pulsar::ReaderConfiguration, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
getAckGroupingMaxSize() constpulsar::ReaderConfiguration
getAckGroupingTimeMs() constpulsar::ReaderConfiguration
getCryptoFailureAction() constpulsar::ReaderConfiguration
getCryptoKeyReader() constpulsar::ReaderConfiguration
getInternalSubscriptionName() constpulsar::ReaderConfiguration
getProperties() constpulsar::ReaderConfiguration
getProperty(const std::string &name) constpulsar::ReaderConfiguration
getReaderListener() constpulsar::ReaderConfiguration
getReaderName() constpulsar::ReaderConfiguration
getReceiverQueueSize() constpulsar::ReaderConfiguration
getSchema() constpulsar::ReaderConfiguration
getSubscriptionRolePrefix() constpulsar::ReaderConfiguration
getTickDurationInMs() constpulsar::ReaderConfiguration
getUnAckedMessagesTimeoutMs() constpulsar::ReaderConfiguration
hasProperty(const std::string &name) constpulsar::ReaderConfiguration
hasReaderListener() constpulsar::ReaderConfiguration
isEncryptionEnabled() constpulsar::ReaderConfiguration
isReadCompacted() constpulsar::ReaderConfiguration
isStartMessageIdInclusive() constpulsar::ReaderConfiguration
operator=(const ReaderConfiguration &) (defined in pulsar::ReaderConfiguration)pulsar::ReaderConfiguration
ReaderConfiguration() (defined in pulsar::ReaderConfiguration)pulsar::ReaderConfiguration
ReaderConfiguration(const ReaderConfiguration &) (defined in pulsar::ReaderConfiguration)pulsar::ReaderConfiguration
setAckGroupingMaxSize(long maxGroupingSize)pulsar::ReaderConfiguration
setAckGroupingTimeMs(long ackGroupingMillis)pulsar::ReaderConfiguration
setCryptoFailureAction(ConsumerCryptoFailureAction action)pulsar::ReaderConfiguration
setCryptoKeyReader(CryptoKeyReaderPtr cryptoKeyReader)pulsar::ReaderConfiguration
setInternalSubscriptionName(std::string internalSubscriptionName)pulsar::ReaderConfiguration
setProperties(const std::map< std::string, std::string > &properties)pulsar::ReaderConfiguration
setProperty(const std::string &name, const std::string &value)pulsar::ReaderConfiguration
setReadCompacted(bool compacted)pulsar::ReaderConfiguration
setReaderListener(ReaderListener listener)pulsar::ReaderConfiguration
setReaderName(const std::string &readerName)pulsar::ReaderConfiguration
setReceiverQueueSize(int size)pulsar::ReaderConfiguration
setSchema(const SchemaInfo &schemaInfo)pulsar::ReaderConfiguration
setStartMessageIdInclusive(bool startMessageIdInclusive)pulsar::ReaderConfiguration
setSubscriptionRolePrefix(const std::string &subscriptionRolePrefix)pulsar::ReaderConfiguration
setTickDurationInMs(const uint64_t milliSeconds)pulsar::ReaderConfiguration
setUnAckedMessagesTimeoutMs(const uint64_t milliSeconds)pulsar::ReaderConfiguration
~ReaderConfiguration() (defined in pulsar::ReaderConfiguration)pulsar::ReaderConfiguration
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_reader_configuration.html b/static/api/cpp/3.5.x/classpulsar_1_1_reader_configuration.html new file mode 100644 index 000000000000..6b6738aedefd --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_reader_configuration.html @@ -0,0 +1,939 @@ + + + + + + + +pulsar-client-cpp: pulsar::ReaderConfiguration Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +List of all members
+
pulsar::ReaderConfiguration Class Reference
+
+
+ +

#include <ReaderConfiguration.h>

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ ReaderConfiguration (const ReaderConfiguration &)
 
+ReaderConfiguration & operator= (const ReaderConfiguration &)
 
ReaderConfiguration & setSchema (const SchemaInfo &schemaInfo)
 
const SchemaInfo & getSchema () const
 
ReaderConfiguration & setReaderListener (ReaderListener listener)
 
ReaderListener getReaderListener () const
 
bool hasReaderListener () const
 
void setReceiverQueueSize (int size)
 
int getReceiverQueueSize () const
 
void setReaderName (const std::string &readerName)
 
const std::string & getReaderName () const
 
void setSubscriptionRolePrefix (const std::string &subscriptionRolePrefix)
 
const std::string & getSubscriptionRolePrefix () const
 
void setReadCompacted (bool compacted)
 
bool isReadCompacted () const
 
void setInternalSubscriptionName (std::string internalSubscriptionName)
 
const std::string & getInternalSubscriptionName () const
 
void setUnAckedMessagesTimeoutMs (const uint64_t milliSeconds)
 
long getUnAckedMessagesTimeoutMs () const
 
void setTickDurationInMs (const uint64_t milliSeconds)
 
long getTickDurationInMs () const
 
void setAckGroupingTimeMs (long ackGroupingMillis)
 
long getAckGroupingTimeMs () const
 
void setAckGroupingMaxSize (long maxGroupingSize)
 
long getAckGroupingMaxSize () const
 
bool isEncryptionEnabled () const
 
const CryptoKeyReaderPtr getCryptoKeyReader () const
 
ReaderConfiguration & setCryptoKeyReader (CryptoKeyReaderPtr cryptoKeyReader)
 
ConsumerCryptoFailureAction getCryptoFailureAction () const
 
ReaderConfiguration & setCryptoFailureAction (ConsumerCryptoFailureAction action)
 
ReaderConfiguration & setStartMessageIdInclusive (bool startMessageIdInclusive)
 
bool isStartMessageIdInclusive () const
 
bool hasProperty (const std::string &name) const
 
const std::string & getProperty (const std::string &name) const
 
std::map< std::string, std::string > & getProperties () const
 
ReaderConfiguration & setProperty (const std::string &name, const std::string &value)
 
ReaderConfiguration & setProperties (const std::map< std::string, std::string > &properties)
 
+

Detailed Description

+

Class specifying the configuration of a consumer.

+

Member Function Documentation

+ +

◆ getAckGroupingMaxSize()

+ +
+
+ + + + + + + +
long pulsar::ReaderConfiguration::getAckGroupingMaxSize () const
+
+

Get max number of grouped messages within one grouping time window.

+
Returns
max number of grouped messages within one grouping time window.
+ +
+
+ +

◆ getAckGroupingTimeMs()

+ +
+
+ + + + + + + +
long pulsar::ReaderConfiguration::getAckGroupingTimeMs () const
+
+

Get grouping time window in milliseconds.

+
Returns
grouping time window in milliseconds.
+ +
+
+ +

◆ getCryptoFailureAction()

+ +
+
+ + + + + + + +
ConsumerCryptoFailureAction pulsar::ReaderConfiguration::getCryptoFailureAction () const
+
+
Returns
the ConsumerCryptoFailureAction
+ +
+
+ +

◆ getCryptoKeyReader()

+ +
+
+ + + + + + + +
const CryptoKeyReaderPtr pulsar::ReaderConfiguration::getCryptoKeyReader () const
+
+
Returns
the shared pointer to CryptoKeyReader
+ +
+
+ +

◆ getInternalSubscriptionName()

+ +
+
+ + + + + + + +
const std::string & pulsar::ReaderConfiguration::getInternalSubscriptionName () const
+
+
Returns
the internal subscription name
+ +
+
+ +

◆ getProperties()

+ +
+
+ + + + + + + +
std::map< std::string, std::string > & pulsar::ReaderConfiguration::getProperties () const
+
+

Get all the properties attached to this producer.

+ +
+
+ +

◆ getProperty()

+ +
+
+ + + + + + + + +
const std::string & pulsar::ReaderConfiguration::getProperty (const std::string & name) const
+
+

Get the value of a specific property

+
Parameters
+ + +
namethe name of the property
+
+
+
Returns
the value of the property or null if the property was not defined
+ +
+
+ +

◆ getReaderListener()

+ +
+
+ + + + + + + +
ReaderListener pulsar::ReaderConfiguration::getReaderListener () const
+
+
Returns
the configured ReaderListener for the reader
+ +
+
+ +

◆ getReaderName()

+ +
+
+ + + + + + + +
const std::string & pulsar::ReaderConfiguration::getReaderName () const
+
+
Returns
the reader name
+ +
+
+ +

◆ getReceiverQueueSize()

+ +
+
+ + + + + + + +
int pulsar::ReaderConfiguration::getReceiverQueueSize () const
+
+
Returns
the receiver queue size
+ +
+
+ +

◆ getSchema()

+ +
+
+ + + + + + + +
const SchemaInfo & pulsar::ReaderConfiguration::getSchema () const
+
+
Returns
the schema information declared for this consumer
+ +
+
+ +

◆ getSubscriptionRolePrefix()

+ +
+
+ + + + + + + +
const std::string & pulsar::ReaderConfiguration::getSubscriptionRolePrefix () const
+
+
Returns
the subscription role prefix
+ +
+
+ +

◆ getTickDurationInMs()

+ +
+
+ + + + + + + +
long pulsar::ReaderConfiguration::getTickDurationInMs () const
+
+
Returns
the tick duration time (in milliseconds)
+ +
+
+ +

◆ getUnAckedMessagesTimeoutMs()

+ +
+
+ + + + + + + +
long pulsar::ReaderConfiguration::getUnAckedMessagesTimeoutMs () const
+
+
Returns
the configured timeout in milliseconds for unacked messages.
+ +
+
+ +

◆ hasProperty()

+ +
+
+ + + + + + + + +
bool pulsar::ReaderConfiguration::hasProperty (const std::string & name) const
+
+

Check whether the message has a specific property attached.

+
Parameters
+ + +
namethe name of the property to check
+
+
+
Returns
true if the message has the specified property
+
+false if the property is not defined
+ +
+
+ +

◆ hasReaderListener()

+ +
+
+ + + + + + + +
bool pulsar::ReaderConfiguration::hasReaderListener () const
+
+
Returns
true if ReaderListener has been set
+ +
+
+ +

◆ isEncryptionEnabled()

+ +
+
+ + + + + + + +
bool pulsar::ReaderConfiguration::isEncryptionEnabled () const
+
+
Returns
true if encryption keys are added
+ +
+
+ +

◆ isReadCompacted()

+ +
+
+ + + + + + + +
bool pulsar::ReaderConfiguration::isReadCompacted () const
+
+
Returns
true if readCompacted is enabled
+ +
+
+ +

◆ isStartMessageIdInclusive()

+ +
+
+ + + + + + + +
bool pulsar::ReaderConfiguration::isStartMessageIdInclusive () const
+
+

The associated getter of setStartMessageIdInclusive

+ +
+
+ +

◆ setAckGroupingMaxSize()

+ +
+
+ + + + + + + + +
void pulsar::ReaderConfiguration::setAckGroupingMaxSize (long maxGroupingSize)
+
+

Set max number of grouped messages within one grouping time window. If it's set to a non-positive value, number of grouped messages is not limited. Default is 1000.

+
Parameters
+ + +
maxGroupingSizemax number of grouped messages with in one grouping time window.
+
+
+ +
+
+ +

◆ setAckGroupingTimeMs()

+ +
+
+ + + + + + + + +
void pulsar::ReaderConfiguration::setAckGroupingTimeMs (long ackGroupingMillis)
+
+

Set time window in milliseconds for grouping message ACK requests. An ACK request is not sent to broker until the time window reaches its end, or the number of grouped messages reaches limit. Default is 100 milliseconds. If it's set to a non-positive value, ACK requests will be directly sent to broker without grouping.

+
Parameters
+ + +
ackGroupMillistime of ACK grouping window in milliseconds.
+
+
+ +
+
+ +

◆ setCryptoFailureAction()

+ +
+
+ + + + + + + + +
ReaderConfiguration & pulsar::ReaderConfiguration::setCryptoFailureAction (ConsumerCryptoFailureAction action)
+
+

Set the CryptoFailureAction for the reader.

+ +
+
+ +

◆ setCryptoKeyReader()

+ +
+
+ + + + + + + + +
ReaderConfiguration & pulsar::ReaderConfiguration::setCryptoKeyReader (CryptoKeyReaderPtr cryptoKeyReader)
+
+

Set the shared pointer to CryptoKeyReader.

+
Parameters
+ + +
theshared pointer to CryptoKeyReader
+
+
+ +
+
+ +

◆ setInternalSubscriptionName()

+ +
+
+ + + + + + + + +
void pulsar::ReaderConfiguration::setInternalSubscriptionName (std::string internalSubscriptionName)
+
+

Set the internal subscription name.

+
Parameters
+ + +
internalsubscriptionName Default value is reader-{random string}.
+
+
+ +
+
+ +

◆ setProperties()

+ +
+
+ + + + + + + + +
ReaderConfiguration & pulsar::ReaderConfiguration::setProperties (const std::map< std::string, std::string > & properties)
+
+

Add all the properties in the provided map

+ +
+
+ +

◆ setProperty()

+ +
+
+ + + + + + + + + + + + + + + + + + +
ReaderConfiguration & pulsar::ReaderConfiguration::setProperty (const std::string & name,
const std::string & value 
)
+
+

Sets a new property on a message.

Parameters
+ + + +
namethe name of the property
valuethe associated value
+
+
+ +
+
+ +

◆ setReadCompacted()

+ +
+
+ + + + + + + + +
void pulsar::ReaderConfiguration::setReadCompacted (bool compacted)
+
+

If enabled, the consumer reads messages from the compacted topics rather than reading the full message backlog of the topic. This means that if the topic has been compacted, the consumer only sees the latest value for each key in the topic, up until the point in the topic message backlog that has been compacted. Beyond that point, message is sent as normal.

+

readCompacted can only be enabled subscriptions to persistent topics, which have a single active consumer (for example, failure or exclusive subscriptions). Attempting to enable it on subscriptions to a non-persistent topics or on a shared subscription leads to the subscription call failure.

+
Parameters
+ + +
readCompactedwhether to read from the compacted topic
+
+
+ +
+
+ +

◆ setReaderListener()

+ +
+
+ + + + + + + + +
ReaderConfiguration & pulsar::ReaderConfiguration::setReaderListener (ReaderListener listener)
+
+

A message listener enables your application to configure how to process messages. A listener will be called in order for every message received.

+ +
+
+ +

◆ setReaderName()

+ +
+
+ + + + + + + + +
void pulsar::ReaderConfiguration::setReaderName (const std::string & readerName)
+
+

Set the reader name.

+
Parameters
+ + +
readerName
+
+
+ +
+
+ +

◆ setReceiverQueueSize()

+ +
+
+ + + + + + + + +
void pulsar::ReaderConfiguration::setReceiverQueueSize (int size)
+
+

Sets the size of the reader receive queue.

+

The consumer receive queue controls how many messages can be accumulated by the consumer before the application calls receive(). Using a higher value may potentially increase the consumer throughput at the expense of bigger memory utilization.

+

Setting the consumer queue size to 0 decreases the throughput of the consumer by disabling pre-fetching of messages. This approach improves the message distribution on shared subscription by pushing messages only to the consumers that are ready to process them. Neither receive with timeout nor partitioned topics can be used if the consumer queue size is 0. The receive() function call should not be interrupted when the consumer queue size is 0.

+

The default value is 1000 messages and it is appropriate for most use cases.

+
Parameters
+ + +
sizethe new receiver queue size value
+
+
+ +
+
+ +

◆ setSchema()

+ +
+
+ + + + + + + + +
ReaderConfiguration & pulsar::ReaderConfiguration::setSchema (const SchemaInfo & schemaInfo)
+
+

Declare the schema of the data that this reader will be accepting.

+

The schema will be checked against the schema of the topic, and the reader creation will fail if it's not compatible.

+
Parameters
+ + +
schemaInfothe schema definition object
+
+
+ +
+
+ +

◆ setStartMessageIdInclusive()

+ +
+
+ + + + + + + + +
ReaderConfiguration & pulsar::ReaderConfiguration::setStartMessageIdInclusive (bool startMessageIdInclusive)
+
+

Set the reader to include the startMessageId or given position of any reset operation like Reader::seek.

+

Default: false

+
Parameters
+ + +
startMessageIdInclusivewhether to include the reset position
+
+
+ +
+
+ +

◆ setSubscriptionRolePrefix()

+ +
+
+ + + + + + + + +
void pulsar::ReaderConfiguration::setSubscriptionRolePrefix (const std::string & subscriptionRolePrefix)
+
+

Set the subscription role prefix.

+

The default prefix is an empty string.

+
Parameters
+ + +
subscriptionRolePrefix
+
+
+ +
+
+ +

◆ setTickDurationInMs()

+ +
+
+ + + + + + + + +
void pulsar::ReaderConfiguration::setTickDurationInMs (const uint64_t milliSeconds)
+
+

Set the tick duration time that defines the granularity of the ack-timeout redelivery (in milliseconds).

+

The default value is 1000, which means 1 second.

+

Using a higher tick time reduces the memory overhead to track messages when the ack-timeout is set to a bigger value.

+
Parameters
+ + +
milliSecondsthe tick duration time (in milliseconds)
+
+
+ +
+
+ +

◆ setUnAckedMessagesTimeoutMs()

+ +
+
+ + + + + + + + +
void pulsar::ReaderConfiguration::setUnAckedMessagesTimeoutMs (const uint64_t milliSeconds)
+
+

Set the timeout in milliseconds for unacknowledged messages, the timeout needs to be greater than 10 seconds. An Exception is thrown if the given value is less than 10000 (10 seconds). If a successful acknowledgement is not sent within the timeout all the unacknowledged messages are redelivered.

Parameters
+ + +
timeoutin milliseconds
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_schema_info-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_schema_info-members.html new file mode 100644 index 000000000000..b519b0df91e5 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_schema_info-members.html @@ -0,0 +1,96 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::SchemaInfo Member List
+
+
+ +

This is the complete list of members for pulsar::SchemaInfo, including all inherited members.

+ + + + + + + + +
getName() constpulsar::SchemaInfo
getProperties() constpulsar::SchemaInfo
getSchema() constpulsar::SchemaInfo
getSchemaType() constpulsar::SchemaInfo
SchemaInfo()pulsar::SchemaInfo
SchemaInfo(SchemaType schemaType, const std::string &name, const std::string &schema, const StringMap &properties=StringMap())pulsar::SchemaInfo
SchemaInfo(const SchemaInfo &keySchema, const SchemaInfo &valueSchema, const KeyValueEncodingType &keyValueEncodingType=KeyValueEncodingType::INLINE)pulsar::SchemaInfo
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_schema_info.html b/static/api/cpp/3.5.x/classpulsar_1_1_schema_info.html new file mode 100644 index 000000000000..37e606ee0879 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_schema_info.html @@ -0,0 +1,304 @@ + + + + + + + +pulsar-client-cpp: pulsar::SchemaInfo Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +List of all members
+
pulsar::SchemaInfo Class Reference
+
+
+ +

#include <Schema.h>

+ + + + + + + + + + + + + + + + +

+Public Member Functions

 SchemaInfo ()
 
 SchemaInfo (SchemaType schemaType, const std::string &name, const std::string &schema, const StringMap &properties=StringMap())
 
 SchemaInfo (const SchemaInfo &keySchema, const SchemaInfo &valueSchema, const KeyValueEncodingType &keyValueEncodingType=KeyValueEncodingType::INLINE)
 
SchemaType getSchemaType () const
 
const std::string & getName () const
 
const std::string & getSchema () const
 
const StringMap & getProperties () const
 
+

Detailed Description

+

Encapsulates data around the schema definition

+

Constructor & Destructor Documentation

+ +

◆ SchemaInfo() [1/3]

+ +
+
+ + + + + + + +
pulsar::SchemaInfo::SchemaInfo ()
+
+

The default constructor with following configs:

+
See also
SchemaInfo(SchemaType schemaType, const std::string& name, const std::string& schema, const +StringMap& properties)
+ +
+
+ +

◆ SchemaInfo() [2/3]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
pulsar::SchemaInfo::SchemaInfo (SchemaType schemaType,
const std::string & name,
const std::string & schema,
const StringMap & properties = StringMap() 
)
+
+
Parameters
+ + + + + +
schemaTypethe schema type
namethe name of the schema definition
schemathe schema definition as a JSON string
propertiesa map of custom defined properties attached to the schema
+
+
+ +
+
+ +

◆ SchemaInfo() [3/3]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
pulsar::SchemaInfo::SchemaInfo (const SchemaInfo & keySchema,
const SchemaInfo & valueSchema,
const KeyValueEncodingType & keyValueEncodingType = KeyValueEncodingType::INLINE 
)
+
+
Parameters
+ + + + +
keySchemathe key schema.
valueSchemathe value schema.
keyValueEncodingTypeEncoding types of supported KeyValueSchema for Pulsar messages.
+
+
+ +
+
+

Member Function Documentation

+ +

◆ getName()

+ +
+
+ + + + + + + +
const std::string & pulsar::SchemaInfo::getName () const
+
+
Returns
the name of the schema definition
+ +
+
+ +

◆ getProperties()

+ +
+
+ + + + + + + +
const StringMap & pulsar::SchemaInfo::getProperties () const
+
+
Returns
a map of custom defined properties attached to the schema
+ +
+
+ +

◆ getSchema()

+ +
+
+ + + + + + + +
const std::string & pulsar::SchemaInfo::getSchema () const
+
+
Returns
the schema definition as a JSON string
+ +
+
+ +

◆ getSchemaType()

+ +
+
+ + + + + + + +
SchemaType pulsar::SchemaInfo::getSchemaType () const
+
+
Returns
the schema type
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_table_view-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_table_view-members.html new file mode 100644 index 000000000000..51da1e258294 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_table_view-members.html @@ -0,0 +1,101 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::TableView Member List
+
+
+ +

This is the complete list of members for pulsar::TableView, including all inherited members.

+ + + + + + + + + + + + + +
ClientImpl (defined in pulsar::TableView)pulsar::TableViewfriend
close()pulsar::TableView
closeAsync(ResultCallback callback)pulsar::TableView
containsKey(const std::string &key) constpulsar::TableView
forEach(TableViewAction action)pulsar::TableView
forEachAndListen(TableViewAction action)pulsar::TableView
getValue(const std::string &key, std::string &value) constpulsar::TableView
PulsarFriend (defined in pulsar::TableView)pulsar::TableViewfriend
retrieveValue(const std::string &key, std::string &value)pulsar::TableView
size() constpulsar::TableView
snapshot()pulsar::TableView
TableView()pulsar::TableView
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_table_view.html b/static/api/cpp/3.5.x/classpulsar_1_1_table_view.html new file mode 100644 index 000000000000..11841f5eb89f --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_table_view.html @@ -0,0 +1,365 @@ + + + + + + + +pulsar-client-cpp: pulsar::TableView Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +Friends | +List of all members
+
pulsar::TableView Class Reference
+
+
+ + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 TableView ()
 
bool retrieveValue (const std::string &key, std::string &value)
 
bool getValue (const std::string &key, std::string &value) const
 
bool containsKey (const std::string &key) const
 
std::unordered_map< std::string, std::string > snapshot ()
 
std::size_t size () const
 
void forEach (TableViewAction action)
 
void forEachAndListen (TableViewAction action)
 
void closeAsync (ResultCallback callback)
 
Result close ()
 
+ + + + + +

+Friends

+class PulsarFriend
 
+class ClientImpl
 
+

Constructor & Destructor Documentation

+ +

◆ TableView()

+ +
+
+ + + + + + + +
pulsar::TableView::TableView ()
+
+

Construct an uninitialized tableView object

+ +
+
+

Member Function Documentation

+ +

◆ close()

+ +
+
+ + + + + + + +
Result pulsar::TableView::close ()
+
+

Close the table view and stop the broker to push more messages

+ +
+
+ +

◆ closeAsync()

+ +
+
+ + + + + + + + +
void pulsar::TableView::closeAsync (ResultCallback callback)
+
+

Asynchronously close the tableview and stop the broker to push more messages

+ +
+
+ +

◆ containsKey()

+ +
+
+ + + + + + + + +
bool pulsar::TableView::containsKey (const std::string & key) const
+
+

Check if the key exists in the table view.

+
Returns
true if the key exists in the table view
+ +
+
+ +

◆ forEach()

+ +
+
+ + + + + + + + +
void pulsar::TableView::forEach (TableViewAction action)
+
+

Performs the given action for each entry in this map until all entries have been processed or the action throws an exception.

+ +
+
+ +

◆ forEachAndListen()

+ +
+
+ + + + + + + + +
void pulsar::TableView::forEachAndListen (TableViewAction action)
+
+

Performs the given action for each entry in this map until all entries have been processed and register the callback, which will be called each time a key-value pair is updated.

+ +
+
+ +

◆ getValue()

+ +
+
+ + + + + + + + + + + + + + + + + + +
bool pulsar::TableView::getValue (const std::string & key,
std::string & value 
) const
+
+

It's similar with retrievedValue except the value is copied into value.

+
Parameters
+ + + +
key
valuethe value associated with the key
+
+
+
Returns
Whether the key exists in the table view.
+ +
+
+ +

◆ retrieveValue()

+ +
+
+ + + + + + + + + + + + + + + + + + +
bool pulsar::TableView::retrieveValue (const std::string & key,
std::string & value 
)
+
+

Move the latest value associated with the key.

+

Example:

+
++
+
TableView view;
+
std::string value;
+
while (true) {
+
if (view.retrieveValue("key", value)) {
+
std::cout << "value is updated to: " << value;
+
} else {
+
// sleep for a while or print the message that value is not updated
+
}
+
}
+
pulsar::TableView
Definition TableView.h:38
+
pulsar::TableView::retrieveValue
bool retrieveValue(const std::string &key, std::string &value)
+
Parameters
+ + + +
key
valuethe value associated with the key
+
+
+
Returns
true if there is an associated value of the key, otherwise false
+

NOTE: Once the value has been retrieved successfully, the associated value will be removed from the table view until next time the value is updated.

+ +
+
+ +

◆ size()

+ +
+
+ + + + + + + +
std::size_t pulsar::TableView::size () const
+
+

Get the size of the elements.

+ +
+
+ +

◆ snapshot()

+ +
+
+ + + + + + + +
std::unordered_map< std::string, std::string > pulsar::TableView::snapshot ()
+
+

Move the table view data into the unordered map.

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_topic_metadata-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_topic_metadata-members.html new file mode 100644 index 000000000000..01f8fbcf1a1b --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_topic_metadata-members.html @@ -0,0 +1,91 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::TopicMetadata Member List
+
+
+ +

This is the complete list of members for pulsar::TopicMetadata, including all inherited members.

+ + + +
getNumPartitions() const =0pulsar::TopicMetadatapure virtual
~TopicMetadata() (defined in pulsar::TopicMetadata)pulsar::TopicMetadatainlinevirtual
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_topic_metadata.html b/static/api/cpp/3.5.x/classpulsar_1_1_topic_metadata.html new file mode 100644 index 000000000000..0516ba408c4a --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_topic_metadata.html @@ -0,0 +1,129 @@ + + + + + + + +pulsar-client-cpp: pulsar::TopicMetadata Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Member Functions | +List of all members
+
pulsar::TopicMetadata Class Referenceabstract
+
+
+ +

#include <TopicMetadata.h>

+ + + + +

+Public Member Functions

virtual int getNumPartitions () const =0
 
+

Detailed Description

+

Metadata of a topic that can be used for message routing.

+

Member Function Documentation

+ +

◆ getNumPartitions()

+ +
+
+ + + + + +
+ + + + + + + +
virtual int pulsar::TopicMetadata::getNumPartitions () const
+ 		+pure virtual
+
+
Returns
the number of partitions
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_typed_message-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_typed_message-members.html new file mode 100644 index 000000000000..94d23d59e307 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_typed_message-members.html @@ -0,0 +1,123 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::TypedMessage< T > Member List
+
+
+ +

This is the complete list of members for pulsar::TypedMessage< T >, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Decoder typedef (defined in pulsar::TypedMessage< T >)pulsar::TypedMessage< T >
getData() constpulsar::Message
getDataAsString() constpulsar::Message
getEventTimestamp() constpulsar::Message
getIndex() constpulsar::Message
getKeyValueData() constpulsar::Message
getLength() constpulsar::Message
getLongSchemaVersion() constpulsar::Message
getMessageId() constpulsar::Message
getOrderingKey() constpulsar::Message
getPartitionKey() constpulsar::Message
getProperties() constpulsar::Message
getProperty(const std::string &name) constpulsar::Message
getPublishTimestamp() constpulsar::Message
getRedeliveryCount() constpulsar::Message
getSchemaVersion() constpulsar::Message
getTopicName() constpulsar::Message
getValue() const (defined in pulsar::TypedMessage< T >)pulsar::TypedMessage< T >inline
hasOrderingKey() constpulsar::Message
hasPartitionKey() constpulsar::Message
hasProperty(const std::string &name) constpulsar::Message
hasSchemaVersion() constpulsar::Message
impl_ (defined in pulsar::Message)pulsar::Messageprotected
Message() (defined in pulsar::Message)pulsar::Message
Message(MessageImplPtr &impl) (defined in pulsar::Message)pulsar::Messageprotected
Message(const MessageId &messageId, proto::BrokerEntryMetadata &brokerEntryMetadata, proto::MessageMetadata &metadata, SharedBuffer &payload) (defined in pulsar::Message)pulsar::Messageprotected
Message(const MessageId &messageId, proto::BrokerEntryMetadata &brokerEntryMetadata, proto::MessageMetadata &metadata, SharedBuffer &payload, proto::SingleMessageMetadata &singleMetadata, const std::shared_ptr< std::string > &topicName)pulsar::Messageprotected
MessageImplPtr typedef (defined in pulsar::Message)pulsar::Messageprotected
operator==(const Message &msg) const (defined in pulsar::Message)pulsar::Message
setDecoder(Decoder decoder) (defined in pulsar::TypedMessage< T >)pulsar::TypedMessage< T >inline
setMessageId(const MessageId &messageId) constpulsar::Message
StringMap typedef (defined in pulsar::Message)pulsar::Message
TypedMessage()=default (defined in pulsar::TypedMessage< T >)pulsar::TypedMessage< T >
TypedMessage(const Message &message, Decoder decoder=[](const char *, std::size_t) { return T{};}) (defined in pulsar::TypedMessage< T >)pulsar::TypedMessage< T >inline
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_typed_message.html b/static/api/cpp/3.5.x/classpulsar_1_1_typed_message.html new file mode 100644 index 000000000000..e3fcf1de488b --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_typed_message.html @@ -0,0 +1,193 @@ + + + + + + + +pulsar-client-cpp: pulsar::TypedMessage< T > Class Template Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Types | +Public Member Functions | +List of all members
+
pulsar::TypedMessage< T > Class Template Reference
+
+
+
+Inheritance diagram for pulsar::TypedMessage< T >:
+
+
+ + +pulsar::Message + +
+ + + + + + + +

+Public Types

+using Decoder = std::function< T(const char *, std::size_t)>
 
- Public Types inherited from pulsar::Message
+typedef std::map< std::string, std::string > StringMap
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ TypedMessage (const Message &message, Decoder decoder=[](const char *, std::size_t) { return T{};})
 
+T getValue () const
 
+TypedMessage & setDecoder (Decoder decoder)
 
- Public Member Functions inherited from pulsar::Message
const StringMap & getProperties () const
 
bool hasProperty (const std::string &name) const
 
const std::string & getProperty (const std::string &name) const
 
const void * getData () const
 
std::size_t getLength () const
 
std::string getDataAsString () const
 
KeyValue getKeyValueData () const
 
const MessageId & getMessageId () const
 
void setMessageId (const MessageId &messageId) const
 
int64_t getIndex () const
 
const std::string & getPartitionKey () const
 
bool hasPartitionKey () const
 
const std::string & getOrderingKey () const
 
bool hasOrderingKey () const
 
uint64_t getPublishTimestamp () const
 
uint64_t getEventTimestamp () const
 
const std::string & getTopicName () const
 
const int getRedeliveryCount () const
 
bool hasSchemaVersion () const
 
int64_t getLongSchemaVersion () const
 
const std::string & getSchemaVersion () const
 
+bool operator== (const Message &msg) const
 
+ + + + + + + + + + + + + + + +

+Additional Inherited Members

- Protected Types inherited from pulsar::Message
+typedef std::shared_ptr< MessageImpl > MessageImplPtr
 
- Protected Member Functions inherited from pulsar::Message
+ Message (MessageImplPtr &impl)
 
+ Message (const MessageId &messageId, proto::BrokerEntryMetadata &brokerEntryMetadata, proto::MessageMetadata &metadata, SharedBuffer &payload)
 
+ Message (const MessageId &messageId, proto::BrokerEntryMetadata &brokerEntryMetadata, proto::MessageMetadata &metadata, SharedBuffer &payload, proto::SingleMessageMetadata &singleMetadata, const std::shared_ptr< std::string > &topicName)
 Used for Batch Messages.
 
- Protected Attributes inherited from pulsar::Message
+MessageImplPtr impl_
 
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_typed_message.png b/static/api/cpp/3.5.x/classpulsar_1_1_typed_message.png new file mode 100644 index 000000000000..89f225e90482 Binary files /dev/null and b/static/api/cpp/3.5.x/classpulsar_1_1_typed_message.png differ diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_typed_message_builder-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_typed_message_builder-members.html new file mode 100644 index 000000000000..08ed4c0d5930 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_typed_message_builder-members.html @@ -0,0 +1,114 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::TypedMessageBuilder< T > Member List
+
+
+ +

This is the complete list of members for pulsar::TypedMessageBuilder< T >, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
build()pulsar::MessageBuilder
create()pulsar::MessageBuilder
data() const (defined in pulsar::MessageBuilder)pulsar::MessageBuilderprotected
disableReplication(bool flag)pulsar::MessageBuilder
Encoder typedef (defined in pulsar::TypedMessageBuilder< T >)pulsar::TypedMessageBuilder< T >
MessageBuilder() (defined in pulsar::MessageBuilder)pulsar::MessageBuilder
setAllocatedContent(void *data, size_t size)pulsar::MessageBuilder
setContent(const void *data, size_t size)pulsar::MessageBuilder
setContent(const std::string &data)pulsar::MessageBuilder
setContent(std::string &&data)pulsar::MessageBuilder
setContent(const KeyValue &data)pulsar::MessageBuilder
setDeliverAfter(const std::chrono::milliseconds delay)pulsar::MessageBuilder
setDeliverAt(uint64_t deliveryTimestamp)pulsar::MessageBuilder
setEventTimestamp(uint64_t eventTimestamp)pulsar::MessageBuilder
setOrderingKey(const std::string &orderingKey)pulsar::MessageBuilder
setPartitionKey(const std::string &partitionKey)pulsar::MessageBuilder
setProperties(const StringMap &properties)pulsar::MessageBuilder
setProperty(const std::string &name, const std::string &value)pulsar::MessageBuilder
setReplicationClusters(const std::vector< std::string > &clusters)pulsar::MessageBuilder
setSequenceId(int64_t sequenceId)pulsar::MessageBuilder
setValue(const T &value) (defined in pulsar::TypedMessageBuilder< T >)pulsar::TypedMessageBuilder< T >inline
size() const (defined in pulsar::MessageBuilder)pulsar::MessageBuilderprotected
StringMap typedef (defined in pulsar::MessageBuilder)pulsar::MessageBuilder
TypedMessageBuilder(Encoder encoder, Validator validator=[](const char *, std::size_t) {}) (defined in pulsar::TypedMessageBuilder< T >)pulsar::TypedMessageBuilder< T >inline
Validator typedef (defined in pulsar::TypedMessageBuilder< T >)pulsar::TypedMessageBuilder< T >
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_typed_message_builder.html b/static/api/cpp/3.5.x/classpulsar_1_1_typed_message_builder.html new file mode 100644 index 000000000000..31cab16524cc --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_typed_message_builder.html @@ -0,0 +1,170 @@ + + + + + + + +pulsar-client-cpp: pulsar::TypedMessageBuilder< T > Class Template Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Types | +Public Member Functions | +List of all members
+
pulsar::TypedMessageBuilder< T > Class Template Reference
+
+
+
+Inheritance diagram for pulsar::TypedMessageBuilder< T >:
+
+
+ + +pulsar::MessageBuilder + +
+ + + + + + + + + +

+Public Types

+using Encoder = std::function< std::string(const T &)>
 
+using Validator = std::function< void(const char *data, size_t)>
 
- Public Types inherited from pulsar::MessageBuilder
+typedef std::map< std::string, std::string > StringMap
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ TypedMessageBuilder (Encoder encoder, Validator validator=[](const char *, std::size_t) {})
 
+TypedMessageBuilder & setValue (const T &value)
 
- Public Member Functions inherited from pulsar::MessageBuilder
Message build ()
 
MessageBuilder & setContent (const void *data, size_t size)
 
MessageBuilder & setContent (const std::string &data)
 
MessageBuilder & setContent (std::string &&data)
 
MessageBuilder & setContent (const KeyValue &data)
 
MessageBuilder & setAllocatedContent (void *data, size_t size)
 
MessageBuilder & setProperty (const std::string &name, const std::string &value)
 
MessageBuilder & setProperties (const StringMap &properties)
 
MessageBuilder & setPartitionKey (const std::string &partitionKey)
 
MessageBuilder & setOrderingKey (const std::string &orderingKey)
 
MessageBuilder & setDeliverAfter (const std::chrono::milliseconds delay)
 
MessageBuilder & setDeliverAt (uint64_t deliveryTimestamp)
 
MessageBuilder & setEventTimestamp (uint64_t eventTimestamp)
 
MessageBuilder & setSequenceId (int64_t sequenceId)
 
MessageBuilder & setReplicationClusters (const std::vector< std::string > &clusters)
 
MessageBuilder & disableReplication (bool flag)
 
MessageBuilder & create ()
 
+ + + + + + +

+Additional Inherited Members

- Protected Member Functions inherited from pulsar::MessageBuilder
+const char * data () const
 
+std::size_t size () const
 
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_typed_message_builder.png b/static/api/cpp/3.5.x/classpulsar_1_1_typed_message_builder.png new file mode 100644 index 000000000000..f7f05ed956cd Binary files /dev/null and b/static/api/cpp/3.5.x/classpulsar_1_1_typed_message_builder.png differ diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_typed_message_builder_3_01std_1_1string_01_4-members.html b/static/api/cpp/3.5.x/classpulsar_1_1_typed_message_builder_3_01std_1_1string_01_4-members.html new file mode 100644 index 000000000000..f8b314d30476 --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_typed_message_builder_3_01std_1_1string_01_4-members.html @@ -0,0 +1,114 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar::TypedMessageBuilder< std::string > Member List
+
+
+ +

This is the complete list of members for pulsar::TypedMessageBuilder< std::string >, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
build()pulsar::MessageBuilder
create()pulsar::MessageBuilder
data() const (defined in pulsar::MessageBuilder)pulsar::MessageBuilderprotected
disableReplication(bool flag)pulsar::MessageBuilder
MessageBuilder() (defined in pulsar::MessageBuilder)pulsar::MessageBuilder
setAllocatedContent(void *data, size_t size)pulsar::MessageBuilder
setContent(const void *data, size_t size)pulsar::MessageBuilder
setContent(const std::string &data)pulsar::MessageBuilder
setContent(std::string &&data)pulsar::MessageBuilder
setContent(const KeyValue &data)pulsar::MessageBuilder
setDeliverAfter(const std::chrono::milliseconds delay)pulsar::MessageBuilder
setDeliverAt(uint64_t deliveryTimestamp)pulsar::MessageBuilder
setEventTimestamp(uint64_t eventTimestamp)pulsar::MessageBuilder
setOrderingKey(const std::string &orderingKey)pulsar::MessageBuilder
setPartitionKey(const std::string &partitionKey)pulsar::MessageBuilder
setProperties(const StringMap &properties)pulsar::MessageBuilder
setProperty(const std::string &name, const std::string &value)pulsar::MessageBuilder
setReplicationClusters(const std::vector< std::string > &clusters)pulsar::MessageBuilder
setSequenceId(int64_t sequenceId)pulsar::MessageBuilder
setValue(const std::string &value) (defined in pulsar::TypedMessageBuilder< std::string >)pulsar::TypedMessageBuilder< std::string >inline
setValue(std::string &&value) (defined in pulsar::TypedMessageBuilder< std::string >)pulsar::TypedMessageBuilder< std::string >inline
size() const (defined in pulsar::MessageBuilder)pulsar::MessageBuilderprotected
StringMap typedef (defined in pulsar::MessageBuilder)pulsar::MessageBuilder
TypedMessageBuilder(Validator validator=nullptr) (defined in pulsar::TypedMessageBuilder< std::string >)pulsar::TypedMessageBuilder< std::string >inline
Validator typedef (defined in pulsar::TypedMessageBuilder< std::string >)pulsar::TypedMessageBuilder< std::string >
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_typed_message_builder_3_01std_1_1string_01_4.html b/static/api/cpp/3.5.x/classpulsar_1_1_typed_message_builder_3_01std_1_1string_01_4.html new file mode 100644 index 000000000000..e8778a536f0e --- /dev/null +++ b/static/api/cpp/3.5.x/classpulsar_1_1_typed_message_builder_3_01std_1_1string_01_4.html @@ -0,0 +1,170 @@ + + + + + + + +pulsar-client-cpp: pulsar::TypedMessageBuilder< std::string > Class Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
+Public Types | +Public Member Functions | +List of all members
+
pulsar::TypedMessageBuilder< std::string > Class Reference
+
+
+
+Inheritance diagram for pulsar::TypedMessageBuilder< std::string >:
+
+
+ + +pulsar::MessageBuilder + +
+ + + + + + + +

+Public Types

+using Validator = std::function< void(const char *data, size_t)>
 
- Public Types inherited from pulsar::MessageBuilder
+typedef std::map< std::string, std::string > StringMap
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ TypedMessageBuilder (Validator validator=nullptr)
 
+TypedMessageBuilder & setValue (const std::string &value)
 
+TypedMessageBuilder & setValue (std::string &&value)
 
- Public Member Functions inherited from pulsar::MessageBuilder
Message build ()
 
MessageBuilder & setContent (const void *data, size_t size)
 
MessageBuilder & setContent (const std::string &data)
 
MessageBuilder & setContent (std::string &&data)
 
MessageBuilder & setContent (const KeyValue &data)
 
MessageBuilder & setAllocatedContent (void *data, size_t size)
 
MessageBuilder & setProperty (const std::string &name, const std::string &value)
 
MessageBuilder & setProperties (const StringMap &properties)
 
MessageBuilder & setPartitionKey (const std::string &partitionKey)
 
MessageBuilder & setOrderingKey (const std::string &orderingKey)
 
MessageBuilder & setDeliverAfter (const std::chrono::milliseconds delay)
 
MessageBuilder & setDeliverAt (uint64_t deliveryTimestamp)
 
MessageBuilder & setEventTimestamp (uint64_t eventTimestamp)
 
MessageBuilder & setSequenceId (int64_t sequenceId)
 
MessageBuilder & setReplicationClusters (const std::vector< std::string > &clusters)
 
MessageBuilder & disableReplication (bool flag)
 
MessageBuilder & create ()
 
+ + + + + + +

+Additional Inherited Members

- Protected Member Functions inherited from pulsar::MessageBuilder
+const char * data () const
 
+std::size_t size () const
 
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/classpulsar_1_1_typed_message_builder_3_01std_1_1string_01_4.png b/static/api/cpp/3.5.x/classpulsar_1_1_typed_message_builder_3_01std_1_1string_01_4.png new file mode 100644 index 000000000000..aff219fc73fc Binary files /dev/null and b/static/api/cpp/3.5.x/classpulsar_1_1_typed_message_builder_3_01std_1_1string_01_4.png differ diff --git a/static/api/cpp/3.5.x/client__configuration_8h_source.html b/static/api/cpp/3.5.x/client__configuration_8h_source.html new file mode 100644 index 000000000000..40110988adc2 --- /dev/null +++ b/static/api/cpp/3.5.x/client__configuration_8h_source.html @@ -0,0 +1,223 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/c/client_configuration.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
client_configuration.h
+
+
+
1
+
20#pragma once
+
21
+
22#include <pulsar/defines.h>
+
23#include <stdbool.h>
+
24
+
25#ifdef __cplusplus
+
26extern "C" {
+
27#endif
+
28
+
29typedef enum
+
30{
+
31 pulsar_DEBUG = 0,
+
32 pulsar_INFO = 1,
+
33 pulsar_WARN = 2,
+
34 pulsar_ERROR = 3
+
35} pulsar_logger_level_t;
+
36
+
37typedef void (*pulsar_logger)(pulsar_logger_level_t level, const char *file, int line, const char *message,
+
38 void *ctx);
+
39
+
+
40typedef struct pulsar_logger_t {
+
41 // The context that will be passed into `is_enabled` and `log` as the last argument
+
42 void *ctx;
+
43 // Whether to log for the given log level
+
44 bool (*is_enabled)(pulsar_logger_level_t level, void *ctx);
+
45 // How to log the message
+
46 pulsar_logger log;
+
47} pulsar_logger_t;
+
+
48
+
49typedef struct _pulsar_client_configuration pulsar_client_configuration_t;
+
50typedef struct _pulsar_authentication pulsar_authentication_t;
+
51
+
52PULSAR_PUBLIC pulsar_client_configuration_t *pulsar_client_configuration_create();
+
53
+
54PULSAR_PUBLIC void pulsar_client_configuration_free(pulsar_client_configuration_t *conf);
+
55
+
61PULSAR_PUBLIC void pulsar_client_configuration_set_auth(pulsar_client_configuration_t *conf,
+
62 pulsar_authentication_t *authentication);
+
63
+
70PULSAR_PUBLIC void pulsar_client_configuration_set_memory_limit(pulsar_client_configuration_t *conf,
+
71 unsigned long long memoryLimitBytes);
+
72
+
76PULSAR_PUBLIC unsigned long long pulsar_client_configuration_get_memory_limit(
+
77 pulsar_client_configuration_t *conf);
+
78
+
85PULSAR_PUBLIC void pulsar_client_configuration_set_operation_timeout_seconds(
+
86 pulsar_client_configuration_t *conf, int timeout);
+
87
+
91PULSAR_PUBLIC int pulsar_client_configuration_get_operation_timeout_seconds(
+
92 pulsar_client_configuration_t *conf);
+
93
+
100PULSAR_PUBLIC void pulsar_client_configuration_set_io_threads(pulsar_client_configuration_t *conf,
+
101 int threads);
+
102
+
106PULSAR_PUBLIC int pulsar_client_configuration_get_io_threads(pulsar_client_configuration_t *conf);
+
107
+
118PULSAR_PUBLIC void pulsar_client_configuration_set_message_listener_threads(
+
119 pulsar_client_configuration_t *conf, int threads);
+
120
+
124PULSAR_PUBLIC int pulsar_client_configuration_get_message_listener_threads(
+
125 pulsar_client_configuration_t *conf);
+
126
+
135PULSAR_PUBLIC void pulsar_client_configuration_set_concurrent_lookup_request(
+
136 pulsar_client_configuration_t *conf, int concurrentLookupRequest);
+
137
+
141PULSAR_PUBLIC int pulsar_client_configuration_get_concurrent_lookup_request(
+
142 pulsar_client_configuration_t *conf);
+
143
+
144PULSAR_PUBLIC void pulsar_client_configuration_set_logger(pulsar_client_configuration_t *conf,
+
145 pulsar_logger logger, void *ctx);
+
146
+
147PULSAR_PUBLIC void pulsar_client_configuration_set_logger_t(pulsar_client_configuration_t *conf,
+
148 pulsar_logger_t logger);
+
149
+
150PULSAR_PUBLIC void pulsar_client_configuration_set_use_tls(pulsar_client_configuration_t *conf, int useTls);
+
151
+
152PULSAR_PUBLIC int pulsar_client_configuration_is_use_tls(pulsar_client_configuration_t *conf);
+
153
+
154PULSAR_PUBLIC void pulsar_client_configuration_set_tls_trust_certs_file_path(
+
155 pulsar_client_configuration_t *conf, const char *tlsTrustCertsFilePath);
+
156
+
157PULSAR_PUBLIC const char *pulsar_client_configuration_get_tls_trust_certs_file_path(
+
158 pulsar_client_configuration_t *conf);
+
159
+
160PULSAR_PUBLIC void pulsar_client_configuration_set_tls_allow_insecure_connection(
+
161 pulsar_client_configuration_t *conf, int allowInsecure);
+
162
+
163PULSAR_PUBLIC void pulsar_client_configuration_set_tls_private_key_file_path(
+
164 pulsar_client_configuration_t *conf, const char *private_key_file_path);
+
165
+
166PULSAR_PUBLIC const char *pulsar_client_configuration_get_tls_private_key_file_path(
+
167 pulsar_client_configuration_t *conf);
+
168
+
169PULSAR_PUBLIC void pulsar_client_configuration_set_tls_certificate_file_path(
+
170 pulsar_client_configuration_t *conf, const char *certificateFilePath);
+
171
+
172PULSAR_PUBLIC const char *pulsar_client_configuration_get_tls_certificate_file_path(
+
173 pulsar_client_configuration_t *conf);
+
174
+
175PULSAR_PUBLIC int pulsar_client_configuration_is_tls_allow_insecure_connection(
+
176 pulsar_client_configuration_t *conf);
+
177
+
178/*
+
179 * Initialize stats interval in seconds. Stats are printed and reset after every 'statsIntervalInSeconds'.
+
180 * Set to 0 in order to disable stats collection.
+
181 */
+
182PULSAR_PUBLIC void pulsar_client_configuration_set_stats_interval_in_seconds(
+
183 pulsar_client_configuration_t *conf, const unsigned int interval);
+
184
+
185PULSAR_PUBLIC int pulsar_client_configuration_is_validate_hostname(pulsar_client_configuration_t *conf);
+
186
+
187PULSAR_PUBLIC void pulsar_client_configuration_set_validate_hostname(pulsar_client_configuration_t *conf,
+
188 int validateHostName);
+
189
+
190PULSAR_PUBLIC void pulsar_client_configuration_set_listener_name(pulsar_client_configuration_t *conf,
+
191 const char *listenerName);
+
192
+
193PULSAR_PUBLIC const char *pulsar_client_configuration_get_listener_name(pulsar_client_configuration_t *conf);
+
194
+
195/*
+
196 * Get the stats interval set in the client.
+
197 */
+
198PULSAR_PUBLIC const unsigned int pulsar_client_configuration_get_stats_interval_in_seconds(
+
199 pulsar_client_configuration_t *conf);
+
200
+
201#ifdef __cplusplus
+
202}
+
203#endif
+
pulsar_logger_t
Definition client_configuration.h:40
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/closed.png b/static/api/cpp/3.5.x/closed.png new file mode 100644 index 000000000000..98cc2c909da3 Binary files /dev/null and b/static/api/cpp/3.5.x/closed.png differ diff --git a/static/api/cpp/3.5.x/consumer__configuration_8h_source.html b/static/api/cpp/3.5.x/consumer__configuration_8h_source.html new file mode 100644 index 000000000000..22b7b082bf70 --- /dev/null +++ b/static/api/cpp/3.5.x/consumer__configuration_8h_source.html @@ -0,0 +1,342 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/c/consumer_configuration.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
consumer_configuration.h
+
+
+
1
+
19#pragma once
+
20
+
21#include <pulsar/defines.h>
+
22
+
23#include "consumer.h"
+
24#include "producer_configuration.h"
+
25
+
26#ifdef __cplusplus
+
27extern "C" {
+
28#endif
+
29
+
30typedef struct _pulsar_consumer_configuration pulsar_consumer_configuration_t;
+
31
+
32typedef enum
+
33{
+
37 pulsar_ConsumerExclusive,
+
38
+
43 pulsar_ConsumerShared,
+
44
+
48 pulsar_ConsumerFailover,
+
49
+
54 pulsar_ConsumerKeyShared
+
55} pulsar_consumer_type;
+
56
+
57typedef enum
+
58{
+
62 initial_position_latest,
+
66 initial_position_earliest
+
67} initial_position;
+
68
+
69typedef enum
+
70{
+
71 // This is the default option to fail consume until crypto succeeds
+
72 pulsar_ConsumerFail,
+
73 // Message is silently acknowledged and not delivered to the application
+
74 pulsar_ConsumerDiscard,
+
75 // Deliver the encrypted message to the application. It's the application's
+
76 // responsibility to decrypt the message. If message is also compressed,
+
77 // decompression will fail. If message contain batch messages, client will
+
78 // not be able to retrieve individual messages in the batch
+
79 pulsar_ConsumerConsume
+
80} pulsar_consumer_crypto_failure_action;
+
81
+
82typedef enum
+
83{
+
84 // Only subscribe to persistent topics.
+
85 pulsar_consumer_regex_sub_mode_PersistentOnly = 0,
+
86 // Only subscribe to non-persistent topics.
+
87 pulsar_consumer_regex_sub_mode_NonPersistentOnly = 1,
+
88 // Subscribe to both persistent and non-persistent topics.
+
89 pulsar_consumer_regex_sub_mode_AllTopics = 2
+
90} pulsar_consumer_regex_subscription_mode;
+
91
+
92// Though any field could be non-positive, if all of them are non-positive, this policy will be treated as
+
93// invalid
+
+
94typedef struct {
+
95 // Max num messages, a non-positive value means no limit.
+
96 int maxNumMessages;
+
97 // Max num bytes, a non-positive value means no limit.
+
98 long maxNumBytes;
+
99 // The receive timeout, a non-positive value means no limit.
+
100 long timeoutMs;
+
101} pulsar_consumer_batch_receive_policy_t;
+
+
102
+
+
103typedef struct {
+
104 // Name of the dead topic where the failing messages are sent.
+
105 // If it's null, use sourceTopicName + "-" + subscriptionName + "-DLQ" as the value
+
106 const char *dead_letter_topic;
+
107 // Maximum number of times that a message is redelivered before being sent to the dead letter queue.
+
108 // If it's not greater than 0, treat it as INT_MAX, it means DLQ disable.
+
109 int max_redeliver_count;
+
110 // Name of the initial subscription name of the dead letter topic.
+
111 // If it's null, the initial subscription for the dead letter topic is not created.
+
112 // If this field is set but the broker's `allowAutoSubscriptionCreation` is disabled, the DLQ producer
+
113 // fails to be created.
+
114 const char *initial_subscription_name;
+
115} pulsar_consumer_config_dead_letter_policy_t;
+
+
116
+
118typedef void (*pulsar_message_listener)(pulsar_consumer_t *consumer, pulsar_message_t *msg, void *ctx);
+
119
+
120PULSAR_PUBLIC pulsar_consumer_configuration_t *pulsar_consumer_configuration_create();
+
121
+
122PULSAR_PUBLIC void pulsar_consumer_configuration_free(
+
123 pulsar_consumer_configuration_t *consumer_configuration);
+
124
+
137PULSAR_PUBLIC void pulsar_consumer_configuration_set_consumer_type(
+
138 pulsar_consumer_configuration_t *consumer_configuration, pulsar_consumer_type consumerType);
+
139
+
140PULSAR_PUBLIC pulsar_consumer_type
+
141pulsar_consumer_configuration_get_consumer_type(pulsar_consumer_configuration_t *consumer_configuration);
+
142
+
143PULSAR_PUBLIC void pulsar_consumer_configuration_set_schema_info(
+
144 pulsar_consumer_configuration_t *consumer_configuration, pulsar_schema_type schemaType, const char *name,
+
145 const char *schema, pulsar_string_map_t *properties);
+
146
+
152PULSAR_PUBLIC void pulsar_consumer_configuration_set_message_listener(
+
153 pulsar_consumer_configuration_t *consumer_configuration, pulsar_message_listener messageListener,
+
154 void *ctx);
+
155
+
156PULSAR_PUBLIC int pulsar_consumer_configuration_has_message_listener(
+
157 pulsar_consumer_configuration_t *consumer_configuration);
+
158
+
180PULSAR_PUBLIC void pulsar_consumer_configuration_set_receiver_queue_size(
+
181 pulsar_consumer_configuration_t *consumer_configuration, int size);
+
182
+
183PULSAR_PUBLIC int pulsar_consumer_configuration_get_receiver_queue_size(
+
184 pulsar_consumer_configuration_t *consumer_configuration);
+
185
+
194PULSAR_PUBLIC void pulsar_consumer_set_max_total_receiver_queue_size_across_partitions(
+
195 pulsar_consumer_configuration_t *consumer_configuration, int maxTotalReceiverQueueSizeAcrossPartitions);
+
196
+
200PULSAR_PUBLIC int pulsar_consumer_get_max_total_receiver_queue_size_across_partitions(
+
201 pulsar_consumer_configuration_t *consumer_configuration);
+
202
+
203PULSAR_PUBLIC void pulsar_consumer_set_consumer_name(pulsar_consumer_configuration_t *consumer_configuration,
+
204 const char *consumerName);
+
205
+
206PULSAR_PUBLIC const char *pulsar_consumer_get_consumer_name(
+
207 pulsar_consumer_configuration_t *consumer_configuration);
+
208
+
216PULSAR_PUBLIC void pulsar_consumer_set_unacked_messages_timeout_ms(
+
217 pulsar_consumer_configuration_t *consumer_configuration, const uint64_t milliSeconds);
+
218
+
222PULSAR_PUBLIC long pulsar_consumer_get_unacked_messages_timeout_ms(
+
223 pulsar_consumer_configuration_t *consumer_configuration);
+
224
+
237PULSAR_PUBLIC void pulsar_configure_set_negative_ack_redelivery_delay_ms(
+
238 pulsar_consumer_configuration_t *consumer_configuration, long redeliveryDelayMillis);
+
239
+
246PULSAR_PUBLIC long pulsar_configure_get_negative_ack_redelivery_delay_ms(
+
247 pulsar_consumer_configuration_t *consumer_configuration);
+
248
+
258PULSAR_PUBLIC void pulsar_configure_set_ack_grouping_time_ms(
+
259 pulsar_consumer_configuration_t *consumer_configuration, long ackGroupingMillis);
+
260
+
267PULSAR_PUBLIC long pulsar_configure_get_ack_grouping_time_ms(
+
268 pulsar_consumer_configuration_t *consumer_configuration);
+
269
+
277PULSAR_PUBLIC void pulsar_configure_set_ack_grouping_max_size(
+
278 pulsar_consumer_configuration_t *consumer_configuration, long maxGroupingSize);
+
279
+
286PULSAR_PUBLIC long pulsar_configure_get_ack_grouping_max_size(
+
287 pulsar_consumer_configuration_t *consumer_configuration);
+
288
+
289PULSAR_PUBLIC int pulsar_consumer_is_encryption_enabled(
+
290 pulsar_consumer_configuration_t *consumer_configuration);
+
291
+
292PULSAR_PUBLIC void pulsar_consumer_configuration_set_default_crypto_key_reader(
+
293 pulsar_consumer_configuration_t *consumer_configuration, const char *public_key_path,
+
294 const char *private_key_path);
+
295
+
296PULSAR_PUBLIC pulsar_consumer_crypto_failure_action pulsar_consumer_configuration_get_crypto_failure_action(
+
297 pulsar_consumer_configuration_t *consumer_configuration);
+
298
+
299PULSAR_PUBLIC void pulsar_consumer_configuration_set_crypto_failure_action(
+
300 pulsar_consumer_configuration_t *consumer_configuration,
+
301 pulsar_consumer_crypto_failure_action cryptoFailureAction);
+
302
+
303PULSAR_PUBLIC int pulsar_consumer_is_read_compacted(pulsar_consumer_configuration_t *consumer_configuration);
+
304
+
305PULSAR_PUBLIC void pulsar_consumer_set_read_compacted(pulsar_consumer_configuration_t *consumer_configuration,
+
306 int compacted);
+
307
+
308PULSAR_PUBLIC int pulsar_consumer_get_subscription_initial_position(
+
309 pulsar_consumer_configuration_t *consumer_configuration);
+
310
+
311PULSAR_PUBLIC void pulsar_consumer_set_subscription_initial_position(
+
312 pulsar_consumer_configuration_t *consumer_configuration, initial_position subscriptionInitialPosition);
+
313
+
314PULSAR_PUBLIC void pulsar_consumer_configuration_set_property(pulsar_consumer_configuration_t *conf,
+
315 const char *name, const char *value);
+
316
+
317PULSAR_PUBLIC void pulsar_consumer_configuration_set_priority_level(
+
318 pulsar_consumer_configuration_t *consumer_configuration, int priority_level);
+
319
+
320PULSAR_PUBLIC int pulsar_consumer_configuration_get_priority_level(
+
321 pulsar_consumer_configuration_t *consumer_configuration);
+
322
+
323PULSAR_PUBLIC void pulsar_consumer_configuration_set_max_pending_chunked_message(
+
324 pulsar_consumer_configuration_t *consumer_configuration, int max_pending_chunked_message);
+
325
+
326PULSAR_PUBLIC int pulsar_consumer_configuration_get_max_pending_chunked_message(
+
327 pulsar_consumer_configuration_t *consumer_configuration);
+
328
+
329PULSAR_PUBLIC void pulsar_consumer_configuration_set_auto_ack_oldest_chunked_message_on_queue_full(
+
330 pulsar_consumer_configuration_t *consumer_configuration,
+
331 int auto_ack_oldest_chunked_message_on_queue_full);
+
332
+
333PULSAR_PUBLIC int pulsar_consumer_configuration_is_auto_ack_oldest_chunked_message_on_queue_full(
+
334 pulsar_consumer_configuration_t *consumer_configuration);
+
335
+
336PULSAR_PUBLIC void pulsar_consumer_configuration_set_start_message_id_inclusive(
+
337 pulsar_consumer_configuration_t *consumer_configuration, int start_message_id_inclusive);
+
338
+
339PULSAR_PUBLIC int pulsar_consumer_configuration_is_start_message_id_inclusive(
+
340 pulsar_consumer_configuration_t *consumer_configuration);
+
341
+
342PULSAR_PUBLIC void pulsar_consumer_configuration_set_batch_index_ack_enabled(
+
343 pulsar_consumer_configuration_t *consumer_configuration, int enabled);
+
344
+
345PULSAR_PUBLIC int pulsar_consumer_configuration_is_batch_index_ack_enabled(
+
346 pulsar_consumer_configuration_t *consumer_configuration);
+
347
+
348PULSAR_PUBLIC void pulsar_consumer_configuration_set_regex_subscription_mode(
+
349 pulsar_consumer_configuration_t *consumer_configuration,
+
350 pulsar_consumer_regex_subscription_mode regex_sub_mode);
+
351
+
352PULSAR_PUBLIC pulsar_consumer_regex_subscription_mode
+
353pulsar_consumer_configuration_get_regex_subscription_mode(
+
354 pulsar_consumer_configuration_t *consumer_configuration);
+
355
+
367PULSAR_PUBLIC int pulsar_consumer_configuration_set_batch_receive_policy(
+
368 pulsar_consumer_configuration_t *consumer_configuration,
+
369 const pulsar_consumer_batch_receive_policy_t *batch_receive_policy);
+
370
+
383PULSAR_PUBLIC void pulsar_consumer_configuration_get_batch_receive_policy(
+
384 pulsar_consumer_configuration_t *consumer_configuration,
+
385 pulsar_consumer_batch_receive_policy_t *batch_receive_policy);
+
386
+
387PULSAR_PUBLIC void pulsar_consumer_configuration_set_dlq_policy(
+
388 pulsar_consumer_configuration_t *consumer_configuration,
+
389 const pulsar_consumer_config_dead_letter_policy_t *dlq_policy);
+
390
+
399PULSAR_PUBLIC void pulsar_consumer_configuration_get_dlq_policy(
+
400 pulsar_consumer_configuration_t *consumer_configuration,
+
401 pulsar_consumer_config_dead_letter_policy_t *dlq_policy);
+
402
+
403// const CryptoKeyReaderPtr getCryptoKeyReader()
+
404//
+
405// const;
+
406// ConsumerConfiguration&
+
407// setCryptoKeyReader(CryptoKeyReaderPtr
+
408// cryptoKeyReader);
+
409//
+
410// ConsumerCryptoFailureAction getCryptoFailureAction()
+
411//
+
412// const;
+
413// ConsumerConfiguration&
+
414// setCryptoFailureAction(ConsumerCryptoFailureAction
+
415// action);
+
416
+
417#ifdef __cplusplus
+
418}
+
419#endif
+
pulsar_consumer_batch_receive_policy_t
Definition consumer_configuration.h:94
+
pulsar_consumer_config_dead_letter_policy_t
Definition consumer_configuration.h:103
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/darkmode_toggle.js b/static/api/cpp/3.5.x/darkmode_toggle.js new file mode 100644 index 000000000000..0b27d4f6a5c7 --- /dev/null +++ b/static/api/cpp/3.5.x/darkmode_toggle.js @@ -0,0 +1,281 @@ +/** + +The code below is based on the Doxygen Awesome project with some minor modifications +https://github.com/jothepro/doxygen-awesome-css + +MIT License + +Copyright (c) 2021 - 2022 jothepro + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +*/ + +class DarkModeToggle extends HTMLElement { + static icon = ''; + static title = "Toggle Light/Dark Mode" + + static prefersLightModeInDarkModeKey = "prefers-light-mode-in-dark-mode" + static prefersDarkModeInLightModeKey = "prefers-dark-mode-in-light-mode" + + static _staticConstructor = function() { + DarkModeToggle.enableDarkMode(DarkModeToggle.userPreference) + // Update the color scheme when the browsers preference changes + // without user interaction on the website. + window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', event => { + DarkModeToggle.onSystemPreferenceChanged() + }) + // Update the color scheme when the tab is made visible again. + // It is possible that the appearance was changed in another tab + // while this tab was in the background. + document.addEventListener("visibilitychange", visibilityState => { + if (document.visibilityState === 'visible') { + DarkModeToggle.onSystemPreferenceChanged() + } + }); + }() + + static init() { + $(function() { + $(document).ready(function() { + const toggleButton = document.createElement('dark-mode-toggle') + toggleButton.title = DarkModeToggle.title + toggleButton.innerHTML = DarkModeToggle.icon + toggleButton.tabIndex = 0; + + function addButton() { + var titleArea = document.getElementById("titlearea"); + var searchBox = document.getElementById("MSearchBox"); + var mainMenu = document.getElementById("main-menu"); + var navRow1 = document.getElementById("navrow1"); + var mainMenuVisible = false; + if (mainMenu) { + var menuStyle = window.getComputedStyle(mainMenu); + mainMenuVisible = menuStyle.display!=='none' + } + var searchBoxPos1 = document.getElementById("searchBoxPos1"); + if (searchBox) { // (1) search box visible + searchBox.parentNode.appendChild(toggleButton) + } else if (navRow1) { // (2) no search box, static menu bar + var li = document.createElement('li'); + li.style = 'float: right;' + li.appendChild(toggleButton); + toggleButton.style = 'width: 24px; height: 25px; padding-top: 11px; float: right;'; + var row = document.querySelector('#navrow1 > ul:first-of-type'); + row.appendChild(li) + } else if (mainMenu && mainMenuVisible) { // (3) no search box + dynamic menu bar expanded + var li = document.createElement('li'); + li.style = 'float: right;' + li.appendChild(toggleButton); + toggleButton.style = 'width: 14px; height: 36px; padding-top: 10px; float: right;'; + mainMenu.appendChild(li) + } else if (searchBoxPos1) { // (4) no search box + dynamic menu bar collapsed + toggleButton.style = 'width: 24px; height: 36px; padding-top: 10px; float: right;'; + searchBoxPos1.style = 'top: 0px;' + searchBoxPos1.appendChild(toggleButton); + } else if (titleArea) { // (5) no search box and no navigation tabs + toggleButton.style = 'width: 24px; height: 24px; position: absolute; right: 0px; top: 34px;'; + titleArea.append(toggleButton); + } + } + + $(document).ready(function(){ + addButton(); + }) + $(window).resize(function(){ + addButton(); + }) + var inFocus = false; + $(document).focusin(function(e) { + inFocus = true; + }) + $(document).focusout(function(e) { + inFocus = false; + }) + $(document).keyup(function(e) { + if (e.keyCode==27 && !inFocus) { // escape key maps to keycode `27` + e.stopPropagation(); + DarkModeToggle.userPreference = !DarkModeToggle.userPreference + } + }) + DarkModeToggle.setDarkModeVisibility(DarkModeToggle.darkModeEnabled) + }) + }) + } + + constructor() { + super(); + this.onclick=this.toggleDarkMode + this.onkeypress=function(e){if (e.keyCode==13) { this.toggleDarkMode(); }}; + } + + static createCookie(name, value, days) { + if (days) { + var date = new Date(); + date.setTime(date.getTime() + (days * 24 * 60 * 60 * 1000)); + var expires = "; expires=" + date.toGMTString(); + } + else var expires = ""; + + document.cookie = name + "=" + value + expires + "; path=/"; + } + + static readCookie(name) { + var nameEQ = name + "="; + var ca = document.cookie.split(';'); + for (var i = 0; i < ca.length; i++) { + var c = ca[i]; + while (c.charAt(0) == ' ') c = c.substring(1, c.length); + if (c.indexOf(nameEQ) == 0) return c.substring(nameEQ.length, c.length); + } + return null; + } + + static eraseCookie(name) { + DarkModeToggle.createCookie(name, "", -1); + } + + /** + * @returns `true` for dark-mode, `false` for light-mode system preference + */ + static get systemPreference() { + return window.matchMedia('(prefers-color-scheme: dark)').matches + } + + static get prefersDarkModeInLightMode() { + if (window.chrome) { // Chrome supports localStorage in combination with file:// but not cookies + return localStorage.getItem(DarkModeToggle.prefersDarkModeInLightModeKey) + } else { // Other browsers support cookies in combination with file:// but not localStorage + return DarkModeToggle.readCookie('doxygen_prefers_dark')=='1' + } + } + + static set prefersDarkModeInLightMode(preference) { + if (window.chrome) { + if (preference) { + localStorage.setItem(DarkModeToggle.prefersDarkModeInLightModeKey, true) + } else { + localStorage.removeItem(DarkModeToggle.prefersDarkModeInLightModeKey) + } + } else { + if (preference) { + DarkModeToggle.createCookie('doxygen_prefers_dark','1',365) + } else { + DarkModeToggle.eraseCookie('doxygen_prefers_dark') + } + } + } + + static get prefersLightModeInDarkMode() { + if (window.chrome) { // Chrome supports localStorage in combination with file:// but not cookies + return localStorage.getItem(DarkModeToggle.prefersLightModeInDarkModeKey) + } else { // Other browsers support cookies in combination with file:// but not localStorage + return DarkModeToggle.readCookie('doxygen_prefers_light')=='1' + } + } + + static set prefersLightModeInDarkMode(preference) { + if (window.chrome) { + if (preference) { + localStorage.setItem(DarkModeToggle.prefersLightModeInDarkModeKey, true) + } else { + localStorage.removeItem(DarkModeToggle.prefersLightModeInDarkModeKey) + } + } else { + if (preference) { + DarkModeToggle.createCookie('doxygen_prefers_light','1',365) + } else { + DarkModeToggle.eraseCookie('doxygen_prefers_light') + } + } + } + + + /** + * @returns `true` for dark-mode, `false` for light-mode user preference + */ + static get userPreference() { + return (!DarkModeToggle.systemPreference && DarkModeToggle.prefersDarkModeInLightMode) || + (DarkModeToggle.systemPreference && !DarkModeToggle.prefersLightModeInDarkMode) + } + + static set userPreference(userPreference) { + DarkModeToggle.darkModeEnabled = userPreference + if (!userPreference) { + if (DarkModeToggle.systemPreference) { + DarkModeToggle.prefersLightModeInDarkMode = true + } else { + DarkModeToggle.prefersDarkModeInLightMode = false + } + } else { + if (!DarkModeToggle.systemPreference) { + DarkModeToggle.prefersDarkModeInLightMode = true + } else { + DarkModeToggle.prefersLightModeInDarkMode = false + } + } + DarkModeToggle.onUserPreferenceChanged() + } + + static setDarkModeVisibility(enable) { + var darkModeStyle, lightModeStyle; + if(enable) { + darkModeStyle = 'inline-block'; + lightModeStyle = 'none' + } else { + darkModeStyle = 'none'; + lightModeStyle = 'inline-block' + } + document.querySelectorAll('.dark-mode-visible').forEach(function(el) { + el.style.display = darkModeStyle; + }); + document.querySelectorAll('.light-mode-visible').forEach(function(el) { + el.style.display = lightModeStyle; + }); + } + static enableDarkMode(enable) { + if(enable) { + DarkModeToggle.darkModeEnabled = true + document.documentElement.classList.add("dark-mode") + document.documentElement.classList.remove("light-mode") + } else { + DarkModeToggle.darkModeEnabled = false + document.documentElement.classList.remove("dark-mode") + document.documentElement.classList.add("light-mode") + } + DarkModeToggle.setDarkModeVisibility(enable) + } + + static onSystemPreferenceChanged() { + DarkModeToggle.darkModeEnabled = DarkModeToggle.userPreference + DarkModeToggle.enableDarkMode(DarkModeToggle.darkModeEnabled) + } + + static onUserPreferenceChanged() { + DarkModeToggle.enableDarkMode(DarkModeToggle.darkModeEnabled) + } + + toggleDarkMode() { + DarkModeToggle.userPreference = !DarkModeToggle.userPreference + } +} + +customElements.define("dark-mode-toggle", DarkModeToggle); + +DarkModeToggle.init(); diff --git a/static/api/cpp/3.5.x/defines_8h_source.html b/static/api/cpp/3.5.x/defines_8h_source.html new file mode 100644 index 000000000000..f6534c455729 --- /dev/null +++ b/static/api/cpp/3.5.x/defines_8h_source.html @@ -0,0 +1,118 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/defines.h Source File + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
defines.h
+
+
+
1
+
19#ifndef PULSAR_DEFINES_H_
+
20#define PULSAR_DEFINES_H_
+
21
+
22#ifdef PULSAR_STATIC
+
23
+
24#define PULSAR_PUBLIC
+
25
+
26#else
+
27
+
28#ifdef _WIN32
+
29
+
30#ifdef BUILDING_PULSAR
+
31#define PULSAR_PUBLIC __declspec(dllexport)
+
32#else
+
33#define PULSAR_PUBLIC __declspec(dllimport)
+
34#endif /*BUILDING_PULSAR*/
+
35
+
36#else
+
37
+
38#define PULSAR_PUBLIC __attribute__((visibility("default")))
+
39
+
40#endif /*_WIN32*/
+
41
+
42#endif /*PULSAR_STATIC*/
+
43
+
44#endif /* PULSAR_DEFINES_H_ */
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/deprecated.html b/static/api/cpp/3.5.x/deprecated.html new file mode 100644 index 000000000000..a07f8a620bf6 --- /dev/null +++ b/static/api/cpp/3.5.x/deprecated.html @@ -0,0 +1,97 @@ + + + + + + + +pulsar-client-cpp: Deprecated List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+
Deprecated List
+
+
+
+
Member pulsar::BrokerConsumerStats::getImpl () const
+
+
Member pulsar::KeySharedPolicy::setStickyRanges (std::initializer_list< StickyRange > ranges)
+
use the function that takes StickyRanges instead of std::initializer_list
+
Member pulsar::MessageId::MessageId (int32_t partition, int64_t ledgerId, int64_t entryId, int32_t batchIndex)
+
+
Member pulsar::MessageId::setTopicName (const std::string &topicName)
+
This method will be eventually removed
+
Member pulsar::MessageRoutingPolicy::getPartition (const Message &msg)
+
Use int getPartition(const Message& msg, const TopicMetadata& topicMetadata)
+
Member pulsar::Producer::send (const Message &msg)
+
It's the same with send(const Message& msg, MessageId& messageId) except that MessageId will be stored in msg though msg is const.
+
+
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/dir_501ae28692a6b25a33adbd2bed71d4b9.html b/static/api/cpp/3.5.x/dir_501ae28692a6b25a33adbd2bed71d4b9.html new file mode 100644 index 000000000000..79b9430bd079 --- /dev/null +++ b/static/api/cpp/3.5.x/dir_501ae28692a6b25a33adbd2bed71d4b9.html @@ -0,0 +1,128 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/c Directory Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
c Directory Reference
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Files

 authentication.h
 
 client.h
 
 client_configuration.h
 
 consumer.h
 
 consumer_configuration.h
 
 message.h
 
 message_id.h
 
 message_router.h
 
 messages.h
 
 producer.h
 
 producer_configuration.h
 
 reader.h
 
 reader_configuration.h
 
 result.h
 
 string_list.h
 
 string_map.h
 
 table_view.h
 
 table_view_configuration.h
 
 version.h
 
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/dir_84093bac216bb6272e4432021f1ca7f4.html b/static/api/cpp/3.5.x/dir_84093bac216bb6272e4432021f1ca7f4.html new file mode 100644 index 000000000000..0d23fbb628ba --- /dev/null +++ b/static/api/cpp/3.5.x/dir_84093bac216bb6272e4432021f1ca7f4.html @@ -0,0 +1,185 @@ + + + + + + + +pulsar-client-cpp: include/pulsar Directory Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
pulsar Directory Reference
+
+
+ + + + +

+Directories

 c
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Files

 Authentication.h
 
 BatchReceivePolicy.h
 
 BrokerConsumerStats.h
 
 Client.h
 
 ClientConfiguration.h
 
 CompressionType.h
 
 ConsoleLoggerFactory.h
 
 Consumer.h
 
 ConsumerConfiguration.h
 
 ConsumerCryptoFailureAction.h
 
 ConsumerEventListener.h
 
 ConsumerInterceptor.h
 
 ConsumerType.h
 
 CryptoKeyReader.h
 
 DeadLetterPolicy.h
 
 DeadLetterPolicyBuilder.h
 
 defines.h
 
 DeprecatedException.h
 
 EncryptionKeyInfo.h
 
 FileLoggerFactory.h
 
 InitialPosition.h
 
 KeySharedPolicy.h
 
 KeyValue.h
 
 Logger.h
 
 Message.h
 
 MessageBatch.h
 
 MessageBuilder.h
 
 MessageId.h
 
 MessageIdBuilder.h
 
 MessageRoutingPolicy.h
 
 Producer.h
 
 ProducerConfiguration.h
 
 ProducerCryptoFailureAction.h
 
 ProducerInterceptor.h
 
 ProtobufNativeSchema.h
 
 Reader.h
 
 ReaderConfiguration.h
 
 RegexSubscriptionMode.h
 
 Result.h
 
 Schema.h
 
 TableView.h
 
 TableViewConfiguration.h
 
 TopicMetadata.h
 
 TypedMessage.h
 
 TypedMessageBuilder.h
 
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/dir_d44c64559bbebec7f509842c48db8b23.html b/static/api/cpp/3.5.x/dir_d44c64559bbebec7f509842c48db8b23.html new file mode 100644 index 000000000000..f37a941a1b1a --- /dev/null +++ b/static/api/cpp/3.5.x/dir_d44c64559bbebec7f509842c48db8b23.html @@ -0,0 +1,92 @@ + + + + + + + +pulsar-client-cpp: include Directory Reference + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ + +
+
+
include Directory Reference
+
+
+ + + + +

+Directories

 pulsar
 
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/doc.svg b/static/api/cpp/3.5.x/doc.svg new file mode 100644 index 000000000000..0b928a531713 --- /dev/null +++ b/static/api/cpp/3.5.x/doc.svg @@ -0,0 +1,12 @@ + + + + + + + + + + + diff --git a/static/api/cpp/3.5.x/docd.svg b/static/api/cpp/3.5.x/docd.svg new file mode 100644 index 000000000000..ac18b2755226 --- /dev/null +++ b/static/api/cpp/3.5.x/docd.svg @@ -0,0 +1,12 @@ + + + + + + + + + + + diff --git a/static/api/cpp/3.5.x/doxygen.css b/static/api/cpp/3.5.x/doxygen.css new file mode 100644 index 000000000000..08fb5e6f1ed6 --- /dev/null +++ b/static/api/cpp/3.5.x/doxygen.css @@ -0,0 +1,2043 @@ +/* The standard CSS for doxygen 1.9.8*/ + +html { +/* page base colors */ +--page-background-color: white; +--page-foreground-color: black; +--page-link-color: #3D578C; +--page-visited-link-color: #4665A2; + +/* index */ +--index-odd-item-bg-color: #F8F9FC; +--index-even-item-bg-color: white; +--index-header-color: black; +--index-separator-color: #A0A0A0; + +/* header */ +--header-background-color: #F9FAFC; +--header-separator-color: #C4CFE5; +--header-gradient-image: url('nav_h.png'); +--group-header-separator-color: #879ECB; +--group-header-color: #354C7B; +--inherit-header-color: gray; + +--footer-foreground-color: #2A3D61; +--footer-logo-width: 104px; +--citation-label-color: #334975; +--glow-color: cyan; + +--title-background-color: white; +--title-separator-color: #5373B4; +--directory-separator-color: #9CAFD4; +--separator-color: #4A6AAA; + +--blockquote-background-color: #F7F8FB; +--blockquote-border-color: #9CAFD4; + +--scrollbar-thumb-color: #9CAFD4; +--scrollbar-background-color: #F9FAFC; + +--icon-background-color: #728DC1; +--icon-foreground-color: white; +--icon-doc-image: url('doc.svg'); +--icon-folder-open-image: url('folderopen.svg'); +--icon-folder-closed-image: url('folderclosed.svg'); + +/* brief member declaration list */ +--memdecl-background-color: #F9FAFC; +--memdecl-separator-color: #DEE4F0; +--memdecl-foreground-color: #555; +--memdecl-template-color: #4665A2; + +/* detailed member list */ +--memdef-border-color: #A8B8D9; +--memdef-title-background-color: #E2E8F2; +--memdef-title-gradient-image: url('nav_f.png'); +--memdef-proto-background-color: #DFE5F1; +--memdef-proto-text-color: #253555; +--memdef-proto-text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); +--memdef-doc-background-color: white; +--memdef-param-name-color: #602020; +--memdef-template-color: #4665A2; + +/* tables */ +--table-cell-border-color: #2D4068; +--table-header-background-color: #374F7F; +--table-header-foreground-color: #FFFFFF; + +/* labels */ +--label-background-color: #728DC1; +--label-left-top-border-color: #5373B4; +--label-right-bottom-border-color: #C4CFE5; +--label-foreground-color: white; + +/** navigation bar/tree/menu */ +--nav-background-color: #F9FAFC; +--nav-foreground-color: #364D7C; +--nav-gradient-image: url('tab_b.png'); +--nav-gradient-hover-image: url('tab_h.png'); +--nav-gradient-active-image: url('tab_a.png'); +--nav-gradient-active-image-parent: url("../tab_a.png"); +--nav-separator-image: url('tab_s.png'); +--nav-breadcrumb-image: url('bc_s.png'); +--nav-breadcrumb-border-color: #C2CDE4; +--nav-splitbar-image: url('splitbar.png'); +--nav-font-size-level1: 13px; +--nav-font-size-level2: 10px; +--nav-font-size-level3: 9px; +--nav-text-normal-color: #283A5D; +--nav-text-hover-color: white; +--nav-text-active-color: white; +--nav-text-normal-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); +--nav-text-hover-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); +--nav-text-active-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); +--nav-menu-button-color: #364D7C; +--nav-menu-background-color: white; +--nav-menu-foreground-color: #555555; +--nav-menu-toggle-color: rgba(255, 255, 255, 0.5); +--nav-arrow-color: #9CAFD4; +--nav-arrow-selected-color: #9CAFD4; + +/* table of contents */ +--toc-background-color: #F4F6FA; +--toc-border-color: #D8DFEE; +--toc-header-color: #4665A2; +--toc-down-arrow-image: url("data:image/svg+xml;utf8,&%238595;"); + +/** search field */ +--search-background-color: white; +--search-foreground-color: #909090; +--search-magnification-image: url('mag.svg'); +--search-magnification-select-image: url('mag_sel.svg'); +--search-active-color: black; +--search-filter-background-color: #F9FAFC; +--search-filter-foreground-color: black; +--search-filter-border-color: #90A5CE; +--search-filter-highlight-text-color: white; +--search-filter-highlight-bg-color: #3D578C; +--search-results-foreground-color: #425E97; +--search-results-background-color: #EEF1F7; +--search-results-border-color: black; +--search-box-shadow: inset 0.5px 0.5px 3px 0px #555; + +/** code fragments */ +--code-keyword-color: #008000; +--code-type-keyword-color: #604020; +--code-flow-keyword-color: #E08000; +--code-comment-color: #800000; +--code-preprocessor-color: #806020; +--code-string-literal-color: #002080; +--code-char-literal-color: #008080; +--code-xml-cdata-color: black; +--code-vhdl-digit-color: #FF00FF; +--code-vhdl-char-color: #000000; +--code-vhdl-keyword-color: #700070; +--code-vhdl-logic-color: #FF0000; +--code-link-color: #4665A2; +--code-external-link-color: #4665A2; +--fragment-foreground-color: black; +--fragment-background-color: #FBFCFD; +--fragment-border-color: #C4CFE5; +--fragment-lineno-border-color: #00FF00; +--fragment-lineno-background-color: #E8E8E8; +--fragment-lineno-foreground-color: black; +--fragment-lineno-link-fg-color: #4665A2; +--fragment-lineno-link-bg-color: #D8D8D8; +--fragment-lineno-link-hover-fg-color: #4665A2; +--fragment-lineno-link-hover-bg-color: #C8C8C8; +--tooltip-foreground-color: black; +--tooltip-background-color: white; +--tooltip-border-color: gray; +--tooltip-doc-color: grey; +--tooltip-declaration-color: #006318; +--tooltip-link-color: #4665A2; +--tooltip-shadow: 1px 1px 7px gray; +--fold-line-color: #808080; +--fold-minus-image: url('minus.svg'); +--fold-plus-image: url('plus.svg'); +--fold-minus-image-relpath: url('../../minus.svg'); +--fold-plus-image-relpath: url('../../plus.svg'); + +/** font-family */ +--font-family-normal: Roboto,sans-serif; +--font-family-monospace: 'JetBrains Mono',Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace,fixed; +--font-family-nav: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif; +--font-family-title: Tahoma,Arial,sans-serif; +--font-family-toc: Verdana,'DejaVu Sans',Geneva,sans-serif; +--font-family-search: Arial,Verdana,sans-serif; +--font-family-icon: Arial,Helvetica; +--font-family-tooltip: Roboto,sans-serif; + +} + +html.dark-mode { +/* page base colors */ +--page-background-color: black; +--page-foreground-color: #C9D1D9; +--page-link-color: #90A5CE; +--page-visited-link-color: #A3B4D7; + +/* index */ +--index-odd-item-bg-color: #0B101A; +--index-even-item-bg-color: black; +--index-header-color: #C4CFE5; +--index-separator-color: #334975; + +/* header */ +--header-background-color: #070B11; +--header-separator-color: #141C2E; +--header-gradient-image: url('nav_hd.png'); +--group-header-separator-color: #283A5D; +--group-header-color: #90A5CE; +--inherit-header-color: #A0A0A0; + +--footer-foreground-color: #5B7AB7; +--footer-logo-width: 60px; +--citation-label-color: #90A5CE; +--glow-color: cyan; + +--title-background-color: #090D16; +--title-separator-color: #354C79; +--directory-separator-color: #283A5D; +--separator-color: #283A5D; + +--blockquote-background-color: #101826; +--blockquote-border-color: #283A5D; + +--scrollbar-thumb-color: #283A5D; +--scrollbar-background-color: #070B11; + +--icon-background-color: #334975; +--icon-foreground-color: #C4CFE5; +--icon-doc-image: url('docd.svg'); +--icon-folder-open-image: url('folderopend.svg'); +--icon-folder-closed-image: url('folderclosedd.svg'); + +/* brief member declaration list */ +--memdecl-background-color: #0B101A; +--memdecl-separator-color: #2C3F65; +--memdecl-foreground-color: #BBB; +--memdecl-template-color: #7C95C6; + +/* detailed member list */ +--memdef-border-color: #233250; +--memdef-title-background-color: #1B2840; +--memdef-title-gradient-image: url('nav_fd.png'); +--memdef-proto-background-color: #19243A; +--memdef-proto-text-color: #9DB0D4; +--memdef-proto-text-shadow: 0px 1px 1px rgba(0, 0, 0, 0.9); +--memdef-doc-background-color: black; +--memdef-param-name-color: #D28757; +--memdef-template-color: #7C95C6; + +/* tables */ +--table-cell-border-color: #283A5D; +--table-header-background-color: #283A5D; +--table-header-foreground-color: #C4CFE5; + +/* labels */ +--label-background-color: #354C7B; +--label-left-top-border-color: #4665A2; +--label-right-bottom-border-color: #283A5D; +--label-foreground-color: #CCCCCC; + +/** navigation bar/tree/menu */ +--nav-background-color: #101826; +--nav-foreground-color: #364D7C; +--nav-gradient-image: url('tab_bd.png'); +--nav-gradient-hover-image: url('tab_hd.png'); +--nav-gradient-active-image: url('tab_ad.png'); +--nav-gradient-active-image-parent: url("../tab_ad.png"); +--nav-separator-image: url('tab_sd.png'); +--nav-breadcrumb-image: url('bc_sd.png'); +--nav-breadcrumb-border-color: #2A3D61; +--nav-splitbar-image: url('splitbard.png'); +--nav-font-size-level1: 13px; +--nav-font-size-level2: 10px; +--nav-font-size-level3: 9px; +--nav-text-normal-color: #B6C4DF; +--nav-text-hover-color: #DCE2EF; +--nav-text-active-color: #DCE2EF; +--nav-text-normal-shadow: 0px 1px 1px black; +--nav-text-hover-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); +--nav-text-active-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); +--nav-menu-button-color: #B6C4DF; +--nav-menu-background-color: #05070C; +--nav-menu-foreground-color: #BBBBBB; +--nav-menu-toggle-color: rgba(255, 255, 255, 0.2); +--nav-arrow-color: #334975; +--nav-arrow-selected-color: #90A5CE; + +/* table of contents */ +--toc-background-color: #151E30; +--toc-border-color: #202E4A; +--toc-header-color: #A3B4D7; +--toc-down-arrow-image: url("data:image/svg+xml;utf8,&%238595;"); + +/** search field */ +--search-background-color: black; +--search-foreground-color: #C5C5C5; +--search-magnification-image: url('mag_d.svg'); +--search-magnification-select-image: url('mag_seld.svg'); +--search-active-color: #C5C5C5; +--search-filter-background-color: #101826; +--search-filter-foreground-color: #90A5CE; +--search-filter-border-color: #7C95C6; +--search-filter-highlight-text-color: #BCC9E2; +--search-filter-highlight-bg-color: #283A5D; +--search-results-background-color: #101826; +--search-results-foreground-color: #90A5CE; +--search-results-border-color: #7C95C6; +--search-box-shadow: inset 0.5px 0.5px 3px 0px #2F436C; + +/** code fragments */ +--code-keyword-color: #CC99CD; +--code-type-keyword-color: #AB99CD; +--code-flow-keyword-color: #E08000; +--code-comment-color: #717790; +--code-preprocessor-color: #65CABE; +--code-string-literal-color: #7EC699; +--code-char-literal-color: #00E0F0; +--code-xml-cdata-color: #C9D1D9; +--code-vhdl-digit-color: #FF00FF; +--code-vhdl-char-color: #C0C0C0; +--code-vhdl-keyword-color: #CF53C9; +--code-vhdl-logic-color: #FF0000; +--code-link-color: #79C0FF; +--code-external-link-color: #79C0FF; +--fragment-foreground-color: #C9D1D9; +--fragment-background-color: black; +--fragment-border-color: #30363D; +--fragment-lineno-border-color: #30363D; +--fragment-lineno-background-color: black; +--fragment-lineno-foreground-color: #6E7681; +--fragment-lineno-link-fg-color: #6E7681; +--fragment-lineno-link-bg-color: #303030; +--fragment-lineno-link-hover-fg-color: #8E96A1; +--fragment-lineno-link-hover-bg-color: #505050; +--tooltip-foreground-color: #C9D1D9; +--tooltip-background-color: #202020; +--tooltip-border-color: #C9D1D9; +--tooltip-doc-color: #D9E1E9; +--tooltip-declaration-color: #20C348; +--tooltip-link-color: #79C0FF; +--tooltip-shadow: none; +--fold-line-color: #808080; +--fold-minus-image: url('minusd.svg'); +--fold-plus-image: url('plusd.svg'); +--fold-minus-image-relpath: url('../../minusd.svg'); +--fold-plus-image-relpath: url('../../plusd.svg'); + +/** font-family */ +--font-family-normal: Roboto,sans-serif; +--font-family-monospace: 'JetBrains Mono',Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace,fixed; +--font-family-nav: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif; +--font-family-title: Tahoma,Arial,sans-serif; +--font-family-toc: Verdana,'DejaVu Sans',Geneva,sans-serif; +--font-family-search: Arial,Verdana,sans-serif; +--font-family-icon: Arial,Helvetica; +--font-family-tooltip: Roboto,sans-serif; + +} + +body { + background-color: var(--page-background-color); + color: var(--page-foreground-color); +} + +body, table, div, p, dl { + font-weight: 400; + font-size: 14px; + font-family: var(--font-family-normal); + line-height: 22px; +} + +/* @group Heading Levels */ + +.title { + font-weight: 400; + font-size: 14px; + font-family: var(--font-family-normal); + line-height: 28px; + font-size: 150%; + font-weight: bold; + margin: 10px 2px; +} + +h1.groupheader { + font-size: 150%; +} + +h2.groupheader { + border-bottom: 1px solid var(--group-header-separator-color); + color: var(--group-header-color); + font-size: 150%; + font-weight: normal; + margin-top: 1.75em; + padding-top: 8px; + padding-bottom: 4px; + width: 100%; +} + +h3.groupheader { + font-size: 100%; +} + +h1, h2, h3, h4, h5, h6 { + -webkit-transition: text-shadow 0.5s linear; + -moz-transition: text-shadow 0.5s linear; + -ms-transition: text-shadow 0.5s linear; + -o-transition: text-shadow 0.5s linear; + transition: text-shadow 0.5s linear; + margin-right: 15px; +} + +h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow { + text-shadow: 0 0 15px var(--glow-color); +} + +dt { + font-weight: bold; +} + +p.startli, p.startdd { + margin-top: 2px; +} + +th p.starttd, th p.intertd, th p.endtd { + font-size: 100%; + font-weight: 700; +} + +p.starttd { + margin-top: 0px; +} + +p.endli { + margin-bottom: 0px; +} + +p.enddd { + margin-bottom: 4px; +} + +p.endtd { + margin-bottom: 2px; +} + +p.interli { +} + +p.interdd { +} + +p.intertd { +} + +/* @end */ + +caption { + font-weight: bold; +} + +span.legend { + font-size: 70%; + text-align: center; +} + +h3.version { + font-size: 90%; + text-align: center; +} + +div.navtab { + padding-right: 15px; + text-align: right; + line-height: 110%; +} + +div.navtab table { + border-spacing: 0; +} + +td.navtab { + padding-right: 6px; + padding-left: 6px; +} + +td.navtabHL { + background-image: var(--nav-gradient-active-image); + background-repeat:repeat-x; + padding-right: 6px; + padding-left: 6px; +} + +td.navtabHL a, td.navtabHL a:visited { + color: var(--nav-text-hover-color); + text-shadow: var(--nav-text-hover-shadow); +} + +a.navtab { + font-weight: bold; +} + +div.qindex{ + text-align: center; + width: 100%; + line-height: 140%; + font-size: 130%; + color: var(--index-separator-color); +} + +#main-menu a:focus { + outline: auto; + z-index: 10; + position: relative; +} + +dt.alphachar{ + font-size: 180%; + font-weight: bold; +} + +.alphachar a{ + color: var(--index-header-color); +} + +.alphachar a:hover, .alphachar a:visited{ + text-decoration: none; +} + +.classindex dl { + padding: 25px; + column-count:1 +} + +.classindex dd { + display:inline-block; + margin-left: 50px; + width: 90%; + line-height: 1.15em; +} + +.classindex dl.even { + background-color: var(--index-even-item-bg-color); +} + +.classindex dl.odd { + background-color: var(--index-odd-item-bg-color); +} + +@media(min-width: 1120px) { + .classindex dl { + column-count:2 + } +} + +@media(min-width: 1320px) { + .classindex dl { + column-count:3 + } +} + + +/* @group Link Styling */ + +a { + color: var(--page-link-color); + font-weight: normal; + text-decoration: none; +} + +.contents a:visited { + color: var(--page-visited-link-color); +} + +a:hover { + text-decoration: underline; +} + +a.el { + font-weight: bold; +} + +a.elRef { +} + +a.code, a.code:visited, a.line, a.line:visited { + color: var(--code-link-color); +} + +a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited { + color: var(--code-external-link-color); +} + +a.code.hl_class { /* style for links to class names in code snippets */ } +a.code.hl_struct { /* style for links to struct names in code snippets */ } +a.code.hl_union { /* style for links to union names in code snippets */ } +a.code.hl_interface { /* style for links to interface names in code snippets */ } +a.code.hl_protocol { /* style for links to protocol names in code snippets */ } +a.code.hl_category { /* style for links to category names in code snippets */ } +a.code.hl_exception { /* style for links to exception names in code snippets */ } +a.code.hl_service { /* style for links to service names in code snippets */ } +a.code.hl_singleton { /* style for links to singleton names in code snippets */ } +a.code.hl_concept { /* style for links to concept names in code snippets */ } +a.code.hl_namespace { /* style for links to namespace names in code snippets */ } +a.code.hl_package { /* style for links to package names in code snippets */ } +a.code.hl_define { /* style for links to macro names in code snippets */ } +a.code.hl_function { /* style for links to function names in code snippets */ } +a.code.hl_variable { /* style for links to variable names in code snippets */ } +a.code.hl_typedef { /* style for links to typedef names in code snippets */ } +a.code.hl_enumvalue { /* style for links to enum value names in code snippets */ } +a.code.hl_enumeration { /* style for links to enumeration names in code snippets */ } +a.code.hl_signal { /* style for links to Qt signal names in code snippets */ } +a.code.hl_slot { /* style for links to Qt slot names in code snippets */ } +a.code.hl_friend { /* style for links to friend names in code snippets */ } +a.code.hl_dcop { /* style for links to KDE3 DCOP names in code snippets */ } +a.code.hl_property { /* style for links to property names in code snippets */ } +a.code.hl_event { /* style for links to event names in code snippets */ } +a.code.hl_sequence { /* style for links to sequence names in code snippets */ } +a.code.hl_dictionary { /* style for links to dictionary names in code snippets */ } + +/* @end */ + +dl.el { + margin-left: -1cm; +} + +ul { + overflow: visible; +} + +ul.multicol { + -moz-column-gap: 1em; + -webkit-column-gap: 1em; + column-gap: 1em; + -moz-column-count: 3; + -webkit-column-count: 3; + column-count: 3; + list-style-type: none; +} + +#side-nav ul { + overflow: visible; /* reset ul rule for scroll bar in GENERATE_TREEVIEW window */ +} + +#main-nav ul { + overflow: visible; /* reset ul rule for the navigation bar drop down lists */ +} + +.fragment { + text-align: left; + direction: ltr; + overflow-x: auto; /*Fixed: fragment lines overlap floating elements*/ + overflow-y: hidden; +} + +pre.fragment { + border: 1px solid var(--fragment-border-color); + background-color: var(--fragment-background-color); + color: var(--fragment-foreground-color); + padding: 4px 6px; + margin: 4px 8px 4px 2px; + overflow: auto; + word-wrap: break-word; + font-size: 9pt; + line-height: 125%; + font-family: var(--font-family-monospace); + font-size: 105%; +} + +div.fragment { + padding: 0 0 1px 0; /*Fixed: last line underline overlap border*/ + margin: 4px 8px 4px 2px; + color: var(--fragment-foreground-color); + background-color: var(--fragment-background-color); + border: 1px solid var(--fragment-border-color); +} + +div.line { + font-family: var(--font-family-monospace); + font-size: 13px; + min-height: 13px; + line-height: 1.2; + text-wrap: unrestricted; + white-space: -moz-pre-wrap; /* Moz */ + white-space: -pre-wrap; /* Opera 4-6 */ + white-space: -o-pre-wrap; /* Opera 7 */ + white-space: pre-wrap; /* CSS3 */ + word-wrap: break-word; /* IE 5.5+ */ + text-indent: -53px; + padding-left: 53px; + padding-bottom: 0px; + margin: 0px; + -webkit-transition-property: background-color, box-shadow; + -webkit-transition-duration: 0.5s; + -moz-transition-property: background-color, box-shadow; + -moz-transition-duration: 0.5s; + -ms-transition-property: background-color, box-shadow; + -ms-transition-duration: 0.5s; + -o-transition-property: background-color, box-shadow; + -o-transition-duration: 0.5s; + transition-property: background-color, box-shadow; + transition-duration: 0.5s; +} + +div.line:after { + content:"\000A"; + white-space: pre; +} + +div.line.glow { + background-color: var(--glow-color); + box-shadow: 0 0 10px var(--glow-color); +} + +span.fold { + margin-left: 5px; + margin-right: 1px; + margin-top: 0px; + margin-bottom: 0px; + padding: 0px; + display: inline-block; + width: 12px; + height: 12px; + background-repeat:no-repeat; + background-position:center; +} + +span.lineno { + padding-right: 4px; + margin-right: 9px; + text-align: right; + border-right: 2px solid var(--fragment-lineno-border-color); + color: var(--fragment-lineno-foreground-color); + background-color: var(--fragment-lineno-background-color); + white-space: pre; +} +span.lineno a, span.lineno a:visited { + color: var(--fragment-lineno-link-fg-color); + background-color: var(--fragment-lineno-link-bg-color); +} + +span.lineno a:hover { + color: var(--fragment-lineno-link-hover-fg-color); + background-color: var(--fragment-lineno-link-hover-bg-color); +} + +.lineno { + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +div.classindex ul { + list-style: none; + padding-left: 0; +} + +div.classindex span.ai { + display: inline-block; +} + +div.groupHeader { + margin-left: 16px; + margin-top: 12px; + font-weight: bold; +} + +div.groupText { + margin-left: 16px; + font-style: italic; +} + +body { + color: var(--page-foreground-color); + margin: 0; +} + +div.contents { + margin-top: 10px; + margin-left: 12px; + margin-right: 8px; +} + +p.formulaDsp { + text-align: center; +} + +img.dark-mode-visible { + display: none; +} +img.light-mode-visible { + display: none; +} + +img.formulaDsp { + +} + +img.formulaInl, img.inline { + vertical-align: middle; +} + +div.center { + text-align: center; + margin-top: 0px; + margin-bottom: 0px; + padding: 0px; +} + +div.center img { + border: 0px; +} + +address.footer { + text-align: right; + padding-right: 12px; +} + +img.footer { + border: 0px; + vertical-align: middle; + width: var(--footer-logo-width); +} + +.compoundTemplParams { + color: var(--memdecl-template-color); + font-size: 80%; + line-height: 120%; +} + +/* @group Code Colorization */ + +span.keyword { + color: var(--code-keyword-color); +} + +span.keywordtype { + color: var(--code-type-keyword-color); +} + +span.keywordflow { + color: var(--code-flow-keyword-color); +} + +span.comment { + color: var(--code-comment-color); +} + +span.preprocessor { + color: var(--code-preprocessor-color); +} + +span.stringliteral { + color: var(--code-string-literal-color); +} + +span.charliteral { + color: var(--code-char-literal-color); +} + +span.xmlcdata { + color: var(--code-xml-cdata-color); +} + +span.vhdldigit { + color: var(--code-vhdl-digit-color); +} + +span.vhdlchar { + color: var(--code-vhdl-char-color); +} + +span.vhdlkeyword { + color: var(--code-vhdl-keyword-color); +} + +span.vhdllogic { + color: var(--code-vhdl-logic-color); +} + +blockquote { + background-color: var(--blockquote-background-color); + border-left: 2px solid var(--blockquote-border-color); + margin: 0 24px 0 4px; + padding: 0 12px 0 16px; +} + +/* @end */ + +td.tiny { + font-size: 75%; +} + +.dirtab { + padding: 4px; + border-collapse: collapse; + border: 1px solid var(--table-cell-border-color); +} + +th.dirtab { + background-color: var(--table-header-background-color); + color: var(--table-header-foreground-color); + font-weight: bold; +} + +hr { + height: 0px; + border: none; + border-top: 1px solid var(--separator-color); +} + +hr.footer { + height: 1px; +} + +/* @group Member Descriptions */ + +table.memberdecls { + border-spacing: 0px; + padding: 0px; +} + +.memberdecls td, .fieldtable tr { + -webkit-transition-property: background-color, box-shadow; + -webkit-transition-duration: 0.5s; + -moz-transition-property: background-color, box-shadow; + -moz-transition-duration: 0.5s; + -ms-transition-property: background-color, box-shadow; + -ms-transition-duration: 0.5s; + -o-transition-property: background-color, box-shadow; + -o-transition-duration: 0.5s; + transition-property: background-color, box-shadow; + transition-duration: 0.5s; +} + +.memberdecls td.glow, .fieldtable tr.glow { + background-color: var(--glow-color); + box-shadow: 0 0 15px var(--glow-color); +} + +.mdescLeft, .mdescRight, +.memItemLeft, .memItemRight, +.memTemplItemLeft, .memTemplItemRight, .memTemplParams { + background-color: var(--memdecl-background-color); + border: none; + margin: 4px; + padding: 1px 0 0 8px; +} + +.mdescLeft, .mdescRight { + padding: 0px 8px 4px 8px; + color: var(--memdecl-foreground-color); +} + +.memSeparator { + border-bottom: 1px solid var(--memdecl-separator-color); + line-height: 1px; + margin: 0px; + padding: 0px; +} + +.memItemLeft, .memTemplItemLeft { + white-space: nowrap; +} + +.memItemRight, .memTemplItemRight { + width: 100%; +} + +.memTemplParams { + color: var(--memdecl-template-color); + white-space: nowrap; + font-size: 80%; +} + +/* @end */ + +/* @group Member Details */ + +/* Styles for detailed member documentation */ + +.memtitle { + padding: 8px; + border-top: 1px solid var(--memdef-border-color); + border-left: 1px solid var(--memdef-border-color); + border-right: 1px solid var(--memdef-border-color); + border-top-right-radius: 4px; + border-top-left-radius: 4px; + margin-bottom: -1px; + background-image: var(--memdef-title-gradient-image); + background-repeat: repeat-x; + background-color: var(--memdef-title-background-color); + line-height: 1.25; + font-weight: 300; + float:left; +} + +.permalink +{ + font-size: 65%; + display: inline-block; + vertical-align: middle; +} + +.memtemplate { + font-size: 80%; + color: var(--memdef-template-color); + font-weight: normal; + margin-left: 9px; +} + +.mempage { + width: 100%; +} + +.memitem { + padding: 0; + margin-bottom: 10px; + margin-right: 5px; + -webkit-transition: box-shadow 0.5s linear; + -moz-transition: box-shadow 0.5s linear; + -ms-transition: box-shadow 0.5s linear; + -o-transition: box-shadow 0.5s linear; + transition: box-shadow 0.5s linear; + display: table !important; + width: 100%; +} + +.memitem.glow { + box-shadow: 0 0 15px var(--glow-color); +} + +.memname { + font-weight: 400; + margin-left: 6px; +} + +.memname td { + vertical-align: bottom; +} + +.memproto, dl.reflist dt { + border-top: 1px solid var(--memdef-border-color); + border-left: 1px solid var(--memdef-border-color); + border-right: 1px solid var(--memdef-border-color); + padding: 6px 0px 6px 0px; + color: var(--memdef-proto-text-color); + font-weight: bold; + text-shadow: var(--memdef-proto-text-shadow); + background-color: var(--memdef-proto-background-color); + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + border-top-right-radius: 4px; +} + +.overload { + font-family: var(--font-family-monospace); + font-size: 65%; +} + +.memdoc, dl.reflist dd { + border-bottom: 1px solid var(--memdef-border-color); + border-left: 1px solid var(--memdef-border-color); + border-right: 1px solid var(--memdef-border-color); + padding: 6px 10px 2px 10px; + border-top-width: 0; + background-image:url('nav_g.png'); + background-repeat:repeat-x; + background-color: var(--memdef-doc-background-color); + /* opera specific markup */ + border-bottom-left-radius: 4px; + border-bottom-right-radius: 4px; + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + /* firefox specific markup */ + -moz-border-radius-bottomleft: 4px; + -moz-border-radius-bottomright: 4px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + /* webkit specific markup */ + -webkit-border-bottom-left-radius: 4px; + -webkit-border-bottom-right-radius: 4px; + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); +} + +dl.reflist dt { + padding: 5px; +} + +dl.reflist dd { + margin: 0px 0px 10px 0px; + padding: 5px; +} + +.paramkey { + text-align: right; +} + +.paramtype { + white-space: nowrap; +} + +.paramname { + color: var(--memdef-param-name-color); + white-space: nowrap; +} +.paramname em { + font-style: normal; +} +.paramname code { + line-height: 14px; +} + +.params, .retval, .exception, .tparams { + margin-left: 0px; + padding-left: 0px; +} + +.params .paramname, .retval .paramname, .tparams .paramname, .exception .paramname { + font-weight: bold; + vertical-align: top; +} + +.params .paramtype, .tparams .paramtype { + font-style: italic; + vertical-align: top; +} + +.params .paramdir, .tparams .paramdir { + font-family: var(--font-family-monospace); + vertical-align: top; +} + +table.mlabels { + border-spacing: 0px; +} + +td.mlabels-left { + width: 100%; + padding: 0px; +} + +td.mlabels-right { + vertical-align: bottom; + padding: 0px; + white-space: nowrap; +} + +span.mlabels { + margin-left: 8px; +} + +span.mlabel { + background-color: var(--label-background-color); + border-top:1px solid var(--label-left-top-border-color); + border-left:1px solid var(--label-left-top-border-color); + border-right:1px solid var(--label-right-bottom-border-color); + border-bottom:1px solid var(--label-right-bottom-border-color); + text-shadow: none; + color: var(--label-foreground-color); + margin-right: 4px; + padding: 2px 3px; + border-radius: 3px; + font-size: 7pt; + white-space: nowrap; + vertical-align: middle; +} + + + +/* @end */ + +/* these are for tree view inside a (index) page */ + +div.directory { + margin: 10px 0px; + border-top: 1px solid var(--directory-separator-color); + border-bottom: 1px solid var(--directory-separator-color); + width: 100%; +} + +.directory table { + border-collapse:collapse; +} + +.directory td { + margin: 0px; + padding: 0px; + vertical-align: top; +} + +.directory td.entry { + white-space: nowrap; + padding-right: 6px; + padding-top: 3px; +} + +.directory td.entry a { + outline:none; +} + +.directory td.entry a img { + border: none; +} + +.directory td.desc { + width: 100%; + padding-left: 6px; + padding-right: 6px; + padding-top: 3px; + border-left: 1px solid rgba(0,0,0,0.05); +} + +.directory tr.odd { + padding-left: 6px; + background-color: var(--index-odd-item-bg-color); +} + +.directory tr.even { + padding-left: 6px; + background-color: var(--index-even-item-bg-color); +} + +.directory img { + vertical-align: -30%; +} + +.directory .levels { + white-space: nowrap; + width: 100%; + text-align: right; + font-size: 9pt; +} + +.directory .levels span { + cursor: pointer; + padding-left: 2px; + padding-right: 2px; + color: var(--page-link-color); +} + +.arrow { + color: var(--nav-arrow-color); + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + cursor: pointer; + font-size: 80%; + display: inline-block; + width: 16px; + height: 22px; +} + +.icon { + font-family: var(--font-family-icon); + line-height: normal; + font-weight: bold; + font-size: 12px; + height: 14px; + width: 16px; + display: inline-block; + background-color: var(--icon-background-color); + color: var(--icon-foreground-color); + text-align: center; + border-radius: 4px; + margin-left: 2px; + margin-right: 2px; +} + +.icona { + width: 24px; + height: 22px; + display: inline-block; +} + +.iconfopen { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:var(--icon-folder-open-image); + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +.iconfclosed { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:var(--icon-folder-closed-image); + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +.icondoc { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:var(--icon-doc-image); + background-position: 0px -4px; + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +/* @end */ + +div.dynheader { + margin-top: 8px; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +address { + font-style: normal; + color: var(--footer-foreground-color); +} + +table.doxtable caption { + caption-side: top; +} + +table.doxtable { + border-collapse:collapse; + margin-top: 4px; + margin-bottom: 4px; +} + +table.doxtable td, table.doxtable th { + border: 1px solid var(--table-cell-border-color); + padding: 3px 7px 2px; +} + +table.doxtable th { + background-color: var(--table-header-background-color); + color: var(--table-header-foreground-color); + font-size: 110%; + padding-bottom: 4px; + padding-top: 5px; +} + +table.fieldtable { + margin-bottom: 10px; + border: 1px solid var(--memdef-border-color); + border-spacing: 0px; + border-radius: 4px; + box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); +} + +.fieldtable td, .fieldtable th { + padding: 3px 7px 2px; +} + +.fieldtable td.fieldtype, .fieldtable td.fieldname { + white-space: nowrap; + border-right: 1px solid var(--memdef-border-color); + border-bottom: 1px solid var(--memdef-border-color); + vertical-align: top; +} + +.fieldtable td.fieldname { + padding-top: 3px; +} + +.fieldtable td.fielddoc { + border-bottom: 1px solid var(--memdef-border-color); +} + +.fieldtable td.fielddoc p:first-child { + margin-top: 0px; +} + +.fieldtable td.fielddoc p:last-child { + margin-bottom: 2px; +} + +.fieldtable tr:last-child td { + border-bottom: none; +} + +.fieldtable th { + background-image: var(--memdef-title-gradient-image); + background-repeat:repeat-x; + background-color: var(--memdef-title-background-color); + font-size: 90%; + color: var(--memdef-proto-text-color); + padding-bottom: 4px; + padding-top: 5px; + text-align:left; + font-weight: 400; + border-top-left-radius: 4px; + border-top-right-radius: 4px; + border-bottom: 1px solid var(--memdef-border-color); +} + + +.tabsearch { + top: 0px; + left: 10px; + height: 36px; + background-image: var(--nav-gradient-image); + z-index: 101; + overflow: hidden; + font-size: 13px; +} + +.navpath ul +{ + font-size: 11px; + background-image: var(--nav-gradient-image); + background-repeat:repeat-x; + background-position: 0 -5px; + height:30px; + line-height:30px; + color:var(--nav-text-normal-color); + border:solid 1px var(--nav-breadcrumb-border-color); + overflow:hidden; + margin:0px; + padding:0px; +} + +.navpath li +{ + list-style-type:none; + float:left; + padding-left:10px; + padding-right:15px; + background-image:var(--nav-breadcrumb-image); + background-repeat:no-repeat; + background-position:right; + color: var(--nav-foreground-color); +} + +.navpath li.navelem a +{ + height:32px; + display:block; + text-decoration: none; + outline: none; + color: var(--nav-text-normal-color); + font-family: var(--font-family-nav); + text-shadow: var(--nav-text-normal-shadow); + text-decoration: none; +} + +.navpath li.navelem a:hover +{ + color: var(--nav-text-hover-color); + text-shadow: var(--nav-text-hover-shadow); +} + +.navpath li.footer +{ + list-style-type:none; + float:right; + padding-left:10px; + padding-right:15px; + background-image:none; + background-repeat:no-repeat; + background-position:right; + color: var(--footer-foreground-color); + font-size: 8pt; +} + + +div.summary +{ + float: right; + font-size: 8pt; + padding-right: 5px; + width: 50%; + text-align: right; +} + +div.summary a +{ + white-space: nowrap; +} + +table.classindex +{ + margin: 10px; + white-space: nowrap; + margin-left: 3%; + margin-right: 3%; + width: 94%; + border: 0; + border-spacing: 0; + padding: 0; +} + +div.ingroups +{ + font-size: 8pt; + width: 50%; + text-align: left; +} + +div.ingroups a +{ + white-space: nowrap; +} + +div.header +{ + background-image: var(--header-gradient-image); + background-repeat:repeat-x; + background-color: var(--header-background-color); + margin: 0px; + border-bottom: 1px solid var(--header-separator-color); +} + +div.headertitle +{ + padding: 5px 5px 5px 10px; +} + +.PageDocRTL-title div.headertitle { + text-align: right; + direction: rtl; +} + +dl { + padding: 0 0 0 0; +} + +/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug, dl.examples */ +dl.section { + margin-left: 0px; + padding-left: 0px; +} + +dl.note { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #D0C000; +} + +dl.warning, dl.attention { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #FF0000; +} + +dl.pre, dl.post, dl.invariant { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #00D000; +} + +dl.deprecated { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #505050; +} + +dl.todo { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #00C0E0; +} + +dl.test { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #3030E0; +} + +dl.bug { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #C08050; +} + +dl.section dd { + margin-bottom: 6px; +} + + +#projectrow +{ + height: 56px; +} + +#projectlogo +{ + text-align: center; + vertical-align: bottom; + border-collapse: separate; +} + +#projectlogo img +{ + border: 0px none; +} + +#projectalign +{ + vertical-align: middle; + padding-left: 0.5em; +} + +#projectname +{ + font-size: 200%; + font-family: var(--font-family-title); + margin: 0px; + padding: 2px 0px; +} + +#projectbrief +{ + font-size: 90%; + font-family: var(--font-family-title); + margin: 0px; + padding: 0px; +} + +#projectnumber +{ + font-size: 50%; + font-family: 50% var(--font-family-title); + margin: 0px; + padding: 0px; +} + +#titlearea +{ + padding: 0px; + margin: 0px; + width: 100%; + border-bottom: 1px solid var(--title-separator-color); + background-color: var(--title-background-color); +} + +.image +{ + text-align: center; +} + +.dotgraph +{ + text-align: center; +} + +.mscgraph +{ + text-align: center; +} + +.plantumlgraph +{ + text-align: center; +} + +.diagraph +{ + text-align: center; +} + +.caption +{ + font-weight: bold; +} + +dl.citelist { + margin-bottom:50px; +} + +dl.citelist dt { + color:var(--citation-label-color); + float:left; + font-weight:bold; + margin-right:10px; + padding:5px; + text-align:right; + width:52px; +} + +dl.citelist dd { + margin:2px 0 2px 72px; + padding:5px 0; +} + +div.toc { + padding: 14px 25px; + background-color: var(--toc-background-color); + border: 1px solid var(--toc-border-color); + border-radius: 7px 7px 7px 7px; + float: right; + height: auto; + margin: 0 8px 10px 10px; + width: 200px; +} + +div.toc li { + background: var(--toc-down-arrow-image) no-repeat scroll 0 5px transparent; + font: 10px/1.2 var(--font-family-toc); + margin-top: 5px; + padding-left: 10px; + padding-top: 2px; +} + +div.toc h3 { + font: bold 12px/1.2 var(--font-family-toc); + color: var(--toc-header-color); + border-bottom: 0 none; + margin: 0; +} + +div.toc ul { + list-style: none outside none; + border: medium none; + padding: 0px; +} + +div.toc li.level1 { + margin-left: 0px; +} + +div.toc li.level2 { + margin-left: 15px; +} + +div.toc li.level3 { + margin-left: 15px; +} + +div.toc li.level4 { + margin-left: 15px; +} + +span.emoji { + /* font family used at the site: https://unicode.org/emoji/charts/full-emoji-list.html + * font-family: "Noto Color Emoji", "Apple Color Emoji", "Segoe UI Emoji", Times, Symbola, Aegyptus, Code2000, Code2001, Code2002, Musica, serif, LastResort; + */ +} + +span.obfuscator { + display: none; +} + +.inherit_header { + font-weight: bold; + color: var(--inherit-header-color); + cursor: pointer; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +.inherit_header td { + padding: 6px 0px 2px 5px; +} + +.inherit { + display: none; +} + +tr.heading h2 { + margin-top: 12px; + margin-bottom: 4px; +} + +/* tooltip related style info */ + +.ttc { + position: absolute; + display: none; +} + +#powerTip { + cursor: default; + /*white-space: nowrap;*/ + color: var(--tooltip-foreground-color); + background-color: var(--tooltip-background-color); + border: 1px solid var(--tooltip-border-color); + border-radius: 4px 4px 4px 4px; + box-shadow: var(--tooltip-shadow); + display: none; + font-size: smaller; + max-width: 80%; + opacity: 0.9; + padding: 1ex 1em 1em; + position: absolute; + z-index: 2147483647; +} + +#powerTip div.ttdoc { + color: var(--tooltip-doc-color); + font-style: italic; +} + +#powerTip div.ttname a { + font-weight: bold; +} + +#powerTip a { + color: var(--tooltip-link-color); +} + +#powerTip div.ttname { + font-weight: bold; +} + +#powerTip div.ttdeci { + color: var(--tooltip-declaration-color); +} + +#powerTip div { + margin: 0px; + padding: 0px; + font-size: 12px; + font-family: var(--font-family-tooltip); + line-height: 16px; +} + +#powerTip:before, #powerTip:after { + content: ""; + position: absolute; + margin: 0px; +} + +#powerTip.n:after, #powerTip.n:before, +#powerTip.s:after, #powerTip.s:before, +#powerTip.w:after, #powerTip.w:before, +#powerTip.e:after, #powerTip.e:before, +#powerTip.ne:after, #powerTip.ne:before, +#powerTip.se:after, #powerTip.se:before, +#powerTip.nw:after, #powerTip.nw:before, +#powerTip.sw:after, #powerTip.sw:before { + border: solid transparent; + content: " "; + height: 0; + width: 0; + position: absolute; +} + +#powerTip.n:after, #powerTip.s:after, +#powerTip.w:after, #powerTip.e:after, +#powerTip.nw:after, #powerTip.ne:after, +#powerTip.sw:after, #powerTip.se:after { + border-color: rgba(255, 255, 255, 0); +} + +#powerTip.n:before, #powerTip.s:before, +#powerTip.w:before, #powerTip.e:before, +#powerTip.nw:before, #powerTip.ne:before, +#powerTip.sw:before, #powerTip.se:before { + border-color: rgba(128, 128, 128, 0); +} + +#powerTip.n:after, #powerTip.n:before, +#powerTip.ne:after, #powerTip.ne:before, +#powerTip.nw:after, #powerTip.nw:before { + top: 100%; +} + +#powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after { + border-top-color: var(--tooltip-background-color); + border-width: 10px; + margin: 0px -10px; +} +#powerTip.n:before, #powerTip.ne:before, #powerTip.nw:before { + border-top-color: var(--tooltip-border-color); + border-width: 11px; + margin: 0px -11px; +} +#powerTip.n:after, #powerTip.n:before { + left: 50%; +} + +#powerTip.nw:after, #powerTip.nw:before { + right: 14px; +} + +#powerTip.ne:after, #powerTip.ne:before { + left: 14px; +} + +#powerTip.s:after, #powerTip.s:before, +#powerTip.se:after, #powerTip.se:before, +#powerTip.sw:after, #powerTip.sw:before { + bottom: 100%; +} + +#powerTip.s:after, #powerTip.se:after, #powerTip.sw:after { + border-bottom-color: var(--tooltip-background-color); + border-width: 10px; + margin: 0px -10px; +} + +#powerTip.s:before, #powerTip.se:before, #powerTip.sw:before { + border-bottom-color: var(--tooltip-border-color); + border-width: 11px; + margin: 0px -11px; +} + +#powerTip.s:after, #powerTip.s:before { + left: 50%; +} + +#powerTip.sw:after, #powerTip.sw:before { + right: 14px; +} + +#powerTip.se:after, #powerTip.se:before { + left: 14px; +} + +#powerTip.e:after, #powerTip.e:before { + left: 100%; +} +#powerTip.e:after { + border-left-color: var(--tooltip-border-color); + border-width: 10px; + top: 50%; + margin-top: -10px; +} +#powerTip.e:before { + border-left-color: var(--tooltip-border-color); + border-width: 11px; + top: 50%; + margin-top: -11px; +} + +#powerTip.w:after, #powerTip.w:before { + right: 100%; +} +#powerTip.w:after { + border-right-color: var(--tooltip-border-color); + border-width: 10px; + top: 50%; + margin-top: -10px; +} +#powerTip.w:before { + border-right-color: var(--tooltip-border-color); + border-width: 11px; + top: 50%; + margin-top: -11px; +} + +@media print +{ + #top { display: none; } + #side-nav { display: none; } + #nav-path { display: none; } + body { overflow:visible; } + h1, h2, h3, h4, h5, h6 { page-break-after: avoid; } + .summary { display: none; } + .memitem { page-break-inside: avoid; } + #doc-content + { + margin-left:0 !important; + height:auto !important; + width:auto !important; + overflow:inherit; + display:inline; + } +} + +/* @group Markdown */ + +table.markdownTable { + border-collapse:collapse; + margin-top: 4px; + margin-bottom: 4px; +} + +table.markdownTable td, table.markdownTable th { + border: 1px solid var(--table-cell-border-color); + padding: 3px 7px 2px; +} + +table.markdownTable tr { +} + +th.markdownTableHeadLeft, th.markdownTableHeadRight, th.markdownTableHeadCenter, th.markdownTableHeadNone { + background-color: var(--table-header-background-color); + color: var(--table-header-foreground-color); + font-size: 110%; + padding-bottom: 4px; + padding-top: 5px; +} + +th.markdownTableHeadLeft, td.markdownTableBodyLeft { + text-align: left +} + +th.markdownTableHeadRight, td.markdownTableBodyRight { + text-align: right +} + +th.markdownTableHeadCenter, td.markdownTableBodyCenter { + text-align: center +} + +tt, code, kbd, samp +{ + display: inline-block; +} +/* @end */ + +u { + text-decoration: underline; +} + +details>summary { + list-style-type: none; +} + +details > summary::-webkit-details-marker { + display: none; +} + +details>summary::before { + content: "\25ba"; + padding-right:4px; + font-size: 80%; +} + +details[open]>summary::before { + content: "\25bc"; + padding-right:4px; + font-size: 80%; +} + +body { + scrollbar-color: var(--scrollbar-thumb-color) var(--scrollbar-background-color); +} + +::-webkit-scrollbar { + background-color: var(--scrollbar-background-color); + height: 12px; + width: 12px; +} +::-webkit-scrollbar-thumb { + border-radius: 6px; + box-shadow: inset 0 0 12px 12px var(--scrollbar-thumb-color); + border: solid 2px transparent; +} +::-webkit-scrollbar-corner { + background-color: var(--scrollbar-background-color); +} + diff --git a/static/api/cpp/3.5.x/doxygen.svg b/static/api/cpp/3.5.x/doxygen.svg new file mode 100644 index 000000000000..79a76354078d --- /dev/null +++ b/static/api/cpp/3.5.x/doxygen.svg @@ -0,0 +1,28 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/static/api/cpp/3.5.x/dynsections.js b/static/api/cpp/3.5.x/dynsections.js new file mode 100644 index 000000000000..b73c82889471 --- /dev/null +++ b/static/api/cpp/3.5.x/dynsections.js @@ -0,0 +1,192 @@ +/* + @licstart The following is the entire license notice for the JavaScript code in this file. + + The MIT License (MIT) + + Copyright (C) 1997-2020 by Dimitri van Heesch + + Permission is hereby granted, free of charge, to any person obtaining a copy of this software + and associated documentation files (the "Software"), to deal in the Software without restriction, + including without limitation the rights to use, copy, modify, merge, publish, distribute, + sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all copies or + substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + @licend The above is the entire license notice for the JavaScript code in this file + */ +function toggleVisibility(linkObj) +{ + var base = $(linkObj).attr('id'); + var summary = $('#'+base+'-summary'); + var content = $('#'+base+'-content'); + var trigger = $('#'+base+'-trigger'); + var src=$(trigger).attr('src'); + if (content.is(':visible')===true) { + content.hide(); + summary.show(); + $(linkObj).addClass('closed').removeClass('opened'); + $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png'); + } else { + content.show(); + summary.hide(); + $(linkObj).removeClass('closed').addClass('opened'); + $(trigger).attr('src',src.substring(0,src.length-10)+'open.png'); + } + return false; +} + +function updateStripes() +{ + $('table.directory tr'). + removeClass('even').filter(':visible:even').addClass('even'); + $('table.directory tr'). + removeClass('odd').filter(':visible:odd').addClass('odd'); +} + +function toggleLevel(level) +{ + $('table.directory tr').each(function() { + var l = this.id.split('_').length-1; + var i = $('#img'+this.id.substring(3)); + var a = $('#arr'+this.id.substring(3)); + if (l'); + // add vertical lines to other rows + $('span[class=lineno]').not(':eq(0)').append(''); + // add toggle controls to lines with fold divs + $('div[class=foldopen]').each(function() { + // extract specific id to use + var id = $(this).attr('id').replace('foldopen',''); + // extract start and end foldable fragment attributes + var start = $(this).attr('data-start'); + var end = $(this).attr('data-end'); + // replace normal fold span with controls for the first line of a foldable fragment + $(this).find('span[class=fold]:first').replaceWith(''); + // append div for folded (closed) representation + $(this).after(''); + // extract the first line from the "open" section to represent closed content + var line = $(this).children().first().clone(); + // remove any glow that might still be active on the original line + $(line).removeClass('glow'); + if (start) { + // if line already ends with a start marker (e.g. trailing {), remove it + $(line).html($(line).html().replace(new RegExp('\\s*'+start+'\\s*$','g'),'')); + } + // replace minus with plus symbol + $(line).find('span[class=fold]').css('background-image',plusImg[relPath]); + // append ellipsis + $(line).append(' '+start+'…'+end); + // insert constructed line into closed div + $('#foldclosed'+id).html(line); + }); +} + +/* @license-end */ diff --git a/static/api/cpp/3.5.x/files.html b/static/api/cpp/3.5.x/files.html new file mode 100644 index 000000000000..bdab86a4dd2c --- /dev/null +++ b/static/api/cpp/3.5.x/files.html @@ -0,0 +1,153 @@ + + + + + + + +pulsar-client-cpp: File List + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
File List
+
+
+
Here is a list of all documented files with brief descriptions:
+
[detail level 1234]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 ▼ include
 ▼ pulsar
 ▼ c
 authentication.h
 client.h
 client_configuration.h
 consumer.h
 consumer_configuration.h
 message.h
 message_id.h
 message_router.h
 messages.h
 producer.h
 producer_configuration.h
 reader.h
 reader_configuration.h
 result.h
 string_list.h
 string_map.h
 table_view.h
 table_view_configuration.h
 version.h
 Authentication.h
 BatchReceivePolicy.h
 BrokerConsumerStats.h
 Client.h
 ClientConfiguration.h
 CompressionType.h
 ConsoleLoggerFactory.h
 Consumer.h
 ConsumerConfiguration.h
 ConsumerCryptoFailureAction.h
 ConsumerEventListener.h
 ConsumerInterceptor.h
 ConsumerType.h
 CryptoKeyReader.h
 DeadLetterPolicy.h
 DeadLetterPolicyBuilder.h
 defines.h
 DeprecatedException.h
 EncryptionKeyInfo.h
 FileLoggerFactory.h
 InitialPosition.h
 KeySharedPolicy.h
 KeyValue.h
 Logger.h
 Message.h
 MessageBatch.h
 MessageBuilder.h
 MessageId.h
 MessageIdBuilder.h
 MessageRoutingPolicy.h
 Producer.h
 ProducerConfiguration.h
 ProducerCryptoFailureAction.h
 ProducerInterceptor.h
 ProtobufNativeSchema.h
 Reader.h
 ReaderConfiguration.h
 RegexSubscriptionMode.h
 Result.h
 Schema.h
 TableView.h
 TableViewConfiguration.h
 TopicMetadata.h
 TypedMessage.h
 TypedMessageBuilder.h
+
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/folderclosed.svg b/static/api/cpp/3.5.x/folderclosed.svg new file mode 100644 index 000000000000..b04bed2e7236 --- /dev/null +++ b/static/api/cpp/3.5.x/folderclosed.svg @@ -0,0 +1,11 @@ + + + + + + + + + + diff --git a/static/api/cpp/3.5.x/folderclosedd.svg b/static/api/cpp/3.5.x/folderclosedd.svg new file mode 100644 index 000000000000..52f0166a23e7 --- /dev/null +++ b/static/api/cpp/3.5.x/folderclosedd.svg @@ -0,0 +1,11 @@ + + + + + + + + + + diff --git a/static/api/cpp/3.5.x/folderopen.svg b/static/api/cpp/3.5.x/folderopen.svg new file mode 100644 index 000000000000..f6896dd254b6 --- /dev/null +++ b/static/api/cpp/3.5.x/folderopen.svg @@ -0,0 +1,17 @@ + + + + + + + + + + diff --git a/static/api/cpp/3.5.x/folderopend.svg b/static/api/cpp/3.5.x/folderopend.svg new file mode 100644 index 000000000000..2d1f06e7bc6e --- /dev/null +++ b/static/api/cpp/3.5.x/folderopend.svg @@ -0,0 +1,12 @@ + + + + + + + + + + + diff --git a/static/api/cpp/3.5.x/functions.html b/static/api/cpp/3.5.x/functions.html new file mode 100644 index 000000000000..64b8a2a90f7a --- /dev/null +++ b/static/api/cpp/3.5.x/functions.html @@ -0,0 +1,89 @@ + + + + + + + +pulsar-client-cpp: Class Members + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented class members with links to the class documentation for each member:
+ +

- a -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_b.html b/static/api/cpp/3.5.x/functions_b.html new file mode 100644 index 000000000000..6b60f626c323 --- /dev/null +++ b/static/api/cpp/3.5.x/functions_b.html @@ -0,0 +1,94 @@ + + + + + + + +pulsar-client-cpp: Class Members + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented class members with links to the class documentation for each member:
+ +

- b -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_c.html b/static/api/cpp/3.5.x/functions_c.html new file mode 100644 index 000000000000..29f6689bd4b0 --- /dev/null +++ b/static/api/cpp/3.5.x/functions_c.html @@ -0,0 +1,97 @@ + + + + + + + +pulsar-client-cpp: Class Members + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented class members with links to the class documentation for each member:
+ +

- c -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_d.html b/static/api/cpp/3.5.x/functions_d.html new file mode 100644 index 000000000000..772d138cb3d8 --- /dev/null +++ b/static/api/cpp/3.5.x/functions_d.html @@ -0,0 +1,88 @@ + + + + + + + +pulsar-client-cpp: Class Members + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented class members with links to the class documentation for each member:
+ +

- d -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_e.html b/static/api/cpp/3.5.x/functions_e.html new file mode 100644 index 000000000000..fae2b6a21332 --- /dev/null +++ b/static/api/cpp/3.5.x/functions_e.html @@ -0,0 +1,88 @@ + + + + + + + +pulsar-client-cpp: Class Members + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented class members with links to the class documentation for each member:
+ +

- e -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_enum.html b/static/api/cpp/3.5.x/functions_enum.html new file mode 100644 index 000000000000..095151126f8e --- /dev/null +++ b/static/api/cpp/3.5.x/functions_enum.html @@ -0,0 +1,83 @@ + + + + + + + +pulsar-client-cpp: Class Members - Enumerations + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented enums with links to the class documentation for each member:
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_eval.html b/static/api/cpp/3.5.x/functions_eval.html new file mode 100644 index 000000000000..9dfba09eeee2 --- /dev/null +++ b/static/api/cpp/3.5.x/functions_eval.html @@ -0,0 +1,87 @@ + + + + + + + +pulsar-client-cpp: Class Members - Enumerator + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented enum values with links to the class documentation for each member:
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_f.html b/static/api/cpp/3.5.x/functions_f.html new file mode 100644 index 000000000000..9d4d0bc364d7 --- /dev/null +++ b/static/api/cpp/3.5.x/functions_f.html @@ -0,0 +1,89 @@ + + + + + + + +pulsar-client-cpp: Class Members + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented class members with links to the class documentation for each member:
+ +

- f -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_func.html b/static/api/cpp/3.5.x/functions_func.html new file mode 100644 index 000000000000..5b91c6331064 --- /dev/null +++ b/static/api/cpp/3.5.x/functions_func.html @@ -0,0 +1,89 @@ + + + + + + + +pulsar-client-cpp: Class Members - Functions + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented functions with links to the class documentation for each member:
+ +

- a -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_func_b.html b/static/api/cpp/3.5.x/functions_func_b.html new file mode 100644 index 000000000000..092b4a4d3ebd --- /dev/null +++ b/static/api/cpp/3.5.x/functions_func_b.html @@ -0,0 +1,93 @@ + + + + + + + +pulsar-client-cpp: Class Members - Functions + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented functions with links to the class documentation for each member:
+ +

- b -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_func_c.html b/static/api/cpp/3.5.x/functions_func_c.html new file mode 100644 index 000000000000..46c42b7a4cd8 --- /dev/null +++ b/static/api/cpp/3.5.x/functions_func_c.html @@ -0,0 +1,97 @@ + + + + + + + +pulsar-client-cpp: Class Members - Functions + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented functions with links to the class documentation for each member:
+ +

- c -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_func_d.html b/static/api/cpp/3.5.x/functions_func_d.html new file mode 100644 index 000000000000..082c43b080c3 --- /dev/null +++ b/static/api/cpp/3.5.x/functions_func_d.html @@ -0,0 +1,87 @@ + + + + + + + +pulsar-client-cpp: Class Members - Functions + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented functions with links to the class documentation for each member:
+ +

- d -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_func_e.html b/static/api/cpp/3.5.x/functions_func_e.html new file mode 100644 index 000000000000..5406db1c0272 --- /dev/null +++ b/static/api/cpp/3.5.x/functions_func_e.html @@ -0,0 +1,86 @@ + + + + + + + +pulsar-client-cpp: Class Members - Functions + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented functions with links to the class documentation for each member:
+ +

- e -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_func_f.html b/static/api/cpp/3.5.x/functions_func_f.html new file mode 100644 index 000000000000..84cc8faae4ee --- /dev/null +++ b/static/api/cpp/3.5.x/functions_func_f.html @@ -0,0 +1,89 @@ + + + + + + + +pulsar-client-cpp: Class Members - Functions + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented functions with links to the class documentation for each member:
+ +

- f -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_func_g.html b/static/api/cpp/3.5.x/functions_func_g.html new file mode 100644 index 000000000000..d49510b26b56 --- /dev/null +++ b/static/api/cpp/3.5.x/functions_func_g.html @@ -0,0 +1,217 @@ + + + + + + + +pulsar-client-cpp: Class Members - Functions + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented functions with links to the class documentation for each member:
+ +

- g -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_func_h.html b/static/api/cpp/3.5.x/functions_func_h.html new file mode 100644 index 000000000000..270b93253b88 --- /dev/null +++ b/static/api/cpp/3.5.x/functions_func_h.html @@ -0,0 +1,95 @@ + + + + + + + +pulsar-client-cpp: Class Members - Functions + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented functions with links to the class documentation for each member:
+ +

- h -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_func_i.html b/static/api/cpp/3.5.x/functions_func_i.html new file mode 100644 index 000000000000..cb127bd96956 --- /dev/null +++ b/static/api/cpp/3.5.x/functions_func_i.html @@ -0,0 +1,103 @@ + + + + + + + +pulsar-client-cpp: Class Members - Functions + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented functions with links to the class documentation for each member:
+ +

- i -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_func_k.html b/static/api/cpp/3.5.x/functions_func_k.html new file mode 100644 index 000000000000..aa7eff439af6 --- /dev/null +++ b/static/api/cpp/3.5.x/functions_func_k.html @@ -0,0 +1,84 @@ + + + + + + + +pulsar-client-cpp: Class Members - Functions + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented functions with links to the class documentation for each member:
+ +

- k -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_func_l.html b/static/api/cpp/3.5.x/functions_func_l.html new file mode 100644 index 000000000000..1a03dbac8cb9 --- /dev/null +++ b/static/api/cpp/3.5.x/functions_func_l.html @@ -0,0 +1,86 @@ + + + + + + + +pulsar-client-cpp: Class Members - Functions + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented functions with links to the class documentation for each member:
+ +

- l -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_func_m.html b/static/api/cpp/3.5.x/functions_func_m.html new file mode 100644 index 000000000000..bff8a2c78dc1 --- /dev/null +++ b/static/api/cpp/3.5.x/functions_func_m.html @@ -0,0 +1,86 @@ + + + + + + + +pulsar-client-cpp: Class Members - Functions + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented functions with links to the class documentation for each member:
+ +

- m -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_func_n.html b/static/api/cpp/3.5.x/functions_func_n.html new file mode 100644 index 000000000000..1e961ddea47c --- /dev/null +++ b/static/api/cpp/3.5.x/functions_func_n.html @@ -0,0 +1,84 @@ + + + + + + + +pulsar-client-cpp: Class Members - Functions + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented functions with links to the class documentation for each member:
+ +

- n -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_func_o.html b/static/api/cpp/3.5.x/functions_func_o.html new file mode 100644 index 000000000000..fffccabfac98 --- /dev/null +++ b/static/api/cpp/3.5.x/functions_func_o.html @@ -0,0 +1,88 @@ + + + + + + + +pulsar-client-cpp: Class Members - Functions + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented functions with links to the class documentation for each member:
+ +

- o -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_func_p.html b/static/api/cpp/3.5.x/functions_func_p.html new file mode 100644 index 000000000000..dbd8b42cc151 --- /dev/null +++ b/static/api/cpp/3.5.x/functions_func_p.html @@ -0,0 +1,87 @@ + + + + + + + +pulsar-client-cpp: Class Members - Functions + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented functions with links to the class documentation for each member:
+ +

- p -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_func_r.html b/static/api/cpp/3.5.x/functions_func_r.html new file mode 100644 index 000000000000..abe3b959c401 --- /dev/null +++ b/static/api/cpp/3.5.x/functions_func_r.html @@ -0,0 +1,91 @@ + + + + + + + +pulsar-client-cpp: Class Members - Functions + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented functions with links to the class documentation for each member:
+ +

- r -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_func_s.html b/static/api/cpp/3.5.x/functions_func_s.html new file mode 100644 index 000000000000..f3f2133df828 --- /dev/null +++ b/static/api/cpp/3.5.x/functions_func_s.html @@ -0,0 +1,194 @@ + + + + + + + +pulsar-client-cpp: Class Members - Functions + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented functions with links to the class documentation for each member:
+ +

- s -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_func_t.html b/static/api/cpp/3.5.x/functions_func_t.html new file mode 100644 index 000000000000..1ff78603bea8 --- /dev/null +++ b/static/api/cpp/3.5.x/functions_func_t.html @@ -0,0 +1,84 @@ + + + + + + + +pulsar-client-cpp: Class Members - Functions + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented functions with links to the class documentation for each member:
+ +

- t -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_func_u.html b/static/api/cpp/3.5.x/functions_func_u.html new file mode 100644 index 000000000000..0006af523672 --- /dev/null +++ b/static/api/cpp/3.5.x/functions_func_u.html @@ -0,0 +1,85 @@ + + + + + + + +pulsar-client-cpp: Class Members - Functions + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented functions with links to the class documentation for each member:
+ +

- u -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_g.html b/static/api/cpp/3.5.x/functions_g.html new file mode 100644 index 000000000000..58488d00ffb5 --- /dev/null +++ b/static/api/cpp/3.5.x/functions_g.html @@ -0,0 +1,217 @@ + + + + + + + +pulsar-client-cpp: Class Members + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented class members with links to the class documentation for each member:
+ +

- g -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_h.html b/static/api/cpp/3.5.x/functions_h.html new file mode 100644 index 000000000000..84a1be4b797f --- /dev/null +++ b/static/api/cpp/3.5.x/functions_h.html @@ -0,0 +1,95 @@ + + + + + + + +pulsar-client-cpp: Class Members + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented class members with links to the class documentation for each member:
+ +

- h -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_i.html b/static/api/cpp/3.5.x/functions_i.html new file mode 100644 index 000000000000..6adc564fdc8d --- /dev/null +++ b/static/api/cpp/3.5.x/functions_i.html @@ -0,0 +1,103 @@ + + + + + + + +pulsar-client-cpp: Class Members + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented class members with links to the class documentation for each member:
+ +

- i -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_k.html b/static/api/cpp/3.5.x/functions_k.html new file mode 100644 index 000000000000..0a531d850118 --- /dev/null +++ b/static/api/cpp/3.5.x/functions_k.html @@ -0,0 +1,85 @@ + + + + + + + +pulsar-client-cpp: Class Members + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented class members with links to the class documentation for each member:
+ +

- k -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_l.html b/static/api/cpp/3.5.x/functions_l.html new file mode 100644 index 000000000000..ae92c4cec11d --- /dev/null +++ b/static/api/cpp/3.5.x/functions_l.html @@ -0,0 +1,86 @@ + + + + + + + +pulsar-client-cpp: Class Members + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented class members with links to the class documentation for each member:
+ +

- l -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_m.html b/static/api/cpp/3.5.x/functions_m.html new file mode 100644 index 000000000000..94ab919ff66e --- /dev/null +++ b/static/api/cpp/3.5.x/functions_m.html @@ -0,0 +1,86 @@ + + + + + + + +pulsar-client-cpp: Class Members + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented class members with links to the class documentation for each member:
+ +

- m -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_n.html b/static/api/cpp/3.5.x/functions_n.html new file mode 100644 index 000000000000..e391fd22dfee --- /dev/null +++ b/static/api/cpp/3.5.x/functions_n.html @@ -0,0 +1,84 @@ + + + + + + + +pulsar-client-cpp: Class Members + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented class members with links to the class documentation for each member:
+ +

- n -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_o.html b/static/api/cpp/3.5.x/functions_o.html new file mode 100644 index 000000000000..092ae521d50b --- /dev/null +++ b/static/api/cpp/3.5.x/functions_o.html @@ -0,0 +1,88 @@ + + + + + + + +pulsar-client-cpp: Class Members + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented class members with links to the class documentation for each member:
+ +

- o -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_p.html b/static/api/cpp/3.5.x/functions_p.html new file mode 100644 index 000000000000..b15e53cae74d --- /dev/null +++ b/static/api/cpp/3.5.x/functions_p.html @@ -0,0 +1,88 @@ + + + + + + + +pulsar-client-cpp: Class Members + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented class members with links to the class documentation for each member:
+ +

- p -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_r.html b/static/api/cpp/3.5.x/functions_r.html new file mode 100644 index 000000000000..ac39c2714d16 --- /dev/null +++ b/static/api/cpp/3.5.x/functions_r.html @@ -0,0 +1,91 @@ + + + + + + + +pulsar-client-cpp: Class Members + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented class members with links to the class documentation for each member:
+ +

- r -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_s.html b/static/api/cpp/3.5.x/functions_s.html new file mode 100644 index 000000000000..fe52a1559f7e --- /dev/null +++ b/static/api/cpp/3.5.x/functions_s.html @@ -0,0 +1,195 @@ + + + + + + + +pulsar-client-cpp: Class Members + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented class members with links to the class documentation for each member:
+ +

- s -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_t.html b/static/api/cpp/3.5.x/functions_t.html new file mode 100644 index 000000000000..a79060035889 --- /dev/null +++ b/static/api/cpp/3.5.x/functions_t.html @@ -0,0 +1,84 @@ + + + + + + + +pulsar-client-cpp: Class Members + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented class members with links to the class documentation for each member:
+ +

- t -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_u.html b/static/api/cpp/3.5.x/functions_u.html new file mode 100644 index 000000000000..6b0fb38f047d --- /dev/null +++ b/static/api/cpp/3.5.x/functions_u.html @@ -0,0 +1,85 @@ + + + + + + + +pulsar-client-cpp: Class Members + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented class members with links to the class documentation for each member:
+ +

- u -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/functions_w.html b/static/api/cpp/3.5.x/functions_w.html new file mode 100644 index 000000000000..792207d10ade --- /dev/null +++ b/static/api/cpp/3.5.x/functions_w.html @@ -0,0 +1,84 @@ + + + + + + + +pulsar-client-cpp: Class Members + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all documented class members with links to the class documentation for each member:
+ +

- w -

+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/hierarchy.html b/static/api/cpp/3.5.x/hierarchy.html new file mode 100644 index 000000000000..8a5f30d5993e --- /dev/null +++ b/static/api/cpp/3.5.x/hierarchy.html @@ -0,0 +1,139 @@ + + + + + + + +pulsar-client-cpp: Class Hierarchy + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Class Hierarchy
+
+
+
This inheritance list is sorted roughly, but not completely, alphabetically:
+
[detail level 12]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 ▼Cpulsar::Authentication
 Cpulsar::AuthAthenz
 Cpulsar::AuthBasic
 Cpulsar::AuthOauth2
 Cpulsar::AuthTls
 Cpulsar::AuthToken
 Cpulsar::AuthenticationDataProvider
 Cpulsar::AuthFactory
 Cpulsar::BatchReceivePolicy
 Cpulsar::BrokerConsumerStats
 Cpulsar::CachedToken
 Cpulsar::Client
 Cpulsar::ClientConfiguration
 Cpulsar::Consumer
 Cpulsar::ConsumerConfiguration
 Cpulsar::ConsumerEventListener
 Cpulsar::ConsumerInterceptor
 ▼Cpulsar::CryptoKeyReader
 Cpulsar::DefaultCryptoKeyReader
 Cpulsar::DeadLetterPolicy
 Cpulsar::DeadLetterPolicyBuilder
 Cpulsar::EncryptionKeyInfo
 Cpulsar::KeySharedPolicy
 Cpulsar::KeyValue
 Cpulsar::Logger
 ▼Cpulsar::LoggerFactory
 Cpulsar::ConsoleLoggerFactory
 Cpulsar::FileLoggerFactory
 ▼Cpulsar::Message
 Cpulsar::TypedMessage< T >
 Cpulsar::MessageBatch
 ▼Cpulsar::MessageBuilder
 Cpulsar::TypedMessageBuilder< T >
 Cpulsar::TypedMessageBuilder< std::string >
 Cpulsar::MessageId
 Cpulsar::MessageIdBuilder
 Cpulsar::MessageRoutingPolicy
 Cpulsar::Oauth2Flow
 Cpulsar::Oauth2TokenResult
 Cpulsar::Producer
 Cpulsar::ProducerConfiguration
 Cpulsar::ProducerInterceptor
 Cpulsar_consumer_batch_receive_policy_t
 Cpulsar_consumer_config_dead_letter_policy_t
 Cpulsar_logger_t
 Cpulsar::Reader
 Cpulsar::ReaderConfiguration
 ▼Cstd::runtime_error
 Cpulsar::DeprecatedException
 Cpulsar::SchemaInfo
 Cpulsar::TableView
 Cpulsar::TableViewConfiguration
 Cpulsar::TopicMetadata
+
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/index.html b/static/api/cpp/3.5.x/index.html new file mode 100644 index 000000000000..6a6caca1ac2c --- /dev/null +++ b/static/api/cpp/3.5.x/index.html @@ -0,0 +1,147 @@ + + + + + + + +pulsar-client-cpp: pulsar-client-cpp + + + + + + + + + + +
+
+ + + + + + +
+
pulsar-client-cpp +
+
+
+ + + + + + + +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
pulsar-client-cpp
+
+
+

+

Pulsar C++ client library

+

Pulsar C++ clients support a variety of Pulsar features to enable building applications connecting to your Pulsar cluster.

+

For the supported Pulsar features, see Client Feature Matrix.

+

For how to use APIs to publish and consume messages, see examples.

+

Import the library into your project

+

CMake with vcpkg integration

+

Navigate to vcpkg-example for how to import the pulsar-client-cpp into your project via vcpkg.

+

Download pre-built binaries

+

For non-vcpkg projects, you can download pre-built binaries from the official release page.

+

Generate the API documents

+

Pulsar C++ client uses doxygen to build API documents. After installing doxygen, you only need to run doxygen to generate the API documents whose main page is under the doxygen/html/index.html path.

+

Build with vcpkg

+

Since it's integrated with vcpkg, see vcpkg::README for the requirements. See LEGACY_BUILD if you want to manage dependencies by yourself or you cannot install vcpkg in your own environment.

+

How to build from source

+
git clone https://github.com/apache/pulsar-client-cpp.git
+
cd pulsar-client-cpp
+
git submodule update --init --recursive
+
cmake -B build -DINTEGRATE_VCPKG=ON
+
cmake --build build -j8
+

The 1st step will download vcpkg and then install all dependencies according to the version description in vcpkg.json. The 2nd step will build the Pulsar C++ libraries under ./build/lib/, where ./build is the CMake build directory.

+

After the build, the hierarchy of the build directory will be:

+
build/
+
include/ -- extra C++ headers
+
lib/ -- libraries
+
tests/ -- test executables
+
examples/ -- example executables
+
generated/
+
lib/ -- protobuf source files for PulsarApi.proto
+
tests/ -- protobuf source files for *.proto used in tests
+

How to install

+

To install the C++ headers and libraries into a specific path, e.g. /tmp/pulsar, run the following commands:

+
cmake -B build -DINTEGRATE_VCPKG=ON -DCMAKE_INSTALL_PREFIX=/tmp/pulsar
+
cmake --build build -j8 --target install
+

For example, on macOS you will see:

+
/tmp/pulsar/
+
include/pulsar -- C/C++ headers
+
lib/
+
libpulsar.a -- Static library
+
libpulsar.dylib -- Dynamic library
+

Tests

+

Tests are built by default. You should execute run-unit-tests.sh to run tests locally.

+

If you don't want to build the tests, disable the BUILD_TESTS option:

+
cmake -B build -DINTEGRATE_VCPKG=ON -DBUILD_TESTS=OFF
+
cmake --build build -j8
+

Build perf tools

+

If you want to build the perf tools, enable the BUILD_PERF_TOOLS option:

+
cmake -B build -DINTEGRATE_VCPKG=ON -DBUILD_PERF_TOOLS=ON
+
cmake --build build -j8
+

Then the perf tools will be built under ./build/perf/.

+

Platforms

+

Pulsar C++ Client Library has been tested on:

+
    +
  • Linux
    • +
  • Mac OS X
    • +
  • Windows x64
    • +
+

Wireshark Dissector

+

See the wireshark directory for details.

+

Requirements for Contributors

+

It's required to install LLVM for clang-tidy and clang-format. Pulsar C++ client use clang-format 11 to format files. make format automatically formats the files.

+

For Ubuntu users, you can install clang-format-11 via apt install clang-format-11. For other users, run ./build-support/docker-format.sh if you have Docker installed.

+

We welcome contributions from the open source community, kindly make sure your changes are backward compatible with GCC 4.8 and Boost 1.53.

+

If your contribution adds Pulsar features for C++ clients, you need to update both the Pulsar docs and the Client Feature Matrix. See Contribution Guide for more details.

+
+
+ +
+Generated by doxygen 1.9.8 +
+ + diff --git a/static/api/cpp/3.5.x/jquery.js b/static/api/cpp/3.5.x/jquery.js new file mode 100644 index 000000000000..1dffb65b58c8 --- /dev/null +++ b/static/api/cpp/3.5.x/jquery.js @@ -0,0 +1,34 @@ +/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0",options:{classes:{},disabled:!1,create:null},_createWidget:function(t,e){e=y(e||this.defaultElement||this)[0],this.element=y(e),this.uuid=i++,this.eventNamespace="."+this.widgetName+this.uuid,this.bindings=y(),this.hoverable=y(),this.focusable=y(),this.classesElementLookup={},e!==this&&(y.data(e,this.widgetFullName,this),this._on(!0,this.element,{remove:function(t){t.target===e&&this.destroy()}}),this.document=y(e.style?e.ownerDocument:e.document||e),this.window=y(this.document[0].defaultView||this.document[0].parentWindow)),this.options=y.widget.extend({},this.options,this._getCreateOptions(),t),this._create(),this.options.disabled&&this._setOptionDisabled(this.options.disabled),this._trigger("create",null,this._getCreateEventData()),this._init()},_getCreateOptions:function(){return{}},_getCreateEventData:y.noop,_create:y.noop,_init:y.noop,destroy:function(){var i=this;this._destroy(),y.each(this.classesElementLookup,function(t,e){i._removeClass(e,t)}),this.element.off(this.eventNamespace).removeData(this.widgetFullName),this.widget().off(this.eventNamespace).removeAttr("aria-disabled"),this.bindings.off(this.eventNamespace)},_destroy:y.noop,widget:function(){return this.element},option:function(t,e){var i,s,n,o=t;if(0===arguments.length)return y.widget.extend({},this.options);if("string"==typeof t)if(o={},t=(i=t.split(".")).shift(),i.length){for(s=o[t]=y.widget.extend({},this.options[t]),n=0;n
"),i=e.children()[0];return y("body").append(e),t=i.offsetWidth,e.css("overflow","scroll"),t===(i=i.offsetWidth)&&(i=e[0].clientWidth),e.remove(),s=t-i},getScrollInfo:function(t){var e=t.isWindow||t.isDocument?"":t.element.css("overflow-x"),i=t.isWindow||t.isDocument?"":t.element.css("overflow-y"),e="scroll"===e||"auto"===e&&t.widthx(D(s),D(n))?o.important="horizontal":o.important="vertical",p.using.call(this,t,o)}),h.offset(y.extend(l,{using:t}))})},y.ui.position={fit:{left:function(t,e){var i=e.within,s=i.isWindow?i.scrollLeft:i.offset.left,n=i.width,o=t.left-e.collisionPosition.marginLeft,h=s-o,a=o+e.collisionWidth-n-s;e.collisionWidth>n?0n?0=this.options.distance},_mouseDelayMet:function(){return this.mouseDelayMet},_mouseStart:function(){},_mouseDrag:function(){},_mouseStop:function(){},_mouseCapture:function(){return!0}}),y.ui.plugin={add:function(t,e,i){var s,n=y.ui[t].prototype;for(s in i)n.plugins[s]=n.plugins[s]||[],n.plugins[s].push([e,i[s]])},call:function(t,e,i,s){var n,o=t.plugins[e];if(o&&(s||t.element[0].parentNode&&11!==t.element[0].parentNode.nodeType))for(n=0;n").css({overflow:"hidden",position:this.element.css("position"),width:this.element.outerWidth(),height:this.element.outerHeight(),top:this.element.css("top"),left:this.element.css("left")})),this.element=this.element.parent().data("ui-resizable",this.element.resizable("instance")),this.elementIsWrapper=!0,t={marginTop:this.originalElement.css("marginTop"),marginRight:this.originalElement.css("marginRight"),marginBottom:this.originalElement.css("marginBottom"),marginLeft:this.originalElement.css("marginLeft")},this.element.css(t),this.originalElement.css("margin",0),this.originalResizeStyle=this.originalElement.css("resize"),this.originalElement.css("resize","none"),this._proportionallyResizeElements.push(this.originalElement.css({position:"static",zoom:1,display:"block"})),this.originalElement.css(t),this._proportionallyResize()),this._setupHandles(),e.autoHide&&y(this.element).on("mouseenter",function(){e.disabled||(i._removeClass("ui-resizable-autohide"),i._handles.show())}).on("mouseleave",function(){e.disabled||i.resizing||(i._addClass("ui-resizable-autohide"),i._handles.hide())}),this._mouseInit()},_destroy:function(){this._mouseDestroy(),this._addedHandles.remove();function t(t){y(t).removeData("resizable").removeData("ui-resizable").off(".resizable")}var e;return this.elementIsWrapper&&(t(this.element),e=this.element,this.originalElement.css({position:e.css("position"),width:e.outerWidth(),height:e.outerHeight(),top:e.css("top"),left:e.css("left")}).insertAfter(e),e.remove()),this.originalElement.css("resize",this.originalResizeStyle),t(this.originalElement),this},_setOption:function(t,e){switch(this._super(t,e),t){case"handles":this._removeHandles(),this._setupHandles();break;case"aspectRatio":this._aspectRatio=!!e}},_setupHandles:function(){var t,e,i,s,n,o=this.options,h=this;if(this.handles=o.handles||(y(".ui-resizable-handle",this.element).length?{n:".ui-resizable-n",e:".ui-resizable-e",s:".ui-resizable-s",w:".ui-resizable-w",se:".ui-resizable-se",sw:".ui-resizable-sw",ne:".ui-resizable-ne",nw:".ui-resizable-nw"}:"e,s,se"),this._handles=y(),this._addedHandles=y(),this.handles.constructor===String)for("all"===this.handles&&(this.handles="n,e,s,w,se,sw,ne,nw"),i=this.handles.split(","),this.handles={},e=0;e"),this._addClass(n,"ui-resizable-handle "+s),n.css({zIndex:o.zIndex}),this.handles[t]=".ui-resizable-"+t,this.element.children(this.handles[t]).length||(this.element.append(n),this._addedHandles=this._addedHandles.add(n));this._renderAxis=function(t){var e,i,s;for(e in t=t||this.element,this.handles)this.handles[e].constructor===String?this.handles[e]=this.element.children(this.handles[e]).first().show():(this.handles[e].jquery||this.handles[e].nodeType)&&(this.handles[e]=y(this.handles[e]),this._on(this.handles[e],{mousedown:h._mouseDown})),this.elementIsWrapper&&this.originalElement[0].nodeName.match(/^(textarea|input|select|button)$/i)&&(i=y(this.handles[e],this.element),s=/sw|ne|nw|se|n|s/.test(e)?i.outerHeight():i.outerWidth(),i=["padding",/ne|nw|n/.test(e)?"Top":/se|sw|s/.test(e)?"Bottom":/^e$/.test(e)?"Right":"Left"].join(""),t.css(i,s),this._proportionallyResize()),this._handles=this._handles.add(this.handles[e])},this._renderAxis(this.element),this._handles=this._handles.add(this.element.find(".ui-resizable-handle")),this._handles.disableSelection(),this._handles.on("mouseover",function(){h.resizing||(this.className&&(n=this.className.match(/ui-resizable-(se|sw|ne|nw|n|e|s|w)/i)),h.axis=n&&n[1]?n[1]:"se")}),o.autoHide&&(this._handles.hide(),this._addClass("ui-resizable-autohide"))},_removeHandles:function(){this._addedHandles.remove()},_mouseCapture:function(t){var e,i,s=!1;for(e in this.handles)(i=y(this.handles[e])[0])!==t.target&&!y.contains(i,t.target)||(s=!0);return!this.options.disabled&&s},_mouseStart:function(t){var e,i,s=this.options,n=this.element;return this.resizing=!0,this._renderProxy(),e=this._num(this.helper.css("left")),i=this._num(this.helper.css("top")),s.containment&&(e+=y(s.containment).scrollLeft()||0,i+=y(s.containment).scrollTop()||0),this.offset=this.helper.offset(),this.position={left:e,top:i},this.size=this._helper?{width:this.helper.width(),height:this.helper.height()}:{width:n.width(),height:n.height()},this.originalSize=this._helper?{width:n.outerWidth(),height:n.outerHeight()}:{width:n.width(),height:n.height()},this.sizeDiff={width:n.outerWidth()-n.width(),height:n.outerHeight()-n.height()},this.originalPosition={left:e,top:i},this.originalMousePosition={left:t.pageX,top:t.pageY},this.aspectRatio="number"==typeof s.aspectRatio?s.aspectRatio:this.originalSize.width/this.originalSize.height||1,s=y(".ui-resizable-"+this.axis).css("cursor"),y("body").css("cursor","auto"===s?this.axis+"-resize":s),this._addClass("ui-resizable-resizing"),this._propagate("start",t),!0},_mouseDrag:function(t){var e=this.originalMousePosition,i=this.axis,s=t.pageX-e.left||0,e=t.pageY-e.top||0,i=this._change[i];return this._updatePrevProperties(),i&&(e=i.apply(this,[t,s,e]),this._updateVirtualBoundaries(t.shiftKey),(this._aspectRatio||t.shiftKey)&&(e=this._updateRatio(e,t)),e=this._respectSize(e,t),this._updateCache(e),this._propagate("resize",t),e=this._applyChanges(),!this._helper&&this._proportionallyResizeElements.length&&this._proportionallyResize(),y.isEmptyObject(e)||(this._updatePrevProperties(),this._trigger("resize",t,this.ui()),this._applyChanges())),!1},_mouseStop:function(t){this.resizing=!1;var e,i,s,n=this.options,o=this;return this._helper&&(s=(e=(i=this._proportionallyResizeElements).length&&/textarea/i.test(i[0].nodeName))&&this._hasScroll(i[0],"left")?0:o.sizeDiff.height,i=e?0:o.sizeDiff.width,e={width:o.helper.width()-i,height:o.helper.height()-s},i=parseFloat(o.element.css("left"))+(o.position.left-o.originalPosition.left)||null,s=parseFloat(o.element.css("top"))+(o.position.top-o.originalPosition.top)||null,n.animate||this.element.css(y.extend(e,{top:s,left:i})),o.helper.height(o.size.height),o.helper.width(o.size.width),this._helper&&!n.animate&&this._proportionallyResize()),y("body").css("cursor","auto"),this._removeClass("ui-resizable-resizing"),this._propagate("stop",t),this._helper&&this.helper.remove(),!1},_updatePrevProperties:function(){this.prevPosition={top:this.position.top,left:this.position.left},this.prevSize={width:this.size.width,height:this.size.height}},_applyChanges:function(){var t={};return this.position.top!==this.prevPosition.top&&(t.top=this.position.top+"px"),this.position.left!==this.prevPosition.left&&(t.left=this.position.left+"px"),this.size.width!==this.prevSize.width&&(t.width=this.size.width+"px"),this.size.height!==this.prevSize.height&&(t.height=this.size.height+"px"),this.helper.css(t),t},_updateVirtualBoundaries:function(t){var e,i,s=this.options,n={minWidth:this._isNumber(s.minWidth)?s.minWidth:0,maxWidth:this._isNumber(s.maxWidth)?s.maxWidth:1/0,minHeight:this._isNumber(s.minHeight)?s.minHeight:0,maxHeight:this._isNumber(s.maxHeight)?s.maxHeight:1/0};(this._aspectRatio||t)&&(e=n.minHeight*this.aspectRatio,i=n.minWidth/this.aspectRatio,s=n.maxHeight*this.aspectRatio,t=n.maxWidth/this.aspectRatio,e>n.minWidth&&(n.minWidth=e),i>n.minHeight&&(n.minHeight=i),st.width,h=this._isNumber(t.height)&&e.minHeight&&e.minHeight>t.height,a=this.originalPosition.left+this.originalSize.width,r=this.originalPosition.top+this.originalSize.height,l=/sw|nw|w/.test(i),i=/nw|ne|n/.test(i);return o&&(t.width=e.minWidth),h&&(t.height=e.minHeight),s&&(t.width=e.maxWidth),n&&(t.height=e.maxHeight),o&&l&&(t.left=a-e.minWidth),s&&l&&(t.left=a-e.maxWidth),h&&i&&(t.top=r-e.minHeight),n&&i&&(t.top=r-e.maxHeight),t.width||t.height||t.left||!t.top?t.width||t.height||t.top||!t.left||(t.left=null):t.top=null,t},_getPaddingPlusBorderDimensions:function(t){for(var e=0,i=[],s=[t.css("borderTopWidth"),t.css("borderRightWidth"),t.css("borderBottomWidth"),t.css("borderLeftWidth")],n=[t.css("paddingTop"),t.css("paddingRight"),t.css("paddingBottom"),t.css("paddingLeft")];e<4;e++)i[e]=parseFloat(s[e])||0,i[e]+=parseFloat(n[e])||0;return{height:i[0]+i[2],width:i[1]+i[3]}},_proportionallyResize:function(){if(this._proportionallyResizeElements.length)for(var t,e=0,i=this.helper||this.element;e").css({overflow:"hidden"}),this._addClass(this.helper,this._helper),this.helper.css({width:this.element.outerWidth(),height:this.element.outerHeight(),position:"absolute",left:this.elementOffset.left+"px",top:this.elementOffset.top+"px",zIndex:++e.zIndex}),this.helper.appendTo("body").disableSelection()):this.helper=this.element},_change:{e:function(t,e){return{width:this.originalSize.width+e}},w:function(t,e){var i=this.originalSize;return{left:this.originalPosition.left+e,width:i.width-e}},n:function(t,e,i){var s=this.originalSize;return{top:this.originalPosition.top+i,height:s.height-i}},s:function(t,e,i){return{height:this.originalSize.height+i}},se:function(t,e,i){return y.extend(this._change.s.apply(this,arguments),this._change.e.apply(this,[t,e,i]))},sw:function(t,e,i){return y.extend(this._change.s.apply(this,arguments),this._change.w.apply(this,[t,e,i]))},ne:function(t,e,i){return y.extend(this._change.n.apply(this,arguments),this._change.e.apply(this,[t,e,i]))},nw:function(t,e,i){return y.extend(this._change.n.apply(this,arguments),this._change.w.apply(this,[t,e,i]))}},_propagate:function(t,e){y.ui.plugin.call(this,t,[e,this.ui()]),"resize"!==t&&this._trigger(t,e,this.ui())},plugins:{},ui:function(){return{originalElement:this.originalElement,element:this.element,helper:this.helper,position:this.position,size:this.size,originalSize:this.originalSize,originalPosition:this.originalPosition}}}),y.ui.plugin.add("resizable","animate",{stop:function(e){var i=y(this).resizable("instance"),t=i.options,s=i._proportionallyResizeElements,n=s.length&&/textarea/i.test(s[0].nodeName),o=n&&i._hasScroll(s[0],"left")?0:i.sizeDiff.height,h=n?0:i.sizeDiff.width,n={width:i.size.width-h,height:i.size.height-o},h=parseFloat(i.element.css("left"))+(i.position.left-i.originalPosition.left)||null,o=parseFloat(i.element.css("top"))+(i.position.top-i.originalPosition.top)||null;i.element.animate(y.extend(n,o&&h?{top:o,left:h}:{}),{duration:t.animateDuration,easing:t.animateEasing,step:function(){var t={width:parseFloat(i.element.css("width")),height:parseFloat(i.element.css("height")),top:parseFloat(i.element.css("top")),left:parseFloat(i.element.css("left"))};s&&s.length&&y(s[0]).css({width:t.width,height:t.height}),i._updateCache(t),i._propagate("resize",e)}})}}),y.ui.plugin.add("resizable","containment",{start:function(){var i,s,n=y(this).resizable("instance"),t=n.options,e=n.element,o=t.containment,h=o instanceof y?o.get(0):/parent/.test(o)?e.parent().get(0):o;h&&(n.containerElement=y(h),/document/.test(o)||o===document?(n.containerOffset={left:0,top:0},n.containerPosition={left:0,top:0},n.parentData={element:y(document),left:0,top:0,width:y(document).width(),height:y(document).height()||document.body.parentNode.scrollHeight}):(i=y(h),s=[],y(["Top","Right","Left","Bottom"]).each(function(t,e){s[t]=n._num(i.css("padding"+e))}),n.containerOffset=i.offset(),n.containerPosition=i.position(),n.containerSize={height:i.innerHeight()-s[3],width:i.innerWidth()-s[1]},t=n.containerOffset,e=n.containerSize.height,o=n.containerSize.width,o=n._hasScroll(h,"left")?h.scrollWidth:o,e=n._hasScroll(h)?h.scrollHeight:e,n.parentData={element:h,left:t.left,top:t.top,width:o,height:e}))},resize:function(t){var e=y(this).resizable("instance"),i=e.options,s=e.containerOffset,n=e.position,o=e._aspectRatio||t.shiftKey,h={top:0,left:0},a=e.containerElement,t=!0;a[0]!==document&&/static/.test(a.css("position"))&&(h=s),n.left<(e._helper?s.left:0)&&(e.size.width=e.size.width+(e._helper?e.position.left-s.left:e.position.left-h.left),o&&(e.size.height=e.size.width/e.aspectRatio,t=!1),e.position.left=i.helper?s.left:0),n.top<(e._helper?s.top:0)&&(e.size.height=e.size.height+(e._helper?e.position.top-s.top:e.position.top),o&&(e.size.width=e.size.height*e.aspectRatio,t=!1),e.position.top=e._helper?s.top:0),i=e.containerElement.get(0)===e.element.parent().get(0),n=/relative|absolute/.test(e.containerElement.css("position")),i&&n?(e.offset.left=e.parentData.left+e.position.left,e.offset.top=e.parentData.top+e.position.top):(e.offset.left=e.element.offset().left,e.offset.top=e.element.offset().top),n=Math.abs(e.sizeDiff.width+(e._helper?e.offset.left-h.left:e.offset.left-s.left)),s=Math.abs(e.sizeDiff.height+(e._helper?e.offset.top-h.top:e.offset.top-s.top)),n+e.size.width>=e.parentData.width&&(e.size.width=e.parentData.width-n,o&&(e.size.height=e.size.width/e.aspectRatio,t=!1)),s+e.size.height>=e.parentData.height&&(e.size.height=e.parentData.height-s,o&&(e.size.width=e.size.height*e.aspectRatio,t=!1)),t||(e.position.left=e.prevPosition.left,e.position.top=e.prevPosition.top,e.size.width=e.prevSize.width,e.size.height=e.prevSize.height)},stop:function(){var t=y(this).resizable("instance"),e=t.options,i=t.containerOffset,s=t.containerPosition,n=t.containerElement,o=y(t.helper),h=o.offset(),a=o.outerWidth()-t.sizeDiff.width,o=o.outerHeight()-t.sizeDiff.height;t._helper&&!e.animate&&/relative/.test(n.css("position"))&&y(this).css({left:h.left-s.left-i.left,width:a,height:o}),t._helper&&!e.animate&&/static/.test(n.css("position"))&&y(this).css({left:h.left-s.left-i.left,width:a,height:o})}}),y.ui.plugin.add("resizable","alsoResize",{start:function(){var t=y(this).resizable("instance").options;y(t.alsoResize).each(function(){var t=y(this);t.data("ui-resizable-alsoresize",{width:parseFloat(t.width()),height:parseFloat(t.height()),left:parseFloat(t.css("left")),top:parseFloat(t.css("top"))})})},resize:function(t,i){var e=y(this).resizable("instance"),s=e.options,n=e.originalSize,o=e.originalPosition,h={height:e.size.height-n.height||0,width:e.size.width-n.width||0,top:e.position.top-o.top||0,left:e.position.left-o.left||0};y(s.alsoResize).each(function(){var t=y(this),s=y(this).data("ui-resizable-alsoresize"),n={},e=t.parents(i.originalElement[0]).length?["width","height"]:["width","height","top","left"];y.each(e,function(t,e){var i=(s[e]||0)+(h[e]||0);i&&0<=i&&(n[e]=i||null)}),t.css(n)})},stop:function(){y(this).removeData("ui-resizable-alsoresize")}}),y.ui.plugin.add("resizable","ghost",{start:function(){var t=y(this).resizable("instance"),e=t.size;t.ghost=t.originalElement.clone(),t.ghost.css({opacity:.25,display:"block",position:"relative",height:e.height,width:e.width,margin:0,left:0,top:0}),t._addClass(t.ghost,"ui-resizable-ghost"),!1!==y.uiBackCompat&&"string"==typeof t.options.ghost&&t.ghost.addClass(this.options.ghost),t.ghost.appendTo(t.helper)},resize:function(){var t=y(this).resizable("instance");t.ghost&&t.ghost.css({position:"relative",height:t.size.height,width:t.size.width})},stop:function(){var t=y(this).resizable("instance");t.ghost&&t.helper&&t.helper.get(0).removeChild(t.ghost.get(0))}}),y.ui.plugin.add("resizable","grid",{resize:function(){var t,e=y(this).resizable("instance"),i=e.options,s=e.size,n=e.originalSize,o=e.originalPosition,h=e.axis,a="number"==typeof i.grid?[i.grid,i.grid]:i.grid,r=a[0]||1,l=a[1]||1,u=Math.round((s.width-n.width)/r)*r,p=Math.round((s.height-n.height)/l)*l,d=n.width+u,c=n.height+p,f=i.maxWidth&&i.maxWidthd,s=i.minHeight&&i.minHeight>c;i.grid=a,m&&(d+=r),s&&(c+=l),f&&(d-=r),g&&(c-=l),/^(se|s|e)$/.test(h)?(e.size.width=d,e.size.height=c):/^(ne)$/.test(h)?(e.size.width=d,e.size.height=c,e.position.top=o.top-p):/^(sw)$/.test(h)?(e.size.width=d,e.size.height=c,e.position.left=o.left-u):((c-l<=0||d-r<=0)&&(t=e._getPaddingPlusBorderDimensions(this)),0=f[g]?0:Math.min(f[g],n));!a&&1-1){targetElements.on(evt+EVENT_NAMESPACE,function elementToggle(event){$.powerTip.toggle(this,event)})}else{targetElements.on(evt+EVENT_NAMESPACE,function elementOpen(event){$.powerTip.show(this,event)})}});$.each(options.closeEvents,function(idx,evt){if($.inArray(evt,options.openEvents)<0){targetElements.on(evt+EVENT_NAMESPACE,function elementClose(event){$.powerTip.hide(this,!isMouseEvent(event))})}});targetElements.on("keydown"+EVENT_NAMESPACE,function elementKeyDown(event){if(event.keyCode===27){$.powerTip.hide(this,true)}})}return targetElements};$.fn.powerTip.defaults={fadeInTime:200,fadeOutTime:100,followMouse:false,popupId:"powerTip",popupClass:null,intentSensitivity:7,intentPollInterval:100,closeDelay:100,placement:"n",smartPlacement:false,offset:10,mouseOnToPopup:false,manual:false,openEvents:["mouseenter","focus"],closeEvents:["mouseleave","blur"]};$.fn.powerTip.smartPlacementLists={n:["n","ne","nw","s"],e:["e","ne","se","w","nw","sw","n","s","e"],s:["s","se","sw","n"],w:["w","nw","sw","e","ne","se","n","s","w"],nw:["nw","w","sw","n","s","se","nw"],ne:["ne","e","se","n","s","sw","ne"],sw:["sw","w","nw","s","n","ne","sw"],se:["se","e","ne","s","n","nw","se"],"nw-alt":["nw-alt","n","ne-alt","sw-alt","s","se-alt","w","e"],"ne-alt":["ne-alt","n","nw-alt","se-alt","s","sw-alt","e","w"],"sw-alt":["sw-alt","s","se-alt","nw-alt","n","ne-alt","w","e"],"se-alt":["se-alt","s","sw-alt","ne-alt","n","nw-alt","e","w"]};$.powerTip={show:function apiShowTip(element,event){if(isMouseEvent(event)){trackMouse(event);session.previousX=event.pageX;session.previousY=event.pageY;$(element).data(DATA_DISPLAYCONTROLLER).show()}else{$(element).first().data(DATA_DISPLAYCONTROLLER).show(true,true)}return element},reposition:function apiResetPosition(element){$(element).first().data(DATA_DISPLAYCONTROLLER).resetPosition();return element},hide:function apiCloseTip(element,immediate){var displayController;immediate=element?immediate:true;if(element){displayController=$(element).first().data(DATA_DISPLAYCONTROLLER)}else if(session.activeHover){displayController=session.activeHover.data(DATA_DISPLAYCONTROLLER)}if(displayController){displayController.hide(immediate)}return element},toggle:function apiToggle(element,event){if(session.activeHover&&session.activeHover.is(element)){$.powerTip.hide(element,!isMouseEvent(event))}else{$.powerTip.show(element,event)}return element}};$.powerTip.showTip=$.powerTip.show;$.powerTip.closeTip=$.powerTip.hide;function CSSCoordinates(){var me=this;me.top="auto";me.left="auto";me.right="auto";me.bottom="auto";me.set=function(property,value){if($.isNumeric(value)){me[property]=Math.round(value)}}}function DisplayController(element,options,tipController){var hoverTimer=null,myCloseDelay=null;function openTooltip(immediate,forceOpen){cancelTimer();if(!element.data(DATA_HASACTIVEHOVER)){if(!immediate){session.tipOpenImminent=true;hoverTimer=setTimeout(function intentDelay(){hoverTimer=null;checkForIntent()},options.intentPollInterval)}else{if(forceOpen){element.data(DATA_FORCEDOPEN,true)}closeAnyDelayed();tipController.showTip(element)}}else{cancelClose()}}function closeTooltip(disableDelay){if(myCloseDelay){myCloseDelay=session.closeDelayTimeout=clearTimeout(myCloseDelay);session.delayInProgress=false}cancelTimer();session.tipOpenImminent=false;if(element.data(DATA_HASACTIVEHOVER)){element.data(DATA_FORCEDOPEN,false);if(!disableDelay){session.delayInProgress=true;session.closeDelayTimeout=setTimeout(function closeDelay(){session.closeDelayTimeout=null;tipController.hideTip(element);session.delayInProgress=false;myCloseDelay=null},options.closeDelay);myCloseDelay=session.closeDelayTimeout}else{tipController.hideTip(element)}}}function checkForIntent(){var xDifference=Math.abs(session.previousX-session.currentX),yDifference=Math.abs(session.previousY-session.currentY),totalDifference=xDifference+yDifference;if(totalDifference",{id:options.popupId});if($body.length===0){$body=$("body")}$body.append(tipElement);session.tooltips=session.tooltips?session.tooltips.add(tipElement):tipElement}if(options.followMouse){if(!tipElement.data(DATA_HASMOUSEMOVE)){$document.on("mousemove"+EVENT_NAMESPACE,positionTipOnCursor);$window.on("scroll"+EVENT_NAMESPACE,positionTipOnCursor);tipElement.data(DATA_HASMOUSEMOVE,true)}}function beginShowTip(element){element.data(DATA_HASACTIVEHOVER,true);tipElement.queue(function queueTipInit(next){showTip(element);next()})}function showTip(element){var tipContent;if(!element.data(DATA_HASACTIVEHOVER)){return}if(session.isTipOpen){if(!session.isClosing){hideTip(session.activeHover)}tipElement.delay(100).queue(function queueTipAgain(next){showTip(element);next()});return}element.trigger("powerTipPreRender");tipContent=getTooltipContent(element);if(tipContent){tipElement.empty().append(tipContent)}else{return}element.trigger("powerTipRender");session.activeHover=element;session.isTipOpen=true;tipElement.data(DATA_MOUSEONTOTIP,options.mouseOnToPopup);tipElement.addClass(options.popupClass);if(!options.followMouse||element.data(DATA_FORCEDOPEN)){positionTipOnElement(element);session.isFixedTipOpen=true}else{positionTipOnCursor()}if(!element.data(DATA_FORCEDOPEN)&&!options.followMouse){$document.on("click"+EVENT_NAMESPACE,function documentClick(event){var target=event.target;if(target!==element[0]){if(options.mouseOnToPopup){if(target!==tipElement[0]&&!$.contains(tipElement[0],target)){$.powerTip.hide()}}else{$.powerTip.hide()}}})}if(options.mouseOnToPopup&&!options.manual){tipElement.on("mouseenter"+EVENT_NAMESPACE,function tipMouseEnter(){if(session.activeHover){session.activeHover.data(DATA_DISPLAYCONTROLLER).cancel()}});tipElement.on("mouseleave"+EVENT_NAMESPACE,function tipMouseLeave(){if(session.activeHover){session.activeHover.data(DATA_DISPLAYCONTROLLER).hide()}})}tipElement.fadeIn(options.fadeInTime,function fadeInCallback(){if(!session.desyncTimeout){session.desyncTimeout=setInterval(closeDesyncedTip,500)}element.trigger("powerTipOpen")})}function hideTip(element){session.isClosing=true;session.isTipOpen=false;session.desyncTimeout=clearInterval(session.desyncTimeout);element.data(DATA_HASACTIVEHOVER,false);element.data(DATA_FORCEDOPEN,false);$document.off("click"+EVENT_NAMESPACE);tipElement.off(EVENT_NAMESPACE);tipElement.fadeOut(options.fadeOutTime,function fadeOutCallback(){var coords=new CSSCoordinates;session.activeHover=null;session.isClosing=false;session.isFixedTipOpen=false;tipElement.removeClass();coords.set("top",session.currentY+options.offset);coords.set("left",session.currentX+options.offset);tipElement.css(coords);element.trigger("powerTipClose")})}function positionTipOnCursor(){var tipWidth,tipHeight,coords,collisions,collisionCount;if(!session.isFixedTipOpen&&(session.isTipOpen||session.tipOpenImminent&&tipElement.data(DATA_HASMOUSEMOVE))){tipWidth=tipElement.outerWidth();tipHeight=tipElement.outerHeight();coords=new CSSCoordinates;coords.set("top",session.currentY+options.offset);coords.set("left",session.currentX+options.offset);collisions=getViewportCollisions(coords,tipWidth,tipHeight);if(collisions!==Collision.none){collisionCount=countFlags(collisions);if(collisionCount===1){if(collisions===Collision.right){coords.set("left",session.scrollLeft+session.windowWidth-tipWidth)}else if(collisions===Collision.bottom){coords.set("top",session.scrollTop+session.windowHeight-tipHeight)}}else{coords.set("left",session.currentX-tipWidth-options.offset);coords.set("top",session.currentY-tipHeight-options.offset)}}tipElement.css(coords)}}function positionTipOnElement(element){var priorityList,finalPlacement;if(options.smartPlacement||options.followMouse&&element.data(DATA_FORCEDOPEN)){priorityList=$.fn.powerTip.smartPlacementLists[options.placement];$.each(priorityList,function(idx,pos){var collisions=getViewportCollisions(placeTooltip(element,pos),tipElement.outerWidth(),tipElement.outerHeight());finalPlacement=pos;return collisions!==Collision.none})}else{placeTooltip(element,options.placement);finalPlacement=options.placement}tipElement.removeClass("w nw sw e ne se n s w se-alt sw-alt ne-alt nw-alt");tipElement.addClass(finalPlacement)}function placeTooltip(element,placement){var iterationCount=0,tipWidth,tipHeight,coords=new CSSCoordinates;coords.set("top",0);coords.set("left",0);tipElement.css(coords);do{tipWidth=tipElement.outerWidth();tipHeight=tipElement.outerHeight();coords=placementCalculator.compute(element,placement,tipWidth,tipHeight,options.offset);tipElement.css(coords)}while(++iterationCount<=5&&(tipWidth!==tipElement.outerWidth()||tipHeight!==tipElement.outerHeight()));return coords}function closeDesyncedTip(){var isDesynced=false,hasDesyncableCloseEvent=$.grep(["mouseleave","mouseout","blur","focusout"],function(eventType){return $.inArray(eventType,options.closeEvents)!==-1}).length>0;if(session.isTipOpen&&!session.isClosing&&!session.delayInProgress&&hasDesyncableCloseEvent){if(session.activeHover.data(DATA_HASACTIVEHOVER)===false||session.activeHover.is(":disabled")){isDesynced=true}else if(!isMouseOver(session.activeHover)&&!session.activeHover.is(":focus")&&!session.activeHover.data(DATA_FORCEDOPEN)){if(tipElement.data(DATA_MOUSEONTOTIP)){if(!isMouseOver(tipElement)){isDesynced=true}}else{isDesynced=true}}if(isDesynced){hideTip(session.activeHover)}}}this.showTip=beginShowTip;this.hideTip=hideTip;this.resetPosition=positionTipOnElement}function isSvgElement(element){return Boolean(window.SVGElement&&element[0]instanceof SVGElement)}function isMouseEvent(event){return Boolean(event&&$.inArray(event.type,MOUSE_EVENTS)>-1&&typeof event.pageX==="number")}function initTracking(){if(!session.mouseTrackingActive){session.mouseTrackingActive=true;getViewportDimensions();$(getViewportDimensions);$document.on("mousemove"+EVENT_NAMESPACE,trackMouse);$window.on("resize"+EVENT_NAMESPACE,trackResize);$window.on("scroll"+EVENT_NAMESPACE,trackScroll)}}function getViewportDimensions(){session.scrollLeft=$window.scrollLeft();session.scrollTop=$window.scrollTop();session.windowWidth=$window.width();session.windowHeight=$window.height()}function trackResize(){session.windowWidth=$window.width();session.windowHeight=$window.height()}function trackScroll(){var x=$window.scrollLeft(),y=$window.scrollTop();if(x!==session.scrollLeft){session.currentX+=x-session.scrollLeft;session.scrollLeft=x}if(y!==session.scrollTop){session.currentY+=y-session.scrollTop;session.scrollTop=y}}function trackMouse(event){session.currentX=event.pageX;session.currentY=event.pageY}function isMouseOver(element){var elementPosition=element.offset(),elementBox=element[0].getBoundingClientRect(),elementWidth=elementBox.right-elementBox.left,elementHeight=elementBox.bottom-elementBox.top;return session.currentX>=elementPosition.left&&session.currentX<=elementPosition.left+elementWidth&&session.currentY>=elementPosition.top&&session.currentY<=elementPosition.top+elementHeight}function getTooltipContent(element){var tipText=element.data(DATA_POWERTIP),tipObject=element.data(DATA_POWERTIPJQ),tipTarget=element.data(DATA_POWERTIPTARGET),targetElement,content;if(tipText){if($.isFunction(tipText)){tipText=tipText.call(element[0])}content=tipText}else if(tipObject){if($.isFunction(tipObject)){tipObject=tipObject.call(element[0])}if(tipObject.length>0){content=tipObject.clone(true,true)}}else if(tipTarget){targetElement=$("#"+tipTarget);if(targetElement.length>0){content=targetElement.html()}}return content}function getViewportCollisions(coords,elementWidth,elementHeight){var viewportTop=session.scrollTop,viewportLeft=session.scrollLeft,viewportBottom=viewportTop+session.windowHeight,viewportRight=viewportLeft+session.windowWidth,collisions=Collision.none;if(coords.topviewportBottom||Math.abs(coords.bottom-session.windowHeight)>viewportBottom){collisions|=Collision.bottom}if(coords.leftviewportRight){collisions|=Collision.left}if(coords.left+elementWidth>viewportRight||coords.right1)){a.preventDefault();var c=a.originalEvent.changedTouches[0],d=document.createEvent("MouseEvents");d.initMouseEvent(b,!0,!0,window,1,c.screenX,c.screenY,c.clientX,c.clientY,!1,!1,!1,!1,0,null),a.target.dispatchEvent(d)}}if(a.support.touch="ontouchend"in document,a.support.touch){var e,b=a.ui.mouse.prototype,c=b._mouseInit,d=b._mouseDestroy;b._touchStart=function(a){var b=this;!e&&b._mouseCapture(a.originalEvent.changedTouches[0])&&(e=!0,b._touchMoved=!1,f(a,"mouseover"),f(a,"mousemove"),f(a,"mousedown"))},b._touchMove=function(a){e&&(this._touchMoved=!0,f(a,"mousemove"))},b._touchEnd=function(a){e&&(f(a,"mouseup"),f(a,"mouseout"),this._touchMoved||f(a,"click"),e=!1)},b._mouseInit=function(){var b=this;b.element.bind({touchstart:a.proxy(b,"_touchStart"),touchmove:a.proxy(b,"_touchMove"),touchend:a.proxy(b,"_touchEnd")}),c.call(b)},b._mouseDestroy=function(){var b=this;b.element.unbind({touchstart:a.proxy(b,"_touchStart"),touchmove:a.proxy(b,"_touchMove"),touchend:a.proxy(b,"_touchEnd")}),d.call(b)}}}(jQuery);/*! SmartMenus jQuery Plugin - v1.1.0 - September 17, 2017 + * http://www.smartmenus.org/ + * Copyright Vasil Dinkov, Vadikom Web Ltd. http://vadikom.com; Licensed MIT */(function(t){"function"==typeof define&&define.amd?define(["jquery"],t):"object"==typeof module&&"object"==typeof module.exports?module.exports=t(require("jquery")):t(jQuery)})(function($){function initMouseDetection(t){var e=".smartmenus_mouse";if(mouseDetectionEnabled||t)mouseDetectionEnabled&&t&&($(document).off(e),mouseDetectionEnabled=!1);else{var i=!0,s=null,o={mousemove:function(t){var e={x:t.pageX,y:t.pageY,timeStamp:(new Date).getTime()};if(s){var o=Math.abs(s.x-e.x),a=Math.abs(s.y-e.y);if((o>0||a>0)&&2>=o&&2>=a&&300>=e.timeStamp-s.timeStamp&&(mouse=!0,i)){var n=$(t.target).closest("a");n.is("a")&&$.each(menuTrees,function(){return $.contains(this.$root[0],n[0])?(this.itemEnter({currentTarget:n[0]}),!1):void 0}),i=!1}}s=e}};o[touchEvents?"touchstart":"pointerover pointermove pointerout MSPointerOver MSPointerMove MSPointerOut"]=function(t){isTouchEvent(t.originalEvent)&&(mouse=!1)},$(document).on(getEventsNS(o,e)),mouseDetectionEnabled=!0}}function isTouchEvent(t){return!/^(4|mouse)$/.test(t.pointerType)}function getEventsNS(t,e){e||(e="");var i={};for(var s in t)i[s.split(" ").join(e+" ")+e]=t[s];return i}var menuTrees=[],mouse=!1,touchEvents="ontouchstart"in window,mouseDetectionEnabled=!1,requestAnimationFrame=window.requestAnimationFrame||function(t){return setTimeout(t,1e3/60)},cancelAnimationFrame=window.cancelAnimationFrame||function(t){clearTimeout(t)},canAnimate=!!$.fn.animate;return $.SmartMenus=function(t,e){this.$root=$(t),this.opts=e,this.rootId="",this.accessIdPrefix="",this.$subArrow=null,this.activatedItems=[],this.visibleSubMenus=[],this.showTimeout=0,this.hideTimeout=0,this.scrollTimeout=0,this.clickActivated=!1,this.focusActivated=!1,this.zIndexInc=0,this.idInc=0,this.$firstLink=null,this.$firstSub=null,this.disabled=!1,this.$disableOverlay=null,this.$touchScrollingSub=null,this.cssTransforms3d="perspective"in t.style||"webkitPerspective"in t.style,this.wasCollapsible=!1,this.init()},$.extend($.SmartMenus,{hideAll:function(){$.each(menuTrees,function(){this.menuHideAll()})},destroy:function(){for(;menuTrees.length;)menuTrees[0].destroy();initMouseDetection(!0)},prototype:{init:function(t){var e=this;if(!t){menuTrees.push(this),this.rootId=((new Date).getTime()+Math.random()+"").replace(/\D/g,""),this.accessIdPrefix="sm-"+this.rootId+"-",this.$root.hasClass("sm-rtl")&&(this.opts.rightToLeftSubMenus=!0);var i=".smartmenus";this.$root.data("smartmenus",this).attr("data-smartmenus-id",this.rootId).dataSM("level",1).on(getEventsNS({"mouseover focusin":$.proxy(this.rootOver,this),"mouseout focusout":$.proxy(this.rootOut,this),keydown:$.proxy(this.rootKeyDown,this)},i)).on(getEventsNS({mouseenter:$.proxy(this.itemEnter,this),mouseleave:$.proxy(this.itemLeave,this),mousedown:$.proxy(this.itemDown,this),focus:$.proxy(this.itemFocus,this),blur:$.proxy(this.itemBlur,this),click:$.proxy(this.itemClick,this)},i),"a"),i+=this.rootId,this.opts.hideOnClick&&$(document).on(getEventsNS({touchstart:$.proxy(this.docTouchStart,this),touchmove:$.proxy(this.docTouchMove,this),touchend:$.proxy(this.docTouchEnd,this),click:$.proxy(this.docClick,this)},i)),$(window).on(getEventsNS({"resize orientationchange":$.proxy(this.winResize,this)},i)),this.opts.subIndicators&&(this.$subArrow=$("").addClass("sub-arrow"),this.opts.subIndicatorsText&&this.$subArrow.html(this.opts.subIndicatorsText)),initMouseDetection()}if(this.$firstSub=this.$root.find("ul").each(function(){e.menuInit($(this))}).eq(0),this.$firstLink=this.$root.find("a").eq(0),this.opts.markCurrentItem){var s=/(index|default)\.[^#\?\/]*/i,o=/#.*/,a=window.location.href.replace(s,""),n=a.replace(o,"");this.$root.find("a").each(function(){var t=this.href.replace(s,""),i=$(this);(t==a||t==n)&&(i.addClass("current"),e.opts.markCurrentTree&&i.parentsUntil("[data-smartmenus-id]","ul").each(function(){$(this).dataSM("parent-a").addClass("current")}))})}this.wasCollapsible=this.isCollapsible()},destroy:function(t){if(!t){var e=".smartmenus";this.$root.removeData("smartmenus").removeAttr("data-smartmenus-id").removeDataSM("level").off(e),e+=this.rootId,$(document).off(e),$(window).off(e),this.opts.subIndicators&&(this.$subArrow=null)}this.menuHideAll();var i=this;this.$root.find("ul").each(function(){var t=$(this);t.dataSM("scroll-arrows")&&t.dataSM("scroll-arrows").remove(),t.dataSM("shown-before")&&((i.opts.subMenusMinWidth||i.opts.subMenusMaxWidth)&&t.css({width:"",minWidth:"",maxWidth:""}).removeClass("sm-nowrap"),t.dataSM("scroll-arrows")&&t.dataSM("scroll-arrows").remove(),t.css({zIndex:"",top:"",left:"",marginLeft:"",marginTop:"",display:""})),0==(t.attr("id")||"").indexOf(i.accessIdPrefix)&&t.removeAttr("id")}).removeDataSM("in-mega").removeDataSM("shown-before").removeDataSM("scroll-arrows").removeDataSM("parent-a").removeDataSM("level").removeDataSM("beforefirstshowfired").removeAttr("role").removeAttr("aria-hidden").removeAttr("aria-labelledby").removeAttr("aria-expanded"),this.$root.find("a.has-submenu").each(function(){var t=$(this);0==t.attr("id").indexOf(i.accessIdPrefix)&&t.removeAttr("id")}).removeClass("has-submenu").removeDataSM("sub").removeAttr("aria-haspopup").removeAttr("aria-controls").removeAttr("aria-expanded").closest("li").removeDataSM("sub"),this.opts.subIndicators&&this.$root.find("span.sub-arrow").remove(),this.opts.markCurrentItem&&this.$root.find("a.current").removeClass("current"),t||(this.$root=null,this.$firstLink=null,this.$firstSub=null,this.$disableOverlay&&(this.$disableOverlay.remove(),this.$disableOverlay=null),menuTrees.splice($.inArray(this,menuTrees),1))},disable:function(t){if(!this.disabled){if(this.menuHideAll(),!t&&!this.opts.isPopup&&this.$root.is(":visible")){var e=this.$root.offset();this.$disableOverlay=$('
').css({position:"absolute",top:e.top,left:e.left,width:this.$root.outerWidth(),height:this.$root.outerHeight(),zIndex:this.getStartZIndex(!0),opacity:0}).appendTo(document.body)}this.disabled=!0}},docClick:function(t){return this.$touchScrollingSub?(this.$touchScrollingSub=null,void 0):((this.visibleSubMenus.length&&!$.contains(this.$root[0],t.target)||$(t.target).closest("a").length)&&this.menuHideAll(),void 0)},docTouchEnd:function(){if(this.lastTouch){if(!(!this.visibleSubMenus.length||void 0!==this.lastTouch.x2&&this.lastTouch.x1!=this.lastTouch.x2||void 0!==this.lastTouch.y2&&this.lastTouch.y1!=this.lastTouch.y2||this.lastTouch.target&&$.contains(this.$root[0],this.lastTouch.target))){this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0);var t=this;this.hideTimeout=setTimeout(function(){t.menuHideAll()},350)}this.lastTouch=null}},docTouchMove:function(t){if(this.lastTouch){var e=t.originalEvent.touches[0];this.lastTouch.x2=e.pageX,this.lastTouch.y2=e.pageY}},docTouchStart:function(t){var e=t.originalEvent.touches[0];this.lastTouch={x1:e.pageX,y1:e.pageY,target:e.target}},enable:function(){this.disabled&&(this.$disableOverlay&&(this.$disableOverlay.remove(),this.$disableOverlay=null),this.disabled=!1)},getClosestMenu:function(t){for(var e=$(t).closest("ul");e.dataSM("in-mega");)e=e.parent().closest("ul");return e[0]||null},getHeight:function(t){return this.getOffset(t,!0)},getOffset:function(t,e){var i;"none"==t.css("display")&&(i={position:t[0].style.position,visibility:t[0].style.visibility},t.css({position:"absolute",visibility:"hidden"}).show());var s=t[0].getBoundingClientRect&&t[0].getBoundingClientRect(),o=s&&(e?s.height||s.bottom-s.top:s.width||s.right-s.left);return o||0===o||(o=e?t[0].offsetHeight:t[0].offsetWidth),i&&t.hide().css(i),o},getStartZIndex:function(t){var e=parseInt(this[t?"$root":"$firstSub"].css("z-index"));return!t&&isNaN(e)&&(e=parseInt(this.$root.css("z-index"))),isNaN(e)?1:e},getTouchPoint:function(t){return t.touches&&t.touches[0]||t.changedTouches&&t.changedTouches[0]||t},getViewport:function(t){var e=t?"Height":"Width",i=document.documentElement["client"+e],s=window["inner"+e];return s&&(i=Math.min(i,s)),i},getViewportHeight:function(){return this.getViewport(!0)},getViewportWidth:function(){return this.getViewport()},getWidth:function(t){return this.getOffset(t)},handleEvents:function(){return!this.disabled&&this.isCSSOn()},handleItemEvents:function(t){return this.handleEvents()&&!this.isLinkInMegaMenu(t)},isCollapsible:function(){return"static"==this.$firstSub.css("position")},isCSSOn:function(){return"inline"!=this.$firstLink.css("display")},isFixed:function(){var t="fixed"==this.$root.css("position");return t||this.$root.parentsUntil("body").each(function(){return"fixed"==$(this).css("position")?(t=!0,!1):void 0}),t},isLinkInMegaMenu:function(t){return $(this.getClosestMenu(t[0])).hasClass("mega-menu")},isTouchMode:function(){return!mouse||this.opts.noMouseOver||this.isCollapsible()},itemActivate:function(t,e){var i=t.closest("ul"),s=i.dataSM("level");if(s>1&&(!this.activatedItems[s-2]||this.activatedItems[s-2][0]!=i.dataSM("parent-a")[0])){var o=this;$(i.parentsUntil("[data-smartmenus-id]","ul").get().reverse()).add(i).each(function(){o.itemActivate($(this).dataSM("parent-a"))})}if((!this.isCollapsible()||e)&&this.menuHideSubMenus(this.activatedItems[s-1]&&this.activatedItems[s-1][0]==t[0]?s:s-1),this.activatedItems[s-1]=t,this.$root.triggerHandler("activate.smapi",t[0])!==!1){var a=t.dataSM("sub");a&&(this.isTouchMode()||!this.opts.showOnClick||this.clickActivated)&&this.menuShow(a)}},itemBlur:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&this.$root.triggerHandler("blur.smapi",e[0])},itemClick:function(t){var e=$(t.currentTarget);if(this.handleItemEvents(e)){if(this.$touchScrollingSub&&this.$touchScrollingSub[0]==e.closest("ul")[0])return this.$touchScrollingSub=null,t.stopPropagation(),!1;if(this.$root.triggerHandler("click.smapi",e[0])===!1)return!1;var i=$(t.target).is(".sub-arrow"),s=e.dataSM("sub"),o=s?2==s.dataSM("level"):!1,a=this.isCollapsible(),n=/toggle$/.test(this.opts.collapsibleBehavior),r=/link$/.test(this.opts.collapsibleBehavior),h=/^accordion/.test(this.opts.collapsibleBehavior);if(s&&!s.is(":visible")){if((!r||!a||i)&&(this.opts.showOnClick&&o&&(this.clickActivated=!0),this.itemActivate(e,h),s.is(":visible")))return this.focusActivated=!0,!1}else if(a&&(n||i))return this.itemActivate(e,h),this.menuHide(s),n&&(this.focusActivated=!1),!1;return this.opts.showOnClick&&o||e.hasClass("disabled")||this.$root.triggerHandler("select.smapi",e[0])===!1?!1:void 0}},itemDown:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&e.dataSM("mousedown",!0)},itemEnter:function(t){var e=$(t.currentTarget);if(this.handleItemEvents(e)){if(!this.isTouchMode()){this.showTimeout&&(clearTimeout(this.showTimeout),this.showTimeout=0);var i=this;this.showTimeout=setTimeout(function(){i.itemActivate(e)},this.opts.showOnClick&&1==e.closest("ul").dataSM("level")?1:this.opts.showTimeout)}this.$root.triggerHandler("mouseenter.smapi",e[0])}},itemFocus:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&(!this.focusActivated||this.isTouchMode()&&e.dataSM("mousedown")||this.activatedItems.length&&this.activatedItems[this.activatedItems.length-1][0]==e[0]||this.itemActivate(e,!0),this.$root.triggerHandler("focus.smapi",e[0]))},itemLeave:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&(this.isTouchMode()||(e[0].blur(),this.showTimeout&&(clearTimeout(this.showTimeout),this.showTimeout=0)),e.removeDataSM("mousedown"),this.$root.triggerHandler("mouseleave.smapi",e[0]))},menuHide:function(t){if(this.$root.triggerHandler("beforehide.smapi",t[0])!==!1&&(canAnimate&&t.stop(!0,!0),"none"!=t.css("display"))){var e=function(){t.css("z-index","")};this.isCollapsible()?canAnimate&&this.opts.collapsibleHideFunction?this.opts.collapsibleHideFunction.call(this,t,e):t.hide(this.opts.collapsibleHideDuration,e):canAnimate&&this.opts.hideFunction?this.opts.hideFunction.call(this,t,e):t.hide(this.opts.hideDuration,e),t.dataSM("scroll")&&(this.menuScrollStop(t),t.css({"touch-action":"","-ms-touch-action":"","-webkit-transform":"",transform:""}).off(".smartmenus_scroll").removeDataSM("scroll").dataSM("scroll-arrows").hide()),t.dataSM("parent-a").removeClass("highlighted").attr("aria-expanded","false"),t.attr({"aria-expanded":"false","aria-hidden":"true"});var i=t.dataSM("level");this.activatedItems.splice(i-1,1),this.visibleSubMenus.splice($.inArray(t,this.visibleSubMenus),1),this.$root.triggerHandler("hide.smapi",t[0])}},menuHideAll:function(){this.showTimeout&&(clearTimeout(this.showTimeout),this.showTimeout=0);for(var t=this.opts.isPopup?1:0,e=this.visibleSubMenus.length-1;e>=t;e--)this.menuHide(this.visibleSubMenus[e]);this.opts.isPopup&&(canAnimate&&this.$root.stop(!0,!0),this.$root.is(":visible")&&(canAnimate&&this.opts.hideFunction?this.opts.hideFunction.call(this,this.$root):this.$root.hide(this.opts.hideDuration))),this.activatedItems=[],this.visibleSubMenus=[],this.clickActivated=!1,this.focusActivated=!1,this.zIndexInc=0,this.$root.triggerHandler("hideAll.smapi")},menuHideSubMenus:function(t){for(var e=this.activatedItems.length-1;e>=t;e--){var i=this.activatedItems[e].dataSM("sub");i&&this.menuHide(i)}},menuInit:function(t){if(!t.dataSM("in-mega")){t.hasClass("mega-menu")&&t.find("ul").dataSM("in-mega",!0);for(var e=2,i=t[0];(i=i.parentNode.parentNode)!=this.$root[0];)e++;var s=t.prevAll("a").eq(-1);s.length||(s=t.prevAll().find("a").eq(-1)),s.addClass("has-submenu").dataSM("sub",t),t.dataSM("parent-a",s).dataSM("level",e).parent().dataSM("sub",t);var o=s.attr("id")||this.accessIdPrefix+ ++this.idInc,a=t.attr("id")||this.accessIdPrefix+ ++this.idInc;s.attr({id:o,"aria-haspopup":"true","aria-controls":a,"aria-expanded":"false"}),t.attr({id:a,role:"group","aria-hidden":"true","aria-labelledby":o,"aria-expanded":"false"}),this.opts.subIndicators&&s[this.opts.subIndicatorsPos](this.$subArrow.clone())}},menuPosition:function(t){var e,i,s=t.dataSM("parent-a"),o=s.closest("li"),a=o.parent(),n=t.dataSM("level"),r=this.getWidth(t),h=this.getHeight(t),u=s.offset(),l=u.left,c=u.top,d=this.getWidth(s),m=this.getHeight(s),p=$(window),f=p.scrollLeft(),v=p.scrollTop(),b=this.getViewportWidth(),S=this.getViewportHeight(),g=a.parent().is("[data-sm-horizontal-sub]")||2==n&&!a.hasClass("sm-vertical"),M=this.opts.rightToLeftSubMenus&&!o.is("[data-sm-reverse]")||!this.opts.rightToLeftSubMenus&&o.is("[data-sm-reverse]"),w=2==n?this.opts.mainMenuSubOffsetX:this.opts.subMenusSubOffsetX,T=2==n?this.opts.mainMenuSubOffsetY:this.opts.subMenusSubOffsetY;if(g?(e=M?d-r-w:w,i=this.opts.bottomToTopSubMenus?-h-T:m+T):(e=M?w-r:d-w,i=this.opts.bottomToTopSubMenus?m-T-h:T),this.opts.keepInViewport){var y=l+e,I=c+i;if(M&&f>y?e=g?f-y+e:d-w:!M&&y+r>f+b&&(e=g?f+b-r-y+e:w-r),g||(S>h&&I+h>v+S?i+=v+S-h-I:(h>=S||v>I)&&(i+=v-I)),g&&(I+h>v+S+.49||v>I)||!g&&h>S+.49){var x=this;t.dataSM("scroll-arrows")||t.dataSM("scroll-arrows",$([$('')[0],$('')[0]]).on({mouseenter:function(){t.dataSM("scroll").up=$(this).hasClass("scroll-up"),x.menuScroll(t)},mouseleave:function(e){x.menuScrollStop(t),x.menuScrollOut(t,e)},"mousewheel DOMMouseScroll":function(t){t.preventDefault()}}).insertAfter(t));var A=".smartmenus_scroll";if(t.dataSM("scroll",{y:this.cssTransforms3d?0:i-m,step:1,itemH:m,subH:h,arrowDownH:this.getHeight(t.dataSM("scroll-arrows").eq(1))}).on(getEventsNS({mouseover:function(e){x.menuScrollOver(t,e)},mouseout:function(e){x.menuScrollOut(t,e)},"mousewheel DOMMouseScroll":function(e){x.menuScrollMousewheel(t,e)}},A)).dataSM("scroll-arrows").css({top:"auto",left:"0",marginLeft:e+(parseInt(t.css("border-left-width"))||0),width:r-(parseInt(t.css("border-left-width"))||0)-(parseInt(t.css("border-right-width"))||0),zIndex:t.css("z-index")}).eq(g&&this.opts.bottomToTopSubMenus?0:1).show(),this.isFixed()){var C={};C[touchEvents?"touchstart touchmove touchend":"pointerdown pointermove pointerup MSPointerDown MSPointerMove MSPointerUp"]=function(e){x.menuScrollTouch(t,e)},t.css({"touch-action":"none","-ms-touch-action":"none"}).on(getEventsNS(C,A))}}}t.css({top:"auto",left:"0",marginLeft:e,marginTop:i-m})},menuScroll:function(t,e,i){var s,o=t.dataSM("scroll"),a=t.dataSM("scroll-arrows"),n=o.up?o.upEnd:o.downEnd;if(!e&&o.momentum){if(o.momentum*=.92,s=o.momentum,.5>s)return this.menuScrollStop(t),void 0}else s=i||(e||!this.opts.scrollAccelerate?this.opts.scrollStep:Math.floor(o.step));var r=t.dataSM("level");if(this.activatedItems[r-1]&&this.activatedItems[r-1].dataSM("sub")&&this.activatedItems[r-1].dataSM("sub").is(":visible")&&this.menuHideSubMenus(r-1),o.y=o.up&&o.y>=n||!o.up&&n>=o.y?o.y:Math.abs(n-o.y)>s?o.y+(o.up?s:-s):n,t.css(this.cssTransforms3d?{"-webkit-transform":"translate3d(0, "+o.y+"px, 0)",transform:"translate3d(0, "+o.y+"px, 0)"}:{marginTop:o.y}),mouse&&(o.up&&o.y>o.downEnd||!o.up&&o.y0;t.dataSM("scroll-arrows").eq(i?0:1).is(":visible")&&(t.dataSM("scroll").up=i,this.menuScroll(t,!0))}e.preventDefault()},menuScrollOut:function(t,e){mouse&&(/^scroll-(up|down)/.test((e.relatedTarget||"").className)||(t[0]==e.relatedTarget||$.contains(t[0],e.relatedTarget))&&this.getClosestMenu(e.relatedTarget)==t[0]||t.dataSM("scroll-arrows").css("visibility","hidden"))},menuScrollOver:function(t,e){if(mouse&&!/^scroll-(up|down)/.test(e.target.className)&&this.getClosestMenu(e.target)==t[0]){this.menuScrollRefreshData(t);var i=t.dataSM("scroll"),s=$(window).scrollTop()-t.dataSM("parent-a").offset().top-i.itemH;t.dataSM("scroll-arrows").eq(0).css("margin-top",s).end().eq(1).css("margin-top",s+this.getViewportHeight()-i.arrowDownH).end().css("visibility","visible")}},menuScrollRefreshData:function(t){var e=t.dataSM("scroll"),i=$(window).scrollTop()-t.dataSM("parent-a").offset().top-e.itemH;this.cssTransforms3d&&(i=-(parseFloat(t.css("margin-top"))-i)),$.extend(e,{upEnd:i,downEnd:i+this.getViewportHeight()-e.subH})},menuScrollStop:function(t){return this.scrollTimeout?(cancelAnimationFrame(this.scrollTimeout),this.scrollTimeout=0,t.dataSM("scroll").step=1,!0):void 0},menuScrollTouch:function(t,e){if(e=e.originalEvent,isTouchEvent(e)){var i=this.getTouchPoint(e);if(this.getClosestMenu(i.target)==t[0]){var s=t.dataSM("scroll");if(/(start|down)$/i.test(e.type))this.menuScrollStop(t)?(e.preventDefault(),this.$touchScrollingSub=t):this.$touchScrollingSub=null,this.menuScrollRefreshData(t),$.extend(s,{touchStartY:i.pageY,touchStartTime:e.timeStamp});else if(/move$/i.test(e.type)){var o=void 0!==s.touchY?s.touchY:s.touchStartY;if(void 0!==o&&o!=i.pageY){this.$touchScrollingSub=t;var a=i.pageY>o;void 0!==s.up&&s.up!=a&&$.extend(s,{touchStartY:i.pageY,touchStartTime:e.timeStamp}),$.extend(s,{up:a,touchY:i.pageY}),this.menuScroll(t,!0,Math.abs(i.pageY-o))}e.preventDefault()}else void 0!==s.touchY&&((s.momentum=15*Math.pow(Math.abs(i.pageY-s.touchStartY)/(e.timeStamp-s.touchStartTime),2))&&(this.menuScrollStop(t),this.menuScroll(t),e.preventDefault()),delete s.touchY)}}},menuShow:function(t){if((t.dataSM("beforefirstshowfired")||(t.dataSM("beforefirstshowfired",!0),this.$root.triggerHandler("beforefirstshow.smapi",t[0])!==!1))&&this.$root.triggerHandler("beforeshow.smapi",t[0])!==!1&&(t.dataSM("shown-before",!0),canAnimate&&t.stop(!0,!0),!t.is(":visible"))){var e=t.dataSM("parent-a"),i=this.isCollapsible();if((this.opts.keepHighlighted||i)&&e.addClass("highlighted"),i)t.removeClass("sm-nowrap").css({zIndex:"",width:"auto",minWidth:"",maxWidth:"",top:"",left:"",marginLeft:"",marginTop:""});else{if(t.css("z-index",this.zIndexInc=(this.zIndexInc||this.getStartZIndex())+1),(this.opts.subMenusMinWidth||this.opts.subMenusMaxWidth)&&(t.css({width:"auto",minWidth:"",maxWidth:""}).addClass("sm-nowrap"),this.opts.subMenusMinWidth&&t.css("min-width",this.opts.subMenusMinWidth),this.opts.subMenusMaxWidth)){var s=this.getWidth(t);t.css("max-width",this.opts.subMenusMaxWidth),s>this.getWidth(t)&&t.removeClass("sm-nowrap").css("width",this.opts.subMenusMaxWidth)}this.menuPosition(t)}var o=function(){t.css("overflow","")};i?canAnimate&&this.opts.collapsibleShowFunction?this.opts.collapsibleShowFunction.call(this,t,o):t.show(this.opts.collapsibleShowDuration,o):canAnimate&&this.opts.showFunction?this.opts.showFunction.call(this,t,o):t.show(this.opts.showDuration,o),e.attr("aria-expanded","true"),t.attr({"aria-expanded":"true","aria-hidden":"false"}),this.visibleSubMenus.push(t),this.$root.triggerHandler("show.smapi",t[0])}},popupHide:function(t){this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0);var e=this;this.hideTimeout=setTimeout(function(){e.menuHideAll()},t?1:this.opts.hideTimeout)},popupShow:function(t,e){if(!this.opts.isPopup)return alert('SmartMenus jQuery Error:\n\nIf you want to show this menu via the "popupShow" method, set the isPopup:true option.'),void 0;if(this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0),this.$root.dataSM("shown-before",!0),canAnimate&&this.$root.stop(!0,!0),!this.$root.is(":visible")){this.$root.css({left:t,top:e});var i=this,s=function(){i.$root.css("overflow","")};canAnimate&&this.opts.showFunction?this.opts.showFunction.call(this,this.$root,s):this.$root.show(this.opts.showDuration,s),this.visibleSubMenus[0]=this.$root}},refresh:function(){this.destroy(!0),this.init(!0)},rootKeyDown:function(t){if(this.handleEvents())switch(t.keyCode){case 27:var e=this.activatedItems[0];if(e){this.menuHideAll(),e[0].focus();var i=e.dataSM("sub");i&&this.menuHide(i)}break;case 32:var s=$(t.target);if(s.is("a")&&this.handleItemEvents(s)){var i=s.dataSM("sub");i&&!i.is(":visible")&&(this.itemClick({currentTarget:t.target}),t.preventDefault())}}},rootOut:function(t){if(this.handleEvents()&&!this.isTouchMode()&&t.target!=this.$root[0]&&(this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0),!this.opts.showOnClick||!this.opts.hideOnClick)){var e=this;this.hideTimeout=setTimeout(function(){e.menuHideAll()},this.opts.hideTimeout)}},rootOver:function(t){this.handleEvents()&&!this.isTouchMode()&&t.target!=this.$root[0]&&this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0)},winResize:function(t){if(this.handleEvents()){if(!("onorientationchange"in window)||"orientationchange"==t.type){var e=this.isCollapsible();this.wasCollapsible&&e||(this.activatedItems.length&&this.activatedItems[this.activatedItems.length-1][0].blur(),this.menuHideAll()),this.wasCollapsible=e}}else if(this.$disableOverlay){var i=this.$root.offset();this.$disableOverlay.css({top:i.top,left:i.left,width:this.$root.outerWidth(),height:this.$root.outerHeight()})}}}}),$.fn.dataSM=function(t,e){return e?this.data(t+"_smartmenus",e):this.data(t+"_smartmenus")},$.fn.removeDataSM=function(t){return this.removeData(t+"_smartmenus")},$.fn.smartmenus=function(options){if("string"==typeof options){var args=arguments,method=options;return Array.prototype.shift.call(args),this.each(function(){var t=$(this).data("smartmenus");t&&t[method]&&t[method].apply(t,args)})}return this.each(function(){var dataOpts=$(this).data("sm-options")||null;if(dataOpts)try{dataOpts=eval("("+dataOpts+")")}catch(e){dataOpts=null,alert('ERROR\n\nSmartMenus jQuery init:\nInvalid "data-sm-options" attribute value syntax.')}new $.SmartMenus(this,$.extend({},$.fn.smartmenus.defaults,options,dataOpts))})},$.fn.smartmenus.defaults={isPopup:!1,mainMenuSubOffsetX:0,mainMenuSubOffsetY:0,subMenusSubOffsetX:0,subMenusSubOffsetY:0,subMenusMinWidth:"10em",subMenusMaxWidth:"20em",subIndicators:!0,subIndicatorsPos:"append",subIndicatorsText:"",scrollStep:30,scrollAccelerate:!0,showTimeout:250,hideTimeout:500,showDuration:0,showFunction:null,hideDuration:0,hideFunction:function(t,e){t.fadeOut(200,e)},collapsibleShowDuration:0,collapsibleShowFunction:function(t,e){t.slideDown(200,e)},collapsibleHideDuration:0,collapsibleHideFunction:function(t,e){t.slideUp(200,e)},showOnClick:!1,hideOnClick:!0,noMouseOver:!1,keepInViewport:!0,keepHighlighted:!0,markCurrentItem:!1,markCurrentTree:!0,rightToLeftSubMenus:!1,bottomToTopSubMenus:!1,collapsibleBehavior:"default"},$}); \ No newline at end of file diff --git a/static/api/cpp/3.5.x/menu.js b/static/api/cpp/3.5.x/menu.js new file mode 100644 index 000000000000..b0b26936a0d1 --- /dev/null +++ b/static/api/cpp/3.5.x/menu.js @@ -0,0 +1,136 @@ +/* + @licstart The following is the entire license notice for the JavaScript code in this file. + + The MIT License (MIT) + + Copyright (C) 1997-2020 by Dimitri van Heesch + + Permission is hereby granted, free of charge, to any person obtaining a copy of this software + and associated documentation files (the "Software"), to deal in the Software without restriction, + including without limitation the rights to use, copy, modify, merge, publish, distribute, + sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all copies or + substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + @licend The above is the entire license notice for the JavaScript code in this file + */ +function initMenu(relPath,searchEnabled,serverSide,searchPage,search) { + function makeTree(data,relPath) { + var result=''; + if ('children' in data) { + result+='
    '; + for (var i in data.children) { + var url; + var link; + link = data.children[i].url; + if (link.substring(0,1)=='^') { + url = link.substring(1); + } else { + url = relPath+link; + } + result+='
  • '+ + data.children[i].text+''+ + makeTree(data.children[i],relPath)+'
    • '; + } + result+='
'; + } + return result; + } + var searchBoxHtml; + if (searchEnabled) { + if (serverSide) { + searchBoxHtml='
'+ + '
'+ + '
 '+ + ''+ + '
'+ + '
'+ + '
'+ + '
'; + } else { + searchBoxHtml='
'+ + ''+ + ' '+ + ''+ + ''+ + ''+ + ''+ + ''+ + '
'; + } + } + + $('#main-nav').before('
'+ + ''+ + ''+ + '
'); + $('#main-nav').append(makeTree(menudata,relPath)); + $('#main-nav').children(':first').addClass('sm sm-dox').attr('id','main-menu'); + if (searchBoxHtml) { + $('#main-menu').append('
  • '); + } + var $mainMenuState = $('#main-menu-state'); + var prevWidth = 0; + if ($mainMenuState.length) { + function initResizableIfExists() { + if (typeof initResizable==='function') initResizable(); + } + // animate mobile menu + $mainMenuState.change(function(e) { + var $menu = $('#main-menu'); + var options = { duration: 250, step: initResizableIfExists }; + if (this.checked) { + options['complete'] = function() { $menu.css('display', 'block') }; + $menu.hide().slideDown(options); + } else { + options['complete'] = function() { $menu.css('display', 'none') }; + $menu.show().slideUp(options); + } + }); + // set default menu visibility + function resetState() { + var $menu = $('#main-menu'); + var $mainMenuState = $('#main-menu-state'); + var newWidth = $(window).outerWidth(); + if (newWidth!=prevWidth) { + if ($(window).outerWidth()<768) { + $mainMenuState.prop('checked',false); $menu.hide(); + $('#searchBoxPos1').html(searchBoxHtml); + $('#searchBoxPos2').hide(); + } else { + $menu.show(); + $('#searchBoxPos1').empty(); + $('#searchBoxPos2').html(searchBoxHtml); + $('#searchBoxPos2').show(); + } + if (typeof searchBox!=='undefined') { + searchBox.CloseResultsWindow(); + } + prevWidth = newWidth; + } + } + $(window).ready(function() { resetState(); initResizableIfExists(); }); + $(window).resize(resetState); + } + $('#main-menu').smartmenus(); +} +/* @license-end */ diff --git a/static/api/cpp/3.5.x/menudata.js b/static/api/cpp/3.5.x/menudata.js new file mode 100644 index 000000000000..fda97de18272 --- /dev/null +++ b/static/api/cpp/3.5.x/menudata.js @@ -0,0 +1,110 @@ +/* + @licstart The following is the entire license notice for the JavaScript code in this file. + + The MIT License (MIT) + + Copyright (C) 1997-2020 by Dimitri van Heesch + + Permission is hereby granted, free of charge, to any person obtaining a copy of this software + and associated documentation files (the "Software"), to deal in the Software without restriction, + including without limitation the rights to use, copy, modify, merge, publish, distribute, + sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all copies or + substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + @licend The above is the entire license notice for the JavaScript code in this file +*/ +var menudata={children:[ +{text:"Main Page",url:"index.html"}, +{text:"Related Pages",url:"pages.html"}, +{text:"Namespaces",url:"namespaces.html",children:[ +{text:"Namespace List",url:"namespaces.html"}, +{text:"Namespace Members",url:"namespacemembers.html",children:[ +{text:"All",url:"namespacemembers.html",children:[ +{text:"a",url:"namespacemembers.html#index_a"}, +{text:"b",url:"namespacemembers.html#index_b"}, +{text:"c",url:"namespacemembers.html#index_c"}, +{text:"d",url:"namespacemembers.html#index_d"}, +{text:"f",url:"namespacemembers.html#index_f"}, +{text:"i",url:"namespacemembers.html#index_i"}, +{text:"j",url:"namespacemembers.html#index_j"}, +{text:"k",url:"namespacemembers.html#index_k"}, +{text:"m",url:"namespacemembers.html#index_m"}, +{text:"n",url:"namespacemembers.html#index_n"}, +{text:"p",url:"namespacemembers.html#index_p"}, +{text:"r",url:"namespacemembers.html#index_r"}, +{text:"s",url:"namespacemembers.html#index_s"}]}, +{text:"Functions",url:"namespacemembers_func.html"}, +{text:"Typedefs",url:"namespacemembers_type.html"}, +{text:"Enumerations",url:"namespacemembers_enum.html"}, +{text:"Enumerator",url:"namespacemembers_eval.html",children:[ +{text:"a",url:"namespacemembers_eval.html#index_a"}, +{text:"b",url:"namespacemembers_eval.html#index_b"}, +{text:"c",url:"namespacemembers_eval.html#index_c"}, +{text:"d",url:"namespacemembers_eval.html#index_d"}, +{text:"f",url:"namespacemembers_eval.html#index_f"}, +{text:"i",url:"namespacemembers_eval.html#index_i"}, +{text:"j",url:"namespacemembers_eval.html#index_j"}, +{text:"k",url:"namespacemembers_eval.html#index_k"}, +{text:"n",url:"namespacemembers_eval.html#index_n"}, +{text:"p",url:"namespacemembers_eval.html#index_p"}, +{text:"r",url:"namespacemembers_eval.html#index_r"}, +{text:"s",url:"namespacemembers_eval.html#index_s"}]}]}]}, +{text:"Classes",url:"annotated.html",children:[ +{text:"Class List",url:"annotated.html"}, +{text:"Class Index",url:"classes.html"}, +{text:"Class Hierarchy",url:"hierarchy.html"}, +{text:"Class Members",url:"functions.html",children:[ +{text:"All",url:"functions.html",children:[ +{text:"a",url:"functions.html#index_a"}, +{text:"b",url:"functions_b.html#index_b"}, +{text:"c",url:"functions_c.html#index_c"}, +{text:"d",url:"functions_d.html#index_d"}, +{text:"e",url:"functions_e.html#index_e"}, +{text:"f",url:"functions_f.html#index_f"}, +{text:"g",url:"functions_g.html#index_g"}, +{text:"h",url:"functions_h.html#index_h"}, +{text:"i",url:"functions_i.html#index_i"}, +{text:"k",url:"functions_k.html#index_k"}, +{text:"l",url:"functions_l.html#index_l"}, +{text:"m",url:"functions_m.html#index_m"}, +{text:"n",url:"functions_n.html#index_n"}, +{text:"o",url:"functions_o.html#index_o"}, +{text:"p",url:"functions_p.html#index_p"}, +{text:"r",url:"functions_r.html#index_r"}, +{text:"s",url:"functions_s.html#index_s"}, +{text:"t",url:"functions_t.html#index_t"}, +{text:"u",url:"functions_u.html#index_u"}, +{text:"w",url:"functions_w.html#index_w"}]}, +{text:"Functions",url:"functions_func.html",children:[ +{text:"a",url:"functions_func.html#index_a"}, +{text:"b",url:"functions_func_b.html#index_b"}, +{text:"c",url:"functions_func_c.html#index_c"}, +{text:"d",url:"functions_func_d.html#index_d"}, +{text:"e",url:"functions_func_e.html#index_e"}, +{text:"f",url:"functions_func_f.html#index_f"}, +{text:"g",url:"functions_func_g.html#index_g"}, +{text:"h",url:"functions_func_h.html#index_h"}, +{text:"i",url:"functions_func_i.html#index_i"}, +{text:"k",url:"functions_func_k.html#index_k"}, +{text:"l",url:"functions_func_l.html#index_l"}, +{text:"m",url:"functions_func_m.html#index_m"}, +{text:"n",url:"functions_func_n.html#index_n"}, +{text:"o",url:"functions_func_o.html#index_o"}, +{text:"p",url:"functions_func_p.html#index_p"}, +{text:"r",url:"functions_func_r.html#index_r"}, +{text:"s",url:"functions_func_s.html#index_s"}, +{text:"t",url:"functions_func_t.html#index_t"}, +{text:"u",url:"functions_func_u.html#index_u"}]}, +{text:"Enumerations",url:"functions_enum.html"}, +{text:"Enumerator",url:"functions_eval.html"}]}]}, +{text:"Files",url:"files.html",children:[ +{text:"File List",url:"files.html"}]}]} diff --git a/static/api/cpp/3.5.x/message__id_8h_source.html b/static/api/cpp/3.5.x/message__id_8h_source.html new file mode 100644 index 000000000000..78a7915b55a1 --- /dev/null +++ b/static/api/cpp/3.5.x/message__id_8h_source.html @@ -0,0 +1,119 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/c/message_id.h Source File + + + + + + + + + + +
    +
    + + + + + + +
    +
    pulsar-client-cpp +
    +
    +
    + + + + + + + + + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + + +
    +
    +
    message_id.h
    +
    +
    +
    1
    +
    20#pragma once
    +
    21
    +
    22#ifdef __cplusplus
    +
    23extern "C" {
    +
    24#endif
    +
    25
    +
    26#include <pulsar/defines.h>
    +
    27#include <stddef.h>
    +
    28#include <stdint.h>
    +
    29
    +
    30typedef struct _pulsar_message_id pulsar_message_id_t;
    +
    31
    +
    35PULSAR_PUBLIC const pulsar_message_id_t *pulsar_message_id_earliest();
    +
    36
    +
    40PULSAR_PUBLIC const pulsar_message_id_t *pulsar_message_id_latest();
    +
    41
    +
    45PULSAR_PUBLIC void *pulsar_message_id_serialize(pulsar_message_id_t *messageId, int *len);
    +
    46
    +
    50PULSAR_PUBLIC pulsar_message_id_t *pulsar_message_id_deserialize(const void *buffer, uint32_t len);
    +
    51
    +
    52PULSAR_PUBLIC char *pulsar_message_id_str(pulsar_message_id_t *messageId);
    +
    53
    +
    54PULSAR_PUBLIC void pulsar_message_id_free(pulsar_message_id_t *messageId);
    +
    55
    +
    56#ifdef __cplusplus
    +
    57}
    +
    58#endif
    +
    + +
    +Generated by doxygen 1.9.8 +
    + + diff --git a/static/api/cpp/3.5.x/message__router_8h_source.html b/static/api/cpp/3.5.x/message__router_8h_source.html new file mode 100644 index 000000000000..63ad1b4cff7e --- /dev/null +++ b/static/api/cpp/3.5.x/message__router_8h_source.html @@ -0,0 +1,111 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/c/message_router.h Source File + + + + + + + + + + +
    +
    + + + + + + +
    +
    pulsar-client-cpp +
    +
    +
    + + + + + + + + + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + + +
    +
    +
    message_router.h
    +
    +
    +
    1
    +
    20#pragma once
    +
    21
    +
    22#include <pulsar/c/message.h>
    +
    23#include <pulsar/defines.h>
    +
    24
    +
    25#ifdef __cplusplus
    +
    26extern "C" {
    +
    27#endif
    +
    28
    +
    29typedef struct _pulsar_topic_metadata pulsar_topic_metadata_t;
    +
    30
    +
    31typedef int (*pulsar_message_router)(pulsar_message_t *msg, pulsar_topic_metadata_t *topicMetadata,
    +
    32 void *ctx);
    +
    33
    +
    34PULSAR_PUBLIC int pulsar_topic_metadata_get_num_partitions(pulsar_topic_metadata_t *topicMetadata);
    +
    35
    +
    36#ifdef __cplusplus
    +
    37}
    +
    38#endif
    +
    + +
    +Generated by doxygen 1.9.8 +
    + + diff --git a/static/api/cpp/3.5.x/messages_8h_source.html b/static/api/cpp/3.5.x/messages_8h_source.html new file mode 100644 index 000000000000..d6e0114b641a --- /dev/null +++ b/static/api/cpp/3.5.x/messages_8h_source.html @@ -0,0 +1,113 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/c/messages.h Source File + + + + + + + + + + +
    +
    + + + + + + +
    +
    pulsar-client-cpp +
    +
    +
    + + + + + + + + + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + + +
    +
    +
    messages.h
    +
    +
    +
    1
    +
    19#pragma once
    +
    20
    +
    21#include <pulsar/c/message.h>
    +
    22#include <pulsar/defines.h>
    +
    23#include <stdint.h>
    +
    24
    +
    25#ifdef __cplusplus
    +
    26extern "C" {
    +
    27#endif
    +
    28
    +
    29typedef struct _pulsar_messages pulsar_messages_t;
    +
    30
    +
    36PULSAR_PUBLIC size_t pulsar_messages_size(pulsar_messages_t* msgs);
    +
    37
    +
    45PULSAR_PUBLIC pulsar_message_t* pulsar_messages_get(pulsar_messages_t* msgs, size_t index);
    +
    46
    +
    47PULSAR_PUBLIC void pulsar_messages_free(pulsar_messages_t* msgs);
    +
    48
    +
    49#ifdef __cplusplus
    +
    50}
    +
    51#endif
    +
    + +
    +Generated by doxygen 1.9.8 +
    + + diff --git a/static/api/cpp/3.5.x/minus.svg b/static/api/cpp/3.5.x/minus.svg new file mode 100644 index 000000000000..f70d0c1a183d --- /dev/null +++ b/static/api/cpp/3.5.x/minus.svg @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/static/api/cpp/3.5.x/minusd.svg b/static/api/cpp/3.5.x/minusd.svg new file mode 100644 index 000000000000..5f8e879628d5 --- /dev/null +++ b/static/api/cpp/3.5.x/minusd.svg @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/static/api/cpp/3.5.x/namespacemembers.html b/static/api/cpp/3.5.x/namespacemembers.html new file mode 100644 index 000000000000..083334633089 --- /dev/null +++ b/static/api/cpp/3.5.x/namespacemembers.html @@ -0,0 +1,213 @@ + + + + + + + +pulsar-client-cpp: Namespace Members + + + + + + + + + + +
    +
    + + + + + + +
    +
    pulsar-client-cpp +
    +
    +
    + + + + + + + +
    + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + +
    +
    Here is a list of all documented namespace members with links to the namespaces they belong to:
    + +

    - a -

    + + +

    - b -

    + + +

    - c -

      +
    • ConsumerExclusive : pulsar
      • +
    • ConsumerFailover : pulsar
      • +
    • ConsumerKeyShared : pulsar
      • +
    • ConsumerShared : pulsar
      • +
    • ConsumerType : pulsar
      • +
    • createProtobufNativeSchema() : pulsar
      • +
    + + +

    - d -

    + + +

    - f -

    + + +

    - i -

    + + +

    - j -

    + + +

    - k -

    + + +

    - m -

    + + +

    - n -

    + + +

    - p -

    + + +

    - r -

      +
    • ReaderListener : pulsar
      • +
    • RegexSubscriptionMode : pulsar
      • +
    • Result : pulsar
      • +
    • ResultAlreadyClosed : pulsar
      • +
    • ResultAuthenticationError : pulsar
      • +
    • ResultAuthorizationError : pulsar
      • +
    • ResultBrokerMetadataError : pulsar
      • +
    • ResultBrokerPersistenceError : pulsar
      • +
    • ResultCallback : pulsar
      • +
    • ResultChecksumError : pulsar
      • +
    • ResultConnectError : pulsar
      • +
    • ResultConsumerAssignError : pulsar
      • +
    • ResultConsumerBusy : pulsar
      • +
    • ResultConsumerNotFound : pulsar
      • +
    • ResultConsumerNotInitialized : pulsar
      • +
    • ResultCryptoError : pulsar
      • +
    • ResultCumulativeAcknowledgementNotAllowedError : pulsar
      • +
    • ResultDisconnected : pulsar
      • +
    • ResultErrorGettingAuthenticationData : pulsar
      • +
    • ResultIncompatibleSchema : pulsar
      • +
    • ResultInterrupted : pulsar
      • +
    • ResultInvalidConfiguration : pulsar
      • +
    • ResultInvalidMessage : pulsar
      • +
    • ResultInvalidTopicName : pulsar
      • +
    • ResultInvalidTxnStatusError : pulsar
      • +
    • ResultInvalidUrl : pulsar
      • +
    • ResultLookupError : pulsar
      • +
    • ResultMemoryBufferIsFull : pulsar
      • +
    • ResultMessageTooBig : pulsar
      • +
    • ResultNotAllowedError : pulsar
      • +
    • ResultNotConnected : pulsar
      • +
    • ResultOk : pulsar
      • +
    • ResultOperationNotSupported : pulsar
      • +
    • ResultProducerBlockedQuotaExceededException : pulsar
      • +
    • ResultProducerBusy : pulsar
      • +
    • ResultProducerFenced : pulsar
      • +
    • ResultProducerNotInitialized : pulsar
      • +
    • ResultProducerQueueIsFull : pulsar
      • +
    • ResultReadError : pulsar
      • +
    • ResultServiceUnitNotReady : pulsar
      • +
    • ResultSubscriptionNotFound : pulsar
      • +
    • ResultTimeout : pulsar
      • +
    • ResultTooManyLookupRequestException : pulsar
      • +
    • ResultTopicNotFound : pulsar
      • +
    • ResultTopicTerminated : pulsar
      • +
    • ResultTransactionConflict : pulsar
      • +
    • ResultTransactionCoordinatorNotFoundError : pulsar
      • +
    • ResultTransactionNotFound : pulsar
      • +
    • ResultUnknownError : pulsar
      • +
    • ResultUnsupportedVersionError : pulsar
      • +
    + + +

    - s -

    +
    + +
    +Generated by doxygen 1.9.8 +
    + + diff --git a/static/api/cpp/3.5.x/namespacemembers_enum.html b/static/api/cpp/3.5.x/namespacemembers_enum.html new file mode 100644 index 000000000000..c94770849f34 --- /dev/null +++ b/static/api/cpp/3.5.x/namespacemembers_enum.html @@ -0,0 +1,87 @@ + + + + + + + +pulsar-client-cpp: Namespace Members + + + + + + + + + + +
    +
    + + + + + + +
    +
    pulsar-client-cpp +
    +
    +
    + + + + + + + +
    + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + +
    +
    Here is a list of all documented namespace enums with links to the namespaces they belong to:
    +
    + +
    +Generated by doxygen 1.9.8 +
    + + diff --git a/static/api/cpp/3.5.x/namespacemembers_eval.html b/static/api/cpp/3.5.x/namespacemembers_eval.html new file mode 100644 index 000000000000..cfc2e712fca1 --- /dev/null +++ b/static/api/cpp/3.5.x/namespacemembers_eval.html @@ -0,0 +1,198 @@ + + + + + + + +pulsar-client-cpp: Namespace Members + + + + + + + + + + +
    +
    + + + + + + +
    +
    pulsar-client-cpp +
    +
    +
    + + + + + + + +
    + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + +
    +
    Here is a list of all documented namespace enum values with links to the namespaces they belong to:
    + +

    - a -

    + + +

    - b -

    + + +

    - c -

    + + +

    - d -

    + + +

    - f -

    + + +

    - i -

    + + +

    - j -

    + + +

    - k -

    + + +

    - n -

    + + +

    - p -

    + + +

    - r -

      +
    • ResultAlreadyClosed : pulsar
      • +
    • ResultAuthenticationError : pulsar
      • +
    • ResultAuthorizationError : pulsar
      • +
    • ResultBrokerMetadataError : pulsar
      • +
    • ResultBrokerPersistenceError : pulsar
      • +
    • ResultChecksumError : pulsar
      • +
    • ResultConnectError : pulsar
      • +
    • ResultConsumerAssignError : pulsar
      • +
    • ResultConsumerBusy : pulsar
      • +
    • ResultConsumerNotFound : pulsar
      • +
    • ResultConsumerNotInitialized : pulsar
      • +
    • ResultCryptoError : pulsar
      • +
    • ResultCumulativeAcknowledgementNotAllowedError : pulsar
      • +
    • ResultDisconnected : pulsar
      • +
    • ResultErrorGettingAuthenticationData : pulsar
      • +
    • ResultIncompatibleSchema : pulsar
      • +
    • ResultInterrupted : pulsar
      • +
    • ResultInvalidConfiguration : pulsar
      • +
    • ResultInvalidMessage : pulsar
      • +
    • ResultInvalidTopicName : pulsar
      • +
    • ResultInvalidTxnStatusError : pulsar
      • +
    • ResultInvalidUrl : pulsar
      • +
    • ResultLookupError : pulsar
      • +
    • ResultMemoryBufferIsFull : pulsar
      • +
    • ResultMessageTooBig : pulsar
      • +
    • ResultNotAllowedError : pulsar
      • +
    • ResultNotConnected : pulsar
      • +
    • ResultOk : pulsar
      • +
    • ResultOperationNotSupported : pulsar
      • +
    • ResultProducerBlockedQuotaExceededException : pulsar
      • +
    • ResultProducerBusy : pulsar
      • +
    • ResultProducerFenced : pulsar
      • +
    • ResultProducerNotInitialized : pulsar
      • +
    • ResultProducerQueueIsFull : pulsar
      • +
    • ResultReadError : pulsar
      • +
    • ResultServiceUnitNotReady : pulsar
      • +
    • ResultSubscriptionNotFound : pulsar
      • +
    • ResultTimeout : pulsar
      • +
    • ResultTooManyLookupRequestException : pulsar
      • +
    • ResultTopicNotFound : pulsar
      • +
    • ResultTopicTerminated : pulsar
      • +
    • ResultTransactionConflict : pulsar
      • +
    • ResultTransactionCoordinatorNotFoundError : pulsar
      • +
    • ResultTransactionNotFound : pulsar
      • +
    • ResultUnknownError : pulsar
      • +
    • ResultUnsupportedVersionError : pulsar
      • +
    + + +

    - s -

    +
    + +
    +Generated by doxygen 1.9.8 +
    + + diff --git a/static/api/cpp/3.5.x/namespacemembers_func.html b/static/api/cpp/3.5.x/namespacemembers_func.html new file mode 100644 index 000000000000..929cb90dc59b --- /dev/null +++ b/static/api/cpp/3.5.x/namespacemembers_func.html @@ -0,0 +1,82 @@ + + + + + + + +pulsar-client-cpp: Namespace Members + + + + + + + + + + +
    +
    + + + + + + +
    +
    pulsar-client-cpp +
    +
    +
    + + + + + + + +
    + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + +
    +
    Here is a list of all documented namespace functions with links to the namespaces they belong to:
      +
    • createProtobufNativeSchema() : pulsar
      • +
    +
    + +
    +Generated by doxygen 1.9.8 +
    + + diff --git a/static/api/cpp/3.5.x/namespacemembers_type.html b/static/api/cpp/3.5.x/namespacemembers_type.html new file mode 100644 index 000000000000..d366f5c7f933 --- /dev/null +++ b/static/api/cpp/3.5.x/namespacemembers_type.html @@ -0,0 +1,85 @@ + + + + + + + +pulsar-client-cpp: Namespace Members + + + + + + + + + + +
    +
    + + + + + + +
    +
    pulsar-client-cpp +
    +
    +
    + + + + + + + +
    + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + +
    +
    Here is a list of all documented namespace typedefs with links to the namespaces they belong to:
    +
    + +
    +Generated by doxygen 1.9.8 +
    + + diff --git a/static/api/cpp/3.5.x/namespacepulsar.html b/static/api/cpp/3.5.x/namespacepulsar.html new file mode 100644 index 000000000000..c775c1ee1759 --- /dev/null +++ b/static/api/cpp/3.5.x/namespacepulsar.html @@ -0,0 +1,758 @@ + + + + + + + +pulsar-client-cpp: pulsar Namespace Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    pulsar-client-cpp +
    +
    +
    + + + + + + + + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + +
    +
    +
    +Classes | +Typedefs | +Enumerations | +Functions
    +
    pulsar Namespace Reference
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Classes

    class  AuthAthenz
     
    class  AuthBasic
     
    class  Authentication
     
    class  AuthenticationDataProvider
     
    class  AuthFactory
     
    class  AuthOauth2
     
    class  AuthTls
     
    class  AuthToken
     
    class  BatchReceivePolicy
     
    class  BrokerConsumerStats
     
    class  CachedToken
     
    class  Client
     
    class  ClientConfiguration
     
    class  ConsoleLoggerFactory
     
    class  Consumer
     
    class  ConsumerConfiguration
     
    class  ConsumerEventListener
     
    class  ConsumerInterceptor
     
    class  CryptoKeyReader
     
    class  DeadLetterPolicy
     
    class  DeadLetterPolicyBuilder
     
    class  DefaultCryptoKeyReader
     
    class  DeprecatedException
     
    class  EncryptionKeyInfo
     
    class  FileLoggerFactory
     
    class  KeySharedPolicy
     
    class  KeyValue
     
    class  Logger
     
    class  LoggerFactory
     
    class  Message
     
    class  MessageBatch
     
    class  MessageBuilder
     
    class  MessageId
     
    class  MessageIdBuilder
     
    class  MessageRoutingPolicy
     
    class  Oauth2Flow
     
    class  Oauth2TokenResult
     
    class  Producer
     
    class  ProducerConfiguration
     
    class  ProducerInterceptor
     
    class  Reader
     
    class  ReaderConfiguration
     
    class  SchemaInfo
     
    class  TableView
     
    struct  TableViewConfiguration
     
    class  TopicMetadata
     
    class  TypedMessage
     
    class  TypedMessageBuilder
     
    class  TypedMessageBuilder< std::string >
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +Typedefs

    +typedef std::shared_ptr< AuthenticationDataProvider > AuthenticationDataPtr
     
    +typedef std::shared_ptr< Authentication > AuthenticationPtr
     
    +typedef std::map< std::string, std::string > ParamMap
     
    +typedef std::function< std::string()> TokenSupplier
     
    +typedef std::shared_ptr< Oauth2TokenResult > Oauth2TokenResultPtr
     
    +typedef std::shared_ptr< Oauth2Flow > FlowPtr
     
    +typedef std::shared_ptr< CachedToken > CachedTokenPtr
     
    +typedef std::function< void(Result result, BrokerConsumerStats brokerConsumerStats)> BrokerConsumerStatsCallback
     
    +typedef std::function< void(Result, Producer)> CreateProducerCallback
     
    +typedef std::function< void(Result, Consumer)> SubscribeCallback
     
    +typedef std::function< void(Result, Reader)> ReaderCallback
     
    +typedef std::function< void(Result, TableView)> TableViewCallback
     
    +typedef std::function< void(Result, const std::vector< std::string > &)> GetPartitionsCallback
     
    +typedef std::function< void(Result)> CloseCallback
     
    +typedef std::shared_ptr< ConsumerImplBase > ConsumerImplBasePtr
     
    +typedef std::vector< Message > Messages
     Callback definition for non-data operation.
     
    +typedef std::function< void(Result result)> ResultCallback
     Callback definition for non-data operation.
     
    +typedef std::function< void(Result, const Message &msg)> ReceiveCallback
     
    +typedef std::function< void(Result, const Messages &msgs)> BatchReceiveCallback
     
    +typedef std::function< void(Result result, MessageId messageId)> GetLastMessageIdCallback
     
    +typedef std::function< void(Consumer &consumer, const Message &msg)> MessageListener
     Callback definition for MessageListener.
     
    +typedef std::shared_ptr< ConsumerEventListener > ConsumerEventListenerPtr
     
    +typedef std::shared_ptr< ConsumerInterceptor > ConsumerInterceptorPtr
     
    +typedef std::shared_ptr< CryptoKeyReader > CryptoKeyReaderPtr
     
    +typedef std::shared_ptr< EncryptionKeyInfoImpl > EncryptionKeyInfoImplPtr
     
    +typedef std::pair< int, int > StickyRange
     
    +typedef std::vector< StickyRange > StickyRanges
     
    +typedef std::vector< MessageId > MessageIdList
     
    +typedef std::shared_ptr< MessageRoutingPolicy > MessageRoutingPolicyPtr
     
    +typedef std::function< void(Result)> FlushCallback
     
    +typedef std::shared_ptr< ProducerImplBase > ProducerImplBasePtr
     
    +typedef std::function< void(Result, const MessageId &messageId)> SendCallback
     
    +typedef std::shared_ptr< ProducerInterceptor > ProducerInterceptorPtr
     
    +typedef std::function< void(Result result, bool hasMessageAvailable)> HasMessageAvailableCallback
     
    +typedef std::function< void(Result result, const Message &message)> ReadNextCallback
     
    +typedef std::function< void(Reader reader, const Message &msg)> ReaderListener
     Callback definition for MessageListener.
     
    +typedef std::map< std::string, std::string > StringMap
     
    +typedef std::function< void(const std::string &key, const std::string &value)> TableViewAction
     
    +using BytesMessageBuilder = TypedMessageBuilder< std::string >
     
    + + + + + + + + + + + + + + + + + + + + + +

    +Enumerations

    enum  CompressionType {
    +  CompressionNone = 0 +, CompressionLZ4 = 1 +, CompressionZLib = 2 +, CompressionZSTD = 3 +,
    +  CompressionSNAPPY = 4 +
    + }
     
    enum class  ConsumerCryptoFailureAction { FAIL +, DISCARD +, CONSUME + }
     
    enum  ConsumerType { ConsumerExclusive +, ConsumerShared +, ConsumerFailover +, ConsumerKeyShared + }
     
    enum  InitialPosition { InitialPositionLatest +, InitialPositionEarliest + }
     
    enum  KeySharedMode { AUTO_SPLIT = 0 +, STICKY = 1 + }
     
    enum class  ProducerCryptoFailureAction { FAIL +, SEND + }
     
    enum  RegexSubscriptionMode { PersistentOnly = 0 +, NonPersistentOnly = 1 +, AllTopics = 2 + }
     
    enum  Result {
    +  ResultRetryable = -1 +, ResultOk = 0 +, ResultUnknownError +, ResultInvalidConfiguration +,
    +  ResultTimeout +, ResultLookupError +, ResultConnectError +, ResultReadError +,
    +  ResultAuthenticationError +, ResultAuthorizationError +, ResultErrorGettingAuthenticationData +, ResultBrokerMetadataError +,
    +  ResultBrokerPersistenceError +, ResultChecksumError +, ResultConsumerBusy +, ResultNotConnected +,
    +  ResultAlreadyClosed +, ResultInvalidMessage +, ResultConsumerNotInitialized +, ResultProducerNotInitialized +,
    +  ResultProducerBusy +, ResultTooManyLookupRequestException +, ResultInvalidTopicName +, ResultInvalidUrl +,
    +  ResultServiceUnitNotReady +, ResultOperationNotSupported +, ResultProducerBlockedQuotaExceededError +, ResultProducerBlockedQuotaExceededException +,
    +  ResultProducerQueueIsFull +, ResultMessageTooBig +, ResultTopicNotFound +, ResultSubscriptionNotFound +,
    +  ResultConsumerNotFound +, ResultUnsupportedVersionError +, ResultTopicTerminated +, ResultCryptoError +,
    +  ResultIncompatibleSchema +, ResultConsumerAssignError +, ResultCumulativeAcknowledgementNotAllowedError +, ResultTransactionCoordinatorNotFoundError +,
    +  ResultInvalidTxnStatusError +, ResultNotAllowedError +, ResultTransactionConflict +, ResultTransactionNotFound +,
    +  ResultProducerFenced +, ResultMemoryBufferIsFull +, ResultInterrupted +, ResultDisconnected +
    + }
     
    enum class  KeyValueEncodingType { SEPARATED +, INLINE + }
     
    enum  SchemaType {
    +  NONE = 0 +, STRING = 1 +, JSON = 2 +, PROTOBUF = 3 +,
    +  AVRO = 4 +, INT8 = 6 +, INT16 = 7 +, INT32 = 8 +,
    +  INT64 = 9 +, FLOAT = 10 +, DOUBLE = 11 +, KEY_VALUE = 15 +,
    +  PROTOBUF_NATIVE = 20 +, BYTES = -1 +, AUTO_CONSUME = -3 +, AUTO_PUBLISH = -4 +
    + }
     
    + + + + + + + + + + + + + + + +

    +Functions

    PULSAR_PUBLIC SchemaInfo createProtobufNativeSchema (const google::protobuf::Descriptor *descriptor)
     
    +PULSAR_PUBLIC const char * strResult (Result result)
     
    +PULSAR_PUBLIC std::ostream & operator<< (std::ostream &s, pulsar::Result result)
     
    +PULSAR_PUBLIC const char * strEncodingType (pulsar::KeyValueEncodingType encodingType)
     
    +PULSAR_PUBLIC KeyValueEncodingType enumEncodingType (std::string encodingTypeStr)
     
    +PULSAR_PUBLIC const char * strSchemaType (SchemaType schemaType)
     
    +PULSAR_PUBLIC SchemaType enumSchemaType (std::string schemaTypeStr)
     
    +

    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

    + +

    ◆ ConsumerType

    + +
    +
    + + + + +
    enum pulsar::ConsumerType
    +
    + + + + + +
    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

    +
    ConsumerKeyShared 

    Multiple consumer will be able to use the same subscription and all messages with the same key will be dispatched to only one consumer

    +
    + +
    +
    + +

    ◆ KeySharedMode

    + +
    +
    + + + + +
    enum pulsar::KeySharedMode
    +
    +

    KeyShared mode of KeyShared subscription.

    + + + +
    Enumerator
    AUTO_SPLIT 

    Auto split while new consumer connected.

    +
    STICKY 

    New consumer with fixed hash range to attach the topic, if new consumer use conflict hash range with exits consumers, new consumer will be rejected.

    +
    + +
    +
    + +

    ◆ KeyValueEncodingType

    + +
    +
    + + + + + +
    + + + + +
    enum class pulsar::KeyValueEncodingType
    +     		+strong
    +
    +

    Encoding types of supported KeyValueSchema for Pulsar messages.

    + + + +
    Enumerator
    SEPARATED 

    Key is stored as message key, while value is stored as message payload.

    +
    INLINE 

    Key and value are stored as message payload.

    +
    + +
    +
    + +

    ◆ RegexSubscriptionMode

    + +
    +
    + + + + +
    enum pulsar::RegexSubscriptionMode
    +
    + + + + +
    Enumerator
    PersistentOnly 

    Only subscribe to persistent topics.

    +
    NonPersistentOnly 

    Only subscribe to non-persistent topics.

    +
    AllTopics 

    Subscribe to both persistent and non-persistent topics.

    +
    + +
    +
    + +

    ◆ Result

    + +
    +
    + + + + +
    enum pulsar::Result
    +
    +

    Collection of return codes

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Enumerator
    ResultOk 

    An internal error code used for retry.

    +
    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.

    +
    ResultProducerBusy 

    Producer is not initialized.

    +
    ResultTooManyLookupRequestException 

    Producer with same name is already connected.

    +
    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.

    +
    ResultIncompatibleSchema 

    Error when crypto operation fails.

    +
    ResultConsumerAssignError 

    Specified schema is incompatible with the topic's schema.

    +
    ResultCumulativeAcknowledgementNotAllowedError 

    Error when a new consumer connected but can't assign messages to this consumer

    +
    ResultTransactionCoordinatorNotFoundError 

    Not allowed to call cumulativeAcknowledgement in Shared and Key_Shared subscription mode

    +
    ResultInvalidTxnStatusError 

    Transaction coordinator not found.

    +
    ResultNotAllowedError 

    Invalid txn status error.

    +
    ResultTransactionConflict 

    Not allowed.

    +
    ResultTransactionNotFound 

    Transaction ack conflict.

    +
    ResultProducerFenced 

    Transaction not found.

    +
    ResultMemoryBufferIsFull 

    Producer was fenced by broker.

    +
    ResultInterrupted 

    Client-wide memory limit has been reached.

    +
    ResultDisconnected 

    Interrupted while waiting to dequeue.

    +
    + +
    +
    + +

    ◆ SchemaType

    + +
    +
    + + + + +
    enum pulsar::SchemaType
    +
    + + + + + + + + + + + + + + + + + +
    Enumerator
    NONE 

    No schema defined

    +
    STRING 

    Simple String encoding with UTF-8

    +
    JSON 

    JSON object encoding and validation

    +
    PROTOBUF 

    Protobuf message encoding and decoding

    +
    AVRO 

    Serialize and deserialize via Avro

    +
    INT8 

    A 8-byte integer.

    +
    INT16 

    A 16-byte integer.

    +
    INT32 

    A 32-byte integer.

    +
    INT64 

    A 64-byte integer.

    +
    FLOAT 

    A float number.

    +
    DOUBLE 

    A double number

    +
    KEY_VALUE 

    A Schema that contains Key Schema and Value Schema.

    +
    PROTOBUF_NATIVE 

    Protobuf native schema based on Descriptor.

    +
    BYTES 

    A bytes array.

    +
    AUTO_CONSUME 

    Auto Consume Type.

    +
    AUTO_PUBLISH 

    Auto Publish Type.

    +
    + +
    +
    +

    Function Documentation

    + +

    ◆ createProtobufNativeSchema()

    + +
    +
    + + + + + + + + +
    PULSAR_PUBLIC SchemaInfo pulsar::createProtobufNativeSchema (const google::protobuf::Descriptor * descriptor)
    +
    +

    Create a protobuf native schema using a descriptor.

    +
    Parameters
    + + +
    descriptorthe Descriptor object of the target class
    +
    +
    +
    Returns
    the protobuf native schema
    +
    Exceptions
    + + +
    std::invalid_argumentif descriptor is nullptr
    +
    +
    + +
    +
    +
    + +
    +Generated by doxygen 1.9.8 +
    + + diff --git a/static/api/cpp/3.5.x/namespaces.html b/static/api/cpp/3.5.x/namespaces.html new file mode 100644 index 000000000000..680dcf490c92 --- /dev/null +++ b/static/api/cpp/3.5.x/namespaces.html @@ -0,0 +1,136 @@ + + + + + + + +pulsar-client-cpp: Namespace List + + + + + + + + + + +
    +
    + + + + + + +
    +
    pulsar-client-cpp +
    +
    +
    + + + + + + + +
    + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + +
    +
    Namespace List
    +
    +
    +
    Here is a list of all documented namespaces with brief descriptions:
    +
    [detail level 12]
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
     ▼Npulsar
     CAuthAthenz
     CAuthBasic
     CAuthentication
     CAuthenticationDataProvider
     CAuthFactory
     CAuthOauth2
     CAuthTls
     CAuthToken
     CBatchReceivePolicy
     CBrokerConsumerStats
     CCachedToken
     CClient
     CClientConfiguration
     CConsoleLoggerFactory
     CConsumer
     CConsumerConfiguration
     CConsumerEventListener
     CConsumerInterceptor
     CCryptoKeyReader
     CDeadLetterPolicy
     CDeadLetterPolicyBuilder
     CDefaultCryptoKeyReader
     CDeprecatedException
     CEncryptionKeyInfo
     CFileLoggerFactory
     CKeySharedPolicy
     CKeyValue
     CLogger
     CLoggerFactory
     CMessage
     CMessageBatch
     CMessageBuilder
     CMessageId
     CMessageIdBuilder
     CMessageRoutingPolicy
     COauth2Flow
     COauth2TokenResult
     CProducer
     CProducerConfiguration
     CProducerInterceptor
     CReader
     CReaderConfiguration
     CSchemaInfo
     CTableView
     CTableViewConfiguration
     CTopicMetadata
     CTypedMessage
     CTypedMessageBuilder
     CTypedMessageBuilder< std::string >
    +
    +
    + +
    +Generated by doxygen 1.9.8 +
    + + diff --git a/static/api/cpp/3.5.x/nav_f.png b/static/api/cpp/3.5.x/nav_f.png new file mode 100644 index 000000000000..72a58a529ed3 Binary files /dev/null and b/static/api/cpp/3.5.x/nav_f.png differ diff --git a/static/api/cpp/3.5.x/nav_fd.png b/static/api/cpp/3.5.x/nav_fd.png new file mode 100644 index 000000000000..032fbdd4c54f Binary files /dev/null and b/static/api/cpp/3.5.x/nav_fd.png differ diff --git a/static/api/cpp/3.5.x/nav_g.png b/static/api/cpp/3.5.x/nav_g.png new file mode 100644 index 000000000000..2093a237a94f Binary files /dev/null and b/static/api/cpp/3.5.x/nav_g.png differ diff --git a/static/api/cpp/3.5.x/nav_h.png b/static/api/cpp/3.5.x/nav_h.png new file mode 100644 index 000000000000..33389b101d9c Binary files /dev/null and b/static/api/cpp/3.5.x/nav_h.png differ diff --git a/static/api/cpp/3.5.x/nav_hd.png b/static/api/cpp/3.5.x/nav_hd.png new file mode 100644 index 000000000000..de80f18ad648 Binary files /dev/null and b/static/api/cpp/3.5.x/nav_hd.png differ diff --git a/static/api/cpp/3.5.x/open.png b/static/api/cpp/3.5.x/open.png new file mode 100644 index 000000000000..30f75c7efe2d Binary files /dev/null and b/static/api/cpp/3.5.x/open.png differ diff --git a/static/api/cpp/3.5.x/pages.html b/static/api/cpp/3.5.x/pages.html new file mode 100644 index 000000000000..d37f21036207 --- /dev/null +++ b/static/api/cpp/3.5.x/pages.html @@ -0,0 +1,87 @@ + + + + + + + +pulsar-client-cpp: Related Pages + + + + + + + + + + +
    +
    + + + + + + +
    +
    pulsar-client-cpp +
    +
    +
    + + + + + + + +
    + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + +
    +
    Related Pages
    +
    +
    +
    Here is a list of all related documentation pages:
    + + +
     Deprecated List
    +
    +
    + +
    +Generated by doxygen 1.9.8 +
    + + diff --git a/static/api/cpp/3.5.x/plus.svg b/static/api/cpp/3.5.x/plus.svg new file mode 100644 index 000000000000..075201655355 --- /dev/null +++ b/static/api/cpp/3.5.x/plus.svg @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/static/api/cpp/3.5.x/plusd.svg b/static/api/cpp/3.5.x/plusd.svg new file mode 100644 index 000000000000..0c65bfe946d2 --- /dev/null +++ b/static/api/cpp/3.5.x/plusd.svg @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/static/api/cpp/3.5.x/producer__configuration_8h_source.html b/static/api/cpp/3.5.x/producer__configuration_8h_source.html new file mode 100644 index 000000000000..252ae94b9514 --- /dev/null +++ b/static/api/cpp/3.5.x/producer__configuration_8h_source.html @@ -0,0 +1,307 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/c/producer_configuration.h Source File + + + + + + + + + + +
    +
    + + + + + + +
    +
    pulsar-client-cpp +
    +
    +
    + + + + + + + + + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + + +
    +
    +
    producer_configuration.h
    +
    +
    +
    1
    +
    20#pragma once
    +
    21
    +
    22#include <pulsar/c/message_router.h>
    +
    23#include <pulsar/defines.h>
    +
    24#include <stdint.h>
    +
    25
    +
    26#ifdef __cplusplus
    +
    27extern "C" {
    +
    28#endif
    +
    29
    +
    30typedef enum
    +
    31{
    +
    32 pulsar_UseSinglePartition,
    +
    33 pulsar_RoundRobinDistribution,
    +
    34 pulsar_CustomPartition
    +
    35} pulsar_partitions_routing_mode;
    +
    36
    +
    37typedef enum
    +
    38{
    +
    39 pulsar_Murmur3_32Hash,
    +
    40 pulsar_BoostHash,
    +
    41 pulsar_JavaStringHash
    +
    42} pulsar_hashing_scheme;
    +
    43
    +
    44typedef enum
    +
    45{
    +
    46 pulsar_CompressionNone = 0,
    +
    47 pulsar_CompressionLZ4 = 1,
    +
    48 pulsar_CompressionZLib = 2,
    +
    49 pulsar_CompressionZSTD = 3,
    +
    50 pulsar_CompressionSNAPPY = 4
    +
    51} pulsar_compression_type;
    +
    52
    +
    53typedef enum
    +
    54{
    +
    55 pulsar_None = 0,
    +
    56 pulsar_String = 1,
    +
    57 pulsar_Json = 2,
    +
    58 pulsar_Protobuf = 3,
    +
    59 pulsar_Avro = 4,
    +
    60 pulsar_Boolean = 5,
    +
    61 pulsar_Int8 = 6,
    +
    62 pulsar_Int16 = 7,
    +
    63 pulsar_Int32 = 8,
    +
    64 pulsar_Int64 = 9,
    +
    65 pulsar_Float32 = 10,
    +
    66 pulsar_Float64 = 11,
    +
    67 pulsar_KeyValue = 15,
    +
    68 pulsar_Bytes = -1,
    +
    69 pulsar_AutoConsume = -3,
    +
    70 pulsar_AutoPublish = -4,
    +
    71} pulsar_schema_type;
    +
    72
    +
    73typedef enum
    +
    74{
    +
    75 // This is the default option to fail send if crypto operation fails
    +
    76 pulsar_ProducerFail,
    +
    77 // Ignore crypto failure and proceed with sending unencrypted messages
    +
    78 pulsar_ProducerSend
    +
    79} pulsar_producer_crypto_failure_action;
    +
    80
    +
    81typedef enum
    +
    82{
    +
    83 // By default multiple producers can publish on a topic.
    +
    84 pulsar_ProducerAccessModeShared = 0,
    +
    85 // Require exclusive access for producer.
    +
    86 // Fail immediately if there's already a producer connected.
    +
    87 pulsar_ProducerAccessModeExclusive = 1,
    +
    88 // Producer creation is pending until it can acquire exclusive access.
    +
    89 pulsar_ProducerAccessModeWaitForExclusive = 2,
    +
    90 // Acquire exclusive access for the producer.
    +
    91 // Any existing producer will be removed and invalidated immediately.
    +
    92 pulsar_ProducerAccessModeExclusiveWithFencing = 3
    +
    93
    +
    94} pulsar_producer_access_mode;
    +
    95
    +
    96typedef struct _pulsar_producer_configuration pulsar_producer_configuration_t;
    +
    97
    +
    98typedef struct _pulsar_crypto_key_reader pulsar_crypto_key_reader;
    +
    99
    +
    100PULSAR_PUBLIC pulsar_producer_configuration_t *pulsar_producer_configuration_create();
    +
    101
    +
    102PULSAR_PUBLIC void pulsar_producer_configuration_free(pulsar_producer_configuration_t *conf);
    +
    103
    +
    104PULSAR_PUBLIC void pulsar_producer_configuration_set_producer_name(pulsar_producer_configuration_t *conf,
    +
    105 const char *producerName);
    +
    106
    +
    107PULSAR_PUBLIC const char *pulsar_producer_configuration_get_producer_name(
    +
    108 pulsar_producer_configuration_t *conf);
    +
    109
    +
    110PULSAR_PUBLIC void pulsar_producer_configuration_set_send_timeout(pulsar_producer_configuration_t *conf,
    +
    111 int sendTimeoutMs);
    +
    112
    +
    113PULSAR_PUBLIC int pulsar_producer_configuration_get_send_timeout(pulsar_producer_configuration_t *conf);
    +
    114
    +
    115PULSAR_PUBLIC void pulsar_producer_configuration_set_initial_sequence_id(
    +
    116 pulsar_producer_configuration_t *conf, int64_t initialSequenceId);
    +
    117
    +
    118PULSAR_PUBLIC int64_t
    +
    119pulsar_producer_configuration_get_initial_sequence_id(pulsar_producer_configuration_t *conf);
    +
    120
    +
    121PULSAR_PUBLIC void pulsar_producer_configuration_set_compression_type(
    +
    122 pulsar_producer_configuration_t *conf, pulsar_compression_type compressionType);
    +
    123
    +
    124PULSAR_PUBLIC pulsar_compression_type
    +
    125pulsar_producer_configuration_get_compression_type(pulsar_producer_configuration_t *conf);
    +
    126
    +
    127PULSAR_PUBLIC void pulsar_producer_configuration_set_schema_info(pulsar_producer_configuration_t *conf,
    +
    128 pulsar_schema_type schemaType,
    +
    129 const char *name, const char *schema,
    +
    130 pulsar_string_map_t *properties);
    +
    131
    +
    132PULSAR_PUBLIC void pulsar_producer_configuration_set_max_pending_messages(
    +
    133 pulsar_producer_configuration_t *conf, int maxPendingMessages);
    +
    134PULSAR_PUBLIC int pulsar_producer_configuration_get_max_pending_messages(
    +
    135 pulsar_producer_configuration_t *conf);
    +
    136
    +
    145PULSAR_PUBLIC void pulsar_producer_configuration_set_max_pending_messages_across_partitions(
    +
    146 pulsar_producer_configuration_t *conf, int maxPendingMessagesAcrossPartitions);
    +
    147
    +
    152PULSAR_PUBLIC int pulsar_producer_configuration_get_max_pending_messages_across_partitions(
    +
    153 pulsar_producer_configuration_t *conf);
    +
    154
    +
    155PULSAR_PUBLIC void pulsar_producer_configuration_set_partitions_routing_mode(
    +
    156 pulsar_producer_configuration_t *conf, pulsar_partitions_routing_mode mode);
    +
    157
    +
    158PULSAR_PUBLIC pulsar_partitions_routing_mode
    +
    159pulsar_producer_configuration_get_partitions_routing_mode(pulsar_producer_configuration_t *conf);
    +
    160
    +
    161PULSAR_PUBLIC void pulsar_producer_configuration_set_message_router(pulsar_producer_configuration_t *conf,
    +
    162 pulsar_message_router router, void *ctx);
    +
    163
    +
    164PULSAR_PUBLIC void pulsar_producer_configuration_set_hashing_scheme(pulsar_producer_configuration_t *conf,
    +
    165 pulsar_hashing_scheme scheme);
    +
    166
    +
    167PULSAR_PUBLIC pulsar_hashing_scheme
    +
    168pulsar_producer_configuration_get_hashing_scheme(pulsar_producer_configuration_t *conf);
    +
    169
    +
    170PULSAR_PUBLIC void pulsar_producer_configuration_set_lazy_start_partitioned_producers(
    +
    171 pulsar_producer_configuration_t *conf, int useLazyStartPartitionedProducers);
    +
    172
    +
    173PULSAR_PUBLIC int pulsar_producer_configuration_get_lazy_start_partitioned_producers(
    +
    174 pulsar_producer_configuration_t *conf);
    +
    175
    +
    176PULSAR_PUBLIC void pulsar_producer_configuration_set_block_if_queue_full(
    +
    177 pulsar_producer_configuration_t *conf, int blockIfQueueFull);
    +
    178
    +
    179PULSAR_PUBLIC int pulsar_producer_configuration_get_block_if_queue_full(
    +
    180 pulsar_producer_configuration_t *conf);
    +
    181
    +
    182// Zero queue size feature will not be supported on consumer end if batching is enabled
    +
    183PULSAR_PUBLIC void pulsar_producer_configuration_set_batching_enabled(pulsar_producer_configuration_t *conf,
    +
    184 int batchingEnabled);
    +
    185
    +
    186PULSAR_PUBLIC int pulsar_producer_configuration_get_batching_enabled(pulsar_producer_configuration_t *conf);
    +
    187
    +
    188PULSAR_PUBLIC void pulsar_producer_configuration_set_batching_max_messages(
    +
    189 pulsar_producer_configuration_t *conf, unsigned int batchingMaxMessages);
    +
    190
    +
    191PULSAR_PUBLIC unsigned int pulsar_producer_configuration_get_batching_max_messages(
    +
    192 pulsar_producer_configuration_t *conf);
    +
    193
    +
    194PULSAR_PUBLIC void pulsar_producer_configuration_set_batching_max_allowed_size_in_bytes(
    +
    195 pulsar_producer_configuration_t *conf, unsigned long batchingMaxAllowedSizeInBytes);
    +
    196
    +
    197PULSAR_PUBLIC unsigned long pulsar_producer_configuration_get_batching_max_allowed_size_in_bytes(
    +
    198 pulsar_producer_configuration_t *conf);
    +
    199
    +
    200PULSAR_PUBLIC void pulsar_producer_configuration_set_batching_max_publish_delay_ms(
    +
    201 pulsar_producer_configuration_t *conf, unsigned long batchingMaxPublishDelayMs);
    +
    202
    +
    203PULSAR_PUBLIC unsigned long pulsar_producer_configuration_get_batching_max_publish_delay_ms(
    +
    204 pulsar_producer_configuration_t *conf);
    +
    205
    +
    206PULSAR_PUBLIC void pulsar_producer_configuration_set_property(pulsar_producer_configuration_t *conf,
    +
    207 const char *name, const char *value);
    +
    208
    +
    209PULSAR_PUBLIC int pulsar_producer_is_encryption_enabled(pulsar_producer_configuration_t *conf);
    +
    210
    +
    211PULSAR_PUBLIC void pulsar_producer_configuration_set_default_crypto_key_reader(
    +
    212 pulsar_producer_configuration_t *conf, const char *public_key_path, const char *private_key_path);
    +
    213
    +
    214PULSAR_PUBLIC pulsar_producer_crypto_failure_action
    +
    215pulsar_producer_configuration_get_crypto_failure_action(pulsar_producer_configuration_t *conf);
    +
    216
    +
    217PULSAR_PUBLIC void pulsar_producer_configuration_set_crypto_failure_action(
    +
    218 pulsar_producer_configuration_t *conf, pulsar_producer_crypto_failure_action cryptoFailureAction);
    +
    219
    +
    220PULSAR_PUBLIC void pulsar_producer_configuration_set_encryption_key(pulsar_producer_configuration_t *conf,
    +
    221 const char *key);
    +
    222
    +
    223PULSAR_PUBLIC void pulsar_producer_configuration_set_chunking_enabled(pulsar_producer_configuration_t *conf,
    +
    224 int chunkingEnabled);
    +
    225
    +
    226PULSAR_PUBLIC int pulsar_producer_configuration_is_chunking_enabled(pulsar_producer_configuration_t *conf);
    +
    227
    +
    228PULSAR_PUBLIC pulsar_producer_access_mode
    +
    229pulsar_producer_configuration_get_access_mode(pulsar_producer_configuration_t *conf);
    +
    230
    +
    231PULSAR_PUBLIC void pulsar_producer_configuration_set_access_mode(pulsar_producer_configuration_t *conf,
    +
    232 pulsar_producer_access_mode accessMode);
    +
    233
    +
    234// const CryptoKeyReaderPtr getCryptoKeyReader() const;
    +
    235// ProducerConfiguration &setCryptoKeyReader(CryptoKeyReaderPtr cryptoKeyReader);
    +
    236//
    +
    237// ProducerCryptoFailureAction getCryptoFailureAction() const;
    +
    238// ProducerConfiguration &setCryptoFailureAction(ProducerCryptoFailureAction action);
    +
    239//
    +
    240// std::set <std::string> &getEncryptionKeys();
    +
    241// int isEncryptionEnabled() const;
    +
    242// ProducerConfiguration &addEncryptionKey(std::string key);
    +
    243
    +
    244#ifdef __cplusplus
    +
    245}
    +
    246#endif
    +
    + +
    +Generated by doxygen 1.9.8 +
    + + diff --git a/static/api/cpp/3.5.x/reader__configuration_8h_source.html b/static/api/cpp/3.5.x/reader__configuration_8h_source.html new file mode 100644 index 000000000000..a7e69afd51e6 --- /dev/null +++ b/static/api/cpp/3.5.x/reader__configuration_8h_source.html @@ -0,0 +1,154 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/c/reader_configuration.h Source File + + + + + + + + + + +
    +
    + + + + + + +
    +
    pulsar-client-cpp +
    +
    +
    + + + + + + + + + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + + +
    +
    +
    reader_configuration.h
    +
    +
    +
    1
    +
    20#pragma once
    +
    21
    +
    22#include <pulsar/c/message.h>
    +
    23#include <pulsar/c/reader.h>
    +
    24#include <pulsar/defines.h>
    +
    25
    +
    26#include "consumer_configuration.h"
    +
    27
    +
    28#ifdef __cplusplus
    +
    29extern "C" {
    +
    30#endif
    +
    31
    +
    32typedef struct _pulsar_reader_configuration pulsar_reader_configuration_t;
    +
    33
    +
    34typedef void (*pulsar_reader_listener)(pulsar_reader_t *reader, pulsar_message_t *msg, void *ctx);
    +
    35
    +
    36PULSAR_PUBLIC pulsar_reader_configuration_t *pulsar_reader_configuration_create();
    +
    37
    +
    38PULSAR_PUBLIC void pulsar_reader_configuration_free(pulsar_reader_configuration_t *configuration);
    +
    39
    +
    44PULSAR_PUBLIC void pulsar_reader_configuration_set_reader_listener(
    +
    45 pulsar_reader_configuration_t *configuration, pulsar_reader_listener listener, void *ctx);
    +
    46
    +
    47PULSAR_PUBLIC int pulsar_reader_configuration_has_reader_listener(
    +
    48 pulsar_reader_configuration_t *configuration);
    +
    49
    +
    71PULSAR_PUBLIC void pulsar_reader_configuration_set_receiver_queue_size(
    +
    72 pulsar_reader_configuration_t *configuration, int size);
    +
    73
    +
    74PULSAR_PUBLIC int pulsar_reader_configuration_get_receiver_queue_size(
    +
    75 pulsar_reader_configuration_t *configuration);
    +
    76
    +
    77PULSAR_PUBLIC void pulsar_reader_configuration_set_reader_name(pulsar_reader_configuration_t *configuration,
    +
    78 const char *readerName);
    +
    79
    +
    80PULSAR_PUBLIC const char *pulsar_reader_configuration_get_reader_name(
    +
    81 pulsar_reader_configuration_t *configuration);
    +
    82
    +
    83PULSAR_PUBLIC void pulsar_reader_configuration_set_subscription_role_prefix(
    +
    84 pulsar_reader_configuration_t *configuration, const char *subscriptionRolePrefix);
    +
    85
    +
    86PULSAR_PUBLIC const char *pulsar_reader_configuration_get_subscription_role_prefix(
    +
    87 pulsar_reader_configuration_t *configuration);
    +
    88
    +
    89PULSAR_PUBLIC void pulsar_reader_configuration_set_read_compacted(
    +
    90 pulsar_reader_configuration_t *configuration, int readCompacted);
    +
    91
    +
    92PULSAR_PUBLIC int pulsar_reader_configuration_is_read_compacted(pulsar_reader_configuration_t *configuration);
    +
    93
    +
    94PULSAR_PUBLIC void pulsar_reader_configuration_set_default_crypto_key_reader(
    +
    95 pulsar_reader_configuration_t *configuration, const char *public_key_path, const char *private_key_path);
    +
    96
    +
    97PULSAR_PUBLIC pulsar_consumer_crypto_failure_action
    +
    98pulsar_reader_configuration_get_crypto_failure_action(pulsar_reader_configuration_t *configuration);
    +
    99
    +
    100PULSAR_PUBLIC void pulsar_reader_configuration_set_crypto_failure_action(
    +
    101 pulsar_reader_configuration_t *configuration,
    +
    102 pulsar_consumer_crypto_failure_action crypto_failure_action);
    +
    103
    +
    104#ifdef __cplusplus
    +
    105}
    +
    106#endif
    +
    + +
    +Generated by doxygen 1.9.8 +
    + + diff --git a/static/api/cpp/3.5.x/search/all_0.js b/static/api/cpp/3.5.x/search/all_0.js new file mode 100644 index 000000000000..7cd2d1a4a756 --- /dev/null +++ b/static/api/cpp/3.5.x/search/all_0.js @@ -0,0 +1,22 @@ +var searchData= +[ + ['acknowledge_0',['acknowledge',['../classpulsar_1_1_consumer.html#a57fd2c53a44ea53262742d90ff11e0fd',1,'pulsar::Consumer::acknowledge(const MessageIdList &messageIdList)'],['../classpulsar_1_1_consumer.html#aed10e043835e50d8129e6adecd91da72',1,'pulsar::Consumer::acknowledge(const MessageId &messageId)'],['../classpulsar_1_1_consumer.html#a3c3eb5056f228d281798f9ea75f52af9',1,'pulsar::Consumer::acknowledge(const Message &message)']]], + ['acknowledgeasync_1',['acknowledgeasync',['../classpulsar_1_1_consumer.html#a867bebab981d5aa2f74217308aa2353c',1,'pulsar::Consumer::acknowledgeAsync(const Message &message, ResultCallback callback)'],['../classpulsar_1_1_consumer.html#a3a08b7cdcc9a1733ce7066173bfcdc28',1,'pulsar::Consumer::acknowledgeAsync(const MessageId &messageId, ResultCallback callback)'],['../classpulsar_1_1_consumer.html#a74283a098beeb002e15a1dbba9fcff13',1,'pulsar::Consumer::acknowledgeAsync(const MessageIdList &messageIdList, ResultCallback callback)']]], + ['acknowledgecumulative_2',['acknowledgecumulative',['../classpulsar_1_1_consumer.html#a3eb0b0db2da0628da15d3f242e254f6d',1,'pulsar::Consumer::acknowledgeCumulative(const Message &message)'],['../classpulsar_1_1_consumer.html#a79558de7435fd0b6ca0bde84f3061822',1,'pulsar::Consumer::acknowledgeCumulative(const MessageId &messageId)']]], + ['acknowledgecumulativeasync_3',['acknowledgecumulativeasync',['../classpulsar_1_1_consumer.html#a6ad164b1ab4449b17bce764224e92960',1,'pulsar::Consumer::acknowledgeCumulativeAsync(const Message &message, ResultCallback callback)'],['../classpulsar_1_1_consumer.html#a5d4cf148f372618961fd3411792a5cd7',1,'pulsar::Consumer::acknowledgeCumulativeAsync(const MessageId &messageId, ResultCallback callback)']]], + ['addencryptionkey_4',['addEncryptionKey',['../classpulsar_1_1_producer_configuration.html#a5d8739282f60f8c5c25c937eff5aeb2f',1,'pulsar::ProducerConfiguration']]], + ['alltopics_5',['AllTopics',['../namespacepulsar.html#abd9b21e56a6fb78e04cae2664ff0dbbdaa30bab3d7d550e08f128647cbbd5b6ef',1,'pulsar']]], + ['authathenz_6',['AuthAthenz',['../classpulsar_1_1_auth_athenz.html',1,'pulsar']]], + ['authbasic_7',['AuthBasic',['../classpulsar_1_1_auth_basic.html',1,'pulsar']]], + ['authenticate_8',['authenticate',['../classpulsar_1_1_oauth2_flow.html#a26ba112e97d9ce0283adaa9213f848ac',1,'pulsar::Oauth2Flow']]], + ['authentication_9',['Authentication',['../classpulsar_1_1_authentication.html',1,'pulsar']]], + ['authenticationdataprovider_10',['AuthenticationDataProvider',['../classpulsar_1_1_authentication_data_provider.html',1,'pulsar']]], + ['authfactory_11',['AuthFactory',['../classpulsar_1_1_auth_factory.html',1,'pulsar']]], + ['authoauth2_12',['AuthOauth2',['../classpulsar_1_1_auth_oauth2.html',1,'pulsar']]], + ['authtls_13',['AuthTls',['../classpulsar_1_1_auth_tls.html',1,'pulsar']]], + ['authtoken_14',['AuthToken',['../classpulsar_1_1_auth_token.html',1,'pulsar']]], + ['auto_5fconsume_15',['AUTO_CONSUME',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305a6a9078e01119bddf19aa24dc05390f99',1,'pulsar']]], + ['auto_5fpublish_16',['AUTO_PUBLISH',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305ad1af93d272614c940d322497eb8e31f0',1,'pulsar']]], + ['auto_5fsplit_17',['AUTO_SPLIT',['../namespacepulsar.html#a499d1327931169d068b9b353f106dd04a1dce3e502d8e018e90f97c07b37cde1f',1,'pulsar']]], + ['avro_18',['AVRO',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305ac728ff4cb4de807c1b6fa8ca33f41d47',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/all_1.js b/static/api/cpp/3.5.x/search/all_1.js new file mode 100644 index 000000000000..832012effc70 --- /dev/null +++ b/static/api/cpp/3.5.x/search/all_1.js @@ -0,0 +1,16 @@ +var searchData= +[ + ['batchindex_0',['batchIndex',['../classpulsar_1_1_message_id_builder.html#a09df47acda7f3fe3ec8b0b2f7b9f99f9',1,'pulsar::MessageIdBuilder']]], + ['batchingtype_1',['BatchingType',['../classpulsar_1_1_producer_configuration.html#adeed584c68f90401147e31091e54c5e5',1,'pulsar::ProducerConfiguration']]], + ['batchreceive_2',['batchReceive',['../classpulsar_1_1_consumer.html#a49c846a386d778df94a1439982be5cbd',1,'pulsar::Consumer']]], + ['batchreceiveasync_3',['batchReceiveAsync',['../classpulsar_1_1_consumer.html#ac403fe5941453dcfc41cc01055bca16e',1,'pulsar::Consumer']]], + ['batchreceivepolicy_4',['batchreceivepolicy',['../classpulsar_1_1_batch_receive_policy.html',1,'pulsar::BatchReceivePolicy'],['../classpulsar_1_1_batch_receive_policy.html#af991536bbae3de08b7d11ad3ad28f647',1,'pulsar::BatchReceivePolicy::BatchReceivePolicy(int maxNumMessage, long maxNumBytes, long timeoutMs)'],['../classpulsar_1_1_batch_receive_policy.html#a95e11e66f6e2a2ae0d842c39f15ebfe0',1,'pulsar::BatchReceivePolicy::BatchReceivePolicy()']]], + ['batchsize_5',['batchSize',['../classpulsar_1_1_message_id_builder.html#a070889cc7ffd6f403883b64f38146f74',1,'pulsar::MessageIdBuilder']]], + ['becameactive_6',['becameActive',['../classpulsar_1_1_consumer_event_listener.html#ae6423a9fb10d4c76642bf7f036d43875',1,'pulsar::ConsumerEventListener']]], + ['becameinactive_7',['becameInactive',['../classpulsar_1_1_consumer_event_listener.html#aa11768bfa6db7611e95631202d88439e',1,'pulsar::ConsumerEventListener']]], + ['beforeconsume_8',['beforeConsume',['../classpulsar_1_1_consumer_interceptor.html#a390ea752b64d895a6cca218255ba1398',1,'pulsar::ConsumerInterceptor']]], + ['beforesend_9',['beforeSend',['../classpulsar_1_1_producer_interceptor.html#adc40c03231068fa4a13d6017220d0a79',1,'pulsar::ProducerInterceptor']]], + ['brokerconsumerstats_10',['BrokerConsumerStats',['../classpulsar_1_1_broker_consumer_stats.html',1,'pulsar']]], + ['build_11',['build',['../classpulsar_1_1_dead_letter_policy_builder.html#a49862689af514682dae0279889da6c03',1,'pulsar::DeadLetterPolicyBuilder::build()'],['../classpulsar_1_1_message_builder.html#a096971441b85caead9602670d7b901d6',1,'pulsar::MessageBuilder::build()'],['../classpulsar_1_1_message_id_builder.html#a8fe3a6d2cc7a29f59137ad241887bf0e',1,'pulsar::MessageIdBuilder::build()']]], + ['bytes_12',['BYTES',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305a4dcbdcae67c5f78b7c4fff2c2135cba2',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/all_10.js b/static/api/cpp/3.5.x/search/all_10.js new file mode 100644 index 000000000000..4906567198c4 --- /dev/null +++ b/static/api/cpp/3.5.x/search/all_10.js @@ -0,0 +1,62 @@ +var searchData= +[ + ['reader_0',['reader',['../classpulsar_1_1_reader.html',1,'pulsar::Reader'],['../classpulsar_1_1_reader.html#a1c34e49ba3dbca0ff7e23ea9ff94db7b',1,'pulsar::Reader::Reader()']]], + ['readerconfiguration_1',['ReaderConfiguration',['../classpulsar_1_1_reader_configuration.html',1,'pulsar']]], + ['readerlistener_2',['ReaderListener',['../namespacepulsar.html#a9bddad6880419962bbc6af877209cd49',1,'pulsar']]], + ['readnext_3',['readnext',['../classpulsar_1_1_reader.html#a39c664ea68774721bc0e772b38449b22',1,'pulsar::Reader::readNext(Message &msg, int timeoutMs)'],['../classpulsar_1_1_reader.html#a11756c69a2f5bd99e302a384ae8a9ff4',1,'pulsar::Reader::readNext(Message &msg)']]], + ['readnextasync_4',['readNextAsync',['../classpulsar_1_1_reader.html#a1ed12cbc71284694e5ff9fee1e7c462d',1,'pulsar::Reader']]], + ['receive_5',['receive',['../classpulsar_1_1_consumer.html#ace9475b70f37c91df5b442f41058370e',1,'pulsar::Consumer::receive(Message &msg, int timeoutMs)'],['../classpulsar_1_1_consumer.html#abc8cec6e81c582c6af8e3d931e41a2ad',1,'pulsar::Consumer::receive(Message &msg)']]], + ['receiveasync_6',['receiveAsync',['../classpulsar_1_1_consumer.html#a0189416fb8672b23919276cc9f1bba5d',1,'pulsar::Consumer']]], + ['redeliverunacknowledgedmessages_7',['redeliverUnacknowledgedMessages',['../classpulsar_1_1_consumer.html#a3d60ee12b0e9766d60c3a8e08a61287a',1,'pulsar::Consumer']]], + ['regexsubscriptionmode_8',['RegexSubscriptionMode',['../namespacepulsar.html#abd9b21e56a6fb78e04cae2664ff0dbbd',1,'pulsar']]], + ['result_9',['Result',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbb',1,'pulsar']]], + ['resultalreadyclosed_10',['ResultAlreadyClosed',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba6c11f7cd8f0bc274d12c5157157ad916',1,'pulsar']]], + ['resultauthenticationerror_11',['ResultAuthenticationError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba2b40eba56a27dc5615338a0d988e2024',1,'pulsar']]], + ['resultauthorizationerror_12',['ResultAuthorizationError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba4db07aa497065f6cc0d8e314bf852057',1,'pulsar']]], + ['resultbrokermetadataerror_13',['ResultBrokerMetadataError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba2188e16c2e397cee5f64aef6799c419c',1,'pulsar']]], + ['resultbrokerpersistenceerror_14',['ResultBrokerPersistenceError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba3ac5992ae486593f5aee1538970b51a6',1,'pulsar']]], + ['resultcallback_15',['ResultCallback',['../namespacepulsar.html#ae5bf6401bfa8e3962e5c8f9fa2efbf4d',1,'pulsar']]], + ['resultchecksumerror_16',['ResultChecksumError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba60d3371f74155ecb5b11efbf217a2174',1,'pulsar']]], + ['resultconnecterror_17',['ResultConnectError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbab26ee1bb88fafefa107071fa1fd775bc',1,'pulsar']]], + ['resultconsumerassignerror_18',['ResultConsumerAssignError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbac0f35889e7dd6cb7f634baedb8481e9e',1,'pulsar']]], + ['resultconsumerbusy_19',['ResultConsumerBusy',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba5cbe2e189b60f91ff0f2e82b973db31b',1,'pulsar']]], + ['resultconsumernotfound_20',['ResultConsumerNotFound',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbac74e9fb1b2c25caf17ac3446303b7a71',1,'pulsar']]], + ['resultconsumernotinitialized_21',['ResultConsumerNotInitialized',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba48d27a5310cda91d13a23324a08533e9',1,'pulsar']]], + ['resultcryptoerror_22',['ResultCryptoError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbac131b27876dfd64d8e6b3355578a8f77',1,'pulsar']]], + ['resultcumulativeacknowledgementnotallowederror_23',['ResultCumulativeAcknowledgementNotAllowedError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba2e01cfc218b721cbd2e2a06bf3cb78b0',1,'pulsar']]], + ['resultdisconnected_24',['ResultDisconnected',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba287510a5c9a382f29f0cbdf3d32c0d59',1,'pulsar']]], + ['resulterrorgettingauthenticationdata_25',['ResultErrorGettingAuthenticationData',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba8014344f94ba9ad55337f01767e0e30c',1,'pulsar']]], + ['resultincompatibleschema_26',['ResultIncompatibleSchema',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbafe509853528453adc4ca304ea9b1d79e',1,'pulsar']]], + ['resultinterrupted_27',['ResultInterrupted',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba67722ba0750e461ae03912f5dc10d03a',1,'pulsar']]], + ['resultinvalidconfiguration_28',['ResultInvalidConfiguration',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbad3d7545107897e19819066fe42e81a06',1,'pulsar']]], + ['resultinvalidmessage_29',['ResultInvalidMessage',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba875234396481a34fb7f02d3ecd1936f0',1,'pulsar']]], + ['resultinvalidtopicname_30',['ResultInvalidTopicName',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbafcb0b43f04e494ba3784f6c259b5137f',1,'pulsar']]], + ['resultinvalidtxnstatuserror_31',['ResultInvalidTxnStatusError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba742ada2f12ae5b2ca11fa674889dc186',1,'pulsar']]], + ['resultinvalidurl_32',['ResultInvalidUrl',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba685954a2aedb14c0f3669d579bfd1193',1,'pulsar']]], + ['resultlookuperror_33',['ResultLookupError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba42ae88341f22c34ed9baac35804f1b01',1,'pulsar']]], + ['resultmemorybufferisfull_34',['ResultMemoryBufferIsFull',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba7eaf7df2c4a2ac2f874e044db02c6733',1,'pulsar']]], + ['resultmessagetoobig_35',['ResultMessageTooBig',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba43765d6a6cab85363b2cad047371294b',1,'pulsar']]], + ['resultnotallowederror_36',['ResultNotAllowedError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbad38a4ab387c0769f3c8c30fd2c7413a1',1,'pulsar']]], + ['resultnotconnected_37',['ResultNotConnected',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba00976fab0138d80c5fc621e3a44046b6',1,'pulsar']]], + ['resultok_38',['ResultOk',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba0aac5dae08c453e94161e28d7cd5a92f',1,'pulsar']]], + ['resultoperationnotsupported_39',['ResultOperationNotSupported',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba60abb5ad06a78a3d6d40b2131534dfeb',1,'pulsar']]], + ['resultproducerblockedquotaexceededexception_40',['ResultProducerBlockedQuotaExceededException',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbab5cc52655496666d96f35edab07c9e7f',1,'pulsar']]], + ['resultproducerbusy_41',['ResultProducerBusy',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbad0a7588cc2ac84de7fc17331ed59b544',1,'pulsar']]], + ['resultproducerfenced_42',['ResultProducerFenced',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba6370706ff98bf4c513f11489679543cb',1,'pulsar']]], + ['resultproducernotinitialized_43',['ResultProducerNotInitialized',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba2b5f050c9b2aef10831927cece55b02a',1,'pulsar']]], + ['resultproducerqueueisfull_44',['ResultProducerQueueIsFull',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba1849c732b1ec8c7e1c0aa653de998d81',1,'pulsar']]], + ['resultreaderror_45',['ResultReadError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbaa084aea99a198f2d01c6c98eeb44ff9e',1,'pulsar']]], + ['resultserviceunitnotready_46',['ResultServiceUnitNotReady',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbaf8a459f352105f7e853e02ca2af193b0',1,'pulsar']]], + ['resultsubscriptionnotfound_47',['ResultSubscriptionNotFound',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba061d6c40bdf75ca172ffdb862aad7c51',1,'pulsar']]], + ['resulttimeout_48',['ResultTimeout',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbaeb1858ddf791b7288ab1cb066d70cfb4',1,'pulsar']]], + ['resulttoomanylookuprequestexception_49',['ResultTooManyLookupRequestException',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba024fa5ba9fac2cb81fd4e8f6853a81a5',1,'pulsar']]], + ['resulttopicnotfound_50',['ResultTopicNotFound',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbad1921e33dd6a45431a0209b70588cf48',1,'pulsar']]], + ['resulttopicterminated_51',['ResultTopicTerminated',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba62df217dec3d3f75c7099d1464c92750',1,'pulsar']]], + ['resulttransactionconflict_52',['ResultTransactionConflict',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba39c2049f4e7e428d2a4473b68223a53c',1,'pulsar']]], + ['resulttransactioncoordinatornotfounderror_53',['ResultTransactionCoordinatorNotFoundError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba653a82475a2715f839ba52329a9b6414',1,'pulsar']]], + ['resulttransactionnotfound_54',['ResultTransactionNotFound',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbaf4bfae37b494ea0a2599cc4596bccdf0',1,'pulsar']]], + ['resultunknownerror_55',['ResultUnknownError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba213e39d5c84b8794dd21ab4f60ff4b60',1,'pulsar']]], + ['resultunsupportedversionerror_56',['ResultUnsupportedVersionError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba888578f8569121606cfcfa6044c594c3',1,'pulsar']]], + ['resumemessagelistener_57',['resumeMessageListener',['../classpulsar_1_1_consumer.html#a02a9a412f1aa7f1ec8dc0c0134315b66',1,'pulsar::Consumer']]], + ['retrievevalue_58',['retrieveValue',['../classpulsar_1_1_table_view.html#a7184812e0d4bf374a23ba7c99d53f18e',1,'pulsar::TableView']]] +]; diff --git a/static/api/cpp/3.5.x/search/all_11.js b/static/api/cpp/3.5.x/search/all_11.js new file mode 100644 index 000000000000..00b1e57fd2b9 --- /dev/null +++ b/static/api/cpp/3.5.x/search/all_11.js @@ -0,0 +1,119 @@ +var searchData= +[ + ['schemainfo_0',['schemainfo',['../classpulsar_1_1_schema_info.html',1,'pulsar::SchemaInfo'],['../classpulsar_1_1_schema_info.html#a92a6aa4d6f21ce8511e680b86ed0de93',1,'pulsar::SchemaInfo::SchemaInfo()'],['../classpulsar_1_1_schema_info.html#ab0e388e0cc81a21da3917156053e16d2',1,'pulsar::SchemaInfo::SchemaInfo(SchemaType schemaType, const std::string &name, const std::string &schema, const StringMap &properties=StringMap())'],['../classpulsar_1_1_schema_info.html#abb5fa2e2c1dfe4bdd002a90359bab732',1,'pulsar::SchemaInfo::SchemaInfo(const SchemaInfo &keySchema, const SchemaInfo &valueSchema, const KeyValueEncodingType &keyValueEncodingType=KeyValueEncodingType::INLINE)']]], + ['schematype_1',['SchemaType',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305',1,'pulsar']]], + ['seek_2',['seek',['../classpulsar_1_1_consumer.html#ae6835e612b61795a13eff5fd2da85a0e',1,'pulsar::Consumer::seek()'],['../classpulsar_1_1_reader.html#a6bec25700e5b4eb7be41625a9bc856bd',1,'pulsar::Reader::seek(const MessageId &msgId)'],['../classpulsar_1_1_reader.html#adebdd61a5150777704c8ce8dcec08fc8',1,'pulsar::Reader::seek(uint64_t timestamp)'],['../classpulsar_1_1_consumer.html#a45800c18df817caabe6cd9c21e7d72b3',1,'pulsar::Consumer::seek(const MessageId &messageId)']]], + ['seekasync_3',['seekasync',['../classpulsar_1_1_consumer.html#a01761bcf98436600d5f4d461582db94f',1,'pulsar::Consumer::seekAsync(uint64_t timestamp, ResultCallback callback)'],['../classpulsar_1_1_consumer.html#af1c892616483868ce5e30be46e7a40bf',1,'pulsar::Consumer::seekAsync(const MessageId &messageId, ResultCallback callback)'],['../classpulsar_1_1_reader.html#addec61dc54aba2959c06a2017bea7c32',1,'pulsar::Reader::seekAsync(uint64_t timestamp, ResultCallback callback)'],['../classpulsar_1_1_reader.html#acba58f8fb3ecefc4a693a1091f3c4669',1,'pulsar::Reader::seekAsync(const MessageId &msgId, ResultCallback callback)']]], + ['send_4',['send',['../classpulsar_1_1_producer.html#a32a8c234d42e1951c0357a7562ccdb3a',1,'pulsar::Producer::send(const Message &msg, MessageId &messageId)'],['../classpulsar_1_1_producer.html#ad4737186cf798acfb24a167796259443',1,'pulsar::Producer::send(const Message &msg)']]], + ['sendasync_5',['sendAsync',['../classpulsar_1_1_producer.html#a7b31f92eb0362bdff32316fc9ab70fd7',1,'pulsar::Producer']]], + ['separated_6',['SEPARATED',['../namespacepulsar.html#a0dca31b62c0207ea87e146cde0609595a561af55a6a824ae74125a6cf4eade06a',1,'pulsar']]], + ['serialize_7',['serialize',['../classpulsar_1_1_message_id.html#aef0c413f2705d0ebdf1577c84af6ba6b',1,'pulsar::MessageId']]], + ['setaccessmode_8',['setAccessMode',['../classpulsar_1_1_producer_configuration.html#a24fde55a4c296eacd3276b8299b4d0b3',1,'pulsar::ProducerConfiguration']]], + ['setaccesstoken_9',['setAccessToken',['../classpulsar_1_1_oauth2_token_result.html#af592ce6cc7e7633da3c03cfaa9f0876f',1,'pulsar::Oauth2TokenResult']]], + ['setackgroupingmaxsize_10',['setackgroupingmaxsize',['../classpulsar_1_1_reader_configuration.html#af3e84677688a37133d9b270f86aed8da',1,'pulsar::ReaderConfiguration::setAckGroupingMaxSize()'],['../classpulsar_1_1_consumer_configuration.html#a593295c1aa0cd77c32a6cfdee80cd452',1,'pulsar::ConsumerConfiguration::setAckGroupingMaxSize(long maxGroupingSize)']]], + ['setackgroupingtimems_11',['setackgroupingtimems',['../classpulsar_1_1_consumer_configuration.html#af3f26276c9027a78b9e3243a3e2e38bb',1,'pulsar::ConsumerConfiguration::setAckGroupingTimeMs()'],['../classpulsar_1_1_reader_configuration.html#ab909115a0d99bf1d13f00d098bd4af6f',1,'pulsar::ReaderConfiguration::setAckGroupingTimeMs()']]], + ['setackreceiptenabled_12',['setAckReceiptEnabled',['../classpulsar_1_1_consumer_configuration.html#a3f16bf6b26ddb301c03fcb58e31bdd21',1,'pulsar::ConsumerConfiguration']]], + ['setallocatedcontent_13',['setAllocatedContent',['../classpulsar_1_1_message_builder.html#a33536f52b1a0b00d20d57432377a0822',1,'pulsar::MessageBuilder']]], + ['setallowoutoforderdelivery_14',['setAllowOutOfOrderDelivery',['../classpulsar_1_1_key_shared_policy.html#a5ebe39804f4e2c7a6cc31d1ef7d58e6a',1,'pulsar::KeySharedPolicy']]], + ['setauth_15',['setAuth',['../classpulsar_1_1_client_configuration.html#a283f6a724a4fdd8fa1def661e253eafb',1,'pulsar::ClientConfiguration']]], + ['setautoackoldestchunkedmessageonqueuefull_16',['setAutoAckOldestChunkedMessageOnQueueFull',['../classpulsar_1_1_consumer_configuration.html#a3f11566f0654bd4a9df8e7852e4e048e',1,'pulsar::ConsumerConfiguration']]], + ['setbatchindexackenabled_17',['setBatchIndexAckEnabled',['../classpulsar_1_1_consumer_configuration.html#a19565e5aabcb066e97fed95be4724151',1,'pulsar::ConsumerConfiguration']]], + ['setbatchingenabled_18',['setBatchingEnabled',['../classpulsar_1_1_producer_configuration.html#af9a1dd93b7a412b3bf3ec79d4083f0e8',1,'pulsar::ProducerConfiguration']]], + ['setbatchingmaxallowedsizeinbytes_19',['setBatchingMaxAllowedSizeInBytes',['../classpulsar_1_1_producer_configuration.html#abbec0bcbdee8085afd81e94262d72080',1,'pulsar::ProducerConfiguration']]], + ['setbatchingmaxmessages_20',['setBatchingMaxMessages',['../classpulsar_1_1_producer_configuration.html#a1be81019a86b11ed5c685fdc7e899401',1,'pulsar::ProducerConfiguration']]], + ['setbatchingmaxpublishdelayms_21',['setBatchingMaxPublishDelayMs',['../classpulsar_1_1_producer_configuration.html#a34f1bf46378fba5e065f252f982ce350',1,'pulsar::ProducerConfiguration']]], + ['setbatchingtype_22',['setBatchingType',['../classpulsar_1_1_producer_configuration.html#abe21bc7bbb3f7d3bbad5102688e715a7',1,'pulsar::ProducerConfiguration']]], + ['setbatchreceivepolicy_23',['setBatchReceivePolicy',['../classpulsar_1_1_consumer_configuration.html#a576115b74c66df74662b2e4f00a69731',1,'pulsar::ConsumerConfiguration']]], + ['setblockifqueuefull_24',['setBlockIfQueueFull',['../classpulsar_1_1_producer_configuration.html#ae83e7490292fef0b78619135cc90d6a9',1,'pulsar::ProducerConfiguration']]], + ['setbrokerconsumerstatscachetimeinms_25',['setBrokerConsumerStatsCacheTimeInMs',['../classpulsar_1_1_consumer_configuration.html#a453a6af922fea7c45d56264d57925507',1,'pulsar::ConsumerConfiguration']]], + ['setchunkingenabled_26',['setChunkingEnabled',['../classpulsar_1_1_producer_configuration.html#ad79c6bf2280450ba395aea33885738ae',1,'pulsar::ProducerConfiguration']]], + ['setcompressiontype_27',['setCompressionType',['../classpulsar_1_1_producer_configuration.html#a3e4784fdab5471faeddb380849ba60fb',1,'pulsar::ProducerConfiguration']]], + ['setconcurrentlookuprequest_28',['setConcurrentLookupRequest',['../classpulsar_1_1_client_configuration.html#a9ae54146fe16f423faee853705043a0d',1,'pulsar::ClientConfiguration']]], + ['setconnectionsperbroker_29',['setConnectionsPerBroker',['../classpulsar_1_1_client_configuration.html#a3a2246877634534eb3163ed45221a6f5',1,'pulsar::ClientConfiguration']]], + ['setconnectiontimeout_30',['setConnectionTimeout',['../classpulsar_1_1_client_configuration.html#a6d12355701aed4526560e5754312da53',1,'pulsar::ClientConfiguration']]], + ['setconsumereventlistener_31',['setConsumerEventListener',['../classpulsar_1_1_consumer_configuration.html#a6589512011ad7daf2b9eeaaaf4020842',1,'pulsar::ConsumerConfiguration']]], + ['setconsumername_32',['setConsumerName',['../classpulsar_1_1_consumer_configuration.html#a9a9c38d660aabc9162295de38bc26b77',1,'pulsar::ConsumerConfiguration']]], + ['setconsumertype_33',['setConsumerType',['../classpulsar_1_1_consumer_configuration.html#a5029c0a8bc51a764fdd4eaf37e56964d',1,'pulsar::ConsumerConfiguration']]], + ['setcontent_34',['setcontent',['../classpulsar_1_1_message_builder.html#a6ebb6e9660a46e883c5467213093abcd',1,'pulsar::MessageBuilder::setContent(std::string &&data)'],['../classpulsar_1_1_message_builder.html#a6a9f4daf6548d0c24eae92642b2f9401',1,'pulsar::MessageBuilder::setContent(const KeyValue &data)'],['../classpulsar_1_1_message_builder.html#aeae2c95b0639f36fe80c0ce5256cae16',1,'pulsar::MessageBuilder::setContent(const std::string &data)'],['../classpulsar_1_1_message_builder.html#a2cc0fde4d3dcc2aae68e6e1588c8d364',1,'pulsar::MessageBuilder::setContent(const void *data, size_t size)']]], + ['setcryptofailureaction_35',['setcryptofailureaction',['../classpulsar_1_1_reader_configuration.html#a717ee81f7651851635a569fe35d735ea',1,'pulsar::ReaderConfiguration::setCryptoFailureAction()'],['../classpulsar_1_1_producer_configuration.html#acf13ddf392d17cc54100f02431e6ba4f',1,'pulsar::ProducerConfiguration::setCryptoFailureAction()'],['../classpulsar_1_1_consumer_configuration.html#aadf3be3099c2bbb4354839e21a48e875',1,'pulsar::ConsumerConfiguration::setCryptoFailureAction(ConsumerCryptoFailureAction action)']]], + ['setcryptokeyreader_36',['setcryptokeyreader',['../classpulsar_1_1_consumer_configuration.html#a9ff24549af7bda3f2f4da4cce299eb5d',1,'pulsar::ConsumerConfiguration::setCryptoKeyReader()'],['../classpulsar_1_1_producer_configuration.html#a6934b1d5c42a1f03ad011b20ee5c1724',1,'pulsar::ProducerConfiguration::setCryptoKeyReader()'],['../classpulsar_1_1_reader_configuration.html#a3ce07aacf5e43c5e3252d30e70556fc4',1,'pulsar::ReaderConfiguration::setCryptoKeyReader()']]], + ['setdeadletterpolicy_37',['setDeadLetterPolicy',['../classpulsar_1_1_consumer_configuration.html#a84033093b1bf99d7c843634fdc8a32ec',1,'pulsar::ConsumerConfiguration']]], + ['setdeliverafter_38',['setDeliverAfter',['../classpulsar_1_1_message_builder.html#a43996377452478df5ba3d8255eb8e266',1,'pulsar::MessageBuilder']]], + ['setdeliverat_39',['setDeliverAt',['../classpulsar_1_1_message_builder.html#a07e17c0a4721ec937f028ebc0e8d15f4',1,'pulsar::MessageBuilder']]], + ['seteventtimestamp_40',['setEventTimestamp',['../classpulsar_1_1_message_builder.html#a47a1c042b9e686c48b406c993e7982e5',1,'pulsar::MessageBuilder']]], + ['setexpiresin_41',['setExpiresIn',['../classpulsar_1_1_oauth2_token_result.html#aa27ab0a802260bbf7142e03fd6c8bb46',1,'pulsar::Oauth2TokenResult']]], + ['setexpiretimeofincompletechunkedmessagems_42',['setExpireTimeOfIncompleteChunkedMessageMs',['../classpulsar_1_1_consumer_configuration.html#ac1bf9941a3dbb3948e76b9638d188ea9',1,'pulsar::ConsumerConfiguration']]], + ['sethashingscheme_43',['setHashingScheme',['../classpulsar_1_1_producer_configuration.html#a542691ebedfa1f1fdb706e77067680bb',1,'pulsar::ProducerConfiguration']]], + ['setidtoken_44',['setIdToken',['../classpulsar_1_1_oauth2_token_result.html#a9cdc37fbe7d61486affda02a753ff1dc',1,'pulsar::Oauth2TokenResult']]], + ['setinitialbackoffintervalms_45',['setInitialBackoffIntervalMs',['../classpulsar_1_1_client_configuration.html#aeb336cdb14093bb3626496a631e29441',1,'pulsar::ClientConfiguration']]], + ['setinitialsequenceid_46',['setInitialSequenceId',['../classpulsar_1_1_producer_configuration.html#a9b6c3c9f7e734f0e95cb9c7b301e14eb',1,'pulsar::ProducerConfiguration']]], + ['setinternalsubscriptionname_47',['setInternalSubscriptionName',['../classpulsar_1_1_reader_configuration.html#ae1848f9313953faf2ab00f198d412108',1,'pulsar::ReaderConfiguration']]], + ['setiothreads_48',['setIOThreads',['../classpulsar_1_1_client_configuration.html#a7e83eb6526e98259023e93f0c89c1a61',1,'pulsar::ClientConfiguration']]], + ['setkey_49',['setKey',['../classpulsar_1_1_encryption_key_info.html#a243fb74066b5d6c7153660a4a5cd3290',1,'pulsar::EncryptionKeyInfo']]], + ['setkeysharedmode_50',['setKeySharedMode',['../classpulsar_1_1_key_shared_policy.html#a7ecef0d315c8955a5223d07f11213aa2',1,'pulsar::KeySharedPolicy']]], + ['setkeysharedpolicy_51',['setKeySharedPolicy',['../classpulsar_1_1_consumer_configuration.html#a56eb95eb8f39532c49a3300cb2a4a72d',1,'pulsar::ConsumerConfiguration']]], + ['setlazystartpartitionedproducers_52',['setLazyStartPartitionedProducers',['../classpulsar_1_1_producer_configuration.html#af025bdb0f1c7c9c8fe8cfc61f5e7b1e6',1,'pulsar::ProducerConfiguration']]], + ['setlistenername_53',['setListenerName',['../classpulsar_1_1_client_configuration.html#acb0c818a17629bb78d90bf8d174320fe',1,'pulsar::ClientConfiguration']]], + ['setlogger_54',['setLogger',['../classpulsar_1_1_client_configuration.html#a1bf72e7f2e263ed35ff631a379e7e562',1,'pulsar::ClientConfiguration']]], + ['setmaxbackoffintervalms_55',['setMaxBackoffIntervalMs',['../classpulsar_1_1_client_configuration.html#a40d8e808b298b797c38bc2e57df43aa3',1,'pulsar::ClientConfiguration']]], + ['setmaxlookupredirects_56',['setMaxLookupRedirects',['../classpulsar_1_1_client_configuration.html#abcf3777ad94bee91b2f099a2f23e2033',1,'pulsar::ClientConfiguration']]], + ['setmaxpendingchunkedmessage_57',['setMaxPendingChunkedMessage',['../classpulsar_1_1_consumer_configuration.html#a9d17c5b2ed6547ce9e37fad4438e6e83',1,'pulsar::ConsumerConfiguration']]], + ['setmaxpendingmessages_58',['setMaxPendingMessages',['../classpulsar_1_1_producer_configuration.html#aeb61ed9f97923fb9e65d4e750b145a2f',1,'pulsar::ProducerConfiguration']]], + ['setmaxpendingmessagesacrosspartitions_59',['setMaxPendingMessagesAcrossPartitions',['../classpulsar_1_1_producer_configuration.html#ac44a68df892d721fad29056f4d89e9c4',1,'pulsar::ProducerConfiguration']]], + ['setmaxtotalreceiverqueuesizeacrosspartitions_60',['setMaxTotalReceiverQueueSizeAcrossPartitions',['../classpulsar_1_1_consumer_configuration.html#a9c07888abe996b80c2fd168278a24de3',1,'pulsar::ConsumerConfiguration']]], + ['setmemorylimit_61',['setMemoryLimit',['../classpulsar_1_1_client_configuration.html#ace74b6344c19c7039087be76d86528f6',1,'pulsar::ClientConfiguration']]], + ['setmessageid_62',['setMessageId',['../classpulsar_1_1_message.html#a441a530a2943fc45133690bda73a113a',1,'pulsar::Message']]], + ['setmessagelistener_63',['setMessageListener',['../classpulsar_1_1_consumer_configuration.html#a996399917ff343715bf29afe07981c83',1,'pulsar::ConsumerConfiguration']]], + ['setmessagelistenerthreads_64',['setMessageListenerThreads',['../classpulsar_1_1_client_configuration.html#a5c0d6ddb5e00afe43067505bd46a6a9d',1,'pulsar::ClientConfiguration']]], + ['setmessagerouter_65',['setMessageRouter',['../classpulsar_1_1_producer_configuration.html#abf5a23a8d0eaebba237dca1bbf72a8f2',1,'pulsar::ProducerConfiguration']]], + ['setmetadata_66',['setMetadata',['../classpulsar_1_1_encryption_key_info.html#a7ae2f1225fb8897ebbcc74cc7753cfaf',1,'pulsar::EncryptionKeyInfo']]], + ['setnegativeackredeliverydelayms_67',['setNegativeAckRedeliveryDelayMs',['../classpulsar_1_1_consumer_configuration.html#aef99f71cd13324351864dd1e376d8788',1,'pulsar::ConsumerConfiguration']]], + ['setoperationtimeoutseconds_68',['setOperationTimeoutSeconds',['../classpulsar_1_1_client_configuration.html#ac5659a9c3232ab07ed1e81dd406187c1',1,'pulsar::ClientConfiguration']]], + ['setorderingkey_69',['setOrderingKey',['../classpulsar_1_1_message_builder.html#a58e630e1da0388f0a81e2e0474aa346d',1,'pulsar::MessageBuilder']]], + ['setpartitionkey_70',['setPartitionKey',['../classpulsar_1_1_message_builder.html#a1efcf691608abcbb3b915a16f5c99bff',1,'pulsar::MessageBuilder']]], + ['setpartitionsroutingmode_71',['setPartitionsRoutingMode',['../classpulsar_1_1_producer_configuration.html#a6842f9d4d16d50b3b993df67c043ad38',1,'pulsar::ProducerConfiguration']]], + ['setpartititionsupdateinterval_72',['setPartititionsUpdateInterval',['../classpulsar_1_1_client_configuration.html#a5879c3ecf00ee0d1d85a1eea3977f6ba',1,'pulsar::ClientConfiguration']]], + ['setpatternautodiscoveryperiod_73',['setPatternAutoDiscoveryPeriod',['../classpulsar_1_1_consumer_configuration.html#a5910aa7539a7fb217a38813d846a9acb',1,'pulsar::ConsumerConfiguration']]], + ['setprioritylevel_74',['setPriorityLevel',['../classpulsar_1_1_consumer_configuration.html#a09492153409160a4993796f88caadd23',1,'pulsar::ConsumerConfiguration']]], + ['setproducername_75',['setProducerName',['../classpulsar_1_1_producer_configuration.html#a8286421f85e5da6c71abe10e5f1ee7cd',1,'pulsar::ProducerConfiguration']]], + ['setproperties_76',['setproperties',['../classpulsar_1_1_message_builder.html#a90ce43fad4ea63704569ff2a60d02599',1,'pulsar::MessageBuilder::setProperties()'],['../classpulsar_1_1_producer_configuration.html#a45afb46cc1d2083cc58927af5bea3c9d',1,'pulsar::ProducerConfiguration::setProperties()'],['../classpulsar_1_1_reader_configuration.html#a12a43dd43372fb0b173002597bfdb2e3',1,'pulsar::ReaderConfiguration::setProperties()'],['../classpulsar_1_1_consumer_configuration.html#a093486de4b32d91655d8b4e45efd6d6f',1,'pulsar::ConsumerConfiguration::setProperties()']]], + ['setproperty_77',['setproperty',['../classpulsar_1_1_producer_configuration.html#ab6ff6f83f46ac85e60ed1611350d1e79',1,'pulsar::ProducerConfiguration::setProperty()'],['../classpulsar_1_1_message_builder.html#ae59904777c9565d762e4d3230d090ab7',1,'pulsar::MessageBuilder::setProperty()'],['../classpulsar_1_1_reader_configuration.html#a8fa193115478c84dfdef934fd50861fd',1,'pulsar::ReaderConfiguration::setProperty()'],['../classpulsar_1_1_consumer_configuration.html#acb0cfc0ded14bd3c324466a41c9aaf9e',1,'pulsar::ConsumerConfiguration::setProperty()']]], + ['setproxyprotocol_78',['setProxyProtocol',['../classpulsar_1_1_client_configuration.html#ace1db02ebfa21f89ee887d8f8df7c180',1,'pulsar::ClientConfiguration']]], + ['setproxyserviceurl_79',['setProxyServiceUrl',['../classpulsar_1_1_client_configuration.html#a9205dfdb1cb7c0ffe76f2fc2a31f50de',1,'pulsar::ClientConfiguration']]], + ['setreadcompacted_80',['setreadcompacted',['../classpulsar_1_1_consumer_configuration.html#ae3f12b9f76982d8ea64f80adfb8af960',1,'pulsar::ConsumerConfiguration::setReadCompacted()'],['../classpulsar_1_1_reader_configuration.html#aaf766afd6e75d0e1454d81d980f019b3',1,'pulsar::ReaderConfiguration::setReadCompacted(bool compacted)']]], + ['setreaderlistener_81',['setReaderListener',['../classpulsar_1_1_reader_configuration.html#abade75269a49ba228530847e2013303d',1,'pulsar::ReaderConfiguration']]], + ['setreadername_82',['setReaderName',['../classpulsar_1_1_reader_configuration.html#a8d42ba4bd17f9ac54a609d94f98780a2',1,'pulsar::ReaderConfiguration']]], + ['setreceiverqueuesize_83',['setreceiverqueuesize',['../classpulsar_1_1_consumer_configuration.html#a265d2cd1e9d1d329eff9b98346f245c2',1,'pulsar::ConsumerConfiguration::setReceiverQueueSize()'],['../classpulsar_1_1_reader_configuration.html#a0574cedc0bc7ccf457071df866830abe',1,'pulsar::ReaderConfiguration::setReceiverQueueSize()']]], + ['setrefreshtoken_84',['setRefreshToken',['../classpulsar_1_1_oauth2_token_result.html#a87d8e7e923d1ca96d5c0425cf80d5d42',1,'pulsar::Oauth2TokenResult']]], + ['setregexsubscriptionmode_85',['setRegexSubscriptionMode',['../classpulsar_1_1_consumer_configuration.html#a56726bee70b41cc2832fae59a38837a4',1,'pulsar::ConsumerConfiguration']]], + ['setreplicatesubscriptionstateenabled_86',['setReplicateSubscriptionStateEnabled',['../classpulsar_1_1_consumer_configuration.html#a70a15216ef41c8bd38178bdc5e377a31',1,'pulsar::ConsumerConfiguration']]], + ['setreplicationclusters_87',['setReplicationClusters',['../classpulsar_1_1_message_builder.html#acde04b110dbccdd7591fad9d4aa9f9c9',1,'pulsar::MessageBuilder']]], + ['setschema_88',['setschema',['../classpulsar_1_1_reader_configuration.html#acbc3fa4579799b7857ca0daa938b0459',1,'pulsar::ReaderConfiguration::setSchema()'],['../classpulsar_1_1_consumer_configuration.html#a79d9ef9f0698713b38f260b0b46d191f',1,'pulsar::ConsumerConfiguration::setSchema()'],['../classpulsar_1_1_producer_configuration.html#af161c34b3745581293e6df1e2f8115af',1,'pulsar::ProducerConfiguration::setSchema(const SchemaInfo &schemaInfo)']]], + ['setsendtimeout_89',['setSendTimeout',['../classpulsar_1_1_producer_configuration.html#a20cd4b67462cb786f097a74fde857cf5',1,'pulsar::ProducerConfiguration']]], + ['setsequenceid_90',['setSequenceId',['../classpulsar_1_1_message_builder.html#a94372cd317b679b7748149429655a0f3',1,'pulsar::MessageBuilder']]], + ['setstartmessageidinclusive_91',['setstartmessageidinclusive',['../classpulsar_1_1_reader_configuration.html#ad34cc5c0bb490e5588653f7bbbf3cd2a',1,'pulsar::ReaderConfiguration::setStartMessageIdInclusive()'],['../classpulsar_1_1_consumer_configuration.html#af4085925dc8b62bec126cd3ea1e1085a',1,'pulsar::ConsumerConfiguration::setStartMessageIdInclusive()']]], + ['setstatsintervalinseconds_92',['setStatsIntervalInSeconds',['../classpulsar_1_1_client_configuration.html#a0c7c63f49cd66554563c3f5e133c4fc6',1,'pulsar::ClientConfiguration']]], + ['setstickyranges_93',['setstickyranges',['../classpulsar_1_1_key_shared_policy.html#adc25d81437fa23ab5eec077c3600bc73',1,'pulsar::KeySharedPolicy::setStickyRanges(std::initializer_list< StickyRange > ranges)'],['../classpulsar_1_1_key_shared_policy.html#aa76f2ad0ea56748d2f7c52d5a269d6d9',1,'pulsar::KeySharedPolicy::setStickyRanges(const StickyRanges &ranges)']]], + ['setsubscriptioninitialposition_94',['setSubscriptionInitialPosition',['../classpulsar_1_1_consumer_configuration.html#ab0e049e62befb9b924307ba6f990cd97',1,'pulsar::ConsumerConfiguration']]], + ['setsubscriptionproperties_95',['setSubscriptionProperties',['../classpulsar_1_1_consumer_configuration.html#ae60097f3b91d2291dd121e3573f55855',1,'pulsar::ConsumerConfiguration']]], + ['setsubscriptionroleprefix_96',['setSubscriptionRolePrefix',['../classpulsar_1_1_reader_configuration.html#a281c0ae5579461f80677b43126329cd1',1,'pulsar::ReaderConfiguration']]], + ['settickdurationinms_97',['settickdurationinms',['../classpulsar_1_1_reader_configuration.html#a23df99b9e97709fcaa50e1766eb84e9b',1,'pulsar::ReaderConfiguration::setTickDurationInMs()'],['../classpulsar_1_1_consumer_configuration.html#a8b86fc6d5d8ca8e5c5dd35aa8a1c52b4',1,'pulsar::ConsumerConfiguration::setTickDurationInMs()']]], + ['settlsallowinsecureconnection_98',['setTlsAllowInsecureConnection',['../classpulsar_1_1_client_configuration.html#a9c6de9ae9ffe25f93e45d52af33786c7',1,'pulsar::ClientConfiguration']]], + ['settlscertificatefilepath_99',['setTlsCertificateFilePath',['../classpulsar_1_1_client_configuration.html#a9040f07538e832ea521cf37b1d00b5be',1,'pulsar::ClientConfiguration']]], + ['settlsprivatekeyfilepath_100',['setTlsPrivateKeyFilePath',['../classpulsar_1_1_client_configuration.html#a9a3462c57a542998b6324ba4144790c0',1,'pulsar::ClientConfiguration']]], + ['settlstrustcertsfilepath_101',['setTlsTrustCertsFilePath',['../classpulsar_1_1_client_configuration.html#a65e807a8eb8d68b27ba464c3c026d5da',1,'pulsar::ClientConfiguration']]], + ['settopicname_102',['setTopicName',['../classpulsar_1_1_message_id.html#a3d84665dab3feb64ed00183a322b92f2',1,'pulsar::MessageId']]], + ['setunackedmessagestimeoutms_103',['setunackedmessagestimeoutms',['../classpulsar_1_1_reader_configuration.html#a11da218b52a8936415029509b9c707e9',1,'pulsar::ReaderConfiguration::setUnAckedMessagesTimeoutMs()'],['../classpulsar_1_1_consumer_configuration.html#ad55a4f0187517c984de8d01f8660fb8f',1,'pulsar::ConsumerConfiguration::setUnAckedMessagesTimeoutMs()']]], + ['setusetls_104',['setUseTls',['../classpulsar_1_1_client_configuration.html#ad2cd7f96ed00b4a398329cee24aa293c',1,'pulsar::ClientConfiguration']]], + ['setvalidatehostname_105',['setValidateHostName',['../classpulsar_1_1_client_configuration.html#a10233b86c33c352f79eb0dabf954809b',1,'pulsar::ClientConfiguration']]], + ['shared_106',['Shared',['../classpulsar_1_1_producer_configuration.html#ab217b341d1fa532552bcd03064a39ceaa73f8f203fbd16f91a5b123a362bf13e5',1,'pulsar::ProducerConfiguration']]], + ['shutdown_107',['shutdown',['../classpulsar_1_1_client.html#aecac8bf91b474339455fe0519f6ba71e',1,'pulsar::Client']]], + ['size_108',['size',['../classpulsar_1_1_table_view.html#afdb10373c073e4b0722606a0f9b4174e',1,'pulsar::TableView']]], + ['snapshot_109',['snapshot',['../classpulsar_1_1_table_view.html#a5169558ea5a27b29dd5bcf040fa97543',1,'pulsar::TableView']]], + ['sticky_110',['STICKY',['../namespacepulsar.html#a499d1327931169d068b9b353f106dd04aed98d14aabee0f3bc70a0cc7723e5b16',1,'pulsar']]], + ['string_111',['STRING',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305ab936a9dad2cbb5fca28fc477ff39fb70',1,'pulsar']]], + ['subscribe_112',['subscribe',['../classpulsar_1_1_client.html#a11b3ca7d9174a0912bf51b742f7f825a',1,'pulsar::Client::subscribe(const std::string &topic, const std::string &subscriptionName, const ConsumerConfiguration &conf, Consumer &consumer)'],['../classpulsar_1_1_client.html#a9188d5fafbb23da16f859592316947e4',1,'pulsar::Client::subscribe(const std::vector< std::string > &topics, const std::string &subscriptionName, const ConsumerConfiguration &conf, Consumer &consumer)'],['../classpulsar_1_1_client.html#a9f32b4d1101f8f2fb5029013c87779ab',1,'pulsar::Client::subscribe(const std::string &topic, const std::string &subscriptionName, Consumer &consumer)'],['../classpulsar_1_1_client.html#aea2d7918286ecd127751d06e191a5471',1,'pulsar::Client::subscribe(const std::vector< std::string > &topics, const std::string &subscriptionName, Consumer &consumer)']]], + ['subscribeasync_113',['subscribeasync',['../classpulsar_1_1_client.html#a85d82595856f515b22acb623e84daa4b',1,'pulsar::Client::subscribeAsync(const std::string &topic, const std::string &subscriptionName, const ConsumerConfiguration &conf, SubscribeCallback callback)'],['../classpulsar_1_1_client.html#afcfcc1f9bcc63527063ae1b60a41ba8e',1,'pulsar::Client::subscribeAsync(const std::vector< std::string > &topics, const std::string &subscriptionName, const ConsumerConfiguration &conf, SubscribeCallback callback)'],['../classpulsar_1_1_client.html#a33f76797dfbd57daf4c72f96c659fe77',1,'pulsar::Client::subscribeAsync(const std::vector< std::string > &topics, const std::string &subscriptionName, SubscribeCallback callback)'],['../classpulsar_1_1_client.html#a534d1cc013112c4e9eeee037b42b4815',1,'pulsar::Client::subscribeAsync(const std::string &topic, const std::string &subscriptionName, SubscribeCallback callback)']]], + ['subscribewithregex_114',['subscribewithregex',['../classpulsar_1_1_client.html#a086549ca0d057be1e9d00ca483995621',1,'pulsar::Client::subscribeWithRegex(const std::string &regexPattern, const std::string &subscriptionName, Consumer &consumer)'],['../classpulsar_1_1_client.html#a11016481c032f7d07e3ab5be341c9344',1,'pulsar::Client::subscribeWithRegex(const std::string &regexPattern, const std::string &subscriptionName, const ConsumerConfiguration &conf, Consumer &consumer)']]], + ['subscribewithregexasync_115',['subscribewithregexasync',['../classpulsar_1_1_client.html#abef60cadedd17903a245dbaa8368381a',1,'pulsar::Client::subscribeWithRegexAsync(const std::string &regexPattern, const std::string &subscriptionName, const ConsumerConfiguration &conf, SubscribeCallback callback)'],['../classpulsar_1_1_client.html#a49a6024ae4ff44e1e02a59bc08d28c7a',1,'pulsar::Client::subscribeWithRegexAsync(const std::string &regexPattern, const std::string &subscriptionName, SubscribeCallback callback)']]] +]; diff --git a/static/api/cpp/3.5.x/search/all_12.js b/static/api/cpp/3.5.x/search/all_12.js new file mode 100644 index 000000000000..c8da51ce9b0d --- /dev/null +++ b/static/api/cpp/3.5.x/search/all_12.js @@ -0,0 +1,9 @@ +var searchData= +[ + ['tableview_0',['tableview',['../classpulsar_1_1_table_view.html',1,'pulsar::TableView'],['../classpulsar_1_1_table_view.html#ae43275f26ff0ec494a75c11210ec6139',1,'pulsar::TableView::TableView()']]], + ['tableviewconfiguration_1',['TableViewConfiguration',['../structpulsar_1_1_table_view_configuration.html',1,'pulsar']]], + ['topicmetadata_2',['TopicMetadata',['../classpulsar_1_1_topic_metadata.html',1,'pulsar']]], + ['typedmessage_3',['TypedMessage',['../classpulsar_1_1_typed_message.html',1,'pulsar']]], + ['typedmessagebuilder_4',['TypedMessageBuilder',['../classpulsar_1_1_typed_message_builder.html',1,'pulsar']]], + ['typedmessagebuilder_3c_20std_3a_3astring_20_3e_5',['TypedMessageBuilder< std::string >',['../classpulsar_1_1_typed_message_builder_3_01std_1_1string_01_4.html',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/all_13.js b/static/api/cpp/3.5.x/search/all_13.js new file mode 100644 index 000000000000..ec37f23ddfe8 --- /dev/null +++ b/static/api/cpp/3.5.x/search/all_13.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['unsubscribe_0',['unsubscribe',['../classpulsar_1_1_consumer.html#a542ca0a9473a03ccf8bd8aeed24de490',1,'pulsar::Consumer']]], + ['unsubscribeasync_1',['unsubscribeAsync',['../classpulsar_1_1_consumer.html#a8691920cae838418f33f13690a72771d',1,'pulsar::Consumer']]] +]; diff --git a/static/api/cpp/3.5.x/search/all_14.js b/static/api/cpp/3.5.x/search/all_14.js new file mode 100644 index 000000000000..cc6bbd3174b8 --- /dev/null +++ b/static/api/cpp/3.5.x/search/all_14.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['waitforexclusive_0',['WaitForExclusive',['../classpulsar_1_1_producer_configuration.html#ab217b341d1fa532552bcd03064a39ceaa9ba09474e854bd3d7094580ed7a3ff29',1,'pulsar::ProducerConfiguration']]] +]; diff --git a/static/api/cpp/3.5.x/search/all_2.js b/static/api/cpp/3.5.x/search/all_2.js new file mode 100644 index 000000000000..379d2b5c066c --- /dev/null +++ b/static/api/cpp/3.5.x/search/all_2.js @@ -0,0 +1,32 @@ +var searchData= +[ + ['cachedtoken_0',['CachedToken',['../classpulsar_1_1_cached_token.html',1,'pulsar']]], + ['client_1',['client',['../classpulsar_1_1_client.html',1,'pulsar::Client'],['../classpulsar_1_1_client.html#acab90af5d0542803bc1d10e68d27414f',1,'pulsar::Client::Client(const std::string &serviceUrl)'],['../classpulsar_1_1_client.html#a148122b14f22844d359c35c084907962',1,'pulsar::Client::Client(const std::string &serviceUrl, const ClientConfiguration &clientConfiguration)']]], + ['client_20cpp_2',['pulsar-client-cpp',['../index.html',1,'']]], + ['clientconfiguration_3',['ClientConfiguration',['../classpulsar_1_1_client_configuration.html',1,'pulsar']]], + ['clone_4',['clone',['../classpulsar_1_1_key_shared_policy.html#a421a7227c39ba3c199ec86c40b6b5c75',1,'pulsar::KeySharedPolicy::clone()'],['../classpulsar_1_1_consumer_configuration.html#ae5d5850e9e0f3130424860e6715b0fa0',1,'pulsar::ConsumerConfiguration::clone()']]], + ['close_5',['close',['../classpulsar_1_1_consumer_interceptor.html#abe9d12923a7f6b3bc56c9596a4bac7bc',1,'pulsar::ConsumerInterceptor::close()'],['../classpulsar_1_1_producer.html#a0b4a93617a0c0f8d172633a7bf8ba06b',1,'pulsar::Producer::close()'],['../classpulsar_1_1_table_view.html#a5f913f66c65c819a0b151daf08d43440',1,'pulsar::TableView::close()'],['../classpulsar_1_1_reader.html#ab15cfd0e35d625d2f1af5936c314b623',1,'pulsar::Reader::close()'],['../classpulsar_1_1_producer_interceptor.html#a59d5f25b142cd69ebbca13f22842120b',1,'pulsar::ProducerInterceptor::close()'],['../classpulsar_1_1_oauth2_flow.html#ae4815e1adf8cced8553f9e3d6d6717a8',1,'pulsar::Oauth2Flow::close()'],['../classpulsar_1_1_client.html#ac3f0a65b099f88781548d4fad41685ac',1,'pulsar::Client::close()'],['../classpulsar_1_1_consumer.html#a8b01803221c283e4df21715aeb024b84',1,'pulsar::Consumer::close()']]], + ['closeasync_6',['closeasync',['../classpulsar_1_1_client.html#ad2701d78fca53d5261616ca53381241d',1,'pulsar::Client::closeAsync()'],['../classpulsar_1_1_table_view.html#a828d9b3efa7ba6b6a18e97e669e3945e',1,'pulsar::TableView::closeAsync()'],['../classpulsar_1_1_producer.html#a40f5268e6754c9e61e2406d432cffe2f',1,'pulsar::Producer::closeAsync()'],['../classpulsar_1_1_consumer.html#a1b4539f46eb42170a550d6cd9076d8d7',1,'pulsar::Consumer::closeAsync()'],['../classpulsar_1_1_reader.html#a203d50fd687e2c77e4f7e7bb0b14bab7',1,'pulsar::Reader::closeAsync()']]], + ['consoleloggerfactory_7',['ConsoleLoggerFactory',['../classpulsar_1_1_console_logger_factory.html',1,'pulsar']]], + ['consumer_8',['consumer',['../classpulsar_1_1_consumer.html',1,'pulsar::Consumer'],['../classpulsar_1_1_consumer.html#afe59503d5d5309f38d4e246bd9f435b4',1,'pulsar::Consumer::Consumer()']]], + ['consumerconfiguration_9',['ConsumerConfiguration',['../classpulsar_1_1_consumer_configuration.html',1,'pulsar']]], + ['consumereventlistener_10',['ConsumerEventListener',['../classpulsar_1_1_consumer_event_listener.html',1,'pulsar']]], + ['consumerexclusive_11',['ConsumerExclusive',['../namespacepulsar.html#ac3e442abe2558a2b257fc7344af61d40a915cd237340dcd1d212f8d398f3d91ac',1,'pulsar']]], + ['consumerfailover_12',['ConsumerFailover',['../namespacepulsar.html#ac3e442abe2558a2b257fc7344af61d40aadffd5f0d50b1da36685230cd3f910a1',1,'pulsar']]], + ['consumerinterceptor_13',['ConsumerInterceptor',['../classpulsar_1_1_consumer_interceptor.html',1,'pulsar']]], + ['consumerkeyshared_14',['ConsumerKeyShared',['../namespacepulsar.html#ac3e442abe2558a2b257fc7344af61d40acb902cf3781caf307d06e37dc447d5cc',1,'pulsar']]], + ['consumershared_15',['ConsumerShared',['../namespacepulsar.html#ac3e442abe2558a2b257fc7344af61d40ac55370821e835a03c2da742ab27e1705',1,'pulsar']]], + ['consumertype_16',['ConsumerType',['../namespacepulsar.html#ac3e442abe2558a2b257fc7344af61d40',1,'pulsar']]], + ['containskey_17',['containsKey',['../classpulsar_1_1_table_view.html#a212c8a8897249b47c1cd6f44e04d452b',1,'pulsar::TableView']]], + ['cpp_18',['pulsar-client-cpp',['../index.html',1,'']]], + ['create_19',['create',['../classpulsar_1_1_auth_token.html#aa4d3740c838620765a7332bf2247b5e9',1,'pulsar::AuthToken::create(ParamMap &params)'],['../classpulsar_1_1_auth_token.html#a9601a01bd5b7b644531d82fc3cfa7d09',1,'pulsar::AuthToken::create(const std::string &authParamsString)'],['../classpulsar_1_1_auth_token.html#ae9b2da50ad0c22335b298d939239602c',1,'pulsar::AuthToken::create(const TokenSupplier &tokenSupplier)'],['../classpulsar_1_1_auth_basic.html#aee17b2ca84965dfe8b3d9296dd397400',1,'pulsar::AuthBasic::create(ParamMap &params)'],['../classpulsar_1_1_auth_basic.html#ac9f7f369e4559f0aa108708355dcaaec',1,'pulsar::AuthBasic::create(const std::string &authParamsString)'],['../classpulsar_1_1_auth_basic.html#a86ce78ef0606d5642f110dc4ec8c6f67',1,'pulsar::AuthBasic::create(const std::string &username, const std::string &password)'],['../classpulsar_1_1_auth_basic.html#ac85c75b0d48375423cbb5c1421529c46',1,'pulsar::AuthBasic::create(const std::string &username, const std::string &password, const std::string &method)'],['../classpulsar_1_1_auth_athenz.html#acde69fc41668a27d12d558023aaed0d9',1,'pulsar::AuthAthenz::create(ParamMap &params)'],['../classpulsar_1_1_auth_athenz.html#afd40a525e1d8d61fc97880c2c8a958fe',1,'pulsar::AuthAthenz::create(const std::string &authParamsString)'],['../classpulsar_1_1_auth_oauth2.html#a7bb0d842b22b59036587b22da2447377',1,'pulsar::AuthOauth2::create(ParamMap &params)'],['../classpulsar_1_1_auth_oauth2.html#aca6ec2237b43187d8001a5b79a2f11e4',1,'pulsar::AuthOauth2::create(const std::string &authParamsString)'],['../classpulsar_1_1_message_builder.html#aae903d24a17c2bcd1c5c34742953618d',1,'pulsar::MessageBuilder::create()'],['../classpulsar_1_1_auth_factory.html#a551395eda623d3454c758c3479423ce3',1,'pulsar::AuthFactory::create(const std::string &pluginNameOrDynamicLibPath)'],['../classpulsar_1_1_auth_factory.html#af84e99a6be262145d928e599946ab82d',1,'pulsar::AuthFactory::create(const std::string &pluginNameOrDynamicLibPath, const std::string &authParamsString)'],['../classpulsar_1_1_auth_tls.html#a3a2603a8be94cdde4845c941dc8871cc',1,'pulsar::AuthTls::create()'],['../classpulsar_1_1_auth_factory.html#a644b858e4a59482ecce5d1782bd4b452',1,'pulsar::AuthFactory::create()'],['../classpulsar_1_1_auth_tls.html#ac32274cb7d7095cfcd35fcebcf277d5b',1,'pulsar::AuthTls::create(const std::string &certificatePath, const std::string &privateKeyPath)'],['../classpulsar_1_1_auth_tls.html#a19312c7b58d94aa05927ee33922731de',1,'pulsar::AuthTls::create(const std::string &authParamsString)']]], + ['createproducer_20',['createproducer',['../classpulsar_1_1_client.html#a96f49cc0ce27bfe68d75224991f0ba52',1,'pulsar::Client::createProducer(const std::string &topic, Producer &producer)'],['../classpulsar_1_1_client.html#aae7658dee80ad23b418cfb7e12f5df05',1,'pulsar::Client::createProducer(const std::string &topic, const ProducerConfiguration &conf, Producer &producer)']]], + ['createproducerasync_21',['createproducerasync',['../classpulsar_1_1_client.html#a666be9ce0980aeda2921c2229c003db8',1,'pulsar::Client::createProducerAsync(const std::string &topic, CreateProducerCallback callback)'],['../classpulsar_1_1_client.html#a46e87bd20edc2a00c492e2be2c43a644',1,'pulsar::Client::createProducerAsync(const std::string &topic, ProducerConfiguration conf, CreateProducerCallback callback)']]], + ['createprotobufnativeschema_22',['createProtobufNativeSchema',['../namespacepulsar.html#a7dc480604aefdd4119b2e2ee2b9e7764',1,'pulsar']]], + ['createreader_23',['createReader',['../classpulsar_1_1_client.html#ad2f6404e06200714e1fe82419b7c963a',1,'pulsar::Client']]], + ['createreaderasync_24',['createReaderAsync',['../classpulsar_1_1_client.html#ab837056e2ea59c8c55d83d6451ee7b08',1,'pulsar::Client']]], + ['createtableview_25',['createTableView',['../classpulsar_1_1_client.html#aafa5591b8fc3241e50c2b1f2e3bafe24',1,'pulsar::Client']]], + ['createtableviewasync_26',['createTableViewAsync',['../classpulsar_1_1_client.html#addf53e700657aeaf0bcaa8c5ddd89e84',1,'pulsar::Client']]], + ['createwithtoken_27',['createWithToken',['../classpulsar_1_1_auth_token.html#a80911f1374df425fdb76f066dfe7ebd9',1,'pulsar::AuthToken']]], + ['cryptokeyreader_28',['CryptoKeyReader',['../classpulsar_1_1_crypto_key_reader.html',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/all_3.js b/static/api/cpp/3.5.x/search/all_3.js new file mode 100644 index 000000000000..7753d049c236 --- /dev/null +++ b/static/api/cpp/3.5.x/search/all_3.js @@ -0,0 +1,13 @@ +var searchData= +[ + ['deadletterpolicy_0',['DeadLetterPolicy',['../classpulsar_1_1_dead_letter_policy.html',1,'pulsar']]], + ['deadletterpolicybuilder_1',['DeadLetterPolicyBuilder',['../classpulsar_1_1_dead_letter_policy_builder.html',1,'pulsar']]], + ['deadlettertopic_2',['deadLetterTopic',['../classpulsar_1_1_dead_letter_policy_builder.html#a60326f125a4d44099a6eab0d5a64aa22',1,'pulsar::DeadLetterPolicyBuilder']]], + ['defaultbatching_3',['DefaultBatching',['../classpulsar_1_1_producer_configuration.html#adeed584c68f90401147e31091e54c5e5af2acbf3fc9b0dc49d8af65a148d22e27',1,'pulsar::ProducerConfiguration']]], + ['defaultcryptokeyreader_4',['defaultcryptokeyreader',['../classpulsar_1_1_default_crypto_key_reader.html',1,'pulsar::DefaultCryptoKeyReader'],['../classpulsar_1_1_default_crypto_key_reader.html#ae4b1b1f371da031b371e318aa883d5a0',1,'pulsar::DefaultCryptoKeyReader::DefaultCryptoKeyReader()']]], + ['deprecated_20list_5',['Deprecated List',['../deprecated.html',1,'']]], + ['deprecatedexception_6',['DeprecatedException',['../classpulsar_1_1_deprecated_exception.html',1,'pulsar']]], + ['deserialize_7',['deserialize',['../classpulsar_1_1_message_id.html#a3768dd552867827d694077ab6d7a55c8',1,'pulsar::MessageId']]], + ['disablereplication_8',['disableReplication',['../classpulsar_1_1_message_builder.html#afa199d60f52954c93c07ad6eafebe7dd',1,'pulsar::MessageBuilder']]], + ['double_9',['DOUBLE',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305a1b1684230ae9c15941cb3fe05bf972f0',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/all_4.js b/static/api/cpp/3.5.x/search/all_4.js new file mode 100644 index 000000000000..00e14e02a047 --- /dev/null +++ b/static/api/cpp/3.5.x/search/all_4.js @@ -0,0 +1,8 @@ +var searchData= +[ + ['earliest_0',['earliest',['../classpulsar_1_1_message_id.html#a3b0079713b68d0a9d03c269dc2ba2fff',1,'pulsar::MessageId']]], + ['encryptionkeyinfo_1',['encryptionkeyinfo',['../classpulsar_1_1_encryption_key_info.html',1,'pulsar::EncryptionKeyInfo'],['../classpulsar_1_1_encryption_key_info.html#ab5a636493c0a9dc6c4e8ddbf1d0524d9',1,'pulsar::EncryptionKeyInfo::EncryptionKeyInfo()']]], + ['entryid_2',['entryId',['../classpulsar_1_1_message_id_builder.html#ae891d015703255a676ee39fd738df615',1,'pulsar::MessageIdBuilder']]], + ['exclusive_3',['Exclusive',['../classpulsar_1_1_producer_configuration.html#ab217b341d1fa532552bcd03064a39ceaabd2cd3c2f4a00e0dc5d5aeb07404831d',1,'pulsar::ProducerConfiguration']]], + ['exclusivewithfencing_4',['ExclusiveWithFencing',['../classpulsar_1_1_producer_configuration.html#ab217b341d1fa532552bcd03064a39ceaae142b6a80e588880365caa719fe6ebd8',1,'pulsar::ProducerConfiguration']]] +]; diff --git a/static/api/cpp/3.5.x/search/all_5.js b/static/api/cpp/3.5.x/search/all_5.js new file mode 100644 index 000000000000..c1ba28e0eecf --- /dev/null +++ b/static/api/cpp/3.5.x/search/all_5.js @@ -0,0 +1,10 @@ +var searchData= +[ + ['fileloggerfactory_0',['fileloggerfactory',['../classpulsar_1_1_file_logger_factory.html',1,'pulsar::FileLoggerFactory'],['../classpulsar_1_1_file_logger_factory.html#a295a3b87a6a73a67bb8f805b3a4769b5',1,'pulsar::FileLoggerFactory::FileLoggerFactory()']]], + ['float_1',['FLOAT',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305a5102395892b9d15d0a0483a27ca64777',1,'pulsar']]], + ['flush_2',['flush',['../classpulsar_1_1_producer.html#a1cd59ffc4a23162eca39183ba4278146',1,'pulsar::Producer']]], + ['flushasync_3',['flushAsync',['../classpulsar_1_1_producer.html#a3173d56da00ea2225f03e152c8c3df22',1,'pulsar::Producer']]], + ['foreach_4',['forEach',['../classpulsar_1_1_table_view.html#aba35c4ed47372e0d23973c8619ac90a1',1,'pulsar::TableView']]], + ['foreachandlisten_5',['forEachAndListen',['../classpulsar_1_1_table_view.html#a9ea567d48f8df3cdec48d7891d66f6dd',1,'pulsar::TableView']]], + ['from_6',['from',['../classpulsar_1_1_message_id_builder.html#adf978433aad184f7bcb11bfbf86f91ee',1,'pulsar::MessageIdBuilder::from(const MessageId &messageId)'],['../classpulsar_1_1_message_id_builder.html#a46bff6912be430a70ff6d236fdef5d4c',1,'pulsar::MessageIdBuilder::from(const proto::MessageIdData &messageIdData)']]] +]; diff --git a/static/api/cpp/3.5.x/search/all_6.js b/static/api/cpp/3.5.x/search/all_6.js new file mode 100644 index 000000000000..87d06f64e068 --- /dev/null +++ b/static/api/cpp/3.5.x/search/all_6.js @@ -0,0 +1,137 @@ +var searchData= +[ + ['getaccessmode_0',['getAccessMode',['../classpulsar_1_1_producer_configuration.html#a4bb0a493242b1701c8574eee4fa694e5',1,'pulsar::ProducerConfiguration']]], + ['getaccesstoken_1',['getAccessToken',['../classpulsar_1_1_oauth2_token_result.html#a41359aec5371cbcea46cad38e02e28b4',1,'pulsar::Oauth2TokenResult']]], + ['getackgroupingmaxsize_2',['getackgroupingmaxsize',['../classpulsar_1_1_consumer_configuration.html#a5eeb586f29508eca6d1cd602a8da7a06',1,'pulsar::ConsumerConfiguration::getAckGroupingMaxSize()'],['../classpulsar_1_1_reader_configuration.html#af6cfd1444b643e174269b42c961eaa3a',1,'pulsar::ReaderConfiguration::getAckGroupingMaxSize()']]], + ['getackgroupingtimems_3',['getackgroupingtimems',['../classpulsar_1_1_consumer_configuration.html#abc531b79e46a4c2fc70cec8ca573d194',1,'pulsar::ConsumerConfiguration::getAckGroupingTimeMs()'],['../classpulsar_1_1_reader_configuration.html#ad99affc2c9331c5a2116ce5a07147b3d',1,'pulsar::ReaderConfiguration::getAckGroupingTimeMs()']]], + ['getaddress_4',['getAddress',['../classpulsar_1_1_broker_consumer_stats.html#a6b5567d414e4f82f59b97feb2e353d35',1,'pulsar::BrokerConsumerStats']]], + ['getauth_5',['getAuth',['../classpulsar_1_1_client_configuration.html#a2973aed4fed3479aeceef9e97d26ef63',1,'pulsar::ClientConfiguration']]], + ['getauthdata_6',['getauthdata',['../classpulsar_1_1_authentication.html#a14811c36fc300cfa7769f7ee96018688',1,'pulsar::Authentication::getAuthData()'],['../classpulsar_1_1_auth_tls.html#ae88d06f62a47e92e7c52e74df3cacb56',1,'pulsar::AuthTls::getAuthData()'],['../classpulsar_1_1_auth_token.html#a212a8af7680f196e4fba4e0152e6d0a5',1,'pulsar::AuthToken::getAuthData()'],['../classpulsar_1_1_auth_basic.html#a7b1ccda07ff0a22a705159e27149f3d4',1,'pulsar::AuthBasic::getAuthData()'],['../classpulsar_1_1_auth_athenz.html#a274c9e677c536166fd1d4f8af6161546',1,'pulsar::AuthAthenz::getAuthData()'],['../classpulsar_1_1_cached_token.html#a6e249f44ae21288c7365d1baece3da5d',1,'pulsar::CachedToken::getAuthData()'],['../classpulsar_1_1_auth_oauth2.html#adcf1f8cac446270ee6aa0a0ad156842e',1,'pulsar::AuthOauth2::getAuthData()']]], + ['getauthmethodname_7',['getauthmethodname',['../classpulsar_1_1_authentication.html#aafe5c68d220ae0926a2c66953eafed57',1,'pulsar::Authentication::getAuthMethodName()'],['../classpulsar_1_1_auth_tls.html#a2c87f86950aa979f666896e7a5f79398',1,'pulsar::AuthTls::getAuthMethodName()'],['../classpulsar_1_1_auth_token.html#a0d1bf202c18b9131be315b166b4b1caa',1,'pulsar::AuthToken::getAuthMethodName()'],['../classpulsar_1_1_auth_basic.html#ad9d2d1d47a1f1d82fee3522ea5991c3b',1,'pulsar::AuthBasic::getAuthMethodName()'],['../classpulsar_1_1_auth_athenz.html#a65405a1cfd2ec3efcaeea3ed8269fa47',1,'pulsar::AuthAthenz::getAuthMethodName()'],['../classpulsar_1_1_auth_oauth2.html#ac71578130863f59cb02fe1aefa9d70f6',1,'pulsar::AuthOauth2::getAuthMethodName()']]], + ['getavailablepermits_8',['getAvailablePermits',['../classpulsar_1_1_broker_consumer_stats.html#a124a4228983be259fdcfa511814a3920',1,'pulsar::BrokerConsumerStats']]], + ['getbatchingenabled_9',['getBatchingEnabled',['../classpulsar_1_1_producer_configuration.html#ae41daa9000a2df15120e3c42591d63af',1,'pulsar::ProducerConfiguration']]], + ['getbatchingmaxallowedsizeinbytes_10',['getBatchingMaxAllowedSizeInBytes',['../classpulsar_1_1_producer_configuration.html#a7d650931b85e0ee4f6080ca051a3cb28',1,'pulsar::ProducerConfiguration']]], + ['getbatchingmaxmessages_11',['getBatchingMaxMessages',['../classpulsar_1_1_producer_configuration.html#a2debe3bfacf732b7ad40b0b366223f75',1,'pulsar::ProducerConfiguration']]], + ['getbatchingmaxpublishdelayms_12',['getBatchingMaxPublishDelayMs',['../classpulsar_1_1_producer_configuration.html#ad4e8e1802ddc34d4b600bc0fb9cfe2e6',1,'pulsar::ProducerConfiguration']]], + ['getbatchingtype_13',['getBatchingType',['../classpulsar_1_1_producer_configuration.html#a9d92842c76fa71736ee9aec424ff2496',1,'pulsar::ProducerConfiguration']]], + ['getbatchreceivepolicy_14',['getBatchReceivePolicy',['../classpulsar_1_1_consumer_configuration.html#a95a0726c17b428ffa58824171758a6ac',1,'pulsar::ConsumerConfiguration']]], + ['getblockifqueuefull_15',['getBlockIfQueueFull',['../classpulsar_1_1_producer_configuration.html#a41b834ead0a7335a406f0c6b8a4a8815',1,'pulsar::ProducerConfiguration']]], + ['getbrokerconsumerstats_16',['getBrokerConsumerStats',['../classpulsar_1_1_consumer.html#a617639e11e05ecba3d013d831578d19d',1,'pulsar::Consumer']]], + ['getbrokerconsumerstatsasync_17',['getBrokerConsumerStatsAsync',['../classpulsar_1_1_consumer.html#a01e55f7906b6922fa069d84f5459af4b',1,'pulsar::Consumer']]], + ['getbrokerconsumerstatscachetimeinms_18',['getBrokerConsumerStatsCacheTimeInMs',['../classpulsar_1_1_consumer_configuration.html#a23fd67606f5ca05a158226cbd0a2eb54',1,'pulsar::ConsumerConfiguration']]], + ['getcommanddata_19',['getCommandData',['../classpulsar_1_1_authentication_data_provider.html#a1ea19f94ab4b5479022a1df0f566668d',1,'pulsar::AuthenticationDataProvider']]], + ['getcompressiontype_20',['getCompressionType',['../classpulsar_1_1_producer_configuration.html#a61ff42e487a29d8b3a180e23add0135d',1,'pulsar::ProducerConfiguration']]], + ['getconcurrentlookuprequest_21',['getConcurrentLookupRequest',['../classpulsar_1_1_client_configuration.html#aacc5ce498af5ab4535ba3d5a39684b60',1,'pulsar::ClientConfiguration']]], + ['getconnectedsince_22',['getConnectedSince',['../classpulsar_1_1_broker_consumer_stats.html#a9b0459d295199b294c02f16bd388de04',1,'pulsar::BrokerConsumerStats']]], + ['getconnectionsperbroker_23',['getConnectionsPerBroker',['../classpulsar_1_1_client_configuration.html#a0405e2db9228972cfbc972b3f550d8ad',1,'pulsar::ClientConfiguration']]], + ['getconnectiontimeout_24',['getConnectionTimeout',['../classpulsar_1_1_client_configuration.html#abcf01cb88d07e83c1b43abe14854dac2',1,'pulsar::ClientConfiguration']]], + ['getconsumereventlistener_25',['getConsumerEventListener',['../classpulsar_1_1_consumer_configuration.html#ad58be2c7d04522d70a4d4cd447b639b3',1,'pulsar::ConsumerConfiguration']]], + ['getconsumername_26',['getconsumername',['../classpulsar_1_1_broker_consumer_stats.html#a2c473d54fdb38abf2c19d655427185f4',1,'pulsar::BrokerConsumerStats::getConsumerName()'],['../classpulsar_1_1_consumer.html#a83f58a6118a693398c16e70cecac0303',1,'pulsar::Consumer::getConsumerName()'],['../classpulsar_1_1_consumer_configuration.html#af3941af5ed7e7f4ab7b5f5a8737eaee9',1,'pulsar::ConsumerConfiguration::getConsumerName() const']]], + ['getconsumertype_27',['getConsumerType',['../classpulsar_1_1_consumer_configuration.html#a1a7a0dd0f141ae5816c117727f1c201d',1,'pulsar::ConsumerConfiguration']]], + ['getcryptofailureaction_28',['getcryptofailureaction',['../classpulsar_1_1_consumer_configuration.html#a339e3d80453eb963d5d1a64c5660e556',1,'pulsar::ConsumerConfiguration::getCryptoFailureAction()'],['../classpulsar_1_1_producer_configuration.html#a853090927fd2a1eee2ca588a4def3c59',1,'pulsar::ProducerConfiguration::getCryptoFailureAction()'],['../classpulsar_1_1_reader_configuration.html#aed1711ef9d9fed0a14f80451956cabe8',1,'pulsar::ReaderConfiguration::getCryptoFailureAction()']]], + ['getcryptokeyreader_29',['getcryptokeyreader',['../classpulsar_1_1_consumer_configuration.html#a70089f562cb67d8743165540235b2ec7',1,'pulsar::ConsumerConfiguration::getCryptoKeyReader()'],['../classpulsar_1_1_producer_configuration.html#a451838bdf98e10da3fb6183274f4b3e5',1,'pulsar::ProducerConfiguration::getCryptoKeyReader()'],['../classpulsar_1_1_reader_configuration.html#ae14fe911357bd22d2e1eecb5184a95ef',1,'pulsar::ReaderConfiguration::getCryptoKeyReader()']]], + ['getdata_30',['getData',['../classpulsar_1_1_message.html#ab485e3ff7dbefa8c0523ebaabef55d5d',1,'pulsar::Message']]], + ['getdataasstring_31',['getDataAsString',['../classpulsar_1_1_message.html#a45863405a4d3804cc8415d22d502f5c5',1,'pulsar::Message']]], + ['getdeadletterpolicy_32',['getDeadLetterPolicy',['../classpulsar_1_1_consumer_configuration.html#a123b495132d47e17f0cd82f9163eb8c8',1,'pulsar::ConsumerConfiguration']]], + ['getdeadlettertopic_33',['getDeadLetterTopic',['../classpulsar_1_1_dead_letter_policy.html#aff7c4ae5d89b501a238b3a3c1adbd073',1,'pulsar::DeadLetterPolicy']]], + ['getencryptionkeys_34',['getEncryptionKeys',['../classpulsar_1_1_producer_configuration.html#a5b02a79fabba85be433ab7a9bdb02138',1,'pulsar::ProducerConfiguration']]], + ['geteventtimestamp_35',['getEventTimestamp',['../classpulsar_1_1_message.html#a952c044fb615b886070bcda08f7ba9f6',1,'pulsar::Message']]], + ['getexpiresin_36',['getExpiresIn',['../classpulsar_1_1_oauth2_token_result.html#a3fe9ca08aada6022f2977051420eea77',1,'pulsar::Oauth2TokenResult']]], + ['getexpiretimeofincompletechunkedmessagems_37',['getExpireTimeOfIncompleteChunkedMessageMs',['../classpulsar_1_1_consumer_configuration.html#a5caba4e5a875b67c4cf4c794461e4e8d',1,'pulsar::ConsumerConfiguration']]], + ['gethashingscheme_38',['getHashingScheme',['../classpulsar_1_1_producer_configuration.html#abbfd8d17f8fff203536fd7d84c45bd6e',1,'pulsar::ProducerConfiguration']]], + ['gethttpauthtype_39',['getHttpAuthType',['../classpulsar_1_1_authentication_data_provider.html#ab201bbb1a90f3d4ca580bec9021d9d53',1,'pulsar::AuthenticationDataProvider']]], + ['gethttpheaders_40',['getHttpHeaders',['../classpulsar_1_1_authentication_data_provider.html#a90657a3943e3baed5dc5d469e8c64d2a',1,'pulsar::AuthenticationDataProvider']]], + ['getidtoken_41',['getIdToken',['../classpulsar_1_1_oauth2_token_result.html#ad04cbc8f2c1980d7603b13bdac2359e7',1,'pulsar::Oauth2TokenResult']]], + ['getimpl_42',['getImpl',['../classpulsar_1_1_broker_consumer_stats.html#a327a6687c6d5386a54e1a9ac4e027e9e',1,'pulsar::BrokerConsumerStats']]], + ['getindex_43',['getIndex',['../classpulsar_1_1_message.html#a7412304904208c662b346d6328b14261',1,'pulsar::Message']]], + ['getinitialbackoffintervalms_44',['getInitialBackoffIntervalMs',['../classpulsar_1_1_client_configuration.html#a0de6e5a822b7a3c6ab3f66f607e6891d',1,'pulsar::ClientConfiguration']]], + ['getinitialsequenceid_45',['getInitialSequenceId',['../classpulsar_1_1_producer_configuration.html#aad360d7e638bc78e2ed0e9be439d381e',1,'pulsar::ProducerConfiguration']]], + ['getinitialsubscriptionname_46',['getInitialSubscriptionName',['../classpulsar_1_1_dead_letter_policy.html#a889b65c5ac7a57ebfcc347c87f5e8555',1,'pulsar::DeadLetterPolicy']]], + ['getinternalsubscriptionname_47',['getInternalSubscriptionName',['../classpulsar_1_1_reader_configuration.html#a9cbcd290feb9368452ae1536360819f6',1,'pulsar::ReaderConfiguration']]], + ['getiothreads_48',['getIOThreads',['../classpulsar_1_1_client_configuration.html#a961eff6439a7aab387dca6a486f8535b',1,'pulsar::ClientConfiguration']]], + ['getkey_49',['getkey',['../classpulsar_1_1_encryption_key_info.html#a39565fd1977a4051305c7dde26549041',1,'pulsar::EncryptionKeyInfo::getKey()'],['../classpulsar_1_1_key_value.html#a47a193a9bb59fba4b30691a695861272',1,'pulsar::KeyValue::getKey()']]], + ['getkeysharedmode_50',['getKeySharedMode',['../classpulsar_1_1_key_shared_policy.html#a49efb8082529c20caf4eb1e825a0edb2',1,'pulsar::KeySharedPolicy']]], + ['getkeysharedpolicy_51',['getKeySharedPolicy',['../classpulsar_1_1_consumer_configuration.html#ad8febc1509d73daaaa061b5c53f7735b',1,'pulsar::ConsumerConfiguration']]], + ['getkeyvaluedata_52',['getKeyValueData',['../classpulsar_1_1_message.html#a2d282f106addab953cf7b831ffb3f067',1,'pulsar::Message']]], + ['getlastmessageid_53',['getlastmessageid',['../classpulsar_1_1_consumer.html#af60a7e87b76e5c69ee0e14f6ec902908',1,'pulsar::Consumer::getLastMessageId()'],['../classpulsar_1_1_reader.html#a80a0a4dbbe3cf8a9fb074c7556715823',1,'pulsar::Reader::getLastMessageId()']]], + ['getlastmessageidasync_54',['getlastmessageidasync',['../classpulsar_1_1_consumer.html#afbd9e4f5b33b5b10a32866d3485cbeb5',1,'pulsar::Consumer::getLastMessageIdAsync()'],['../classpulsar_1_1_reader.html#a1f863d880dc85400e7e50fcd831d7f5e',1,'pulsar::Reader::getLastMessageIdAsync()']]], + ['getlastsequenceid_55',['getLastSequenceId',['../classpulsar_1_1_producer.html#a99c6c342f700842a065178730c487d5a',1,'pulsar::Producer']]], + ['getlazystartpartitionedproducers_56',['getLazyStartPartitionedProducers',['../classpulsar_1_1_producer_configuration.html#ad1699c4a4b7d8f1b7a2680a2bb6535d4',1,'pulsar::ProducerConfiguration']]], + ['getlength_57',['getLength',['../classpulsar_1_1_message.html#aa47d8ca71292939d4d15e4b543835234',1,'pulsar::Message']]], + ['getlistenername_58',['getListenerName',['../classpulsar_1_1_client_configuration.html#a290b94553eca37e1dddfc2fd48a0b704',1,'pulsar::ClientConfiguration']]], + ['getlogger_59',['getlogger',['../classpulsar_1_1_console_logger_factory.html#a4592e252660038c303b4e71a44da9275',1,'pulsar::ConsoleLoggerFactory::getLogger()'],['../classpulsar_1_1_file_logger_factory.html#a196cbae406d25a82ea6112578ef42126',1,'pulsar::FileLoggerFactory::getLogger()'],['../classpulsar_1_1_logger_factory.html#ae2b97aec20f730fe5e77f24ed048380f',1,'pulsar::LoggerFactory::getLogger()']]], + ['getlongschemaversion_60',['getLongSchemaVersion',['../classpulsar_1_1_message.html#a4a4d35b3098d18b04f998764d3c2ce76',1,'pulsar::Message']]], + ['getmaxbackoffintervalms_61',['getMaxBackoffIntervalMs',['../classpulsar_1_1_client_configuration.html#a7505a6277e8af2ee81468bdc349283ee',1,'pulsar::ClientConfiguration']]], + ['getmaxlookupredirects_62',['getMaxLookupRedirects',['../classpulsar_1_1_client_configuration.html#ac624ce5e221c79282392cf63f91b7f5d',1,'pulsar::ClientConfiguration']]], + ['getmaxnumbytes_63',['getMaxNumBytes',['../classpulsar_1_1_batch_receive_policy.html#a81bf902bd62c003126aafb50a1ea7dea',1,'pulsar::BatchReceivePolicy']]], + ['getmaxnummessages_64',['getMaxNumMessages',['../classpulsar_1_1_batch_receive_policy.html#a079a3ecd654faeff462a673a4ba94940',1,'pulsar::BatchReceivePolicy']]], + ['getmaxpendingchunkedmessage_65',['getMaxPendingChunkedMessage',['../classpulsar_1_1_consumer_configuration.html#a46e9481689880f756588075f64913bb7',1,'pulsar::ConsumerConfiguration']]], + ['getmaxpendingmessages_66',['getMaxPendingMessages',['../classpulsar_1_1_producer_configuration.html#ae0300bcf9ccede2a62c550e3eb79cb4b',1,'pulsar::ProducerConfiguration']]], + ['getmaxpendingmessagesacrosspartitions_67',['getMaxPendingMessagesAcrossPartitions',['../classpulsar_1_1_producer_configuration.html#abbd51b143f4e4fc8ca5fdfc73c8bfb08',1,'pulsar::ProducerConfiguration']]], + ['getmaxredelivercount_68',['getMaxRedeliverCount',['../classpulsar_1_1_dead_letter_policy.html#a29c6c16740a31fed4a357f43298f98bc',1,'pulsar::DeadLetterPolicy']]], + ['getmaxtotalreceiverqueuesizeacrosspartitions_69',['getMaxTotalReceiverQueueSizeAcrossPartitions',['../classpulsar_1_1_consumer_configuration.html#abffc95603a9f983528b4dba82324f146',1,'pulsar::ConsumerConfiguration']]], + ['getmemorylimit_70',['getMemoryLimit',['../classpulsar_1_1_client_configuration.html#aa09cf22a285653ce9a551e85342dff49',1,'pulsar::ClientConfiguration']]], + ['getmessageid_71',['getMessageId',['../classpulsar_1_1_message.html#ad86803a4284b722117abb650c6db0aef',1,'pulsar::Message']]], + ['getmessagelistener_72',['getMessageListener',['../classpulsar_1_1_consumer_configuration.html#a2dcd50261f7fefa42b8fce239ef12f00',1,'pulsar::ConsumerConfiguration']]], + ['getmessagelistenerthreads_73',['getMessageListenerThreads',['../classpulsar_1_1_client_configuration.html#a95829d66c50c4226d79cc2fa835ba59a',1,'pulsar::ClientConfiguration']]], + ['getmessagerouterptr_74',['getMessageRouterPtr',['../classpulsar_1_1_producer_configuration.html#a815e19bc497485c10a4fca3a53dea52b',1,'pulsar::ProducerConfiguration']]], + ['getmetadata_75',['getMetadata',['../classpulsar_1_1_encryption_key_info.html#a7cd86c8e529db92625420de3bc2e8532',1,'pulsar::EncryptionKeyInfo']]], + ['getmsgbacklog_76',['getMsgBacklog',['../classpulsar_1_1_broker_consumer_stats.html#a55167beb17344517fedf88a2e86a3024',1,'pulsar::BrokerConsumerStats']]], + ['getmsgrateexpired_77',['getMsgRateExpired',['../classpulsar_1_1_broker_consumer_stats.html#adee6895ac624d9fbab24f58f7f62859b',1,'pulsar::BrokerConsumerStats']]], + ['getmsgrateout_78',['getMsgRateOut',['../classpulsar_1_1_broker_consumer_stats.html#a09a325a6512dce27e33f8ddeac7a94ba',1,'pulsar::BrokerConsumerStats']]], + ['getmsgrateredeliver_79',['getMsgRateRedeliver',['../classpulsar_1_1_broker_consumer_stats.html#af729bd5a41ddcdf9bfec48d512e3e272',1,'pulsar::BrokerConsumerStats']]], + ['getmsgthroughputout_80',['getMsgThroughputOut',['../classpulsar_1_1_broker_consumer_stats.html#a9527c5b503ce7b96d14cc6bd1125bdb4',1,'pulsar::BrokerConsumerStats']]], + ['getname_81',['getName',['../classpulsar_1_1_schema_info.html#ae253cd885dfbc4a9e70d1374ded43c38',1,'pulsar::SchemaInfo']]], + ['getnegativeackredeliverydelayms_82',['getNegativeAckRedeliveryDelayMs',['../classpulsar_1_1_consumer_configuration.html#a7a4adb22969050a6bfd6919e2ac68917',1,'pulsar::ConsumerConfiguration']]], + ['getnumberofconsumers_83',['getNumberOfConsumers',['../classpulsar_1_1_client.html#a1134874e191f8bf395c020f1ed3b2423',1,'pulsar::Client']]], + ['getnumberofproducers_84',['getNumberOfProducers',['../classpulsar_1_1_client.html#a5225a8d2b121cce6e205ef6e2471cdbc',1,'pulsar::Client']]], + ['getnumpartitions_85',['getNumPartitions',['../classpulsar_1_1_topic_metadata.html#a427a1228dd01108f5748ce92516bf5b1',1,'pulsar::TopicMetadata']]], + ['getoperationtimeoutseconds_86',['getOperationTimeoutSeconds',['../classpulsar_1_1_client_configuration.html#a842576f768383a2434959ece2a039222',1,'pulsar::ClientConfiguration']]], + ['getorderingkey_87',['getOrderingKey',['../classpulsar_1_1_message.html#ab237804a174974f73bb73970b0163c65',1,'pulsar::Message']]], + ['getpartition_88',['getpartition',['../classpulsar_1_1_message_routing_policy.html#a8071e740dd2e44ae75a91901e776c310',1,'pulsar::MessageRoutingPolicy::getPartition(const Message &msg)'],['../classpulsar_1_1_message_routing_policy.html#a080148f08d302d032b0f49d68ada73de',1,'pulsar::MessageRoutingPolicy::getPartition(const Message &msg, const TopicMetadata &topicMetadata)']]], + ['getpartitionkey_89',['getPartitionKey',['../classpulsar_1_1_message.html#a121f31f3216678187c069c681b3b4d7e',1,'pulsar::Message']]], + ['getpartitionsfortopic_90',['getPartitionsForTopic',['../classpulsar_1_1_client.html#a208629aff52395ad0072622ae82f5657',1,'pulsar::Client']]], + ['getpartitionsfortopicasync_91',['getPartitionsForTopicAsync',['../classpulsar_1_1_client.html#a2c3746c12dd5a531efcf2e8af96a3337',1,'pulsar::Client']]], + ['getpartitionsroutingmode_92',['getPartitionsRoutingMode',['../classpulsar_1_1_producer_configuration.html#ae8e2c09b5a04c154f2830db75426e243',1,'pulsar::ProducerConfiguration']]], + ['getpartitionsupdateinterval_93',['getPartitionsUpdateInterval',['../classpulsar_1_1_client_configuration.html#a9b1c684c29b2c484853aaa025aa441cb',1,'pulsar::ClientConfiguration']]], + ['getpatternautodiscoveryperiod_94',['getPatternAutoDiscoveryPeriod',['../classpulsar_1_1_consumer_configuration.html#a5034a765b5b60ea71f1beead267ff88f',1,'pulsar::ConsumerConfiguration']]], + ['getprioritylevel_95',['getPriorityLevel',['../classpulsar_1_1_consumer_configuration.html#a47dd7c844d904d52d3a2d5f4b498402d',1,'pulsar::ConsumerConfiguration']]], + ['getprivatekey_96',['getprivatekey',['../classpulsar_1_1_crypto_key_reader.html#a33a3b281068df053226bb50b59280be0',1,'pulsar::CryptoKeyReader::getPrivateKey()'],['../classpulsar_1_1_default_crypto_key_reader.html#abef165b0c67acb92eb73283564e8dbb5',1,'pulsar::DefaultCryptoKeyReader::getPrivateKey()']]], + ['getproducername_97',['getproducername',['../classpulsar_1_1_producer.html#aba5ac552bef04262ecc989b933ec1d65',1,'pulsar::Producer::getProducerName()'],['../classpulsar_1_1_producer_configuration.html#a526741c1516005ef85990002be06baed',1,'pulsar::ProducerConfiguration::getProducerName()']]], + ['getproperties_98',['getproperties',['../classpulsar_1_1_consumer_configuration.html#a5982ae123e367df322be897f81337ad0',1,'pulsar::ConsumerConfiguration::getProperties()'],['../classpulsar_1_1_message.html#adb69adf5f4e63cf0fb9fef0f7bc7281c',1,'pulsar::Message::getProperties()'],['../classpulsar_1_1_producer_configuration.html#a42d2ec7fafe2b0b3e1554572a487f40f',1,'pulsar::ProducerConfiguration::getProperties()'],['../classpulsar_1_1_reader_configuration.html#a9e201286fcc453d43bd188fbe1c96490',1,'pulsar::ReaderConfiguration::getProperties()'],['../classpulsar_1_1_schema_info.html#a5365dc263da01261bb92c95e27ffa0d6',1,'pulsar::SchemaInfo::getProperties()']]], + ['getproperty_99',['getproperty',['../classpulsar_1_1_consumer_configuration.html#a8b10f7a28e03a4929fc58aea5b67405d',1,'pulsar::ConsumerConfiguration::getProperty()'],['../classpulsar_1_1_message.html#a69b6576136ccce73f448e2dbaad8d357',1,'pulsar::Message::getProperty()'],['../classpulsar_1_1_producer_configuration.html#a15c8b5a9160959e6998aa2615304348c',1,'pulsar::ProducerConfiguration::getProperty()'],['../classpulsar_1_1_reader_configuration.html#ab006f647e263bd9be6f911a1b0299753',1,'pulsar::ReaderConfiguration::getProperty()']]], + ['getpublickey_100',['getpublickey',['../classpulsar_1_1_crypto_key_reader.html#a57456a577dc20b00229bb139bf025aee',1,'pulsar::CryptoKeyReader::getPublicKey()'],['../classpulsar_1_1_default_crypto_key_reader.html#a77289250ef58adf938335f241eeb748f',1,'pulsar::DefaultCryptoKeyReader::getPublicKey()']]], + ['getpublishtimestamp_101',['getPublishTimestamp',['../classpulsar_1_1_message.html#ac0a02a1da349789215e6f1a3b6e3f180',1,'pulsar::Message']]], + ['getreaderlistener_102',['getReaderListener',['../classpulsar_1_1_reader_configuration.html#aac94153e08ec204f23de0700a5f5a26d',1,'pulsar::ReaderConfiguration']]], + ['getreadername_103',['getReaderName',['../classpulsar_1_1_reader_configuration.html#ade2223dccff6f75d659fca0e1a65550c',1,'pulsar::ReaderConfiguration']]], + ['getreceiverqueuesize_104',['getreceiverqueuesize',['../classpulsar_1_1_consumer_configuration.html#a5c268fc7714916cf25c4a34a55a5bdc4',1,'pulsar::ConsumerConfiguration::getReceiverQueueSize()'],['../classpulsar_1_1_reader_configuration.html#acc4df17a3e440a6b6d0b5f887be396b9',1,'pulsar::ReaderConfiguration::getReceiverQueueSize()']]], + ['getredeliverycount_105',['getRedeliveryCount',['../classpulsar_1_1_message.html#aca393b369e6c9ba90c38acac37b54d60',1,'pulsar::Message']]], + ['getrefreshtoken_106',['getRefreshToken',['../classpulsar_1_1_oauth2_token_result.html#ab3f6c44eaa2f4eed65e98fdfa2e3cd95',1,'pulsar::Oauth2TokenResult']]], + ['getregexsubscriptionmode_107',['getRegexSubscriptionMode',['../classpulsar_1_1_consumer_configuration.html#a74fc4ee3cb49f470b46914a3f7d03c6d',1,'pulsar::ConsumerConfiguration']]], + ['getschema_108',['getschema',['../classpulsar_1_1_consumer_configuration.html#acc102de37a90b103be92a24e92fac432',1,'pulsar::ConsumerConfiguration::getSchema()'],['../classpulsar_1_1_producer_configuration.html#a1a38c635f3b3bfb47da547da873f7adc',1,'pulsar::ProducerConfiguration::getSchema()'],['../classpulsar_1_1_reader_configuration.html#a6cd2f670fd1a988fbe94eaa78daeb500',1,'pulsar::ReaderConfiguration::getSchema()'],['../classpulsar_1_1_schema_info.html#ad75d2496d13da8dc13f738606f7c72ec',1,'pulsar::SchemaInfo::getSchema()']]], + ['getschemainfoasync_109',['getSchemaInfoAsync',['../classpulsar_1_1_client.html#aa24ed12d3228c31c923e33fee1eb6f55',1,'pulsar::Client']]], + ['getschematype_110',['getSchemaType',['../classpulsar_1_1_schema_info.html#a6ff46ec7c53346fb9249edd1e34d6e62',1,'pulsar::SchemaInfo']]], + ['getschemaversion_111',['getschemaversion',['../classpulsar_1_1_message.html#ac39590d8db47e6011c4185664350f52d',1,'pulsar::Message::getSchemaVersion()'],['../classpulsar_1_1_producer.html#a2d452694aca8f7ccb5af5e3a974432c3',1,'pulsar::Producer::getSchemaVersion()']]], + ['getsendtimeout_112',['getSendTimeout',['../classpulsar_1_1_producer_configuration.html#a5f3c0ff3a5910207e1731fd1974fe560',1,'pulsar::ProducerConfiguration']]], + ['getstatsintervalinseconds_113',['getStatsIntervalInSeconds',['../classpulsar_1_1_client_configuration.html#a3e86a2ec91591eea6faee445652f6c8b',1,'pulsar::ClientConfiguration']]], + ['getstickyranges_114',['getStickyRanges',['../classpulsar_1_1_key_shared_policy.html#a99d2a2c1555003f42213b3eb4c6742f6',1,'pulsar::KeySharedPolicy']]], + ['getsubscriptioninitialposition_115',['getSubscriptionInitialPosition',['../classpulsar_1_1_consumer_configuration.html#a5ceb47d60826a738ed122cd962220ef7',1,'pulsar::ConsumerConfiguration']]], + ['getsubscriptionname_116',['getSubscriptionName',['../classpulsar_1_1_consumer.html#af6049caaf3e1f8bc91d4dc52b02ab7d1',1,'pulsar::Consumer']]], + ['getsubscriptionproperties_117',['getSubscriptionProperties',['../classpulsar_1_1_consumer_configuration.html#aaa9a9a19c4445bb6521c2b3d1a2037f6',1,'pulsar::ConsumerConfiguration']]], + ['getsubscriptionroleprefix_118',['getSubscriptionRolePrefix',['../classpulsar_1_1_reader_configuration.html#ae5107fa6216f477789c84338ab87675c',1,'pulsar::ReaderConfiguration']]], + ['gettickdurationinms_119',['gettickdurationinms',['../classpulsar_1_1_consumer_configuration.html#a2b45112da6be71eaaff4513bf96a73c0',1,'pulsar::ConsumerConfiguration::getTickDurationInMs()'],['../classpulsar_1_1_reader_configuration.html#a1618961cba0c4c980b01a6a42aac8036',1,'pulsar::ReaderConfiguration::getTickDurationInMs()']]], + ['gettimeoutms_120',['getTimeoutMs',['../classpulsar_1_1_batch_receive_policy.html#acb75726b7e7a75dc65181bada30b9f31',1,'pulsar::BatchReceivePolicy']]], + ['gettlscertificatefilepath_121',['getTlsCertificateFilePath',['../classpulsar_1_1_client_configuration.html#a499d79bdc68fb5b80709b3a794f682f5',1,'pulsar::ClientConfiguration']]], + ['gettlscertificates_122',['getTlsCertificates',['../classpulsar_1_1_authentication_data_provider.html#af2694d6a80dfe8af67c16ef45f3e9645',1,'pulsar::AuthenticationDataProvider']]], + ['gettlsprivatekey_123',['getTlsPrivateKey',['../classpulsar_1_1_authentication_data_provider.html#a8a86f5d276fafcc7f35bc49a365be9f8',1,'pulsar::AuthenticationDataProvider']]], + ['gettlsprivatekeyfilepath_124',['getTlsPrivateKeyFilePath',['../classpulsar_1_1_client_configuration.html#a961555e096d6c7dfd599454b335069ca',1,'pulsar::ClientConfiguration']]], + ['gettlstrustcertsfilepath_125',['getTlsTrustCertsFilePath',['../classpulsar_1_1_client_configuration.html#a2774b2a76b3ed18dc0429f5a6920d1e8',1,'pulsar::ClientConfiguration']]], + ['gettopic_126',['gettopic',['../classpulsar_1_1_consumer.html#ad55d95cd75501562d8ae6d83935d5977',1,'pulsar::Consumer::getTopic()'],['../classpulsar_1_1_producer.html#ab30cecbdcad0f600c1fcd2783cd6caf3',1,'pulsar::Producer::getTopic()'],['../classpulsar_1_1_reader.html#a1b682c6bacd8514221bbb6b25c84c051',1,'pulsar::Reader::getTopic()']]], + ['gettopicname_127',['gettopicname',['../classpulsar_1_1_message.html#adb7dacb620c7fad56f0aa1d6ae52bb88',1,'pulsar::Message::getTopicName()'],['../classpulsar_1_1_message_id.html#a7cd2deeae7cbf71436bc8e9cd786c147',1,'pulsar::MessageId::getTopicName()']]], + ['gettype_128',['getType',['../classpulsar_1_1_broker_consumer_stats.html#a4f56bc158ec0f4abf5a50c4ac03f8a3c',1,'pulsar::BrokerConsumerStats']]], + ['getunackedmessages_129',['getUnackedMessages',['../classpulsar_1_1_broker_consumer_stats.html#aeaa33caf3a417444b631c6db711806f7',1,'pulsar::BrokerConsumerStats']]], + ['getunackedmessagestimeoutms_130',['getunackedmessagestimeoutms',['../classpulsar_1_1_consumer_configuration.html#a373ab78d91d7fbbd0c9b721ba1f34f26',1,'pulsar::ConsumerConfiguration::getUnAckedMessagesTimeoutMs()'],['../classpulsar_1_1_reader_configuration.html#a35aadcf27818f2b46125004dcf160fe6',1,'pulsar::ReaderConfiguration::getUnAckedMessagesTimeoutMs()']]], + ['getvalue_131',['getvalue',['../classpulsar_1_1_key_value.html#a53158bdf562d12f14c7254e6d4b55b37',1,'pulsar::KeyValue::getValue()'],['../classpulsar_1_1_table_view.html#a8bc874dc48a7381726e48145a8037879',1,'pulsar::TableView::getValue()']]], + ['getvalueasstring_132',['getValueAsString',['../classpulsar_1_1_key_value.html#a573eeb6042d04adec7be3d8c46ea2590',1,'pulsar::KeyValue']]], + ['getvaluelength_133',['getValueLength',['../classpulsar_1_1_key_value.html#a3c51a0e66e5935c62dfbdb8e0908cf15',1,'pulsar::KeyValue']]] +]; diff --git a/static/api/cpp/3.5.x/search/all_7.js b/static/api/cpp/3.5.x/search/all_7.js new file mode 100644 index 000000000000..2d32fbf85e0e --- /dev/null +++ b/static/api/cpp/3.5.x/search/all_7.js @@ -0,0 +1,15 @@ +var searchData= +[ + ['hasconsumereventlistener_0',['hasConsumerEventListener',['../classpulsar_1_1_consumer_configuration.html#abc2cdbdc7878fca3205ec77cea2b1fa2',1,'pulsar::ConsumerConfiguration']]], + ['hasdataforhttp_1',['hasDataForHttp',['../classpulsar_1_1_authentication_data_provider.html#afbe3f1d0356a5d362bffc7f8253bf631',1,'pulsar::AuthenticationDataProvider']]], + ['hasdatafortls_2',['hasDataForTls',['../classpulsar_1_1_authentication_data_provider.html#af500b208a36e4849bd9ee1f6c48eb60e',1,'pulsar::AuthenticationDataProvider']]], + ['hasdatafromcommand_3',['hasDataFromCommand',['../classpulsar_1_1_authentication_data_provider.html#a1ad6773dcb324d73d6fe6aaa01927e67',1,'pulsar::AuthenticationDataProvider']]], + ['hasmessageavailable_4',['hasMessageAvailable',['../classpulsar_1_1_reader.html#a7f751b63fba4d4734ff79da590f9fd56',1,'pulsar::Reader']]], + ['hasmessageavailableasync_5',['hasMessageAvailableAsync',['../classpulsar_1_1_reader.html#a0c3755b32954d1aeb1b4ef60e4314c1d',1,'pulsar::Reader']]], + ['hasmessagelistener_6',['hasMessageListener',['../classpulsar_1_1_consumer_configuration.html#afe5439f3160e601a09e62237d2377c1a',1,'pulsar::ConsumerConfiguration']]], + ['hasorderingkey_7',['hasOrderingKey',['../classpulsar_1_1_message.html#ad29a0aeda1dbb934e7c3311d85d0aa02',1,'pulsar::Message']]], + ['haspartitionkey_8',['hasPartitionKey',['../classpulsar_1_1_message.html#a171e78738da5932678cfd83c347186bf',1,'pulsar::Message']]], + ['hasproperty_9',['hasproperty',['../classpulsar_1_1_consumer_configuration.html#a8aab5c5bd65073257d0509d410099570',1,'pulsar::ConsumerConfiguration::hasProperty()'],['../classpulsar_1_1_message.html#ad3e557ed946f94e6964147a8389532bd',1,'pulsar::Message::hasProperty()'],['../classpulsar_1_1_producer_configuration.html#a7f9020dbb5c22a28277009e83695d5e2',1,'pulsar::ProducerConfiguration::hasProperty()'],['../classpulsar_1_1_reader_configuration.html#a0d53c4ac681120500c4d057a60f6f6a6',1,'pulsar::ReaderConfiguration::hasProperty(const std::string &name) const']]], + ['hasreaderlistener_10',['hasReaderListener',['../classpulsar_1_1_reader_configuration.html#a104b07bc32a421a8527e7d167ec2c611',1,'pulsar::ReaderConfiguration']]], + ['hasschemaversion_11',['hasSchemaVersion',['../classpulsar_1_1_message.html#a51dee56cd5f71a4d4c2cae8a1b42feef',1,'pulsar::Message']]] +]; diff --git a/static/api/cpp/3.5.x/search/all_8.js b/static/api/cpp/3.5.x/search/all_8.js new file mode 100644 index 000000000000..ce713d917a3e --- /dev/null +++ b/static/api/cpp/3.5.x/search/all_8.js @@ -0,0 +1,28 @@ +var searchData= +[ + ['initialize_0',['initialize',['../classpulsar_1_1_oauth2_flow.html#a2d9a138289565a4e07aded8fffdcb96e',1,'pulsar::Oauth2Flow']]], + ['initialsubscriptionname_1',['initialSubscriptionName',['../classpulsar_1_1_dead_letter_policy_builder.html#ac2c21735aeb67ffc97ed49351b1de4b0',1,'pulsar::DeadLetterPolicyBuilder']]], + ['inline_2',['INLINE',['../namespacepulsar.html#a0dca31b62c0207ea87e146cde0609595acfbac07c6ae3e73f0e10ca60ad916bef',1,'pulsar']]], + ['int16_3',['INT16',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305a9e5ed020cb2ca197a0918946352cf96e',1,'pulsar']]], + ['int32_4',['INT32',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305ac048e1576ab161018f9e3c6eda6307d0',1,'pulsar']]], + ['int64_5',['INT64',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305a11fafed4115309cf1f33eac044e704a2',1,'pulsar']]], + ['int8_6',['INT8',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305a2c52dde965d6ba972179fa14116160e9',1,'pulsar']]], + ['intercept_7',['intercept',['../classpulsar_1_1_consumer_configuration.html#a37bf6928179a14ab9b2af6e69befa2d8',1,'pulsar::ConsumerConfiguration']]], + ['isackreceiptenabled_8',['isAckReceiptEnabled',['../classpulsar_1_1_consumer_configuration.html#af4f7966e4662ecb250893927909269a3',1,'pulsar::ConsumerConfiguration']]], + ['isallowoutoforderdelivery_9',['isAllowOutOfOrderDelivery',['../classpulsar_1_1_key_shared_policy.html#ac79edf430990c158e23886c21f6f2fea',1,'pulsar::KeySharedPolicy']]], + ['isautoackoldestchunkedmessageonqueuefull_10',['isAutoAckOldestChunkedMessageOnQueueFull',['../classpulsar_1_1_consumer_configuration.html#a4f978c3e8ff479ed0fea93eba5275f6d',1,'pulsar::ConsumerConfiguration']]], + ['isbatchindexackenabled_11',['isBatchIndexAckEnabled',['../classpulsar_1_1_consumer_configuration.html#a1f5847ecf1c8f77992b1a4c110011c9a',1,'pulsar::ConsumerConfiguration']]], + ['isblockedconsumeronunackedmsgs_12',['isBlockedConsumerOnUnackedMsgs',['../classpulsar_1_1_broker_consumer_stats.html#ae47fe1710c172b602bd346baf8791ed9',1,'pulsar::BrokerConsumerStats']]], + ['ischunkingenabled_13',['isChunkingEnabled',['../classpulsar_1_1_producer_configuration.html#a6aa210dd18cbd98ccb39ebc2f0978f95',1,'pulsar::ProducerConfiguration']]], + ['isconnected_14',['isconnected',['../classpulsar_1_1_reader.html#a9eda13274f7b1f880694fc1178ae631d',1,'pulsar::Reader::isConnected()'],['../classpulsar_1_1_producer.html#a0f8b6a4b724a60545a8d427596155f1e',1,'pulsar::Producer::isConnected()'],['../classpulsar_1_1_consumer.html#a95a69d39ec2c8714b6ffce0f6ab74a55',1,'pulsar::Consumer::isConnected()']]], + ['isenabled_15',['isEnabled',['../classpulsar_1_1_logger.html#a6d09f80fd8f35d5634af94a1305c86af',1,'pulsar::Logger']]], + ['isencryptionenabled_16',['isencryptionenabled',['../classpulsar_1_1_reader_configuration.html#aa2cc4490830aeebee9c1a16589b8c429',1,'pulsar::ReaderConfiguration::isEncryptionEnabled()'],['../classpulsar_1_1_consumer_configuration.html#ac9a6a885f0cea261f32dc4a3509643f4',1,'pulsar::ConsumerConfiguration::isEncryptionEnabled()'],['../classpulsar_1_1_producer_configuration.html#a33f5238a6da49fca17816d4251af5512',1,'pulsar::ProducerConfiguration::isEncryptionEnabled()']]], + ['isexpired_17',['isExpired',['../classpulsar_1_1_cached_token.html#a2fe69f2fb7037139b52f9c66a0af05f2',1,'pulsar::CachedToken']]], + ['isreadcompacted_18',['isreadcompacted',['../classpulsar_1_1_reader_configuration.html#a93a555fd5dc20d394ea45e9155301ee4',1,'pulsar::ReaderConfiguration::isReadCompacted()'],['../classpulsar_1_1_consumer_configuration.html#a74209a513ebdb85f5969f2fedafb0b44',1,'pulsar::ConsumerConfiguration::isReadCompacted() const']]], + ['isreplicatesubscriptionstateenabled_19',['isReplicateSubscriptionStateEnabled',['../classpulsar_1_1_consumer_configuration.html#a4ab6c45eb256e8ad9ec4d74199e5c01d',1,'pulsar::ConsumerConfiguration']]], + ['isstartmessageidinclusive_20',['isstartmessageidinclusive',['../classpulsar_1_1_reader_configuration.html#a2c9f4927d01acddc1106c9c1812acd47',1,'pulsar::ReaderConfiguration::isStartMessageIdInclusive()'],['../classpulsar_1_1_consumer_configuration.html#a968b4d4ae6348072965ab98bf1e7212e',1,'pulsar::ConsumerConfiguration::isStartMessageIdInclusive()']]], + ['istlsallowinsecureconnection_21',['isTlsAllowInsecureConnection',['../classpulsar_1_1_client_configuration.html#a134473221c9e91f0c558a5c291aa9d5e',1,'pulsar::ClientConfiguration']]], + ['isusetls_22',['isUseTls',['../classpulsar_1_1_client_configuration.html#a564ce9a6a43fe2db6ac11cc7821b8c27',1,'pulsar::ClientConfiguration']]], + ['isvalid_23',['isValid',['../classpulsar_1_1_broker_consumer_stats.html#a6ab876378e9c76098bd48ee9753faec0',1,'pulsar::BrokerConsumerStats']]], + ['isvalidatehostname_24',['isValidateHostName',['../classpulsar_1_1_client_configuration.html#ae5646c0a8ffd63e9fbcb3a84704d3a10',1,'pulsar::ClientConfiguration']]] +]; diff --git a/static/api/cpp/3.5.x/search/all_9.js b/static/api/cpp/3.5.x/search/all_9.js new file mode 100644 index 000000000000..936dbefa2720 --- /dev/null +++ b/static/api/cpp/3.5.x/search/all_9.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['json_0',['JSON',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305a15f7910601e8d522f151f3129c753283',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/all_a.js b/static/api/cpp/3.5.x/search/all_a.js new file mode 100644 index 000000000000..774fc6c5a5c3 --- /dev/null +++ b/static/api/cpp/3.5.x/search/all_a.js @@ -0,0 +1,9 @@ +var searchData= +[ + ['key_5fvalue_0',['KEY_VALUE',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305ab6fbe0f5b80de2aa67b68572e7a054d3',1,'pulsar']]], + ['keybasedbatching_1',['KeyBasedBatching',['../classpulsar_1_1_producer_configuration.html#adeed584c68f90401147e31091e54c5e5a291402f9cfb8e9f0fa888722930233ea',1,'pulsar::ProducerConfiguration']]], + ['keysharedmode_2',['KeySharedMode',['../namespacepulsar.html#a499d1327931169d068b9b353f106dd04',1,'pulsar']]], + ['keysharedpolicy_3',['KeySharedPolicy',['../classpulsar_1_1_key_shared_policy.html',1,'pulsar']]], + ['keyvalue_4',['keyvalue',['../classpulsar_1_1_key_value.html#a724959978481478da4e45ba79092edad',1,'pulsar::KeyValue::KeyValue()'],['../classpulsar_1_1_key_value.html',1,'pulsar::KeyValue']]], + ['keyvalueencodingtype_5',['KeyValueEncodingType',['../namespacepulsar.html#a0dca31b62c0207ea87e146cde0609595',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/all_b.js b/static/api/cpp/3.5.x/search/all_b.js new file mode 100644 index 000000000000..250cd845c16d --- /dev/null +++ b/static/api/cpp/3.5.x/search/all_b.js @@ -0,0 +1,9 @@ +var searchData= +[ + ['latest_0',['latest',['../classpulsar_1_1_message_id.html#af9c67f2e12e102b07c609a8da5740976',1,'pulsar::MessageId']]], + ['ledgerid_1',['ledgerId',['../classpulsar_1_1_message_id_builder.html#ae1be301cd7f5d7b5444adaa7d209bf2e',1,'pulsar::MessageIdBuilder']]], + ['list_2',['Deprecated List',['../deprecated.html',1,'']]], + ['log_3',['log',['../classpulsar_1_1_logger.html#a753385116eb2e4d73c075de94cc2039b',1,'pulsar::Logger']]], + ['logger_4',['Logger',['../classpulsar_1_1_logger.html',1,'pulsar']]], + ['loggerfactory_5',['LoggerFactory',['../classpulsar_1_1_logger_factory.html',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/all_c.js b/static/api/cpp/3.5.x/search/all_c.js new file mode 100644 index 000000000000..623cb36d68ac --- /dev/null +++ b/static/api/cpp/3.5.x/search/all_c.js @@ -0,0 +1,12 @@ +var searchData= +[ + ['maxredelivercount_0',['maxRedeliverCount',['../classpulsar_1_1_dead_letter_policy_builder.html#ad34f023e1018f636ed488c533e645661',1,'pulsar::DeadLetterPolicyBuilder']]], + ['message_1',['message',['../classpulsar_1_1_message.html',1,'pulsar::Message'],['../classpulsar_1_1_message.html#aa3c4673ec7b3c99cc3faf9aa931a4531',1,'pulsar::Message::Message()']]], + ['messagebatch_2',['MessageBatch',['../classpulsar_1_1_message_batch.html',1,'pulsar']]], + ['messagebuilder_3',['MessageBuilder',['../classpulsar_1_1_message_builder.html',1,'pulsar']]], + ['messageid_4',['messageid',['../classpulsar_1_1_message_id.html#ac91b200bd36b9d887bebdadb747dd4ee',1,'pulsar::MessageId::MessageId()'],['../classpulsar_1_1_message_id.html',1,'pulsar::MessageId']]], + ['messageidbuilder_5',['MessageIdBuilder',['../classpulsar_1_1_message_id_builder.html',1,'pulsar']]], + ['messagelistener_6',['MessageListener',['../namespacepulsar.html#aa2439b1ef83202e8d35359d0134f2d56',1,'pulsar']]], + ['messageroutingpolicy_7',['MessageRoutingPolicy',['../classpulsar_1_1_message_routing_policy.html',1,'pulsar']]], + ['messages_8',['Messages',['../namespacepulsar.html#ac87806090d752fb2248e8da65727630a',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/all_d.js b/static/api/cpp/3.5.x/search/all_d.js new file mode 100644 index 000000000000..55039d0899b2 --- /dev/null +++ b/static/api/cpp/3.5.x/search/all_d.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['negativeacknowledge_0',['negativeacknowledge',['../classpulsar_1_1_consumer.html#a3cd227d9be2ae090c3a55bcdfff1df69',1,'pulsar::Consumer::negativeAcknowledge(const Message &message)'],['../classpulsar_1_1_consumer.html#afd631d1c357bc0284afe3e0cd2acbd6e',1,'pulsar::Consumer::negativeAcknowledge(const MessageId &messageId)']]], + ['none_1',['NONE',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305af9377cb56d5b6973392d0fd2ca76009a',1,'pulsar']]], + ['nonpersistentonly_2',['NonPersistentOnly',['../namespacepulsar.html#abd9b21e56a6fb78e04cae2664ff0dbbda5af3d512f79ac90cacc326d86a230603',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/all_e.js b/static/api/cpp/3.5.x/search/all_e.js new file mode 100644 index 000000000000..97e1de92767f --- /dev/null +++ b/static/api/cpp/3.5.x/search/all_e.js @@ -0,0 +1,10 @@ +var searchData= +[ + ['oauth2flow_0',['Oauth2Flow',['../classpulsar_1_1_oauth2_flow.html',1,'pulsar']]], + ['oauth2tokenresult_1',['Oauth2TokenResult',['../classpulsar_1_1_oauth2_token_result.html',1,'pulsar']]], + ['onacknowledge_2',['onAcknowledge',['../classpulsar_1_1_consumer_interceptor.html#a9d45879671a6585c244b996e0f8e0eae',1,'pulsar::ConsumerInterceptor']]], + ['onacknowledgecumulative_3',['onAcknowledgeCumulative',['../classpulsar_1_1_consumer_interceptor.html#aaa831e0a16b86333a43ee7fed04ab0a1',1,'pulsar::ConsumerInterceptor']]], + ['onnegativeackssend_4',['onNegativeAcksSend',['../classpulsar_1_1_consumer_interceptor.html#a8f11afb9ec2c367cd5006f4a2df45f30',1,'pulsar::ConsumerInterceptor']]], + ['onpartitionschange_5',['onPartitionsChange',['../classpulsar_1_1_producer_interceptor.html#aa4fbfa721d9d9985a304c3d2ce924202',1,'pulsar::ProducerInterceptor']]], + ['onsendacknowledgement_6',['onSendAcknowledgement',['../classpulsar_1_1_producer_interceptor.html#ad9aba4738d6033218f4a970c53aefab0',1,'pulsar::ProducerInterceptor']]] +]; diff --git a/static/api/cpp/3.5.x/search/all_f.js b/static/api/cpp/3.5.x/search/all_f.js new file mode 100644 index 000000000000..5b24dea93a58 --- /dev/null +++ b/static/api/cpp/3.5.x/search/all_f.js @@ -0,0 +1,18 @@ +var searchData= +[ + ['parsedefaultformatauthparams_0',['parseDefaultFormatAuthParams',['../classpulsar_1_1_authentication.html#a0ff47251bd4184cd0e9155e76a5c35bb',1,'pulsar::Authentication']]], + ['partition_1',['partition',['../classpulsar_1_1_message_id_builder.html#a40f7cba248437dd6d1d2d29cbc48f5ac',1,'pulsar::MessageIdBuilder']]], + ['pausemessagelistener_2',['pauseMessageListener',['../classpulsar_1_1_consumer.html#a7370b7a19a08fdff5b044e74ad8bd679',1,'pulsar::Consumer']]], + ['persistentonly_3',['PersistentOnly',['../namespacepulsar.html#abd9b21e56a6fb78e04cae2664ff0dbbda68931062ae96d4dcc4778eeac5fa3de4',1,'pulsar']]], + ['producer_4',['producer',['../classpulsar_1_1_producer.html',1,'pulsar::Producer'],['../classpulsar_1_1_producer.html#a013069fbb382f7f3c7dd58522765698b',1,'pulsar::Producer::Producer()']]], + ['produceraccessmode_5',['ProducerAccessMode',['../classpulsar_1_1_producer_configuration.html#ab217b341d1fa532552bcd03064a39cea',1,'pulsar::ProducerConfiguration']]], + ['producerconfiguration_6',['ProducerConfiguration',['../classpulsar_1_1_producer_configuration.html',1,'pulsar']]], + ['producerinterceptor_7',['ProducerInterceptor',['../classpulsar_1_1_producer_interceptor.html',1,'pulsar']]], + ['protobuf_8',['PROTOBUF',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305a5054f171f6c60b73043727ddc60698a0',1,'pulsar']]], + ['protobuf_5fnative_9',['PROTOBUF_NATIVE',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305a24048f6ae2e1048989e69644edcdc8f6',1,'pulsar']]], + ['pulsar_10',['pulsar',['../namespacepulsar.html',1,'']]], + ['pulsar_20client_20cpp_11',['pulsar-client-cpp',['../index.html',1,'']]], + ['pulsar_5fconsumer_5fbatch_5freceive_5fpolicy_5ft_12',['pulsar_consumer_batch_receive_policy_t',['../structpulsar__consumer__batch__receive__policy__t.html',1,'']]], + ['pulsar_5fconsumer_5fconfig_5fdead_5fletter_5fpolicy_5ft_13',['pulsar_consumer_config_dead_letter_policy_t',['../structpulsar__consumer__config__dead__letter__policy__t.html',1,'']]], + ['pulsar_5flogger_5ft_14',['pulsar_logger_t',['../structpulsar__logger__t.html',1,'']]] +]; diff --git a/static/api/cpp/3.5.x/search/classes_0.js b/static/api/cpp/3.5.x/search/classes_0.js new file mode 100644 index 000000000000..badf5c1f348c --- /dev/null +++ b/static/api/cpp/3.5.x/search/classes_0.js @@ -0,0 +1,11 @@ +var searchData= +[ + ['authathenz_0',['AuthAthenz',['../classpulsar_1_1_auth_athenz.html',1,'pulsar']]], + ['authbasic_1',['AuthBasic',['../classpulsar_1_1_auth_basic.html',1,'pulsar']]], + ['authentication_2',['Authentication',['../classpulsar_1_1_authentication.html',1,'pulsar']]], + ['authenticationdataprovider_3',['AuthenticationDataProvider',['../classpulsar_1_1_authentication_data_provider.html',1,'pulsar']]], + ['authfactory_4',['AuthFactory',['../classpulsar_1_1_auth_factory.html',1,'pulsar']]], + ['authoauth2_5',['AuthOauth2',['../classpulsar_1_1_auth_oauth2.html',1,'pulsar']]], + ['authtls_6',['AuthTls',['../classpulsar_1_1_auth_tls.html',1,'pulsar']]], + ['authtoken_7',['AuthToken',['../classpulsar_1_1_auth_token.html',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/classes_1.js b/static/api/cpp/3.5.x/search/classes_1.js new file mode 100644 index 000000000000..8e590eb00007 --- /dev/null +++ b/static/api/cpp/3.5.x/search/classes_1.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['batchreceivepolicy_0',['BatchReceivePolicy',['../classpulsar_1_1_batch_receive_policy.html',1,'pulsar']]], + ['brokerconsumerstats_1',['BrokerConsumerStats',['../classpulsar_1_1_broker_consumer_stats.html',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/classes_2.js b/static/api/cpp/3.5.x/search/classes_2.js new file mode 100644 index 000000000000..f110b19a8912 --- /dev/null +++ b/static/api/cpp/3.5.x/search/classes_2.js @@ -0,0 +1,12 @@ +var searchData= +[ + ['cachedtoken_0',['CachedToken',['../classpulsar_1_1_cached_token.html',1,'pulsar']]], + ['client_1',['Client',['../classpulsar_1_1_client.html',1,'pulsar']]], + ['clientconfiguration_2',['ClientConfiguration',['../classpulsar_1_1_client_configuration.html',1,'pulsar']]], + ['consoleloggerfactory_3',['ConsoleLoggerFactory',['../classpulsar_1_1_console_logger_factory.html',1,'pulsar']]], + ['consumer_4',['Consumer',['../classpulsar_1_1_consumer.html',1,'pulsar']]], + ['consumerconfiguration_5',['ConsumerConfiguration',['../classpulsar_1_1_consumer_configuration.html',1,'pulsar']]], + ['consumereventlistener_6',['ConsumerEventListener',['../classpulsar_1_1_consumer_event_listener.html',1,'pulsar']]], + ['consumerinterceptor_7',['ConsumerInterceptor',['../classpulsar_1_1_consumer_interceptor.html',1,'pulsar']]], + ['cryptokeyreader_8',['CryptoKeyReader',['../classpulsar_1_1_crypto_key_reader.html',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/classes_3.js b/static/api/cpp/3.5.x/search/classes_3.js new file mode 100644 index 000000000000..057b88a3dbee --- /dev/null +++ b/static/api/cpp/3.5.x/search/classes_3.js @@ -0,0 +1,7 @@ +var searchData= +[ + ['deadletterpolicy_0',['DeadLetterPolicy',['../classpulsar_1_1_dead_letter_policy.html',1,'pulsar']]], + ['deadletterpolicybuilder_1',['DeadLetterPolicyBuilder',['../classpulsar_1_1_dead_letter_policy_builder.html',1,'pulsar']]], + ['defaultcryptokeyreader_2',['DefaultCryptoKeyReader',['../classpulsar_1_1_default_crypto_key_reader.html',1,'pulsar']]], + ['deprecatedexception_3',['DeprecatedException',['../classpulsar_1_1_deprecated_exception.html',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/classes_4.js b/static/api/cpp/3.5.x/search/classes_4.js new file mode 100644 index 000000000000..f493e005020f --- /dev/null +++ b/static/api/cpp/3.5.x/search/classes_4.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['encryptionkeyinfo_0',['EncryptionKeyInfo',['../classpulsar_1_1_encryption_key_info.html',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/classes_5.js b/static/api/cpp/3.5.x/search/classes_5.js new file mode 100644 index 000000000000..106ba4370206 --- /dev/null +++ b/static/api/cpp/3.5.x/search/classes_5.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['fileloggerfactory_0',['FileLoggerFactory',['../classpulsar_1_1_file_logger_factory.html',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/classes_6.js b/static/api/cpp/3.5.x/search/classes_6.js new file mode 100644 index 000000000000..b37829cdc53c --- /dev/null +++ b/static/api/cpp/3.5.x/search/classes_6.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['keysharedpolicy_0',['KeySharedPolicy',['../classpulsar_1_1_key_shared_policy.html',1,'pulsar']]], + ['keyvalue_1',['KeyValue',['../classpulsar_1_1_key_value.html',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/classes_7.js b/static/api/cpp/3.5.x/search/classes_7.js new file mode 100644 index 000000000000..35855e58932d --- /dev/null +++ b/static/api/cpp/3.5.x/search/classes_7.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['logger_0',['Logger',['../classpulsar_1_1_logger.html',1,'pulsar']]], + ['loggerfactory_1',['LoggerFactory',['../classpulsar_1_1_logger_factory.html',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/classes_8.js b/static/api/cpp/3.5.x/search/classes_8.js new file mode 100644 index 000000000000..0001b1a4fc12 --- /dev/null +++ b/static/api/cpp/3.5.x/search/classes_8.js @@ -0,0 +1,9 @@ +var searchData= +[ + ['message_0',['Message',['../classpulsar_1_1_message.html',1,'pulsar']]], + ['messagebatch_1',['MessageBatch',['../classpulsar_1_1_message_batch.html',1,'pulsar']]], + ['messagebuilder_2',['MessageBuilder',['../classpulsar_1_1_message_builder.html',1,'pulsar']]], + ['messageid_3',['MessageId',['../classpulsar_1_1_message_id.html',1,'pulsar']]], + ['messageidbuilder_4',['MessageIdBuilder',['../classpulsar_1_1_message_id_builder.html',1,'pulsar']]], + ['messageroutingpolicy_5',['MessageRoutingPolicy',['../classpulsar_1_1_message_routing_policy.html',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/classes_9.js b/static/api/cpp/3.5.x/search/classes_9.js new file mode 100644 index 000000000000..c26931dce0de --- /dev/null +++ b/static/api/cpp/3.5.x/search/classes_9.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['oauth2flow_0',['Oauth2Flow',['../classpulsar_1_1_oauth2_flow.html',1,'pulsar']]], + ['oauth2tokenresult_1',['Oauth2TokenResult',['../classpulsar_1_1_oauth2_token_result.html',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/classes_a.js b/static/api/cpp/3.5.x/search/classes_a.js new file mode 100644 index 000000000000..5bcd96d23b79 --- /dev/null +++ b/static/api/cpp/3.5.x/search/classes_a.js @@ -0,0 +1,9 @@ +var searchData= +[ + ['producer_0',['Producer',['../classpulsar_1_1_producer.html',1,'pulsar']]], + ['producerconfiguration_1',['ProducerConfiguration',['../classpulsar_1_1_producer_configuration.html',1,'pulsar']]], + ['producerinterceptor_2',['ProducerInterceptor',['../classpulsar_1_1_producer_interceptor.html',1,'pulsar']]], + ['pulsar_5fconsumer_5fbatch_5freceive_5fpolicy_5ft_3',['pulsar_consumer_batch_receive_policy_t',['../structpulsar__consumer__batch__receive__policy__t.html',1,'']]], + ['pulsar_5fconsumer_5fconfig_5fdead_5fletter_5fpolicy_5ft_4',['pulsar_consumer_config_dead_letter_policy_t',['../structpulsar__consumer__config__dead__letter__policy__t.html',1,'']]], + ['pulsar_5flogger_5ft_5',['pulsar_logger_t',['../structpulsar__logger__t.html',1,'']]] +]; diff --git a/static/api/cpp/3.5.x/search/classes_b.js b/static/api/cpp/3.5.x/search/classes_b.js new file mode 100644 index 000000000000..3a759a3967cf --- /dev/null +++ b/static/api/cpp/3.5.x/search/classes_b.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['reader_0',['Reader',['../classpulsar_1_1_reader.html',1,'pulsar']]], + ['readerconfiguration_1',['ReaderConfiguration',['../classpulsar_1_1_reader_configuration.html',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/classes_c.js b/static/api/cpp/3.5.x/search/classes_c.js new file mode 100644 index 000000000000..94a13224313e --- /dev/null +++ b/static/api/cpp/3.5.x/search/classes_c.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['schemainfo_0',['SchemaInfo',['../classpulsar_1_1_schema_info.html',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/classes_d.js b/static/api/cpp/3.5.x/search/classes_d.js new file mode 100644 index 000000000000..9dae12966860 --- /dev/null +++ b/static/api/cpp/3.5.x/search/classes_d.js @@ -0,0 +1,9 @@ +var searchData= +[ + ['tableview_0',['TableView',['../classpulsar_1_1_table_view.html',1,'pulsar']]], + ['tableviewconfiguration_1',['TableViewConfiguration',['../structpulsar_1_1_table_view_configuration.html',1,'pulsar']]], + ['topicmetadata_2',['TopicMetadata',['../classpulsar_1_1_topic_metadata.html',1,'pulsar']]], + ['typedmessage_3',['TypedMessage',['../classpulsar_1_1_typed_message.html',1,'pulsar']]], + ['typedmessagebuilder_4',['TypedMessageBuilder',['../classpulsar_1_1_typed_message_builder.html',1,'pulsar']]], + ['typedmessagebuilder_3c_20std_3a_3astring_20_3e_5',['TypedMessageBuilder< std::string >',['../classpulsar_1_1_typed_message_builder_3_01std_1_1string_01_4.html',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/close.svg b/static/api/cpp/3.5.x/search/close.svg new file mode 100644 index 000000000000..337d6cc13298 --- /dev/null +++ b/static/api/cpp/3.5.x/search/close.svg @@ -0,0 +1,18 @@ + + + + + + diff --git a/static/api/cpp/3.5.x/search/enums_0.js b/static/api/cpp/3.5.x/search/enums_0.js new file mode 100644 index 000000000000..5330f71986b1 --- /dev/null +++ b/static/api/cpp/3.5.x/search/enums_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['batchingtype_0',['BatchingType',['../classpulsar_1_1_producer_configuration.html#adeed584c68f90401147e31091e54c5e5',1,'pulsar::ProducerConfiguration']]] +]; diff --git a/static/api/cpp/3.5.x/search/enums_1.js b/static/api/cpp/3.5.x/search/enums_1.js new file mode 100644 index 000000000000..909f56633498 --- /dev/null +++ b/static/api/cpp/3.5.x/search/enums_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['consumertype_0',['ConsumerType',['../namespacepulsar.html#ac3e442abe2558a2b257fc7344af61d40',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/enums_2.js b/static/api/cpp/3.5.x/search/enums_2.js new file mode 100644 index 000000000000..db120e2f7d1d --- /dev/null +++ b/static/api/cpp/3.5.x/search/enums_2.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['keysharedmode_0',['KeySharedMode',['../namespacepulsar.html#a499d1327931169d068b9b353f106dd04',1,'pulsar']]], + ['keyvalueencodingtype_1',['KeyValueEncodingType',['../namespacepulsar.html#a0dca31b62c0207ea87e146cde0609595',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/enums_3.js b/static/api/cpp/3.5.x/search/enums_3.js new file mode 100644 index 000000000000..a7296b8bc171 --- /dev/null +++ b/static/api/cpp/3.5.x/search/enums_3.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['produceraccessmode_0',['ProducerAccessMode',['../classpulsar_1_1_producer_configuration.html#ab217b341d1fa532552bcd03064a39cea',1,'pulsar::ProducerConfiguration']]] +]; diff --git a/static/api/cpp/3.5.x/search/enums_4.js b/static/api/cpp/3.5.x/search/enums_4.js new file mode 100644 index 000000000000..cd9919d3111a --- /dev/null +++ b/static/api/cpp/3.5.x/search/enums_4.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['regexsubscriptionmode_0',['RegexSubscriptionMode',['../namespacepulsar.html#abd9b21e56a6fb78e04cae2664ff0dbbd',1,'pulsar']]], + ['result_1',['Result',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbb',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/enums_5.js b/static/api/cpp/3.5.x/search/enums_5.js new file mode 100644 index 000000000000..91fb459139bb --- /dev/null +++ b/static/api/cpp/3.5.x/search/enums_5.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['schematype_0',['SchemaType',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/enumvalues_0.js b/static/api/cpp/3.5.x/search/enumvalues_0.js new file mode 100644 index 000000000000..79b121131018 --- /dev/null +++ b/static/api/cpp/3.5.x/search/enumvalues_0.js @@ -0,0 +1,8 @@ +var searchData= +[ + ['alltopics_0',['AllTopics',['../namespacepulsar.html#abd9b21e56a6fb78e04cae2664ff0dbbdaa30bab3d7d550e08f128647cbbd5b6ef',1,'pulsar']]], + ['auto_5fconsume_1',['AUTO_CONSUME',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305a6a9078e01119bddf19aa24dc05390f99',1,'pulsar']]], + ['auto_5fpublish_2',['AUTO_PUBLISH',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305ad1af93d272614c940d322497eb8e31f0',1,'pulsar']]], + ['auto_5fsplit_3',['AUTO_SPLIT',['../namespacepulsar.html#a499d1327931169d068b9b353f106dd04a1dce3e502d8e018e90f97c07b37cde1f',1,'pulsar']]], + ['avro_4',['AVRO',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305ac728ff4cb4de807c1b6fa8ca33f41d47',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/enumvalues_1.js b/static/api/cpp/3.5.x/search/enumvalues_1.js new file mode 100644 index 000000000000..1b52dc43f707 --- /dev/null +++ b/static/api/cpp/3.5.x/search/enumvalues_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['bytes_0',['BYTES',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305a4dcbdcae67c5f78b7c4fff2c2135cba2',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/enumvalues_2.js b/static/api/cpp/3.5.x/search/enumvalues_2.js new file mode 100644 index 000000000000..6c48db536d0d --- /dev/null +++ b/static/api/cpp/3.5.x/search/enumvalues_2.js @@ -0,0 +1,7 @@ +var searchData= +[ + ['consumerexclusive_0',['ConsumerExclusive',['../namespacepulsar.html#ac3e442abe2558a2b257fc7344af61d40a915cd237340dcd1d212f8d398f3d91ac',1,'pulsar']]], + ['consumerfailover_1',['ConsumerFailover',['../namespacepulsar.html#ac3e442abe2558a2b257fc7344af61d40aadffd5f0d50b1da36685230cd3f910a1',1,'pulsar']]], + ['consumerkeyshared_2',['ConsumerKeyShared',['../namespacepulsar.html#ac3e442abe2558a2b257fc7344af61d40acb902cf3781caf307d06e37dc447d5cc',1,'pulsar']]], + ['consumershared_3',['ConsumerShared',['../namespacepulsar.html#ac3e442abe2558a2b257fc7344af61d40ac55370821e835a03c2da742ab27e1705',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/enumvalues_3.js b/static/api/cpp/3.5.x/search/enumvalues_3.js new file mode 100644 index 000000000000..624e21dd7367 --- /dev/null +++ b/static/api/cpp/3.5.x/search/enumvalues_3.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['defaultbatching_0',['DefaultBatching',['../classpulsar_1_1_producer_configuration.html#adeed584c68f90401147e31091e54c5e5af2acbf3fc9b0dc49d8af65a148d22e27',1,'pulsar::ProducerConfiguration']]], + ['double_1',['DOUBLE',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305a1b1684230ae9c15941cb3fe05bf972f0',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/enumvalues_4.js b/static/api/cpp/3.5.x/search/enumvalues_4.js new file mode 100644 index 000000000000..0a30e6be75bd --- /dev/null +++ b/static/api/cpp/3.5.x/search/enumvalues_4.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['exclusive_0',['Exclusive',['../classpulsar_1_1_producer_configuration.html#ab217b341d1fa532552bcd03064a39ceaabd2cd3c2f4a00e0dc5d5aeb07404831d',1,'pulsar::ProducerConfiguration']]], + ['exclusivewithfencing_1',['ExclusiveWithFencing',['../classpulsar_1_1_producer_configuration.html#ab217b341d1fa532552bcd03064a39ceaae142b6a80e588880365caa719fe6ebd8',1,'pulsar::ProducerConfiguration']]] +]; diff --git a/static/api/cpp/3.5.x/search/enumvalues_5.js b/static/api/cpp/3.5.x/search/enumvalues_5.js new file mode 100644 index 000000000000..72dad61a9dbe --- /dev/null +++ b/static/api/cpp/3.5.x/search/enumvalues_5.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['float_0',['FLOAT',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305a5102395892b9d15d0a0483a27ca64777',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/enumvalues_6.js b/static/api/cpp/3.5.x/search/enumvalues_6.js new file mode 100644 index 000000000000..660ae0321e1e --- /dev/null +++ b/static/api/cpp/3.5.x/search/enumvalues_6.js @@ -0,0 +1,8 @@ +var searchData= +[ + ['inline_0',['INLINE',['../namespacepulsar.html#a0dca31b62c0207ea87e146cde0609595acfbac07c6ae3e73f0e10ca60ad916bef',1,'pulsar']]], + ['int16_1',['INT16',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305a9e5ed020cb2ca197a0918946352cf96e',1,'pulsar']]], + ['int32_2',['INT32',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305ac048e1576ab161018f9e3c6eda6307d0',1,'pulsar']]], + ['int64_3',['INT64',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305a11fafed4115309cf1f33eac044e704a2',1,'pulsar']]], + ['int8_4',['INT8',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305a2c52dde965d6ba972179fa14116160e9',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/enumvalues_7.js b/static/api/cpp/3.5.x/search/enumvalues_7.js new file mode 100644 index 000000000000..936dbefa2720 --- /dev/null +++ b/static/api/cpp/3.5.x/search/enumvalues_7.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['json_0',['JSON',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305a15f7910601e8d522f151f3129c753283',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/enumvalues_8.js b/static/api/cpp/3.5.x/search/enumvalues_8.js new file mode 100644 index 000000000000..ec7cf4bf104e --- /dev/null +++ b/static/api/cpp/3.5.x/search/enumvalues_8.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['key_5fvalue_0',['KEY_VALUE',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305ab6fbe0f5b80de2aa67b68572e7a054d3',1,'pulsar']]], + ['keybasedbatching_1',['KeyBasedBatching',['../classpulsar_1_1_producer_configuration.html#adeed584c68f90401147e31091e54c5e5a291402f9cfb8e9f0fa888722930233ea',1,'pulsar::ProducerConfiguration']]] +]; diff --git a/static/api/cpp/3.5.x/search/enumvalues_9.js b/static/api/cpp/3.5.x/search/enumvalues_9.js new file mode 100644 index 000000000000..699ef0f983fe --- /dev/null +++ b/static/api/cpp/3.5.x/search/enumvalues_9.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['none_0',['NONE',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305af9377cb56d5b6973392d0fd2ca76009a',1,'pulsar']]], + ['nonpersistentonly_1',['NonPersistentOnly',['../namespacepulsar.html#abd9b21e56a6fb78e04cae2664ff0dbbda5af3d512f79ac90cacc326d86a230603',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/enumvalues_a.js b/static/api/cpp/3.5.x/search/enumvalues_a.js new file mode 100644 index 000000000000..7408437488a8 --- /dev/null +++ b/static/api/cpp/3.5.x/search/enumvalues_a.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['persistentonly_0',['PersistentOnly',['../namespacepulsar.html#abd9b21e56a6fb78e04cae2664ff0dbbda68931062ae96d4dcc4778eeac5fa3de4',1,'pulsar']]], + ['protobuf_1',['PROTOBUF',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305a5054f171f6c60b73043727ddc60698a0',1,'pulsar']]], + ['protobuf_5fnative_2',['PROTOBUF_NATIVE',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305a24048f6ae2e1048989e69644edcdc8f6',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/enumvalues_b.js b/static/api/cpp/3.5.x/search/enumvalues_b.js new file mode 100644 index 000000000000..8c5e11085fc4 --- /dev/null +++ b/static/api/cpp/3.5.x/search/enumvalues_b.js @@ -0,0 +1,49 @@ +var searchData= +[ + ['resultalreadyclosed_0',['ResultAlreadyClosed',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba6c11f7cd8f0bc274d12c5157157ad916',1,'pulsar']]], + ['resultauthenticationerror_1',['ResultAuthenticationError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba2b40eba56a27dc5615338a0d988e2024',1,'pulsar']]], + ['resultauthorizationerror_2',['ResultAuthorizationError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba4db07aa497065f6cc0d8e314bf852057',1,'pulsar']]], + ['resultbrokermetadataerror_3',['ResultBrokerMetadataError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba2188e16c2e397cee5f64aef6799c419c',1,'pulsar']]], + ['resultbrokerpersistenceerror_4',['ResultBrokerPersistenceError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba3ac5992ae486593f5aee1538970b51a6',1,'pulsar']]], + ['resultchecksumerror_5',['ResultChecksumError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba60d3371f74155ecb5b11efbf217a2174',1,'pulsar']]], + ['resultconnecterror_6',['ResultConnectError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbab26ee1bb88fafefa107071fa1fd775bc',1,'pulsar']]], + ['resultconsumerassignerror_7',['ResultConsumerAssignError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbac0f35889e7dd6cb7f634baedb8481e9e',1,'pulsar']]], + ['resultconsumerbusy_8',['ResultConsumerBusy',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba5cbe2e189b60f91ff0f2e82b973db31b',1,'pulsar']]], + ['resultconsumernotfound_9',['ResultConsumerNotFound',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbac74e9fb1b2c25caf17ac3446303b7a71',1,'pulsar']]], + ['resultconsumernotinitialized_10',['ResultConsumerNotInitialized',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba48d27a5310cda91d13a23324a08533e9',1,'pulsar']]], + ['resultcryptoerror_11',['ResultCryptoError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbac131b27876dfd64d8e6b3355578a8f77',1,'pulsar']]], + ['resultcumulativeacknowledgementnotallowederror_12',['ResultCumulativeAcknowledgementNotAllowedError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba2e01cfc218b721cbd2e2a06bf3cb78b0',1,'pulsar']]], + ['resultdisconnected_13',['ResultDisconnected',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba287510a5c9a382f29f0cbdf3d32c0d59',1,'pulsar']]], + ['resulterrorgettingauthenticationdata_14',['ResultErrorGettingAuthenticationData',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba8014344f94ba9ad55337f01767e0e30c',1,'pulsar']]], + ['resultincompatibleschema_15',['ResultIncompatibleSchema',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbafe509853528453adc4ca304ea9b1d79e',1,'pulsar']]], + ['resultinterrupted_16',['ResultInterrupted',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba67722ba0750e461ae03912f5dc10d03a',1,'pulsar']]], + ['resultinvalidconfiguration_17',['ResultInvalidConfiguration',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbad3d7545107897e19819066fe42e81a06',1,'pulsar']]], + ['resultinvalidmessage_18',['ResultInvalidMessage',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba875234396481a34fb7f02d3ecd1936f0',1,'pulsar']]], + ['resultinvalidtopicname_19',['ResultInvalidTopicName',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbafcb0b43f04e494ba3784f6c259b5137f',1,'pulsar']]], + ['resultinvalidtxnstatuserror_20',['ResultInvalidTxnStatusError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba742ada2f12ae5b2ca11fa674889dc186',1,'pulsar']]], + ['resultinvalidurl_21',['ResultInvalidUrl',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba685954a2aedb14c0f3669d579bfd1193',1,'pulsar']]], + ['resultlookuperror_22',['ResultLookupError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba42ae88341f22c34ed9baac35804f1b01',1,'pulsar']]], + ['resultmemorybufferisfull_23',['ResultMemoryBufferIsFull',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba7eaf7df2c4a2ac2f874e044db02c6733',1,'pulsar']]], + ['resultmessagetoobig_24',['ResultMessageTooBig',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba43765d6a6cab85363b2cad047371294b',1,'pulsar']]], + ['resultnotallowederror_25',['ResultNotAllowedError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbad38a4ab387c0769f3c8c30fd2c7413a1',1,'pulsar']]], + ['resultnotconnected_26',['ResultNotConnected',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba00976fab0138d80c5fc621e3a44046b6',1,'pulsar']]], + ['resultok_27',['ResultOk',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba0aac5dae08c453e94161e28d7cd5a92f',1,'pulsar']]], + ['resultoperationnotsupported_28',['ResultOperationNotSupported',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba60abb5ad06a78a3d6d40b2131534dfeb',1,'pulsar']]], + ['resultproducerblockedquotaexceededexception_29',['ResultProducerBlockedQuotaExceededException',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbab5cc52655496666d96f35edab07c9e7f',1,'pulsar']]], + ['resultproducerbusy_30',['ResultProducerBusy',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbad0a7588cc2ac84de7fc17331ed59b544',1,'pulsar']]], + ['resultproducerfenced_31',['ResultProducerFenced',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba6370706ff98bf4c513f11489679543cb',1,'pulsar']]], + ['resultproducernotinitialized_32',['ResultProducerNotInitialized',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba2b5f050c9b2aef10831927cece55b02a',1,'pulsar']]], + ['resultproducerqueueisfull_33',['ResultProducerQueueIsFull',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba1849c732b1ec8c7e1c0aa653de998d81',1,'pulsar']]], + ['resultreaderror_34',['ResultReadError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbaa084aea99a198f2d01c6c98eeb44ff9e',1,'pulsar']]], + ['resultserviceunitnotready_35',['ResultServiceUnitNotReady',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbaf8a459f352105f7e853e02ca2af193b0',1,'pulsar']]], + ['resultsubscriptionnotfound_36',['ResultSubscriptionNotFound',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba061d6c40bdf75ca172ffdb862aad7c51',1,'pulsar']]], + ['resulttimeout_37',['ResultTimeout',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbaeb1858ddf791b7288ab1cb066d70cfb4',1,'pulsar']]], + ['resulttoomanylookuprequestexception_38',['ResultTooManyLookupRequestException',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba024fa5ba9fac2cb81fd4e8f6853a81a5',1,'pulsar']]], + ['resulttopicnotfound_39',['ResultTopicNotFound',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbad1921e33dd6a45431a0209b70588cf48',1,'pulsar']]], + ['resulttopicterminated_40',['ResultTopicTerminated',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba62df217dec3d3f75c7099d1464c92750',1,'pulsar']]], + ['resulttransactionconflict_41',['ResultTransactionConflict',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba39c2049f4e7e428d2a4473b68223a53c',1,'pulsar']]], + ['resulttransactioncoordinatornotfounderror_42',['ResultTransactionCoordinatorNotFoundError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba653a82475a2715f839ba52329a9b6414',1,'pulsar']]], + ['resulttransactionnotfound_43',['ResultTransactionNotFound',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbbaf4bfae37b494ea0a2599cc4596bccdf0',1,'pulsar']]], + ['resultunknownerror_44',['ResultUnknownError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba213e39d5c84b8794dd21ab4f60ff4b60',1,'pulsar']]], + ['resultunsupportedversionerror_45',['ResultUnsupportedVersionError',['../namespacepulsar.html#ae85314d6b9e8afd831cf8c66705f2dbba888578f8569121606cfcfa6044c594c3',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/enumvalues_c.js b/static/api/cpp/3.5.x/search/enumvalues_c.js new file mode 100644 index 000000000000..247dbcf18b78 --- /dev/null +++ b/static/api/cpp/3.5.x/search/enumvalues_c.js @@ -0,0 +1,7 @@ +var searchData= +[ + ['separated_0',['SEPARATED',['../namespacepulsar.html#a0dca31b62c0207ea87e146cde0609595a561af55a6a824ae74125a6cf4eade06a',1,'pulsar']]], + ['shared_1',['Shared',['../classpulsar_1_1_producer_configuration.html#ab217b341d1fa532552bcd03064a39ceaa73f8f203fbd16f91a5b123a362bf13e5',1,'pulsar::ProducerConfiguration']]], + ['sticky_2',['STICKY',['../namespacepulsar.html#a499d1327931169d068b9b353f106dd04aed98d14aabee0f3bc70a0cc7723e5b16',1,'pulsar']]], + ['string_3',['STRING',['../namespacepulsar.html#abab5b1f233c9cc54c10d28cb5b973305ab936a9dad2cbb5fca28fc477ff39fb70',1,'pulsar']]] +]; diff --git a/static/api/cpp/3.5.x/search/enumvalues_d.js b/static/api/cpp/3.5.x/search/enumvalues_d.js new file mode 100644 index 000000000000..cc6bbd3174b8 --- /dev/null +++ b/static/api/cpp/3.5.x/search/enumvalues_d.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['waitforexclusive_0',['WaitForExclusive',['../classpulsar_1_1_producer_configuration.html#ab217b341d1fa532552bcd03064a39ceaa9ba09474e854bd3d7094580ed7a3ff29',1,'pulsar::ProducerConfiguration']]] +]; diff --git a/static/api/cpp/3.5.x/search/functions_0.js b/static/api/cpp/3.5.x/search/functions_0.js new file mode 100644 index 000000000000..7c102a0d02af --- /dev/null +++ b/static/api/cpp/3.5.x/search/functions_0.js @@ -0,0 +1,9 @@ +var searchData= +[ + ['acknowledge_0',['acknowledge',['../classpulsar_1_1_consumer.html#a3c3eb5056f228d281798f9ea75f52af9',1,'pulsar::Consumer::acknowledge(const Message &message)'],['../classpulsar_1_1_consumer.html#aed10e043835e50d8129e6adecd91da72',1,'pulsar::Consumer::acknowledge(const MessageId &messageId)'],['../classpulsar_1_1_consumer.html#a57fd2c53a44ea53262742d90ff11e0fd',1,'pulsar::Consumer::acknowledge(const MessageIdList &messageIdList)']]], + ['acknowledgeasync_1',['acknowledgeasync',['../classpulsar_1_1_consumer.html#a867bebab981d5aa2f74217308aa2353c',1,'pulsar::Consumer::acknowledgeAsync(const Message &message, ResultCallback callback)'],['../classpulsar_1_1_consumer.html#a3a08b7cdcc9a1733ce7066173bfcdc28',1,'pulsar::Consumer::acknowledgeAsync(const MessageId &messageId, ResultCallback callback)'],['../classpulsar_1_1_consumer.html#a74283a098beeb002e15a1dbba9fcff13',1,'pulsar::Consumer::acknowledgeAsync(const MessageIdList &messageIdList, ResultCallback callback)']]], + ['acknowledgecumulative_2',['acknowledgecumulative',['../classpulsar_1_1_consumer.html#a3eb0b0db2da0628da15d3f242e254f6d',1,'pulsar::Consumer::acknowledgeCumulative(const Message &message)'],['../classpulsar_1_1_consumer.html#a79558de7435fd0b6ca0bde84f3061822',1,'pulsar::Consumer::acknowledgeCumulative(const MessageId &messageId)']]], + ['acknowledgecumulativeasync_3',['acknowledgecumulativeasync',['../classpulsar_1_1_consumer.html#a6ad164b1ab4449b17bce764224e92960',1,'pulsar::Consumer::acknowledgeCumulativeAsync(const Message &message, ResultCallback callback)'],['../classpulsar_1_1_consumer.html#a5d4cf148f372618961fd3411792a5cd7',1,'pulsar::Consumer::acknowledgeCumulativeAsync(const MessageId &messageId, ResultCallback callback)']]], + ['addencryptionkey_4',['addEncryptionKey',['../classpulsar_1_1_producer_configuration.html#a5d8739282f60f8c5c25c937eff5aeb2f',1,'pulsar::ProducerConfiguration']]], + ['authenticate_5',['authenticate',['../classpulsar_1_1_oauth2_flow.html#a26ba112e97d9ce0283adaa9213f848ac',1,'pulsar::Oauth2Flow']]] +]; diff --git a/static/api/cpp/3.5.x/search/functions_1.js b/static/api/cpp/3.5.x/search/functions_1.js new file mode 100644 index 000000000000..048531c2d355 --- /dev/null +++ b/static/api/cpp/3.5.x/search/functions_1.js @@ -0,0 +1,13 @@ +var searchData= +[ + ['batchindex_0',['batchIndex',['../classpulsar_1_1_message_id_builder.html#a09df47acda7f3fe3ec8b0b2f7b9f99f9',1,'pulsar::MessageIdBuilder']]], + ['batchreceive_1',['batchReceive',['../classpulsar_1_1_consumer.html#a49c846a386d778df94a1439982be5cbd',1,'pulsar::Consumer']]], + ['batchreceiveasync_2',['batchReceiveAsync',['../classpulsar_1_1_consumer.html#ac403fe5941453dcfc41cc01055bca16e',1,'pulsar::Consumer']]], + ['batchreceivepolicy_3',['batchreceivepolicy',['../classpulsar_1_1_batch_receive_policy.html#a95e11e66f6e2a2ae0d842c39f15ebfe0',1,'pulsar::BatchReceivePolicy::BatchReceivePolicy()'],['../classpulsar_1_1_batch_receive_policy.html#af991536bbae3de08b7d11ad3ad28f647',1,'pulsar::BatchReceivePolicy::BatchReceivePolicy(int maxNumMessage, long maxNumBytes, long timeoutMs)']]], + ['batchsize_4',['batchSize',['../classpulsar_1_1_message_id_builder.html#a070889cc7ffd6f403883b64f38146f74',1,'pulsar::MessageIdBuilder']]], + ['becameactive_5',['becameActive',['../classpulsar_1_1_consumer_event_listener.html#ae6423a9fb10d4c76642bf7f036d43875',1,'pulsar::ConsumerEventListener']]], + ['becameinactive_6',['becameInactive',['../classpulsar_1_1_consumer_event_listener.html#aa11768bfa6db7611e95631202d88439e',1,'pulsar::ConsumerEventListener']]], + ['beforeconsume_7',['beforeConsume',['../classpulsar_1_1_consumer_interceptor.html#a390ea752b64d895a6cca218255ba1398',1,'pulsar::ConsumerInterceptor']]], + ['beforesend_8',['beforeSend',['../classpulsar_1_1_producer_interceptor.html#adc40c03231068fa4a13d6017220d0a79',1,'pulsar::ProducerInterceptor']]], + ['build_9',['build',['../classpulsar_1_1_dead_letter_policy_builder.html#a49862689af514682dae0279889da6c03',1,'pulsar::DeadLetterPolicyBuilder::build()'],['../classpulsar_1_1_message_builder.html#a096971441b85caead9602670d7b901d6',1,'pulsar::MessageBuilder::build()'],['../classpulsar_1_1_message_id_builder.html#a8fe3a6d2cc7a29f59137ad241887bf0e',1,'pulsar::MessageIdBuilder::build()']]] +]; diff --git a/static/api/cpp/3.5.x/search/functions_10.js b/static/api/cpp/3.5.x/search/functions_10.js new file mode 100644 index 000000000000..62586ffaf596 --- /dev/null +++ b/static/api/cpp/3.5.x/search/functions_10.js @@ -0,0 +1,114 @@ +var searchData= +[ + ['schemainfo_0',['schemainfo',['../classpulsar_1_1_schema_info.html#a92a6aa4d6f21ce8511e680b86ed0de93',1,'pulsar::SchemaInfo::SchemaInfo()'],['../classpulsar_1_1_schema_info.html#ab0e388e0cc81a21da3917156053e16d2',1,'pulsar::SchemaInfo::SchemaInfo(SchemaType schemaType, const std::string &name, const std::string &schema, const StringMap &properties=StringMap())'],['../classpulsar_1_1_schema_info.html#abb5fa2e2c1dfe4bdd002a90359bab732',1,'pulsar::SchemaInfo::SchemaInfo(const SchemaInfo &keySchema, const SchemaInfo &valueSchema, const KeyValueEncodingType &keyValueEncodingType=KeyValueEncodingType::INLINE)']]], + ['seek_1',['seek',['../classpulsar_1_1_consumer.html#a45800c18df817caabe6cd9c21e7d72b3',1,'pulsar::Consumer::seek(const MessageId &messageId)'],['../classpulsar_1_1_consumer.html#ae6835e612b61795a13eff5fd2da85a0e',1,'pulsar::Consumer::seek(uint64_t timestamp)'],['../classpulsar_1_1_reader.html#a6bec25700e5b4eb7be41625a9bc856bd',1,'pulsar::Reader::seek(const MessageId &msgId)'],['../classpulsar_1_1_reader.html#adebdd61a5150777704c8ce8dcec08fc8',1,'pulsar::Reader::seek(uint64_t timestamp)']]], + ['seekasync_2',['seekasync',['../classpulsar_1_1_consumer.html#af1c892616483868ce5e30be46e7a40bf',1,'pulsar::Consumer::seekAsync(const MessageId &messageId, ResultCallback callback)'],['../classpulsar_1_1_consumer.html#a01761bcf98436600d5f4d461582db94f',1,'pulsar::Consumer::seekAsync(uint64_t timestamp, ResultCallback callback)'],['../classpulsar_1_1_reader.html#acba58f8fb3ecefc4a693a1091f3c4669',1,'pulsar::Reader::seekAsync(const MessageId &msgId, ResultCallback callback)'],['../classpulsar_1_1_reader.html#addec61dc54aba2959c06a2017bea7c32',1,'pulsar::Reader::seekAsync(uint64_t timestamp, ResultCallback callback)']]], + ['send_3',['send',['../classpulsar_1_1_producer.html#ad4737186cf798acfb24a167796259443',1,'pulsar::Producer::send(const Message &msg)'],['../classpulsar_1_1_producer.html#a32a8c234d42e1951c0357a7562ccdb3a',1,'pulsar::Producer::send(const Message &msg, MessageId &messageId)']]], + ['sendasync_4',['sendAsync',['../classpulsar_1_1_producer.html#a7b31f92eb0362bdff32316fc9ab70fd7',1,'pulsar::Producer']]], + ['serialize_5',['serialize',['../classpulsar_1_1_message_id.html#aef0c413f2705d0ebdf1577c84af6ba6b',1,'pulsar::MessageId']]], + ['setaccessmode_6',['setAccessMode',['../classpulsar_1_1_producer_configuration.html#a24fde55a4c296eacd3276b8299b4d0b3',1,'pulsar::ProducerConfiguration']]], + ['setaccesstoken_7',['setAccessToken',['../classpulsar_1_1_oauth2_token_result.html#af592ce6cc7e7633da3c03cfaa9f0876f',1,'pulsar::Oauth2TokenResult']]], + ['setackgroupingmaxsize_8',['setackgroupingmaxsize',['../classpulsar_1_1_consumer_configuration.html#a593295c1aa0cd77c32a6cfdee80cd452',1,'pulsar::ConsumerConfiguration::setAckGroupingMaxSize()'],['../classpulsar_1_1_reader_configuration.html#af3e84677688a37133d9b270f86aed8da',1,'pulsar::ReaderConfiguration::setAckGroupingMaxSize()']]], + ['setackgroupingtimems_9',['setackgroupingtimems',['../classpulsar_1_1_consumer_configuration.html#af3f26276c9027a78b9e3243a3e2e38bb',1,'pulsar::ConsumerConfiguration::setAckGroupingTimeMs()'],['../classpulsar_1_1_reader_configuration.html#ab909115a0d99bf1d13f00d098bd4af6f',1,'pulsar::ReaderConfiguration::setAckGroupingTimeMs()']]], + ['setackreceiptenabled_10',['setAckReceiptEnabled',['../classpulsar_1_1_consumer_configuration.html#a3f16bf6b26ddb301c03fcb58e31bdd21',1,'pulsar::ConsumerConfiguration']]], + ['setallocatedcontent_11',['setAllocatedContent',['../classpulsar_1_1_message_builder.html#a33536f52b1a0b00d20d57432377a0822',1,'pulsar::MessageBuilder']]], + ['setallowoutoforderdelivery_12',['setAllowOutOfOrderDelivery',['../classpulsar_1_1_key_shared_policy.html#a5ebe39804f4e2c7a6cc31d1ef7d58e6a',1,'pulsar::KeySharedPolicy']]], + ['setauth_13',['setAuth',['../classpulsar_1_1_client_configuration.html#a283f6a724a4fdd8fa1def661e253eafb',1,'pulsar::ClientConfiguration']]], + ['setautoackoldestchunkedmessageonqueuefull_14',['setAutoAckOldestChunkedMessageOnQueueFull',['../classpulsar_1_1_consumer_configuration.html#a3f11566f0654bd4a9df8e7852e4e048e',1,'pulsar::ConsumerConfiguration']]], + ['setbatchindexackenabled_15',['setBatchIndexAckEnabled',['../classpulsar_1_1_consumer_configuration.html#a19565e5aabcb066e97fed95be4724151',1,'pulsar::ConsumerConfiguration']]], + ['setbatchingenabled_16',['setBatchingEnabled',['../classpulsar_1_1_producer_configuration.html#af9a1dd93b7a412b3bf3ec79d4083f0e8',1,'pulsar::ProducerConfiguration']]], + ['setbatchingmaxallowedsizeinbytes_17',['setBatchingMaxAllowedSizeInBytes',['../classpulsar_1_1_producer_configuration.html#abbec0bcbdee8085afd81e94262d72080',1,'pulsar::ProducerConfiguration']]], + ['setbatchingmaxmessages_18',['setBatchingMaxMessages',['../classpulsar_1_1_producer_configuration.html#a1be81019a86b11ed5c685fdc7e899401',1,'pulsar::ProducerConfiguration']]], + ['setbatchingmaxpublishdelayms_19',['setBatchingMaxPublishDelayMs',['../classpulsar_1_1_producer_configuration.html#a34f1bf46378fba5e065f252f982ce350',1,'pulsar::ProducerConfiguration']]], + ['setbatchingtype_20',['setBatchingType',['../classpulsar_1_1_producer_configuration.html#abe21bc7bbb3f7d3bbad5102688e715a7',1,'pulsar::ProducerConfiguration']]], + ['setbatchreceivepolicy_21',['setBatchReceivePolicy',['../classpulsar_1_1_consumer_configuration.html#a576115b74c66df74662b2e4f00a69731',1,'pulsar::ConsumerConfiguration']]], + ['setblockifqueuefull_22',['setBlockIfQueueFull',['../classpulsar_1_1_producer_configuration.html#ae83e7490292fef0b78619135cc90d6a9',1,'pulsar::ProducerConfiguration']]], + ['setbrokerconsumerstatscachetimeinms_23',['setBrokerConsumerStatsCacheTimeInMs',['../classpulsar_1_1_consumer_configuration.html#a453a6af922fea7c45d56264d57925507',1,'pulsar::ConsumerConfiguration']]], + ['setchunkingenabled_24',['setChunkingEnabled',['../classpulsar_1_1_producer_configuration.html#ad79c6bf2280450ba395aea33885738ae',1,'pulsar::ProducerConfiguration']]], + ['setcompressiontype_25',['setCompressionType',['../classpulsar_1_1_producer_configuration.html#a3e4784fdab5471faeddb380849ba60fb',1,'pulsar::ProducerConfiguration']]], + ['setconcurrentlookuprequest_26',['setConcurrentLookupRequest',['../classpulsar_1_1_client_configuration.html#a9ae54146fe16f423faee853705043a0d',1,'pulsar::ClientConfiguration']]], + ['setconnectionsperbroker_27',['setConnectionsPerBroker',['../classpulsar_1_1_client_configuration.html#a3a2246877634534eb3163ed45221a6f5',1,'pulsar::ClientConfiguration']]], + ['setconnectiontimeout_28',['setConnectionTimeout',['../classpulsar_1_1_client_configuration.html#a6d12355701aed4526560e5754312da53',1,'pulsar::ClientConfiguration']]], + ['setconsumereventlistener_29',['setConsumerEventListener',['../classpulsar_1_1_consumer_configuration.html#a6589512011ad7daf2b9eeaaaf4020842',1,'pulsar::ConsumerConfiguration']]], + ['setconsumername_30',['setConsumerName',['../classpulsar_1_1_consumer_configuration.html#a9a9c38d660aabc9162295de38bc26b77',1,'pulsar::ConsumerConfiguration']]], + ['setconsumertype_31',['setConsumerType',['../classpulsar_1_1_consumer_configuration.html#a5029c0a8bc51a764fdd4eaf37e56964d',1,'pulsar::ConsumerConfiguration']]], + ['setcontent_32',['setcontent',['../classpulsar_1_1_message_builder.html#a2cc0fde4d3dcc2aae68e6e1588c8d364',1,'pulsar::MessageBuilder::setContent(const void *data, size_t size)'],['../classpulsar_1_1_message_builder.html#aeae2c95b0639f36fe80c0ce5256cae16',1,'pulsar::MessageBuilder::setContent(const std::string &data)'],['../classpulsar_1_1_message_builder.html#a6ebb6e9660a46e883c5467213093abcd',1,'pulsar::MessageBuilder::setContent(std::string &&data)'],['../classpulsar_1_1_message_builder.html#a6a9f4daf6548d0c24eae92642b2f9401',1,'pulsar::MessageBuilder::setContent(const KeyValue &data)']]], + ['setcryptofailureaction_33',['setcryptofailureaction',['../classpulsar_1_1_consumer_configuration.html#aadf3be3099c2bbb4354839e21a48e875',1,'pulsar::ConsumerConfiguration::setCryptoFailureAction()'],['../classpulsar_1_1_producer_configuration.html#acf13ddf392d17cc54100f02431e6ba4f',1,'pulsar::ProducerConfiguration::setCryptoFailureAction()'],['../classpulsar_1_1_reader_configuration.html#a717ee81f7651851635a569fe35d735ea',1,'pulsar::ReaderConfiguration::setCryptoFailureAction()']]], + ['setcryptokeyreader_34',['setcryptokeyreader',['../classpulsar_1_1_consumer_configuration.html#a9ff24549af7bda3f2f4da4cce299eb5d',1,'pulsar::ConsumerConfiguration::setCryptoKeyReader()'],['../classpulsar_1_1_producer_configuration.html#a6934b1d5c42a1f03ad011b20ee5c1724',1,'pulsar::ProducerConfiguration::setCryptoKeyReader()'],['../classpulsar_1_1_reader_configuration.html#a3ce07aacf5e43c5e3252d30e70556fc4',1,'pulsar::ReaderConfiguration::setCryptoKeyReader()']]], + ['setdeadletterpolicy_35',['setDeadLetterPolicy',['../classpulsar_1_1_consumer_configuration.html#a84033093b1bf99d7c843634fdc8a32ec',1,'pulsar::ConsumerConfiguration']]], + ['setdeliverafter_36',['setDeliverAfter',['../classpulsar_1_1_message_builder.html#a43996377452478df5ba3d8255eb8e266',1,'pulsar::MessageBuilder']]], + ['setdeliverat_37',['setDeliverAt',['../classpulsar_1_1_message_builder.html#a07e17c0a4721ec937f028ebc0e8d15f4',1,'pulsar::MessageBuilder']]], + ['seteventtimestamp_38',['setEventTimestamp',['../classpulsar_1_1_message_builder.html#a47a1c042b9e686c48b406c993e7982e5',1,'pulsar::MessageBuilder']]], + ['setexpiresin_39',['setExpiresIn',['../classpulsar_1_1_oauth2_token_result.html#aa27ab0a802260bbf7142e03fd6c8bb46',1,'pulsar::Oauth2TokenResult']]], + ['setexpiretimeofincompletechunkedmessagems_40',['setExpireTimeOfIncompleteChunkedMessageMs',['../classpulsar_1_1_consumer_configuration.html#ac1bf9941a3dbb3948e76b9638d188ea9',1,'pulsar::ConsumerConfiguration']]], + ['sethashingscheme_41',['setHashingScheme',['../classpulsar_1_1_producer_configuration.html#a542691ebedfa1f1fdb706e77067680bb',1,'pulsar::ProducerConfiguration']]], + ['setidtoken_42',['setIdToken',['../classpulsar_1_1_oauth2_token_result.html#a9cdc37fbe7d61486affda02a753ff1dc',1,'pulsar::Oauth2TokenResult']]], + ['setinitialbackoffintervalms_43',['setInitialBackoffIntervalMs',['../classpulsar_1_1_client_configuration.html#aeb336cdb14093bb3626496a631e29441',1,'pulsar::ClientConfiguration']]], + ['setinitialsequenceid_44',['setInitialSequenceId',['../classpulsar_1_1_producer_configuration.html#a9b6c3c9f7e734f0e95cb9c7b301e14eb',1,'pulsar::ProducerConfiguration']]], + ['setinternalsubscriptionname_45',['setInternalSubscriptionName',['../classpulsar_1_1_reader_configuration.html#ae1848f9313953faf2ab00f198d412108',1,'pulsar::ReaderConfiguration']]], + ['setiothreads_46',['setIOThreads',['../classpulsar_1_1_client_configuration.html#a7e83eb6526e98259023e93f0c89c1a61',1,'pulsar::ClientConfiguration']]], + ['setkey_47',['setKey',['../classpulsar_1_1_encryption_key_info.html#a243fb74066b5d6c7153660a4a5cd3290',1,'pulsar::EncryptionKeyInfo']]], + ['setkeysharedmode_48',['setKeySharedMode',['../classpulsar_1_1_key_shared_policy.html#a7ecef0d315c8955a5223d07f11213aa2',1,'pulsar::KeySharedPolicy']]], + ['setkeysharedpolicy_49',['setKeySharedPolicy',['../classpulsar_1_1_consumer_configuration.html#a56eb95eb8f39532c49a3300cb2a4a72d',1,'pulsar::ConsumerConfiguration']]], + ['setlazystartpartitionedproducers_50',['setLazyStartPartitionedProducers',['../classpulsar_1_1_producer_configuration.html#af025bdb0f1c7c9c8fe8cfc61f5e7b1e6',1,'pulsar::ProducerConfiguration']]], + ['setlistenername_51',['setListenerName',['../classpulsar_1_1_client_configuration.html#acb0c818a17629bb78d90bf8d174320fe',1,'pulsar::ClientConfiguration']]], + ['setlogger_52',['setLogger',['../classpulsar_1_1_client_configuration.html#a1bf72e7f2e263ed35ff631a379e7e562',1,'pulsar::ClientConfiguration']]], + ['setmaxbackoffintervalms_53',['setMaxBackoffIntervalMs',['../classpulsar_1_1_client_configuration.html#a40d8e808b298b797c38bc2e57df43aa3',1,'pulsar::ClientConfiguration']]], + ['setmaxlookupredirects_54',['setMaxLookupRedirects',['../classpulsar_1_1_client_configuration.html#abcf3777ad94bee91b2f099a2f23e2033',1,'pulsar::ClientConfiguration']]], + ['setmaxpendingchunkedmessage_55',['setMaxPendingChunkedMessage',['../classpulsar_1_1_consumer_configuration.html#a9d17c5b2ed6547ce9e37fad4438e6e83',1,'pulsar::ConsumerConfiguration']]], + ['setmaxpendingmessages_56',['setMaxPendingMessages',['../classpulsar_1_1_producer_configuration.html#aeb61ed9f97923fb9e65d4e750b145a2f',1,'pulsar::ProducerConfiguration']]], + ['setmaxpendingmessagesacrosspartitions_57',['setMaxPendingMessagesAcrossPartitions',['../classpulsar_1_1_producer_configuration.html#ac44a68df892d721fad29056f4d89e9c4',1,'pulsar::ProducerConfiguration']]], + ['setmaxtotalreceiverqueuesizeacrosspartitions_58',['setMaxTotalReceiverQueueSizeAcrossPartitions',['../classpulsar_1_1_consumer_configuration.html#a9c07888abe996b80c2fd168278a24de3',1,'pulsar::ConsumerConfiguration']]], + ['setmemorylimit_59',['setMemoryLimit',['../classpulsar_1_1_client_configuration.html#ace74b6344c19c7039087be76d86528f6',1,'pulsar::ClientConfiguration']]], + ['setmessageid_60',['setMessageId',['../classpulsar_1_1_message.html#a441a530a2943fc45133690bda73a113a',1,'pulsar::Message']]], + ['setmessagelistener_61',['setMessageListener',['../classpulsar_1_1_consumer_configuration.html#a996399917ff343715bf29afe07981c83',1,'pulsar::ConsumerConfiguration']]], + ['setmessagelistenerthreads_62',['setMessageListenerThreads',['../classpulsar_1_1_client_configuration.html#a5c0d6ddb5e00afe43067505bd46a6a9d',1,'pulsar::ClientConfiguration']]], + ['setmessagerouter_63',['setMessageRouter',['../classpulsar_1_1_producer_configuration.html#abf5a23a8d0eaebba237dca1bbf72a8f2',1,'pulsar::ProducerConfiguration']]], + ['setmetadata_64',['setMetadata',['../classpulsar_1_1_encryption_key_info.html#a7ae2f1225fb8897ebbcc74cc7753cfaf',1,'pulsar::EncryptionKeyInfo']]], + ['setnegativeackredeliverydelayms_65',['setNegativeAckRedeliveryDelayMs',['../classpulsar_1_1_consumer_configuration.html#aef99f71cd13324351864dd1e376d8788',1,'pulsar::ConsumerConfiguration']]], + ['setoperationtimeoutseconds_66',['setOperationTimeoutSeconds',['../classpulsar_1_1_client_configuration.html#ac5659a9c3232ab07ed1e81dd406187c1',1,'pulsar::ClientConfiguration']]], + ['setorderingkey_67',['setOrderingKey',['../classpulsar_1_1_message_builder.html#a58e630e1da0388f0a81e2e0474aa346d',1,'pulsar::MessageBuilder']]], + ['setpartitionkey_68',['setPartitionKey',['../classpulsar_1_1_message_builder.html#a1efcf691608abcbb3b915a16f5c99bff',1,'pulsar::MessageBuilder']]], + ['setpartitionsroutingmode_69',['setPartitionsRoutingMode',['../classpulsar_1_1_producer_configuration.html#a6842f9d4d16d50b3b993df67c043ad38',1,'pulsar::ProducerConfiguration']]], + ['setpartititionsupdateinterval_70',['setPartititionsUpdateInterval',['../classpulsar_1_1_client_configuration.html#a5879c3ecf00ee0d1d85a1eea3977f6ba',1,'pulsar::ClientConfiguration']]], + ['setpatternautodiscoveryperiod_71',['setPatternAutoDiscoveryPeriod',['../classpulsar_1_1_consumer_configuration.html#a5910aa7539a7fb217a38813d846a9acb',1,'pulsar::ConsumerConfiguration']]], + ['setprioritylevel_72',['setPriorityLevel',['../classpulsar_1_1_consumer_configuration.html#a09492153409160a4993796f88caadd23',1,'pulsar::ConsumerConfiguration']]], + ['setproducername_73',['setProducerName',['../classpulsar_1_1_producer_configuration.html#a8286421f85e5da6c71abe10e5f1ee7cd',1,'pulsar::ProducerConfiguration']]], + ['setproperties_74',['setproperties',['../classpulsar_1_1_consumer_configuration.html#a093486de4b32d91655d8b4e45efd6d6f',1,'pulsar::ConsumerConfiguration::setProperties()'],['../classpulsar_1_1_message_builder.html#a90ce43fad4ea63704569ff2a60d02599',1,'pulsar::MessageBuilder::setProperties()'],['../classpulsar_1_1_producer_configuration.html#a45afb46cc1d2083cc58927af5bea3c9d',1,'pulsar::ProducerConfiguration::setProperties()'],['../classpulsar_1_1_reader_configuration.html#a12a43dd43372fb0b173002597bfdb2e3',1,'pulsar::ReaderConfiguration::setProperties()']]], + ['setproperty_75',['setproperty',['../classpulsar_1_1_consumer_configuration.html#acb0cfc0ded14bd3c324466a41c9aaf9e',1,'pulsar::ConsumerConfiguration::setProperty()'],['../classpulsar_1_1_message_builder.html#ae59904777c9565d762e4d3230d090ab7',1,'pulsar::MessageBuilder::setProperty()'],['../classpulsar_1_1_producer_configuration.html#ab6ff6f83f46ac85e60ed1611350d1e79',1,'pulsar::ProducerConfiguration::setProperty()'],['../classpulsar_1_1_reader_configuration.html#a8fa193115478c84dfdef934fd50861fd',1,'pulsar::ReaderConfiguration::setProperty()']]], + ['setproxyprotocol_76',['setProxyProtocol',['../classpulsar_1_1_client_configuration.html#ace1db02ebfa21f89ee887d8f8df7c180',1,'pulsar::ClientConfiguration']]], + ['setproxyserviceurl_77',['setProxyServiceUrl',['../classpulsar_1_1_client_configuration.html#a9205dfdb1cb7c0ffe76f2fc2a31f50de',1,'pulsar::ClientConfiguration']]], + ['setreadcompacted_78',['setreadcompacted',['../classpulsar_1_1_consumer_configuration.html#ae3f12b9f76982d8ea64f80adfb8af960',1,'pulsar::ConsumerConfiguration::setReadCompacted()'],['../classpulsar_1_1_reader_configuration.html#aaf766afd6e75d0e1454d81d980f019b3',1,'pulsar::ReaderConfiguration::setReadCompacted(bool compacted)']]], + ['setreaderlistener_79',['setReaderListener',['../classpulsar_1_1_reader_configuration.html#abade75269a49ba228530847e2013303d',1,'pulsar::ReaderConfiguration']]], + ['setreadername_80',['setReaderName',['../classpulsar_1_1_reader_configuration.html#a8d42ba4bd17f9ac54a609d94f98780a2',1,'pulsar::ReaderConfiguration']]], + ['setreceiverqueuesize_81',['setreceiverqueuesize',['../classpulsar_1_1_consumer_configuration.html#a265d2cd1e9d1d329eff9b98346f245c2',1,'pulsar::ConsumerConfiguration::setReceiverQueueSize()'],['../classpulsar_1_1_reader_configuration.html#a0574cedc0bc7ccf457071df866830abe',1,'pulsar::ReaderConfiguration::setReceiverQueueSize()']]], + ['setrefreshtoken_82',['setRefreshToken',['../classpulsar_1_1_oauth2_token_result.html#a87d8e7e923d1ca96d5c0425cf80d5d42',1,'pulsar::Oauth2TokenResult']]], + ['setregexsubscriptionmode_83',['setRegexSubscriptionMode',['../classpulsar_1_1_consumer_configuration.html#a56726bee70b41cc2832fae59a38837a4',1,'pulsar::ConsumerConfiguration']]], + ['setreplicatesubscriptionstateenabled_84',['setReplicateSubscriptionStateEnabled',['../classpulsar_1_1_consumer_configuration.html#a70a15216ef41c8bd38178bdc5e377a31',1,'pulsar::ConsumerConfiguration']]], + ['setreplicationclusters_85',['setReplicationClusters',['../classpulsar_1_1_message_builder.html#acde04b110dbccdd7591fad9d4aa9f9c9',1,'pulsar::MessageBuilder']]], + ['setschema_86',['setschema',['../classpulsar_1_1_consumer_configuration.html#a79d9ef9f0698713b38f260b0b46d191f',1,'pulsar::ConsumerConfiguration::setSchema()'],['../classpulsar_1_1_producer_configuration.html#af161c34b3745581293e6df1e2f8115af',1,'pulsar::ProducerConfiguration::setSchema()'],['../classpulsar_1_1_reader_configuration.html#acbc3fa4579799b7857ca0daa938b0459',1,'pulsar::ReaderConfiguration::setSchema()']]], + ['setsendtimeout_87',['setSendTimeout',['../classpulsar_1_1_producer_configuration.html#a20cd4b67462cb786f097a74fde857cf5',1,'pulsar::ProducerConfiguration']]], + ['setsequenceid_88',['setSequenceId',['../classpulsar_1_1_message_builder.html#a94372cd317b679b7748149429655a0f3',1,'pulsar::MessageBuilder']]], + ['setstartmessageidinclusive_89',['setstartmessageidinclusive',['../classpulsar_1_1_consumer_configuration.html#af4085925dc8b62bec126cd3ea1e1085a',1,'pulsar::ConsumerConfiguration::setStartMessageIdInclusive()'],['../classpulsar_1_1_reader_configuration.html#ad34cc5c0bb490e5588653f7bbbf3cd2a',1,'pulsar::ReaderConfiguration::setStartMessageIdInclusive()']]], + ['setstatsintervalinseconds_90',['setStatsIntervalInSeconds',['../classpulsar_1_1_client_configuration.html#a0c7c63f49cd66554563c3f5e133c4fc6',1,'pulsar::ClientConfiguration']]], + ['setstickyranges_91',['setstickyranges',['../classpulsar_1_1_key_shared_policy.html#adc25d81437fa23ab5eec077c3600bc73',1,'pulsar::KeySharedPolicy::setStickyRanges(std::initializer_list< StickyRange > ranges)'],['../classpulsar_1_1_key_shared_policy.html#aa76f2ad0ea56748d2f7c52d5a269d6d9',1,'pulsar::KeySharedPolicy::setStickyRanges(const StickyRanges &ranges)']]], + ['setsubscriptioninitialposition_92',['setSubscriptionInitialPosition',['../classpulsar_1_1_consumer_configuration.html#ab0e049e62befb9b924307ba6f990cd97',1,'pulsar::ConsumerConfiguration']]], + ['setsubscriptionproperties_93',['setSubscriptionProperties',['../classpulsar_1_1_consumer_configuration.html#ae60097f3b91d2291dd121e3573f55855',1,'pulsar::ConsumerConfiguration']]], + ['setsubscriptionroleprefix_94',['setSubscriptionRolePrefix',['../classpulsar_1_1_reader_configuration.html#a281c0ae5579461f80677b43126329cd1',1,'pulsar::ReaderConfiguration']]], + ['settickdurationinms_95',['settickdurationinms',['../classpulsar_1_1_consumer_configuration.html#a8b86fc6d5d8ca8e5c5dd35aa8a1c52b4',1,'pulsar::ConsumerConfiguration::setTickDurationInMs()'],['../classpulsar_1_1_reader_configuration.html#a23df99b9e97709fcaa50e1766eb84e9b',1,'pulsar::ReaderConfiguration::setTickDurationInMs()']]], + ['settlsallowinsecureconnection_96',['setTlsAllowInsecureConnection',['../classpulsar_1_1_client_configuration.html#a9c6de9ae9ffe25f93e45d52af33786c7',1,'pulsar::ClientConfiguration']]], + ['settlscertificatefilepath_97',['setTlsCertificateFilePath',['../classpulsar_1_1_client_configuration.html#a9040f07538e832ea521cf37b1d00b5be',1,'pulsar::ClientConfiguration']]], + ['settlsprivatekeyfilepath_98',['setTlsPrivateKeyFilePath',['../classpulsar_1_1_client_configuration.html#a9a3462c57a542998b6324ba4144790c0',1,'pulsar::ClientConfiguration']]], + ['settlstrustcertsfilepath_99',['setTlsTrustCertsFilePath',['../classpulsar_1_1_client_configuration.html#a65e807a8eb8d68b27ba464c3c026d5da',1,'pulsar::ClientConfiguration']]], + ['settopicname_100',['setTopicName',['../classpulsar_1_1_message_id.html#a3d84665dab3feb64ed00183a322b92f2',1,'pulsar::MessageId']]], + ['setunackedmessagestimeoutms_101',['setunackedmessagestimeoutms',['../classpulsar_1_1_consumer_configuration.html#ad55a4f0187517c984de8d01f8660fb8f',1,'pulsar::ConsumerConfiguration::setUnAckedMessagesTimeoutMs()'],['../classpulsar_1_1_reader_configuration.html#a11da218b52a8936415029509b9c707e9',1,'pulsar::ReaderConfiguration::setUnAckedMessagesTimeoutMs()']]], + ['setusetls_102',['setUseTls',['../classpulsar_1_1_client_configuration.html#ad2cd7f96ed00b4a398329cee24aa293c',1,'pulsar::ClientConfiguration']]], + ['setvalidatehostname_103',['setValidateHostName',['../classpulsar_1_1_client_configuration.html#a10233b86c33c352f79eb0dabf954809b',1,'pulsar::ClientConfiguration']]], + ['shutdown_104',['shutdown',['../classpulsar_1_1_client.html#aecac8bf91b474339455fe0519f6ba71e',1,'pulsar::Client']]], + ['size_105',['size',['../classpulsar_1_1_table_view.html#afdb10373c073e4b0722606a0f9b4174e',1,'pulsar::TableView']]], + ['snapshot_106',['snapshot',['../classpulsar_1_1_table_view.html#a5169558ea5a27b29dd5bcf040fa97543',1,'pulsar::TableView']]], + ['subscribe_107',['subscribe',['../classpulsar_1_1_client.html#a9f32b4d1101f8f2fb5029013c87779ab',1,'pulsar::Client::subscribe(const std::string &topic, const std::string &subscriptionName, Consumer &consumer)'],['../classpulsar_1_1_client.html#a11b3ca7d9174a0912bf51b742f7f825a',1,'pulsar::Client::subscribe(const std::string &topic, const std::string &subscriptionName, const ConsumerConfiguration &conf, Consumer &consumer)'],['../classpulsar_1_1_client.html#aea2d7918286ecd127751d06e191a5471',1,'pulsar::Client::subscribe(const std::vector< std::string > &topics, const std::string &subscriptionName, Consumer &consumer)'],['../classpulsar_1_1_client.html#a9188d5fafbb23da16f859592316947e4',1,'pulsar::Client::subscribe(const std::vector< std::string > &topics, const std::string &subscriptionName, const ConsumerConfiguration &conf, Consumer &consumer)']]], + ['subscribeasync_108',['subscribeasync',['../classpulsar_1_1_client.html#a534d1cc013112c4e9eeee037b42b4815',1,'pulsar::Client::subscribeAsync(const std::string &topic, const std::string &subscriptionName, SubscribeCallback callback)'],['../classpulsar_1_1_client.html#a85d82595856f515b22acb623e84daa4b',1,'pulsar::Client::subscribeAsync(const std::string &topic, const std::string &subscriptionName, const ConsumerConfiguration &conf, SubscribeCallback callback)'],['../classpulsar_1_1_client.html#a33f76797dfbd57daf4c72f96c659fe77',1,'pulsar::Client::subscribeAsync(const std::vector< std::string > &topics, const std::string &subscriptionName, SubscribeCallback callback)'],['../classpulsar_1_1_client.html#afcfcc1f9bcc63527063ae1b60a41ba8e',1,'pulsar::Client::subscribeAsync(const std::vector< std::string > &topics, const std::string &subscriptionName, const ConsumerConfiguration &conf, SubscribeCallback callback)']]], + ['subscribewithregex_109',['subscribewithregex',['../classpulsar_1_1_client.html#a086549ca0d057be1e9d00ca483995621',1,'pulsar::Client::subscribeWithRegex(const std::string &regexPattern, const std::string &subscriptionName, Consumer &consumer)'],['../classpulsar_1_1_client.html#a11016481c032f7d07e3ab5be341c9344',1,'pulsar::Client::subscribeWithRegex(const std::string &regexPattern, const std::string &subscriptionName, const ConsumerConfiguration &conf, Consumer &consumer)']]], + ['subscribewithregexasync_110',['subscribewithregexasync',['../classpulsar_1_1_client.html#a49a6024ae4ff44e1e02a59bc08d28c7a',1,'pulsar::Client::subscribeWithRegexAsync(const std::string &regexPattern, const std::string &subscriptionName, SubscribeCallback callback)'],['../classpulsar_1_1_client.html#abef60cadedd17903a245dbaa8368381a',1,'pulsar::Client::subscribeWithRegexAsync(const std::string &regexPattern, const std::string &subscriptionName, const ConsumerConfiguration &conf, SubscribeCallback callback)']]] +]; diff --git a/static/api/cpp/3.5.x/search/functions_11.js b/static/api/cpp/3.5.x/search/functions_11.js new file mode 100644 index 000000000000..4e9c78e18adc --- /dev/null +++ b/static/api/cpp/3.5.x/search/functions_11.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['tableview_0',['TableView',['../classpulsar_1_1_table_view.html#ae43275f26ff0ec494a75c11210ec6139',1,'pulsar::TableView']]] +]; diff --git a/static/api/cpp/3.5.x/search/functions_12.js b/static/api/cpp/3.5.x/search/functions_12.js new file mode 100644 index 000000000000..ec37f23ddfe8 --- /dev/null +++ b/static/api/cpp/3.5.x/search/functions_12.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['unsubscribe_0',['unsubscribe',['../classpulsar_1_1_consumer.html#a542ca0a9473a03ccf8bd8aeed24de490',1,'pulsar::Consumer']]], + ['unsubscribeasync_1',['unsubscribeAsync',['../classpulsar_1_1_consumer.html#a8691920cae838418f33f13690a72771d',1,'pulsar::Consumer']]] +]; diff --git a/static/api/cpp/3.5.x/search/functions_2.js b/static/api/cpp/3.5.x/search/functions_2.js new file mode 100644 index 000000000000..31e1ab4b76bd --- /dev/null +++ b/static/api/cpp/3.5.x/search/functions_2.js @@ -0,0 +1,18 @@ +var searchData= +[ + ['client_0',['client',['../classpulsar_1_1_client.html#acab90af5d0542803bc1d10e68d27414f',1,'pulsar::Client::Client(const std::string &serviceUrl)'],['../classpulsar_1_1_client.html#a148122b14f22844d359c35c084907962',1,'pulsar::Client::Client(const std::string &serviceUrl, const ClientConfiguration &clientConfiguration)']]], + ['clone_1',['clone',['../classpulsar_1_1_consumer_configuration.html#ae5d5850e9e0f3130424860e6715b0fa0',1,'pulsar::ConsumerConfiguration::clone()'],['../classpulsar_1_1_key_shared_policy.html#a421a7227c39ba3c199ec86c40b6b5c75',1,'pulsar::KeySharedPolicy::clone()']]], + ['close_2',['close',['../classpulsar_1_1_oauth2_flow.html#ae4815e1adf8cced8553f9e3d6d6717a8',1,'pulsar::Oauth2Flow::close()'],['../classpulsar_1_1_client.html#ac3f0a65b099f88781548d4fad41685ac',1,'pulsar::Client::close()'],['../classpulsar_1_1_consumer.html#a8b01803221c283e4df21715aeb024b84',1,'pulsar::Consumer::close()'],['../classpulsar_1_1_consumer_interceptor.html#abe9d12923a7f6b3bc56c9596a4bac7bc',1,'pulsar::ConsumerInterceptor::close()'],['../classpulsar_1_1_producer.html#a0b4a93617a0c0f8d172633a7bf8ba06b',1,'pulsar::Producer::close()'],['../classpulsar_1_1_producer_interceptor.html#a59d5f25b142cd69ebbca13f22842120b',1,'pulsar::ProducerInterceptor::close()'],['../classpulsar_1_1_reader.html#ab15cfd0e35d625d2f1af5936c314b623',1,'pulsar::Reader::close()'],['../classpulsar_1_1_table_view.html#a5f913f66c65c819a0b151daf08d43440',1,'pulsar::TableView::close()']]], + ['closeasync_3',['closeasync',['../classpulsar_1_1_client.html#ad2701d78fca53d5261616ca53381241d',1,'pulsar::Client::closeAsync()'],['../classpulsar_1_1_consumer.html#a1b4539f46eb42170a550d6cd9076d8d7',1,'pulsar::Consumer::closeAsync()'],['../classpulsar_1_1_producer.html#a40f5268e6754c9e61e2406d432cffe2f',1,'pulsar::Producer::closeAsync()'],['../classpulsar_1_1_reader.html#a203d50fd687e2c77e4f7e7bb0b14bab7',1,'pulsar::Reader::closeAsync()'],['../classpulsar_1_1_table_view.html#a828d9b3efa7ba6b6a18e97e669e3945e',1,'pulsar::TableView::closeAsync()']]], + ['consumer_4',['Consumer',['../classpulsar_1_1_consumer.html#afe59503d5d5309f38d4e246bd9f435b4',1,'pulsar::Consumer']]], + ['containskey_5',['containsKey',['../classpulsar_1_1_table_view.html#a212c8a8897249b47c1cd6f44e04d452b',1,'pulsar::TableView']]], + ['create_6',['create',['../classpulsar_1_1_auth_factory.html#a551395eda623d3454c758c3479423ce3',1,'pulsar::AuthFactory::create(const std::string &pluginNameOrDynamicLibPath)'],['../classpulsar_1_1_auth_factory.html#af84e99a6be262145d928e599946ab82d',1,'pulsar::AuthFactory::create(const std::string &pluginNameOrDynamicLibPath, const std::string &authParamsString)'],['../classpulsar_1_1_auth_factory.html#a644b858e4a59482ecce5d1782bd4b452',1,'pulsar::AuthFactory::create(const std::string &pluginNameOrDynamicLibPath, ParamMap &params)'],['../classpulsar_1_1_auth_tls.html#a3a2603a8be94cdde4845c941dc8871cc',1,'pulsar::AuthTls::create(ParamMap &params)'],['../classpulsar_1_1_auth_tls.html#a19312c7b58d94aa05927ee33922731de',1,'pulsar::AuthTls::create(const std::string &authParamsString)'],['../classpulsar_1_1_auth_tls.html#ac32274cb7d7095cfcd35fcebcf277d5b',1,'pulsar::AuthTls::create(const std::string &certificatePath, const std::string &privateKeyPath)'],['../classpulsar_1_1_auth_token.html#aa4d3740c838620765a7332bf2247b5e9',1,'pulsar::AuthToken::create(ParamMap &params)'],['../classpulsar_1_1_auth_token.html#a9601a01bd5b7b644531d82fc3cfa7d09',1,'pulsar::AuthToken::create(const std::string &authParamsString)'],['../classpulsar_1_1_auth_token.html#ae9b2da50ad0c22335b298d939239602c',1,'pulsar::AuthToken::create(const TokenSupplier &tokenSupplier)'],['../classpulsar_1_1_auth_basic.html#aee17b2ca84965dfe8b3d9296dd397400',1,'pulsar::AuthBasic::create(ParamMap &params)'],['../classpulsar_1_1_auth_basic.html#ac9f7f369e4559f0aa108708355dcaaec',1,'pulsar::AuthBasic::create(const std::string &authParamsString)'],['../classpulsar_1_1_auth_basic.html#a86ce78ef0606d5642f110dc4ec8c6f67',1,'pulsar::AuthBasic::create(const std::string &username, const std::string &password)'],['../classpulsar_1_1_auth_basic.html#ac85c75b0d48375423cbb5c1421529c46',1,'pulsar::AuthBasic::create(const std::string &username, const std::string &password, const std::string &method)'],['../classpulsar_1_1_auth_athenz.html#acde69fc41668a27d12d558023aaed0d9',1,'pulsar::AuthAthenz::create(ParamMap &params)'],['../classpulsar_1_1_auth_athenz.html#afd40a525e1d8d61fc97880c2c8a958fe',1,'pulsar::AuthAthenz::create(const std::string &authParamsString)'],['../classpulsar_1_1_auth_oauth2.html#a7bb0d842b22b59036587b22da2447377',1,'pulsar::AuthOauth2::create(ParamMap &params)'],['../classpulsar_1_1_auth_oauth2.html#aca6ec2237b43187d8001a5b79a2f11e4',1,'pulsar::AuthOauth2::create(const std::string &authParamsString)'],['../classpulsar_1_1_message_builder.html#aae903d24a17c2bcd1c5c34742953618d',1,'pulsar::MessageBuilder::create()']]], + ['createproducer_7',['createproducer',['../classpulsar_1_1_client.html#a96f49cc0ce27bfe68d75224991f0ba52',1,'pulsar::Client::createProducer(const std::string &topic, Producer &producer)'],['../classpulsar_1_1_client.html#aae7658dee80ad23b418cfb7e12f5df05',1,'pulsar::Client::createProducer(const std::string &topic, const ProducerConfiguration &conf, Producer &producer)']]], + ['createproducerasync_8',['createproducerasync',['../classpulsar_1_1_client.html#a666be9ce0980aeda2921c2229c003db8',1,'pulsar::Client::createProducerAsync(const std::string &topic, CreateProducerCallback callback)'],['../classpulsar_1_1_client.html#a46e87bd20edc2a00c492e2be2c43a644',1,'pulsar::Client::createProducerAsync(const std::string &topic, ProducerConfiguration conf, CreateProducerCallback callback)']]], + ['createprotobufnativeschema_9',['createProtobufNativeSchema',['../namespacepulsar.html#a7dc480604aefdd4119b2e2ee2b9e7764',1,'pulsar']]], + ['createreader_10',['createReader',['../classpulsar_1_1_client.html#ad2f6404e06200714e1fe82419b7c963a',1,'pulsar::Client']]], + ['createreaderasync_11',['createReaderAsync',['../classpulsar_1_1_client.html#ab837056e2ea59c8c55d83d6451ee7b08',1,'pulsar::Client']]], + ['createtableview_12',['createTableView',['../classpulsar_1_1_client.html#aafa5591b8fc3241e50c2b1f2e3bafe24',1,'pulsar::Client']]], + ['createtableviewasync_13',['createTableViewAsync',['../classpulsar_1_1_client.html#addf53e700657aeaf0bcaa8c5ddd89e84',1,'pulsar::Client']]], + ['createwithtoken_14',['createWithToken',['../classpulsar_1_1_auth_token.html#a80911f1374df425fdb76f066dfe7ebd9',1,'pulsar::AuthToken']]] +]; diff --git a/static/api/cpp/3.5.x/search/functions_3.js b/static/api/cpp/3.5.x/search/functions_3.js new file mode 100644 index 000000000000..68d7564197e6 --- /dev/null +++ b/static/api/cpp/3.5.x/search/functions_3.js @@ -0,0 +1,7 @@ +var searchData= +[ + ['deadlettertopic_0',['deadLetterTopic',['../classpulsar_1_1_dead_letter_policy_builder.html#a60326f125a4d44099a6eab0d5a64aa22',1,'pulsar::DeadLetterPolicyBuilder']]], + ['defaultcryptokeyreader_1',['DefaultCryptoKeyReader',['../classpulsar_1_1_default_crypto_key_reader.html#ae4b1b1f371da031b371e318aa883d5a0',1,'pulsar::DefaultCryptoKeyReader']]], + ['deserialize_2',['deserialize',['../classpulsar_1_1_message_id.html#a3768dd552867827d694077ab6d7a55c8',1,'pulsar::MessageId']]], + ['disablereplication_3',['disableReplication',['../classpulsar_1_1_message_builder.html#afa199d60f52954c93c07ad6eafebe7dd',1,'pulsar::MessageBuilder']]] +]; diff --git a/static/api/cpp/3.5.x/search/functions_4.js b/static/api/cpp/3.5.x/search/functions_4.js new file mode 100644 index 000000000000..59ec39c0cc17 --- /dev/null +++ b/static/api/cpp/3.5.x/search/functions_4.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['earliest_0',['earliest',['../classpulsar_1_1_message_id.html#a3b0079713b68d0a9d03c269dc2ba2fff',1,'pulsar::MessageId']]], + ['encryptionkeyinfo_1',['EncryptionKeyInfo',['../classpulsar_1_1_encryption_key_info.html#ab5a636493c0a9dc6c4e8ddbf1d0524d9',1,'pulsar::EncryptionKeyInfo']]], + ['entryid_2',['entryId',['../classpulsar_1_1_message_id_builder.html#ae891d015703255a676ee39fd738df615',1,'pulsar::MessageIdBuilder']]] +]; diff --git a/static/api/cpp/3.5.x/search/functions_5.js b/static/api/cpp/3.5.x/search/functions_5.js new file mode 100644 index 000000000000..25e96cba3e77 --- /dev/null +++ b/static/api/cpp/3.5.x/search/functions_5.js @@ -0,0 +1,9 @@ +var searchData= +[ + ['fileloggerfactory_0',['FileLoggerFactory',['../classpulsar_1_1_file_logger_factory.html#a295a3b87a6a73a67bb8f805b3a4769b5',1,'pulsar::FileLoggerFactory']]], + ['flush_1',['flush',['../classpulsar_1_1_producer.html#a1cd59ffc4a23162eca39183ba4278146',1,'pulsar::Producer']]], + ['flushasync_2',['flushAsync',['../classpulsar_1_1_producer.html#a3173d56da00ea2225f03e152c8c3df22',1,'pulsar::Producer']]], + ['foreach_3',['forEach',['../classpulsar_1_1_table_view.html#aba35c4ed47372e0d23973c8619ac90a1',1,'pulsar::TableView']]], + ['foreachandlisten_4',['forEachAndListen',['../classpulsar_1_1_table_view.html#a9ea567d48f8df3cdec48d7891d66f6dd',1,'pulsar::TableView']]], + ['from_5',['from',['../classpulsar_1_1_message_id_builder.html#adf978433aad184f7bcb11bfbf86f91ee',1,'pulsar::MessageIdBuilder::from(const MessageId &messageId)'],['../classpulsar_1_1_message_id_builder.html#a46bff6912be430a70ff6d236fdef5d4c',1,'pulsar::MessageIdBuilder::from(const proto::MessageIdData &messageIdData)']]] +]; diff --git a/static/api/cpp/3.5.x/search/functions_6.js b/static/api/cpp/3.5.x/search/functions_6.js new file mode 100644 index 000000000000..87d06f64e068 --- /dev/null +++ b/static/api/cpp/3.5.x/search/functions_6.js @@ -0,0 +1,137 @@ +var searchData= +[ + ['getaccessmode_0',['getAccessMode',['../classpulsar_1_1_producer_configuration.html#a4bb0a493242b1701c8574eee4fa694e5',1,'pulsar::ProducerConfiguration']]], + ['getaccesstoken_1',['getAccessToken',['../classpulsar_1_1_oauth2_token_result.html#a41359aec5371cbcea46cad38e02e28b4',1,'pulsar::Oauth2TokenResult']]], + ['getackgroupingmaxsize_2',['getackgroupingmaxsize',['../classpulsar_1_1_consumer_configuration.html#a5eeb586f29508eca6d1cd602a8da7a06',1,'pulsar::ConsumerConfiguration::getAckGroupingMaxSize()'],['../classpulsar_1_1_reader_configuration.html#af6cfd1444b643e174269b42c961eaa3a',1,'pulsar::ReaderConfiguration::getAckGroupingMaxSize()']]], + ['getackgroupingtimems_3',['getackgroupingtimems',['../classpulsar_1_1_consumer_configuration.html#abc531b79e46a4c2fc70cec8ca573d194',1,'pulsar::ConsumerConfiguration::getAckGroupingTimeMs()'],['../classpulsar_1_1_reader_configuration.html#ad99affc2c9331c5a2116ce5a07147b3d',1,'pulsar::ReaderConfiguration::getAckGroupingTimeMs()']]], + ['getaddress_4',['getAddress',['../classpulsar_1_1_broker_consumer_stats.html#a6b5567d414e4f82f59b97feb2e353d35',1,'pulsar::BrokerConsumerStats']]], + ['getauth_5',['getAuth',['../classpulsar_1_1_client_configuration.html#a2973aed4fed3479aeceef9e97d26ef63',1,'pulsar::ClientConfiguration']]], + ['getauthdata_6',['getauthdata',['../classpulsar_1_1_authentication.html#a14811c36fc300cfa7769f7ee96018688',1,'pulsar::Authentication::getAuthData()'],['../classpulsar_1_1_auth_tls.html#ae88d06f62a47e92e7c52e74df3cacb56',1,'pulsar::AuthTls::getAuthData()'],['../classpulsar_1_1_auth_token.html#a212a8af7680f196e4fba4e0152e6d0a5',1,'pulsar::AuthToken::getAuthData()'],['../classpulsar_1_1_auth_basic.html#a7b1ccda07ff0a22a705159e27149f3d4',1,'pulsar::AuthBasic::getAuthData()'],['../classpulsar_1_1_auth_athenz.html#a274c9e677c536166fd1d4f8af6161546',1,'pulsar::AuthAthenz::getAuthData()'],['../classpulsar_1_1_cached_token.html#a6e249f44ae21288c7365d1baece3da5d',1,'pulsar::CachedToken::getAuthData()'],['../classpulsar_1_1_auth_oauth2.html#adcf1f8cac446270ee6aa0a0ad156842e',1,'pulsar::AuthOauth2::getAuthData()']]], + ['getauthmethodname_7',['getauthmethodname',['../classpulsar_1_1_authentication.html#aafe5c68d220ae0926a2c66953eafed57',1,'pulsar::Authentication::getAuthMethodName()'],['../classpulsar_1_1_auth_tls.html#a2c87f86950aa979f666896e7a5f79398',1,'pulsar::AuthTls::getAuthMethodName()'],['../classpulsar_1_1_auth_token.html#a0d1bf202c18b9131be315b166b4b1caa',1,'pulsar::AuthToken::getAuthMethodName()'],['../classpulsar_1_1_auth_basic.html#ad9d2d1d47a1f1d82fee3522ea5991c3b',1,'pulsar::AuthBasic::getAuthMethodName()'],['../classpulsar_1_1_auth_athenz.html#a65405a1cfd2ec3efcaeea3ed8269fa47',1,'pulsar::AuthAthenz::getAuthMethodName()'],['../classpulsar_1_1_auth_oauth2.html#ac71578130863f59cb02fe1aefa9d70f6',1,'pulsar::AuthOauth2::getAuthMethodName()']]], + ['getavailablepermits_8',['getAvailablePermits',['../classpulsar_1_1_broker_consumer_stats.html#a124a4228983be259fdcfa511814a3920',1,'pulsar::BrokerConsumerStats']]], + ['getbatchingenabled_9',['getBatchingEnabled',['../classpulsar_1_1_producer_configuration.html#ae41daa9000a2df15120e3c42591d63af',1,'pulsar::ProducerConfiguration']]], + ['getbatchingmaxallowedsizeinbytes_10',['getBatchingMaxAllowedSizeInBytes',['../classpulsar_1_1_producer_configuration.html#a7d650931b85e0ee4f6080ca051a3cb28',1,'pulsar::ProducerConfiguration']]], + ['getbatchingmaxmessages_11',['getBatchingMaxMessages',['../classpulsar_1_1_producer_configuration.html#a2debe3bfacf732b7ad40b0b366223f75',1,'pulsar::ProducerConfiguration']]], + ['getbatchingmaxpublishdelayms_12',['getBatchingMaxPublishDelayMs',['../classpulsar_1_1_producer_configuration.html#ad4e8e1802ddc34d4b600bc0fb9cfe2e6',1,'pulsar::ProducerConfiguration']]], + ['getbatchingtype_13',['getBatchingType',['../classpulsar_1_1_producer_configuration.html#a9d92842c76fa71736ee9aec424ff2496',1,'pulsar::ProducerConfiguration']]], + ['getbatchreceivepolicy_14',['getBatchReceivePolicy',['../classpulsar_1_1_consumer_configuration.html#a95a0726c17b428ffa58824171758a6ac',1,'pulsar::ConsumerConfiguration']]], + ['getblockifqueuefull_15',['getBlockIfQueueFull',['../classpulsar_1_1_producer_configuration.html#a41b834ead0a7335a406f0c6b8a4a8815',1,'pulsar::ProducerConfiguration']]], + ['getbrokerconsumerstats_16',['getBrokerConsumerStats',['../classpulsar_1_1_consumer.html#a617639e11e05ecba3d013d831578d19d',1,'pulsar::Consumer']]], + ['getbrokerconsumerstatsasync_17',['getBrokerConsumerStatsAsync',['../classpulsar_1_1_consumer.html#a01e55f7906b6922fa069d84f5459af4b',1,'pulsar::Consumer']]], + ['getbrokerconsumerstatscachetimeinms_18',['getBrokerConsumerStatsCacheTimeInMs',['../classpulsar_1_1_consumer_configuration.html#a23fd67606f5ca05a158226cbd0a2eb54',1,'pulsar::ConsumerConfiguration']]], + ['getcommanddata_19',['getCommandData',['../classpulsar_1_1_authentication_data_provider.html#a1ea19f94ab4b5479022a1df0f566668d',1,'pulsar::AuthenticationDataProvider']]], + ['getcompressiontype_20',['getCompressionType',['../classpulsar_1_1_producer_configuration.html#a61ff42e487a29d8b3a180e23add0135d',1,'pulsar::ProducerConfiguration']]], + ['getconcurrentlookuprequest_21',['getConcurrentLookupRequest',['../classpulsar_1_1_client_configuration.html#aacc5ce498af5ab4535ba3d5a39684b60',1,'pulsar::ClientConfiguration']]], + ['getconnectedsince_22',['getConnectedSince',['../classpulsar_1_1_broker_consumer_stats.html#a9b0459d295199b294c02f16bd388de04',1,'pulsar::BrokerConsumerStats']]], + ['getconnectionsperbroker_23',['getConnectionsPerBroker',['../classpulsar_1_1_client_configuration.html#a0405e2db9228972cfbc972b3f550d8ad',1,'pulsar::ClientConfiguration']]], + ['getconnectiontimeout_24',['getConnectionTimeout',['../classpulsar_1_1_client_configuration.html#abcf01cb88d07e83c1b43abe14854dac2',1,'pulsar::ClientConfiguration']]], + ['getconsumereventlistener_25',['getConsumerEventListener',['../classpulsar_1_1_consumer_configuration.html#ad58be2c7d04522d70a4d4cd447b639b3',1,'pulsar::ConsumerConfiguration']]], + ['getconsumername_26',['getconsumername',['../classpulsar_1_1_broker_consumer_stats.html#a2c473d54fdb38abf2c19d655427185f4',1,'pulsar::BrokerConsumerStats::getConsumerName()'],['../classpulsar_1_1_consumer.html#a83f58a6118a693398c16e70cecac0303',1,'pulsar::Consumer::getConsumerName()'],['../classpulsar_1_1_consumer_configuration.html#af3941af5ed7e7f4ab7b5f5a8737eaee9',1,'pulsar::ConsumerConfiguration::getConsumerName() const']]], + ['getconsumertype_27',['getConsumerType',['../classpulsar_1_1_consumer_configuration.html#a1a7a0dd0f141ae5816c117727f1c201d',1,'pulsar::ConsumerConfiguration']]], + ['getcryptofailureaction_28',['getcryptofailureaction',['../classpulsar_1_1_consumer_configuration.html#a339e3d80453eb963d5d1a64c5660e556',1,'pulsar::ConsumerConfiguration::getCryptoFailureAction()'],['../classpulsar_1_1_producer_configuration.html#a853090927fd2a1eee2ca588a4def3c59',1,'pulsar::ProducerConfiguration::getCryptoFailureAction()'],['../classpulsar_1_1_reader_configuration.html#aed1711ef9d9fed0a14f80451956cabe8',1,'pulsar::ReaderConfiguration::getCryptoFailureAction()']]], + ['getcryptokeyreader_29',['getcryptokeyreader',['../classpulsar_1_1_consumer_configuration.html#a70089f562cb67d8743165540235b2ec7',1,'pulsar::ConsumerConfiguration::getCryptoKeyReader()'],['../classpulsar_1_1_producer_configuration.html#a451838bdf98e10da3fb6183274f4b3e5',1,'pulsar::ProducerConfiguration::getCryptoKeyReader()'],['../classpulsar_1_1_reader_configuration.html#ae14fe911357bd22d2e1eecb5184a95ef',1,'pulsar::ReaderConfiguration::getCryptoKeyReader()']]], + ['getdata_30',['getData',['../classpulsar_1_1_message.html#ab485e3ff7dbefa8c0523ebaabef55d5d',1,'pulsar::Message']]], + ['getdataasstring_31',['getDataAsString',['../classpulsar_1_1_message.html#a45863405a4d3804cc8415d22d502f5c5',1,'pulsar::Message']]], + ['getdeadletterpolicy_32',['getDeadLetterPolicy',['../classpulsar_1_1_consumer_configuration.html#a123b495132d47e17f0cd82f9163eb8c8',1,'pulsar::ConsumerConfiguration']]], + ['getdeadlettertopic_33',['getDeadLetterTopic',['../classpulsar_1_1_dead_letter_policy.html#aff7c4ae5d89b501a238b3a3c1adbd073',1,'pulsar::DeadLetterPolicy']]], + ['getencryptionkeys_34',['getEncryptionKeys',['../classpulsar_1_1_producer_configuration.html#a5b02a79fabba85be433ab7a9bdb02138',1,'pulsar::ProducerConfiguration']]], + ['geteventtimestamp_35',['getEventTimestamp',['../classpulsar_1_1_message.html#a952c044fb615b886070bcda08f7ba9f6',1,'pulsar::Message']]], + ['getexpiresin_36',['getExpiresIn',['../classpulsar_1_1_oauth2_token_result.html#a3fe9ca08aada6022f2977051420eea77',1,'pulsar::Oauth2TokenResult']]], + ['getexpiretimeofincompletechunkedmessagems_37',['getExpireTimeOfIncompleteChunkedMessageMs',['../classpulsar_1_1_consumer_configuration.html#a5caba4e5a875b67c4cf4c794461e4e8d',1,'pulsar::ConsumerConfiguration']]], + ['gethashingscheme_38',['getHashingScheme',['../classpulsar_1_1_producer_configuration.html#abbfd8d17f8fff203536fd7d84c45bd6e',1,'pulsar::ProducerConfiguration']]], + ['gethttpauthtype_39',['getHttpAuthType',['../classpulsar_1_1_authentication_data_provider.html#ab201bbb1a90f3d4ca580bec9021d9d53',1,'pulsar::AuthenticationDataProvider']]], + ['gethttpheaders_40',['getHttpHeaders',['../classpulsar_1_1_authentication_data_provider.html#a90657a3943e3baed5dc5d469e8c64d2a',1,'pulsar::AuthenticationDataProvider']]], + ['getidtoken_41',['getIdToken',['../classpulsar_1_1_oauth2_token_result.html#ad04cbc8f2c1980d7603b13bdac2359e7',1,'pulsar::Oauth2TokenResult']]], + ['getimpl_42',['getImpl',['../classpulsar_1_1_broker_consumer_stats.html#a327a6687c6d5386a54e1a9ac4e027e9e',1,'pulsar::BrokerConsumerStats']]], + ['getindex_43',['getIndex',['../classpulsar_1_1_message.html#a7412304904208c662b346d6328b14261',1,'pulsar::Message']]], + ['getinitialbackoffintervalms_44',['getInitialBackoffIntervalMs',['../classpulsar_1_1_client_configuration.html#a0de6e5a822b7a3c6ab3f66f607e6891d',1,'pulsar::ClientConfiguration']]], + ['getinitialsequenceid_45',['getInitialSequenceId',['../classpulsar_1_1_producer_configuration.html#aad360d7e638bc78e2ed0e9be439d381e',1,'pulsar::ProducerConfiguration']]], + ['getinitialsubscriptionname_46',['getInitialSubscriptionName',['../classpulsar_1_1_dead_letter_policy.html#a889b65c5ac7a57ebfcc347c87f5e8555',1,'pulsar::DeadLetterPolicy']]], + ['getinternalsubscriptionname_47',['getInternalSubscriptionName',['../classpulsar_1_1_reader_configuration.html#a9cbcd290feb9368452ae1536360819f6',1,'pulsar::ReaderConfiguration']]], + ['getiothreads_48',['getIOThreads',['../classpulsar_1_1_client_configuration.html#a961eff6439a7aab387dca6a486f8535b',1,'pulsar::ClientConfiguration']]], + ['getkey_49',['getkey',['../classpulsar_1_1_encryption_key_info.html#a39565fd1977a4051305c7dde26549041',1,'pulsar::EncryptionKeyInfo::getKey()'],['../classpulsar_1_1_key_value.html#a47a193a9bb59fba4b30691a695861272',1,'pulsar::KeyValue::getKey()']]], + ['getkeysharedmode_50',['getKeySharedMode',['../classpulsar_1_1_key_shared_policy.html#a49efb8082529c20caf4eb1e825a0edb2',1,'pulsar::KeySharedPolicy']]], + ['getkeysharedpolicy_51',['getKeySharedPolicy',['../classpulsar_1_1_consumer_configuration.html#ad8febc1509d73daaaa061b5c53f7735b',1,'pulsar::ConsumerConfiguration']]], + ['getkeyvaluedata_52',['getKeyValueData',['../classpulsar_1_1_message.html#a2d282f106addab953cf7b831ffb3f067',1,'pulsar::Message']]], + ['getlastmessageid_53',['getlastmessageid',['../classpulsar_1_1_consumer.html#af60a7e87b76e5c69ee0e14f6ec902908',1,'pulsar::Consumer::getLastMessageId()'],['../classpulsar_1_1_reader.html#a80a0a4dbbe3cf8a9fb074c7556715823',1,'pulsar::Reader::getLastMessageId()']]], + ['getlastmessageidasync_54',['getlastmessageidasync',['../classpulsar_1_1_consumer.html#afbd9e4f5b33b5b10a32866d3485cbeb5',1,'pulsar::Consumer::getLastMessageIdAsync()'],['../classpulsar_1_1_reader.html#a1f863d880dc85400e7e50fcd831d7f5e',1,'pulsar::Reader::getLastMessageIdAsync()']]], + ['getlastsequenceid_55',['getLastSequenceId',['../classpulsar_1_1_producer.html#a99c6c342f700842a065178730c487d5a',1,'pulsar::Producer']]], + ['getlazystartpartitionedproducers_56',['getLazyStartPartitionedProducers',['../classpulsar_1_1_producer_configuration.html#ad1699c4a4b7d8f1b7a2680a2bb6535d4',1,'pulsar::ProducerConfiguration']]], + ['getlength_57',['getLength',['../classpulsar_1_1_message.html#aa47d8ca71292939d4d15e4b543835234',1,'pulsar::Message']]], + ['getlistenername_58',['getListenerName',['../classpulsar_1_1_client_configuration.html#a290b94553eca37e1dddfc2fd48a0b704',1,'pulsar::ClientConfiguration']]], + ['getlogger_59',['getlogger',['../classpulsar_1_1_console_logger_factory.html#a4592e252660038c303b4e71a44da9275',1,'pulsar::ConsoleLoggerFactory::getLogger()'],['../classpulsar_1_1_file_logger_factory.html#a196cbae406d25a82ea6112578ef42126',1,'pulsar::FileLoggerFactory::getLogger()'],['../classpulsar_1_1_logger_factory.html#ae2b97aec20f730fe5e77f24ed048380f',1,'pulsar::LoggerFactory::getLogger()']]], + ['getlongschemaversion_60',['getLongSchemaVersion',['../classpulsar_1_1_message.html#a4a4d35b3098d18b04f998764d3c2ce76',1,'pulsar::Message']]], + ['getmaxbackoffintervalms_61',['getMaxBackoffIntervalMs',['../classpulsar_1_1_client_configuration.html#a7505a6277e8af2ee81468bdc349283ee',1,'pulsar::ClientConfiguration']]], + ['getmaxlookupredirects_62',['getMaxLookupRedirects',['../classpulsar_1_1_client_configuration.html#ac624ce5e221c79282392cf63f91b7f5d',1,'pulsar::ClientConfiguration']]], + ['getmaxnumbytes_63',['getMaxNumBytes',['../classpulsar_1_1_batch_receive_policy.html#a81bf902bd62c003126aafb50a1ea7dea',1,'pulsar::BatchReceivePolicy']]], + ['getmaxnummessages_64',['getMaxNumMessages',['../classpulsar_1_1_batch_receive_policy.html#a079a3ecd654faeff462a673a4ba94940',1,'pulsar::BatchReceivePolicy']]], + ['getmaxpendingchunkedmessage_65',['getMaxPendingChunkedMessage',['../classpulsar_1_1_consumer_configuration.html#a46e9481689880f756588075f64913bb7',1,'pulsar::ConsumerConfiguration']]], + ['getmaxpendingmessages_66',['getMaxPendingMessages',['../classpulsar_1_1_producer_configuration.html#ae0300bcf9ccede2a62c550e3eb79cb4b',1,'pulsar::ProducerConfiguration']]], + ['getmaxpendingmessagesacrosspartitions_67',['getMaxPendingMessagesAcrossPartitions',['../classpulsar_1_1_producer_configuration.html#abbd51b143f4e4fc8ca5fdfc73c8bfb08',1,'pulsar::ProducerConfiguration']]], + ['getmaxredelivercount_68',['getMaxRedeliverCount',['../classpulsar_1_1_dead_letter_policy.html#a29c6c16740a31fed4a357f43298f98bc',1,'pulsar::DeadLetterPolicy']]], + ['getmaxtotalreceiverqueuesizeacrosspartitions_69',['getMaxTotalReceiverQueueSizeAcrossPartitions',['../classpulsar_1_1_consumer_configuration.html#abffc95603a9f983528b4dba82324f146',1,'pulsar::ConsumerConfiguration']]], + ['getmemorylimit_70',['getMemoryLimit',['../classpulsar_1_1_client_configuration.html#aa09cf22a285653ce9a551e85342dff49',1,'pulsar::ClientConfiguration']]], + ['getmessageid_71',['getMessageId',['../classpulsar_1_1_message.html#ad86803a4284b722117abb650c6db0aef',1,'pulsar::Message']]], + ['getmessagelistener_72',['getMessageListener',['../classpulsar_1_1_consumer_configuration.html#a2dcd50261f7fefa42b8fce239ef12f00',1,'pulsar::ConsumerConfiguration']]], + ['getmessagelistenerthreads_73',['getMessageListenerThreads',['../classpulsar_1_1_client_configuration.html#a95829d66c50c4226d79cc2fa835ba59a',1,'pulsar::ClientConfiguration']]], + ['getmessagerouterptr_74',['getMessageRouterPtr',['../classpulsar_1_1_producer_configuration.html#a815e19bc497485c10a4fca3a53dea52b',1,'pulsar::ProducerConfiguration']]], + ['getmetadata_75',['getMetadata',['../classpulsar_1_1_encryption_key_info.html#a7cd86c8e529db92625420de3bc2e8532',1,'pulsar::EncryptionKeyInfo']]], + ['getmsgbacklog_76',['getMsgBacklog',['../classpulsar_1_1_broker_consumer_stats.html#a55167beb17344517fedf88a2e86a3024',1,'pulsar::BrokerConsumerStats']]], + ['getmsgrateexpired_77',['getMsgRateExpired',['../classpulsar_1_1_broker_consumer_stats.html#adee6895ac624d9fbab24f58f7f62859b',1,'pulsar::BrokerConsumerStats']]], + ['getmsgrateout_78',['getMsgRateOut',['../classpulsar_1_1_broker_consumer_stats.html#a09a325a6512dce27e33f8ddeac7a94ba',1,'pulsar::BrokerConsumerStats']]], + ['getmsgrateredeliver_79',['getMsgRateRedeliver',['../classpulsar_1_1_broker_consumer_stats.html#af729bd5a41ddcdf9bfec48d512e3e272',1,'pulsar::BrokerConsumerStats']]], + ['getmsgthroughputout_80',['getMsgThroughputOut',['../classpulsar_1_1_broker_consumer_stats.html#a9527c5b503ce7b96d14cc6bd1125bdb4',1,'pulsar::BrokerConsumerStats']]], + ['getname_81',['getName',['../classpulsar_1_1_schema_info.html#ae253cd885dfbc4a9e70d1374ded43c38',1,'pulsar::SchemaInfo']]], + ['getnegativeackredeliverydelayms_82',['getNegativeAckRedeliveryDelayMs',['../classpulsar_1_1_consumer_configuration.html#a7a4adb22969050a6bfd6919e2ac68917',1,'pulsar::ConsumerConfiguration']]], + ['getnumberofconsumers_83',['getNumberOfConsumers',['../classpulsar_1_1_client.html#a1134874e191f8bf395c020f1ed3b2423',1,'pulsar::Client']]], + ['getnumberofproducers_84',['getNumberOfProducers',['../classpulsar_1_1_client.html#a5225a8d2b121cce6e205ef6e2471cdbc',1,'pulsar::Client']]], + ['getnumpartitions_85',['getNumPartitions',['../classpulsar_1_1_topic_metadata.html#a427a1228dd01108f5748ce92516bf5b1',1,'pulsar::TopicMetadata']]], + ['getoperationtimeoutseconds_86',['getOperationTimeoutSeconds',['../classpulsar_1_1_client_configuration.html#a842576f768383a2434959ece2a039222',1,'pulsar::ClientConfiguration']]], + ['getorderingkey_87',['getOrderingKey',['../classpulsar_1_1_message.html#ab237804a174974f73bb73970b0163c65',1,'pulsar::Message']]], + ['getpartition_88',['getpartition',['../classpulsar_1_1_message_routing_policy.html#a8071e740dd2e44ae75a91901e776c310',1,'pulsar::MessageRoutingPolicy::getPartition(const Message &msg)'],['../classpulsar_1_1_message_routing_policy.html#a080148f08d302d032b0f49d68ada73de',1,'pulsar::MessageRoutingPolicy::getPartition(const Message &msg, const TopicMetadata &topicMetadata)']]], + ['getpartitionkey_89',['getPartitionKey',['../classpulsar_1_1_message.html#a121f31f3216678187c069c681b3b4d7e',1,'pulsar::Message']]], + ['getpartitionsfortopic_90',['getPartitionsForTopic',['../classpulsar_1_1_client.html#a208629aff52395ad0072622ae82f5657',1,'pulsar::Client']]], + ['getpartitionsfortopicasync_91',['getPartitionsForTopicAsync',['../classpulsar_1_1_client.html#a2c3746c12dd5a531efcf2e8af96a3337',1,'pulsar::Client']]], + ['getpartitionsroutingmode_92',['getPartitionsRoutingMode',['../classpulsar_1_1_producer_configuration.html#ae8e2c09b5a04c154f2830db75426e243',1,'pulsar::ProducerConfiguration']]], + ['getpartitionsupdateinterval_93',['getPartitionsUpdateInterval',['../classpulsar_1_1_client_configuration.html#a9b1c684c29b2c484853aaa025aa441cb',1,'pulsar::ClientConfiguration']]], + ['getpatternautodiscoveryperiod_94',['getPatternAutoDiscoveryPeriod',['../classpulsar_1_1_consumer_configuration.html#a5034a765b5b60ea71f1beead267ff88f',1,'pulsar::ConsumerConfiguration']]], + ['getprioritylevel_95',['getPriorityLevel',['../classpulsar_1_1_consumer_configuration.html#a47dd7c844d904d52d3a2d5f4b498402d',1,'pulsar::ConsumerConfiguration']]], + ['getprivatekey_96',['getprivatekey',['../classpulsar_1_1_crypto_key_reader.html#a33a3b281068df053226bb50b59280be0',1,'pulsar::CryptoKeyReader::getPrivateKey()'],['../classpulsar_1_1_default_crypto_key_reader.html#abef165b0c67acb92eb73283564e8dbb5',1,'pulsar::DefaultCryptoKeyReader::getPrivateKey()']]], + ['getproducername_97',['getproducername',['../classpulsar_1_1_producer.html#aba5ac552bef04262ecc989b933ec1d65',1,'pulsar::Producer::getProducerName()'],['../classpulsar_1_1_producer_configuration.html#a526741c1516005ef85990002be06baed',1,'pulsar::ProducerConfiguration::getProducerName()']]], + ['getproperties_98',['getproperties',['../classpulsar_1_1_consumer_configuration.html#a5982ae123e367df322be897f81337ad0',1,'pulsar::ConsumerConfiguration::getProperties()'],['../classpulsar_1_1_message.html#adb69adf5f4e63cf0fb9fef0f7bc7281c',1,'pulsar::Message::getProperties()'],['../classpulsar_1_1_producer_configuration.html#a42d2ec7fafe2b0b3e1554572a487f40f',1,'pulsar::ProducerConfiguration::getProperties()'],['../classpulsar_1_1_reader_configuration.html#a9e201286fcc453d43bd188fbe1c96490',1,'pulsar::ReaderConfiguration::getProperties()'],['../classpulsar_1_1_schema_info.html#a5365dc263da01261bb92c95e27ffa0d6',1,'pulsar::SchemaInfo::getProperties()']]], + ['getproperty_99',['getproperty',['../classpulsar_1_1_consumer_configuration.html#a8b10f7a28e03a4929fc58aea5b67405d',1,'pulsar::ConsumerConfiguration::getProperty()'],['../classpulsar_1_1_message.html#a69b6576136ccce73f448e2dbaad8d357',1,'pulsar::Message::getProperty()'],['../classpulsar_1_1_producer_configuration.html#a15c8b5a9160959e6998aa2615304348c',1,'pulsar::ProducerConfiguration::getProperty()'],['../classpulsar_1_1_reader_configuration.html#ab006f647e263bd9be6f911a1b0299753',1,'pulsar::ReaderConfiguration::getProperty()']]], + ['getpublickey_100',['getpublickey',['../classpulsar_1_1_crypto_key_reader.html#a57456a577dc20b00229bb139bf025aee',1,'pulsar::CryptoKeyReader::getPublicKey()'],['../classpulsar_1_1_default_crypto_key_reader.html#a77289250ef58adf938335f241eeb748f',1,'pulsar::DefaultCryptoKeyReader::getPublicKey()']]], + ['getpublishtimestamp_101',['getPublishTimestamp',['../classpulsar_1_1_message.html#ac0a02a1da349789215e6f1a3b6e3f180',1,'pulsar::Message']]], + ['getreaderlistener_102',['getReaderListener',['../classpulsar_1_1_reader_configuration.html#aac94153e08ec204f23de0700a5f5a26d',1,'pulsar::ReaderConfiguration']]], + ['getreadername_103',['getReaderName',['../classpulsar_1_1_reader_configuration.html#ade2223dccff6f75d659fca0e1a65550c',1,'pulsar::ReaderConfiguration']]], + ['getreceiverqueuesize_104',['getreceiverqueuesize',['../classpulsar_1_1_consumer_configuration.html#a5c268fc7714916cf25c4a34a55a5bdc4',1,'pulsar::ConsumerConfiguration::getReceiverQueueSize()'],['../classpulsar_1_1_reader_configuration.html#acc4df17a3e440a6b6d0b5f887be396b9',1,'pulsar::ReaderConfiguration::getReceiverQueueSize()']]], + ['getredeliverycount_105',['getRedeliveryCount',['../classpulsar_1_1_message.html#aca393b369e6c9ba90c38acac37b54d60',1,'pulsar::Message']]], + ['getrefreshtoken_106',['getRefreshToken',['../classpulsar_1_1_oauth2_token_result.html#ab3f6c44eaa2f4eed65e98fdfa2e3cd95',1,'pulsar::Oauth2TokenResult']]], + ['getregexsubscriptionmode_107',['getRegexSubscriptionMode',['../classpulsar_1_1_consumer_configuration.html#a74fc4ee3cb49f470b46914a3f7d03c6d',1,'pulsar::ConsumerConfiguration']]], + ['getschema_108',['getschema',['../classpulsar_1_1_consumer_configuration.html#acc102de37a90b103be92a24e92fac432',1,'pulsar::ConsumerConfiguration::getSchema()'],['../classpulsar_1_1_producer_configuration.html#a1a38c635f3b3bfb47da547da873f7adc',1,'pulsar::ProducerConfiguration::getSchema()'],['../classpulsar_1_1_reader_configuration.html#a6cd2f670fd1a988fbe94eaa78daeb500',1,'pulsar::ReaderConfiguration::getSchema()'],['../classpulsar_1_1_schema_info.html#ad75d2496d13da8dc13f738606f7c72ec',1,'pulsar::SchemaInfo::getSchema()']]], + ['getschemainfoasync_109',['getSchemaInfoAsync',['../classpulsar_1_1_client.html#aa24ed12d3228c31c923e33fee1eb6f55',1,'pulsar::Client']]], + ['getschematype_110',['getSchemaType',['../classpulsar_1_1_schema_info.html#a6ff46ec7c53346fb9249edd1e34d6e62',1,'pulsar::SchemaInfo']]], + ['getschemaversion_111',['getschemaversion',['../classpulsar_1_1_message.html#ac39590d8db47e6011c4185664350f52d',1,'pulsar::Message::getSchemaVersion()'],['../classpulsar_1_1_producer.html#a2d452694aca8f7ccb5af5e3a974432c3',1,'pulsar::Producer::getSchemaVersion()']]], + ['getsendtimeout_112',['getSendTimeout',['../classpulsar_1_1_producer_configuration.html#a5f3c0ff3a5910207e1731fd1974fe560',1,'pulsar::ProducerConfiguration']]], + ['getstatsintervalinseconds_113',['getStatsIntervalInSeconds',['../classpulsar_1_1_client_configuration.html#a3e86a2ec91591eea6faee445652f6c8b',1,'pulsar::ClientConfiguration']]], + ['getstickyranges_114',['getStickyRanges',['../classpulsar_1_1_key_shared_policy.html#a99d2a2c1555003f42213b3eb4c6742f6',1,'pulsar::KeySharedPolicy']]], + ['getsubscriptioninitialposition_115',['getSubscriptionInitialPosition',['../classpulsar_1_1_consumer_configuration.html#a5ceb47d60826a738ed122cd962220ef7',1,'pulsar::ConsumerConfiguration']]], + ['getsubscriptionname_116',['getSubscriptionName',['../classpulsar_1_1_consumer.html#af6049caaf3e1f8bc91d4dc52b02ab7d1',1,'pulsar::Consumer']]], + ['getsubscriptionproperties_117',['getSubscriptionProperties',['../classpulsar_1_1_consumer_configuration.html#aaa9a9a19c4445bb6521c2b3d1a2037f6',1,'pulsar::ConsumerConfiguration']]], + ['getsubscriptionroleprefix_118',['getSubscriptionRolePrefix',['../classpulsar_1_1_reader_configuration.html#ae5107fa6216f477789c84338ab87675c',1,'pulsar::ReaderConfiguration']]], + ['gettickdurationinms_119',['gettickdurationinms',['../classpulsar_1_1_consumer_configuration.html#a2b45112da6be71eaaff4513bf96a73c0',1,'pulsar::ConsumerConfiguration::getTickDurationInMs()'],['../classpulsar_1_1_reader_configuration.html#a1618961cba0c4c980b01a6a42aac8036',1,'pulsar::ReaderConfiguration::getTickDurationInMs()']]], + ['gettimeoutms_120',['getTimeoutMs',['../classpulsar_1_1_batch_receive_policy.html#acb75726b7e7a75dc65181bada30b9f31',1,'pulsar::BatchReceivePolicy']]], + ['gettlscertificatefilepath_121',['getTlsCertificateFilePath',['../classpulsar_1_1_client_configuration.html#a499d79bdc68fb5b80709b3a794f682f5',1,'pulsar::ClientConfiguration']]], + ['gettlscertificates_122',['getTlsCertificates',['../classpulsar_1_1_authentication_data_provider.html#af2694d6a80dfe8af67c16ef45f3e9645',1,'pulsar::AuthenticationDataProvider']]], + ['gettlsprivatekey_123',['getTlsPrivateKey',['../classpulsar_1_1_authentication_data_provider.html#a8a86f5d276fafcc7f35bc49a365be9f8',1,'pulsar::AuthenticationDataProvider']]], + ['gettlsprivatekeyfilepath_124',['getTlsPrivateKeyFilePath',['../classpulsar_1_1_client_configuration.html#a961555e096d6c7dfd599454b335069ca',1,'pulsar::ClientConfiguration']]], + ['gettlstrustcertsfilepath_125',['getTlsTrustCertsFilePath',['../classpulsar_1_1_client_configuration.html#a2774b2a76b3ed18dc0429f5a6920d1e8',1,'pulsar::ClientConfiguration']]], + ['gettopic_126',['gettopic',['../classpulsar_1_1_consumer.html#ad55d95cd75501562d8ae6d83935d5977',1,'pulsar::Consumer::getTopic()'],['../classpulsar_1_1_producer.html#ab30cecbdcad0f600c1fcd2783cd6caf3',1,'pulsar::Producer::getTopic()'],['../classpulsar_1_1_reader.html#a1b682c6bacd8514221bbb6b25c84c051',1,'pulsar::Reader::getTopic()']]], + ['gettopicname_127',['gettopicname',['../classpulsar_1_1_message.html#adb7dacb620c7fad56f0aa1d6ae52bb88',1,'pulsar::Message::getTopicName()'],['../classpulsar_1_1_message_id.html#a7cd2deeae7cbf71436bc8e9cd786c147',1,'pulsar::MessageId::getTopicName()']]], + ['gettype_128',['getType',['../classpulsar_1_1_broker_consumer_stats.html#a4f56bc158ec0f4abf5a50c4ac03f8a3c',1,'pulsar::BrokerConsumerStats']]], + ['getunackedmessages_129',['getUnackedMessages',['../classpulsar_1_1_broker_consumer_stats.html#aeaa33caf3a417444b631c6db711806f7',1,'pulsar::BrokerConsumerStats']]], + ['getunackedmessagestimeoutms_130',['getunackedmessagestimeoutms',['../classpulsar_1_1_consumer_configuration.html#a373ab78d91d7fbbd0c9b721ba1f34f26',1,'pulsar::ConsumerConfiguration::getUnAckedMessagesTimeoutMs()'],['../classpulsar_1_1_reader_configuration.html#a35aadcf27818f2b46125004dcf160fe6',1,'pulsar::ReaderConfiguration::getUnAckedMessagesTimeoutMs()']]], + ['getvalue_131',['getvalue',['../classpulsar_1_1_key_value.html#a53158bdf562d12f14c7254e6d4b55b37',1,'pulsar::KeyValue::getValue()'],['../classpulsar_1_1_table_view.html#a8bc874dc48a7381726e48145a8037879',1,'pulsar::TableView::getValue()']]], + ['getvalueasstring_132',['getValueAsString',['../classpulsar_1_1_key_value.html#a573eeb6042d04adec7be3d8c46ea2590',1,'pulsar::KeyValue']]], + ['getvaluelength_133',['getValueLength',['../classpulsar_1_1_key_value.html#a3c51a0e66e5935c62dfbdb8e0908cf15',1,'pulsar::KeyValue']]] +]; diff --git a/static/api/cpp/3.5.x/search/functions_7.js b/static/api/cpp/3.5.x/search/functions_7.js new file mode 100644 index 000000000000..2d32fbf85e0e --- /dev/null +++ b/static/api/cpp/3.5.x/search/functions_7.js @@ -0,0 +1,15 @@ +var searchData= +[ + ['hasconsumereventlistener_0',['hasConsumerEventListener',['../classpulsar_1_1_consumer_configuration.html#abc2cdbdc7878fca3205ec77cea2b1fa2',1,'pulsar::ConsumerConfiguration']]], + ['hasdataforhttp_1',['hasDataForHttp',['../classpulsar_1_1_authentication_data_provider.html#afbe3f1d0356a5d362bffc7f8253bf631',1,'pulsar::AuthenticationDataProvider']]], + ['hasdatafortls_2',['hasDataForTls',['../classpulsar_1_1_authentication_data_provider.html#af500b208a36e4849bd9ee1f6c48eb60e',1,'pulsar::AuthenticationDataProvider']]], + ['hasdatafromcommand_3',['hasDataFromCommand',['../classpulsar_1_1_authentication_data_provider.html#a1ad6773dcb324d73d6fe6aaa01927e67',1,'pulsar::AuthenticationDataProvider']]], + ['hasmessageavailable_4',['hasMessageAvailable',['../classpulsar_1_1_reader.html#a7f751b63fba4d4734ff79da590f9fd56',1,'pulsar::Reader']]], + ['hasmessageavailableasync_5',['hasMessageAvailableAsync',['../classpulsar_1_1_reader.html#a0c3755b32954d1aeb1b4ef60e4314c1d',1,'pulsar::Reader']]], + ['hasmessagelistener_6',['hasMessageListener',['../classpulsar_1_1_consumer_configuration.html#afe5439f3160e601a09e62237d2377c1a',1,'pulsar::ConsumerConfiguration']]], + ['hasorderingkey_7',['hasOrderingKey',['../classpulsar_1_1_message.html#ad29a0aeda1dbb934e7c3311d85d0aa02',1,'pulsar::Message']]], + ['haspartitionkey_8',['hasPartitionKey',['../classpulsar_1_1_message.html#a171e78738da5932678cfd83c347186bf',1,'pulsar::Message']]], + ['hasproperty_9',['hasproperty',['../classpulsar_1_1_consumer_configuration.html#a8aab5c5bd65073257d0509d410099570',1,'pulsar::ConsumerConfiguration::hasProperty()'],['../classpulsar_1_1_message.html#ad3e557ed946f94e6964147a8389532bd',1,'pulsar::Message::hasProperty()'],['../classpulsar_1_1_producer_configuration.html#a7f9020dbb5c22a28277009e83695d5e2',1,'pulsar::ProducerConfiguration::hasProperty()'],['../classpulsar_1_1_reader_configuration.html#a0d53c4ac681120500c4d057a60f6f6a6',1,'pulsar::ReaderConfiguration::hasProperty(const std::string &name) const']]], + ['hasreaderlistener_10',['hasReaderListener',['../classpulsar_1_1_reader_configuration.html#a104b07bc32a421a8527e7d167ec2c611',1,'pulsar::ReaderConfiguration']]], + ['hasschemaversion_11',['hasSchemaVersion',['../classpulsar_1_1_message.html#a51dee56cd5f71a4d4c2cae8a1b42feef',1,'pulsar::Message']]] +]; diff --git a/static/api/cpp/3.5.x/search/functions_8.js b/static/api/cpp/3.5.x/search/functions_8.js new file mode 100644 index 000000000000..93f5461c4296 --- /dev/null +++ b/static/api/cpp/3.5.x/search/functions_8.js @@ -0,0 +1,23 @@ +var searchData= +[ + ['initialize_0',['initialize',['../classpulsar_1_1_oauth2_flow.html#a2d9a138289565a4e07aded8fffdcb96e',1,'pulsar::Oauth2Flow']]], + ['initialsubscriptionname_1',['initialSubscriptionName',['../classpulsar_1_1_dead_letter_policy_builder.html#ac2c21735aeb67ffc97ed49351b1de4b0',1,'pulsar::DeadLetterPolicyBuilder']]], + ['intercept_2',['intercept',['../classpulsar_1_1_consumer_configuration.html#a37bf6928179a14ab9b2af6e69befa2d8',1,'pulsar::ConsumerConfiguration']]], + ['isackreceiptenabled_3',['isAckReceiptEnabled',['../classpulsar_1_1_consumer_configuration.html#af4f7966e4662ecb250893927909269a3',1,'pulsar::ConsumerConfiguration']]], + ['isallowoutoforderdelivery_4',['isAllowOutOfOrderDelivery',['../classpulsar_1_1_key_shared_policy.html#ac79edf430990c158e23886c21f6f2fea',1,'pulsar::KeySharedPolicy']]], + ['isautoackoldestchunkedmessageonqueuefull_5',['isAutoAckOldestChunkedMessageOnQueueFull',['../classpulsar_1_1_consumer_configuration.html#a4f978c3e8ff479ed0fea93eba5275f6d',1,'pulsar::ConsumerConfiguration']]], + ['isbatchindexackenabled_6',['isBatchIndexAckEnabled',['../classpulsar_1_1_consumer_configuration.html#a1f5847ecf1c8f77992b1a4c110011c9a',1,'pulsar::ConsumerConfiguration']]], + ['isblockedconsumeronunackedmsgs_7',['isBlockedConsumerOnUnackedMsgs',['../classpulsar_1_1_broker_consumer_stats.html#ae47fe1710c172b602bd346baf8791ed9',1,'pulsar::BrokerConsumerStats']]], + ['ischunkingenabled_8',['isChunkingEnabled',['../classpulsar_1_1_producer_configuration.html#a6aa210dd18cbd98ccb39ebc2f0978f95',1,'pulsar::ProducerConfiguration']]], + ['isconnected_9',['isconnected',['../classpulsar_1_1_consumer.html#a95a69d39ec2c8714b6ffce0f6ab74a55',1,'pulsar::Consumer::isConnected()'],['../classpulsar_1_1_producer.html#a0f8b6a4b724a60545a8d427596155f1e',1,'pulsar::Producer::isConnected()'],['../classpulsar_1_1_reader.html#a9eda13274f7b1f880694fc1178ae631d',1,'pulsar::Reader::isConnected()']]], + ['isenabled_10',['isEnabled',['../classpulsar_1_1_logger.html#a6d09f80fd8f35d5634af94a1305c86af',1,'pulsar::Logger']]], + ['isencryptionenabled_11',['isencryptionenabled',['../classpulsar_1_1_consumer_configuration.html#ac9a6a885f0cea261f32dc4a3509643f4',1,'pulsar::ConsumerConfiguration::isEncryptionEnabled()'],['../classpulsar_1_1_producer_configuration.html#a33f5238a6da49fca17816d4251af5512',1,'pulsar::ProducerConfiguration::isEncryptionEnabled()'],['../classpulsar_1_1_reader_configuration.html#aa2cc4490830aeebee9c1a16589b8c429',1,'pulsar::ReaderConfiguration::isEncryptionEnabled()']]], + ['isexpired_12',['isExpired',['../classpulsar_1_1_cached_token.html#a2fe69f2fb7037139b52f9c66a0af05f2',1,'pulsar::CachedToken']]], + ['isreadcompacted_13',['isreadcompacted',['../classpulsar_1_1_consumer_configuration.html#a74209a513ebdb85f5969f2fedafb0b44',1,'pulsar::ConsumerConfiguration::isReadCompacted()'],['../classpulsar_1_1_reader_configuration.html#a93a555fd5dc20d394ea45e9155301ee4',1,'pulsar::ReaderConfiguration::isReadCompacted()']]], + ['isreplicatesubscriptionstateenabled_14',['isReplicateSubscriptionStateEnabled',['../classpulsar_1_1_consumer_configuration.html#a4ab6c45eb256e8ad9ec4d74199e5c01d',1,'pulsar::ConsumerConfiguration']]], + ['isstartmessageidinclusive_15',['isstartmessageidinclusive',['../classpulsar_1_1_consumer_configuration.html#a968b4d4ae6348072965ab98bf1e7212e',1,'pulsar::ConsumerConfiguration::isStartMessageIdInclusive()'],['../classpulsar_1_1_reader_configuration.html#a2c9f4927d01acddc1106c9c1812acd47',1,'pulsar::ReaderConfiguration::isStartMessageIdInclusive()']]], + ['istlsallowinsecureconnection_16',['isTlsAllowInsecureConnection',['../classpulsar_1_1_client_configuration.html#a134473221c9e91f0c558a5c291aa9d5e',1,'pulsar::ClientConfiguration']]], + ['isusetls_17',['isUseTls',['../classpulsar_1_1_client_configuration.html#a564ce9a6a43fe2db6ac11cc7821b8c27',1,'pulsar::ClientConfiguration']]], + ['isvalid_18',['isValid',['../classpulsar_1_1_broker_consumer_stats.html#a6ab876378e9c76098bd48ee9753faec0',1,'pulsar::BrokerConsumerStats']]], + ['isvalidatehostname_19',['isValidateHostName',['../classpulsar_1_1_client_configuration.html#ae5646c0a8ffd63e9fbcb3a84704d3a10',1,'pulsar::ClientConfiguration']]] +]; diff --git a/static/api/cpp/3.5.x/search/functions_9.js b/static/api/cpp/3.5.x/search/functions_9.js new file mode 100644 index 000000000000..6b8b6710a9d5 --- /dev/null +++ b/static/api/cpp/3.5.x/search/functions_9.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['keyvalue_0',['KeyValue',['../classpulsar_1_1_key_value.html#a724959978481478da4e45ba79092edad',1,'pulsar::KeyValue']]] +]; diff --git a/static/api/cpp/3.5.x/search/functions_a.js b/static/api/cpp/3.5.x/search/functions_a.js new file mode 100644 index 000000000000..9e33da64619c --- /dev/null +++ b/static/api/cpp/3.5.x/search/functions_a.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['latest_0',['latest',['../classpulsar_1_1_message_id.html#af9c67f2e12e102b07c609a8da5740976',1,'pulsar::MessageId']]], + ['ledgerid_1',['ledgerId',['../classpulsar_1_1_message_id_builder.html#ae1be301cd7f5d7b5444adaa7d209bf2e',1,'pulsar::MessageIdBuilder']]], + ['log_2',['log',['../classpulsar_1_1_logger.html#a753385116eb2e4d73c075de94cc2039b',1,'pulsar::Logger']]] +]; diff --git a/static/api/cpp/3.5.x/search/functions_b.js b/static/api/cpp/3.5.x/search/functions_b.js new file mode 100644 index 000000000000..e20a090dfbed --- /dev/null +++ b/static/api/cpp/3.5.x/search/functions_b.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['maxredelivercount_0',['maxRedeliverCount',['../classpulsar_1_1_dead_letter_policy_builder.html#ad34f023e1018f636ed488c533e645661',1,'pulsar::DeadLetterPolicyBuilder']]], + ['message_1',['Message',['../classpulsar_1_1_message.html#aa3c4673ec7b3c99cc3faf9aa931a4531',1,'pulsar::Message']]], + ['messageid_2',['MessageId',['../classpulsar_1_1_message_id.html#ac91b200bd36b9d887bebdadb747dd4ee',1,'pulsar::MessageId']]] +]; diff --git a/static/api/cpp/3.5.x/search/functions_c.js b/static/api/cpp/3.5.x/search/functions_c.js new file mode 100644 index 000000000000..31d6be7a4b54 --- /dev/null +++ b/static/api/cpp/3.5.x/search/functions_c.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['negativeacknowledge_0',['negativeacknowledge',['../classpulsar_1_1_consumer.html#a3cd227d9be2ae090c3a55bcdfff1df69',1,'pulsar::Consumer::negativeAcknowledge(const Message &message)'],['../classpulsar_1_1_consumer.html#afd631d1c357bc0284afe3e0cd2acbd6e',1,'pulsar::Consumer::negativeAcknowledge(const MessageId &messageId)']]] +]; diff --git a/static/api/cpp/3.5.x/search/functions_d.js b/static/api/cpp/3.5.x/search/functions_d.js new file mode 100644 index 000000000000..faa00208d5e2 --- /dev/null +++ b/static/api/cpp/3.5.x/search/functions_d.js @@ -0,0 +1,8 @@ +var searchData= +[ + ['onacknowledge_0',['onAcknowledge',['../classpulsar_1_1_consumer_interceptor.html#a9d45879671a6585c244b996e0f8e0eae',1,'pulsar::ConsumerInterceptor']]], + ['onacknowledgecumulative_1',['onAcknowledgeCumulative',['../classpulsar_1_1_consumer_interceptor.html#aaa831e0a16b86333a43ee7fed04ab0a1',1,'pulsar::ConsumerInterceptor']]], + ['onnegativeackssend_2',['onNegativeAcksSend',['../classpulsar_1_1_consumer_interceptor.html#a8f11afb9ec2c367cd5006f4a2df45f30',1,'pulsar::ConsumerInterceptor']]], + ['onpartitionschange_3',['onPartitionsChange',['../classpulsar_1_1_producer_interceptor.html#aa4fbfa721d9d9985a304c3d2ce924202',1,'pulsar::ProducerInterceptor']]], + ['onsendacknowledgement_4',['onSendAcknowledgement',['../classpulsar_1_1_producer_interceptor.html#ad9aba4738d6033218f4a970c53aefab0',1,'pulsar::ProducerInterceptor']]] +]; diff --git a/static/api/cpp/3.5.x/search/functions_e.js b/static/api/cpp/3.5.x/search/functions_e.js new file mode 100644 index 000000000000..f3584106cd80 --- /dev/null +++ b/static/api/cpp/3.5.x/search/functions_e.js @@ -0,0 +1,7 @@ +var searchData= +[ + ['parsedefaultformatauthparams_0',['parseDefaultFormatAuthParams',['../classpulsar_1_1_authentication.html#a0ff47251bd4184cd0e9155e76a5c35bb',1,'pulsar::Authentication']]], + ['partition_1',['partition',['../classpulsar_1_1_message_id_builder.html#a40f7cba248437dd6d1d2d29cbc48f5ac',1,'pulsar::MessageIdBuilder']]], + ['pausemessagelistener_2',['pauseMessageListener',['../classpulsar_1_1_consumer.html#a7370b7a19a08fdff5b044e74ad8bd679',1,'pulsar::Consumer']]], + ['producer_3',['Producer',['../classpulsar_1_1_producer.html#a013069fbb382f7f3c7dd58522765698b',1,'pulsar::Producer']]] +]; diff --git a/static/api/cpp/3.5.x/search/functions_f.js b/static/api/cpp/3.5.x/search/functions_f.js new file mode 100644 index 000000000000..59ecce5ecad6 --- /dev/null +++ b/static/api/cpp/3.5.x/search/functions_f.js @@ -0,0 +1,11 @@ +var searchData= +[ + ['reader_0',['Reader',['../classpulsar_1_1_reader.html#a1c34e49ba3dbca0ff7e23ea9ff94db7b',1,'pulsar::Reader']]], + ['readnext_1',['readnext',['../classpulsar_1_1_reader.html#a11756c69a2f5bd99e302a384ae8a9ff4',1,'pulsar::Reader::readNext(Message &msg)'],['../classpulsar_1_1_reader.html#a39c664ea68774721bc0e772b38449b22',1,'pulsar::Reader::readNext(Message &msg, int timeoutMs)']]], + ['readnextasync_2',['readNextAsync',['../classpulsar_1_1_reader.html#a1ed12cbc71284694e5ff9fee1e7c462d',1,'pulsar::Reader']]], + ['receive_3',['receive',['../classpulsar_1_1_consumer.html#abc8cec6e81c582c6af8e3d931e41a2ad',1,'pulsar::Consumer::receive(Message &msg)'],['../classpulsar_1_1_consumer.html#ace9475b70f37c91df5b442f41058370e',1,'pulsar::Consumer::receive(Message &msg, int timeoutMs)']]], + ['receiveasync_4',['receiveAsync',['../classpulsar_1_1_consumer.html#a0189416fb8672b23919276cc9f1bba5d',1,'pulsar::Consumer']]], + ['redeliverunacknowledgedmessages_5',['redeliverUnacknowledgedMessages',['../classpulsar_1_1_consumer.html#a3d60ee12b0e9766d60c3a8e08a61287a',1,'pulsar::Consumer']]], + ['resumemessagelistener_6',['resumeMessageListener',['../classpulsar_1_1_consumer.html#a02a9a412f1aa7f1ec8dc0c0134315b66',1,'pulsar::Consumer']]], + ['retrievevalue_7',['retrieveValue',['../classpulsar_1_1_table_view.html#a7184812e0d4bf374a23ba7c99d53f18e',1,'pulsar::TableView']]] +]; diff --git a/static/api/cpp/3.5.x/search/mag.svg b/static/api/cpp/3.5.x/search/mag.svg new file mode 100644 index 000000000000..ffb6cf0d0251 --- /dev/null +++ b/static/api/cpp/3.5.x/search/mag.svg @@ -0,0 +1,24 @@ + + + + + + + diff --git a/static/api/cpp/3.5.x/search/mag_d.svg b/static/api/cpp/3.5.x/search/mag_d.svg new file mode 100644 index 000000000000..4122773f92c3 --- /dev/null +++ b/static/api/cpp/3.5.x/search/mag_d.svg @@ -0,0 +1,24 @@ + + + + + + + diff --git a/static/api/cpp/3.5.x/search/mag_sel.svg b/static/api/cpp/3.5.x/search/mag_sel.svg new file mode 100644 index 000000000000..553dba877326 --- /dev/null +++ b/static/api/cpp/3.5.x/search/mag_sel.svg @@ -0,0 +1,31 @@ + + + + + + + + + diff --git a/static/api/cpp/3.5.x/search/mag_seld.svg b/static/api/cpp/3.5.x/search/mag_seld.svg new file mode 100644 index 000000000000..c906f84c83a3 --- /dev/null +++ b/static/api/cpp/3.5.x/search/mag_seld.svg @@ -0,0 +1,31 @@ + + + + + + + + + diff --git a/static/api/cpp/3.5.x/search/namespaces_0.js b/static/api/cpp/3.5.x/search/namespaces_0.js new file mode 100644 index 000000000000..5b5da7c124ce --- /dev/null +++ b/static/api/cpp/3.5.x/search/namespaces_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['pulsar_0',['pulsar',['../namespacepulsar.html',1,'']]] +]; diff --git a/static/api/cpp/3.5.x/search/pages_0.js b/static/api/cpp/3.5.x/search/pages_0.js new file mode 100644 index 000000000000..593afc7aa3c9 --- /dev/null +++ b/static/api/cpp/3.5.x/search/pages_0.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['client_20cpp_0',['pulsar-client-cpp',['../index.html',1,'']]], + ['cpp_1',['pulsar-client-cpp',['../index.html',1,'']]] +]; diff --git a/static/api/cpp/3.5.x/search/pages_1.js b/static/api/cpp/3.5.x/search/pages_1.js new file mode 100644 index 000000000000..4d858458c36c --- /dev/null +++ b/static/api/cpp/3.5.x/search/pages_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['deprecated_20list_0',['Deprecated List',['../deprecated.html',1,'']]] +]; diff --git a/static/api/cpp/3.5.x/search/pages_2.js b/static/api/cpp/3.5.x/search/pages_2.js new file mode 100644 index 000000000000..1ad91e39e1a1 --- /dev/null +++ b/static/api/cpp/3.5.x/search/pages_2.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['list_0',['Deprecated List',['../deprecated.html',1,'']]] +]; diff --git a/static/api/cpp/3.5.x/search/pages_3.js b/static/api/cpp/3.5.x/search/pages_3.js new file mode 100644 index 000000000000..4f07d7858ebb --- /dev/null +++ b/static/api/cpp/3.5.x/search/pages_3.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['pulsar_20client_20cpp_0',['pulsar-client-cpp',['../index.html',1,'']]] +]; diff --git a/static/api/cpp/3.5.x/search/search.css b/static/api/cpp/3.5.x/search/search.css new file mode 100644 index 000000000000..19f76f9d5b96 --- /dev/null +++ b/static/api/cpp/3.5.x/search/search.css @@ -0,0 +1,291 @@ +/*---------------- Search Box positioning */ + +#main-menu > li:last-child { + /* This
  • object is the parent of the search bar */ + display: flex; + justify-content: center; + align-items: center; + height: 36px; + margin-right: 1em; +} + +/*---------------- Search box styling */ + +.SRPage * { + font-weight: normal; + line-height: normal; +} + +dark-mode-toggle { + margin-left: 5px; + display: flex; + float: right; +} + +#MSearchBox { + display: inline-block; + white-space : nowrap; + background: var(--search-background-color); + border-radius: 0.65em; + box-shadow: var(--search-box-shadow); + z-index: 102; +} + +#MSearchBox .left { + display: inline-block; + vertical-align: middle; + height: 1.4em; +} + +#MSearchSelect { + display: inline-block; + vertical-align: middle; + width: 20px; + height: 19px; + background-image: var(--search-magnification-select-image); + margin: 0 0 0 0.3em; + padding: 0; +} + +#MSearchSelectExt { + display: inline-block; + vertical-align: middle; + width: 10px; + height: 19px; + background-image: var(--search-magnification-image); + margin: 0 0 0 0.5em; + padding: 0; +} + + +#MSearchField { + display: inline-block; + vertical-align: middle; + width: 7.5em; + height: 19px; + margin: 0 0.15em; + padding: 0; + line-height: 1em; + border:none; + color: var(--search-foreground-color); + outline: none; + font-family: var(--font-family-search); + -webkit-border-radius: 0px; + border-radius: 0px; + background: none; +} + +@media(hover: none) { + /* to avoid zooming on iOS */ + #MSearchField { + font-size: 16px; + } +} + +#MSearchBox .right { + display: inline-block; + vertical-align: middle; + width: 1.4em; + height: 1.4em; +} + +#MSearchClose { + display: none; + font-size: inherit; + background : none; + border: none; + margin: 0; + padding: 0; + outline: none; + +} + +#MSearchCloseImg { + padding: 0.3em; + margin: 0; +} + +.MSearchBoxActive #MSearchField { + color: var(--search-active-color); +} + + + +/*---------------- Search filter selection */ + +#MSearchSelectWindow { + display: none; + position: absolute; + left: 0; top: 0; + border: 1px solid var(--search-filter-border-color); + background-color: var(--search-filter-background-color); + z-index: 10001; + padding-top: 4px; + padding-bottom: 4px; + -moz-border-radius: 4px; + -webkit-border-top-left-radius: 4px; + -webkit-border-top-right-radius: 4px; + -webkit-border-bottom-left-radius: 4px; + -webkit-border-bottom-right-radius: 4px; + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); +} + +.SelectItem { + font: 8pt var(--font-family-search); + padding-left: 2px; + padding-right: 12px; + border: 0px; +} + +span.SelectionMark { + margin-right: 4px; + font-family: var(--font-family-monospace); + outline-style: none; + text-decoration: none; +} + +a.SelectItem { + display: block; + outline-style: none; + color: var(--search-filter-foreground-color); + text-decoration: none; + padding-left: 6px; + padding-right: 12px; +} + +a.SelectItem:focus, +a.SelectItem:active { + color: var(--search-filter-foreground-color); + outline-style: none; + text-decoration: none; +} + +a.SelectItem:hover { + color: var(--search-filter-highlight-text-color); + background-color: var(--search-filter-highlight-bg-color); + outline-style: none; + text-decoration: none; + cursor: pointer; + display: block; +} + +/*---------------- Search results window */ + +iframe#MSearchResults { + /*width: 60ex;*/ + height: 15em; +} + +#MSearchResultsWindow { + display: none; + position: absolute; + left: 0; top: 0; + border: 1px solid var(--search-results-border-color); + background-color: var(--search-results-background-color); + z-index:10000; + width: 300px; + height: 400px; + overflow: auto; +} + +/* ----------------------------------- */ + + +#SRIndex { + clear:both; +} + +.SREntry { + font-size: 10pt; + padding-left: 1ex; +} + +.SRPage .SREntry { + font-size: 8pt; + padding: 1px 5px; +} + +div.SRPage { + margin: 5px 2px; + background-color: var(--search-results-background-color); +} + +.SRChildren { + padding-left: 3ex; padding-bottom: .5em +} + +.SRPage .SRChildren { + display: none; +} + +.SRSymbol { + font-weight: bold; + color: var(--search-results-foreground-color); + font-family: var(--font-family-search); + text-decoration: none; + outline: none; +} + +a.SRScope { + display: block; + color: var(--search-results-foreground-color); + font-family: var(--font-family-search); + font-size: 8pt; + text-decoration: none; + outline: none; +} + +a.SRSymbol:focus, a.SRSymbol:active, +a.SRScope:focus, a.SRScope:active { + text-decoration: underline; +} + +span.SRScope { + padding-left: 4px; + font-family: var(--font-family-search); +} + +.SRPage .SRStatus { + padding: 2px 5px; + font-size: 8pt; + font-style: italic; + font-family: var(--font-family-search); +} + +.SRResult { + display: none; +} + +div.searchresults { + margin-left: 10px; + margin-right: 10px; +} + +/*---------------- External search page results */ + +.pages b { + color: white; + padding: 5px 5px 3px 5px; + background-image: var(--nav-gradient-active-image-parent); + background-repeat: repeat-x; + text-shadow: 0 1px 1px #000000; +} + +.pages { + line-height: 17px; + margin-left: 4px; + text-decoration: none; +} + +.hl { + font-weight: bold; +} + +#searchresults { + margin-bottom: 20px; +} + +.searchpages { + margin-top: 10px; +} + diff --git a/static/api/cpp/3.5.x/search/search.js b/static/api/cpp/3.5.x/search/search.js new file mode 100644 index 000000000000..6fd40c677018 --- /dev/null +++ b/static/api/cpp/3.5.x/search/search.js @@ -0,0 +1,840 @@ +/* + @licstart The following is the entire license notice for the JavaScript code in this file. + + The MIT License (MIT) + + Copyright (C) 1997-2020 by Dimitri van Heesch + + Permission is hereby granted, free of charge, to any person obtaining a copy of this software + and associated documentation files (the "Software"), to deal in the Software without restriction, + including without limitation the rights to use, copy, modify, merge, publish, distribute, + sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all copies or + substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + @licend The above is the entire license notice for the JavaScript code in this file + */ +function convertToId(search) +{ + var result = ''; + for (i=0;i do a search + { + this.Search(); + } + } + + this.OnSearchSelectKey = function(evt) + { + var e = (evt) ? evt : window.event; // for IE + if (e.keyCode==40 && this.searchIndex0) // Up + { + this.searchIndex--; + this.OnSelectItem(this.searchIndex); + } + else if (e.keyCode==13 || e.keyCode==27) + { + e.stopPropagation(); + this.OnSelectItem(this.searchIndex); + this.CloseSelectionWindow(); + this.DOMSearchField().focus(); + } + return false; + } + + // --------- Actions + + // Closes the results window. + this.CloseResultsWindow = function() + { + this.DOMPopupSearchResultsWindow().style.display = 'none'; + this.DOMSearchClose().style.display = 'none'; + this.Activate(false); + } + + this.CloseSelectionWindow = function() + { + this.DOMSearchSelectWindow().style.display = 'none'; + } + + // Performs a search. + this.Search = function() + { + this.keyTimeout = 0; + + // strip leading whitespace + var searchValue = this.DOMSearchField().value.replace(/^ +/, ""); + + var code = searchValue.toLowerCase().charCodeAt(0); + var idxChar = searchValue.substr(0, 1).toLowerCase(); + if ( 0xD800 <= code && code <= 0xDBFF && searchValue > 1) // surrogate pair + { + idxChar = searchValue.substr(0, 2); + } + + var jsFile; + + var idx = indexSectionsWithContent[this.searchIndex].indexOf(idxChar); + if (idx!=-1) + { + var hexCode=idx.toString(16); + jsFile = this.resultsPath + indexSectionNames[this.searchIndex] + '_' + hexCode + '.js'; + } + + var loadJS = function(url, impl, loc){ + var scriptTag = document.createElement('script'); + scriptTag.src = url; + scriptTag.onload = impl; + scriptTag.onreadystatechange = impl; + loc.appendChild(scriptTag); + } + + var domPopupSearchResultsWindow = this.DOMPopupSearchResultsWindow(); + var domSearchBox = this.DOMSearchBox(); + var domPopupSearchResults = this.DOMPopupSearchResults(); + var domSearchClose = this.DOMSearchClose(); + var resultsPath = this.resultsPath; + + var handleResults = function() { + document.getElementById("Loading").style.display="none"; + if (typeof searchData !== 'undefined') { + createResults(resultsPath); + document.getElementById("NoMatches").style.display="none"; + } + + if (idx!=-1) { + searchResults.Search(searchValue); + } else { // no file with search results => force empty search results + searchResults.Search('===='); + } + + if (domPopupSearchResultsWindow.style.display!='block') + { + domSearchClose.style.display = 'inline-block'; + var left = getXPos(domSearchBox) + 150; + var top = getYPos(domSearchBox) + 20; + domPopupSearchResultsWindow.style.display = 'block'; + left -= domPopupSearchResults.offsetWidth; + var maxWidth = document.body.clientWidth; + var maxHeight = document.body.clientHeight; + var width = 300; + if (left<10) left=10; + if (width+left+8>maxWidth) width=maxWidth-left-8; + var height = 400; + if (height+top+8>maxHeight) height=maxHeight-top-8; + domPopupSearchResultsWindow.style.top = top + 'px'; + domPopupSearchResultsWindow.style.left = left + 'px'; + domPopupSearchResultsWindow.style.width = width + 'px'; + domPopupSearchResultsWindow.style.height = height + 'px'; + } + } + + if (jsFile) { + loadJS(jsFile, handleResults, this.DOMPopupSearchResultsWindow()); + } else { + handleResults(); + } + + this.lastSearchValue = searchValue; + } + + // -------- Activation Functions + + // Activates or deactivates the search panel, resetting things to + // their default values if necessary. + this.Activate = function(isActive) + { + if (isActive || // open it + this.DOMPopupSearchResultsWindow().style.display == 'block' + ) + { + this.DOMSearchBox().className = 'MSearchBoxActive'; + this.searchActive = true; + } + else if (!isActive) // directly remove the panel + { + this.DOMSearchBox().className = 'MSearchBoxInactive'; + this.searchActive = false; + this.lastSearchValue = '' + this.lastResultsPage = ''; + this.DOMSearchField().value = ''; + } + } +} + +// ----------------------------------------------------------------------- + +// The class that handles everything on the search results page. +function SearchResults(name) +{ + // The number of matches from the last run of . + this.lastMatchCount = 0; + this.lastKey = 0; + this.repeatOn = false; + + // Toggles the visibility of the passed element ID. + this.FindChildElement = function(id) + { + var parentElement = document.getElementById(id); + var element = parentElement.firstChild; + + while (element && element!=parentElement) + { + if (element.nodeName.toLowerCase() == 'div' && element.className == 'SRChildren') + { + return element; + } + + if (element.nodeName.toLowerCase() == 'div' && element.hasChildNodes()) + { + element = element.firstChild; + } + else if (element.nextSibling) + { + element = element.nextSibling; + } + else + { + do + { + element = element.parentNode; + } + while (element && element!=parentElement && !element.nextSibling); + + if (element && element!=parentElement) + { + element = element.nextSibling; + } + } + } + } + + this.Toggle = function(id) + { + var element = this.FindChildElement(id); + if (element) + { + if (element.style.display == 'block') + { + element.style.display = 'none'; + } + else + { + element.style.display = 'block'; + } + } + } + + // Searches for the passed string. If there is no parameter, + // it takes it from the URL query. + // + // Always returns true, since other documents may try to call it + // and that may or may not be possible. + this.Search = function(search) + { + if (!search) // get search word from URL + { + search = window.location.search; + search = search.substring(1); // Remove the leading '?' + search = unescape(search); + } + + search = search.replace(/^ +/, ""); // strip leading spaces + search = search.replace(/ +$/, ""); // strip trailing spaces + search = search.toLowerCase(); + search = convertToId(search); + + var resultRows = document.getElementsByTagName("div"); + var matches = 0; + + var i = 0; + while (i < resultRows.length) + { + var row = resultRows.item(i); + if (row.className == "SRResult") + { + var rowMatchName = row.id.toLowerCase(); + rowMatchName = rowMatchName.replace(/^sr\d*_/, ''); // strip 'sr123_' + + if (search.length<=rowMatchName.length && + rowMatchName.substr(0, search.length)==search) + { + row.style.display = 'block'; + matches++; + } + else + { + row.style.display = 'none'; + } + } + i++; + } + document.getElementById("Searching").style.display='none'; + if (matches == 0) // no results + { + document.getElementById("NoMatches").style.display='block'; + } + else // at least one result + { + document.getElementById("NoMatches").style.display='none'; + } + this.lastMatchCount = matches; + return true; + } + + // return the first item with index index or higher that is visible + this.NavNext = function(index) + { + var focusItem; + while (1) + { + var focusName = 'Item'+index; + focusItem = document.getElementById(focusName); + if (focusItem && focusItem.parentNode.parentNode.style.display=='block') + { + break; + } + else if (!focusItem) // last element + { + break; + } + focusItem=null; + index++; + } + return focusItem; + } + + this.NavPrev = function(index) + { + var focusItem; + while (1) + { + var focusName = 'Item'+index; + focusItem = document.getElementById(focusName); + if (focusItem && focusItem.parentNode.parentNode.style.display=='block') + { + break; + } + else if (!focusItem) // last element + { + break; + } + focusItem=null; + index--; + } + return focusItem; + } + + this.ProcessKeys = function(e) + { + if (e.type == "keydown") + { + this.repeatOn = false; + this.lastKey = e.keyCode; + } + else if (e.type == "keypress") + { + if (!this.repeatOn) + { + if (this.lastKey) this.repeatOn = true; + return false; // ignore first keypress after keydown + } + } + else if (e.type == "keyup") + { + this.lastKey = 0; + this.repeatOn = false; + } + return this.lastKey!=0; + } + + this.Nav = function(evt,itemIndex) + { + var e = (evt) ? evt : window.event; // for IE + if (e.keyCode==13) return true; + if (!this.ProcessKeys(e)) return false; + + if (this.lastKey==38) // Up + { + var newIndex = itemIndex-1; + var focusItem = this.NavPrev(newIndex); + if (focusItem) + { + var child = this.FindChildElement(focusItem.parentNode.parentNode.id); + if (child && child.style.display == 'block') // children visible + { + var n=0; + var tmpElem; + while (1) // search for last child + { + tmpElem = document.getElementById('Item'+newIndex+'_c'+n); + if (tmpElem) + { + focusItem = tmpElem; + } + else // found it! + { + break; + } + n++; + } + } + } + if (focusItem) + { + focusItem.focus(); + } + else // return focus to search field + { + document.getElementById("MSearchField").focus(); + } + } + else if (this.lastKey==40) // Down + { + var newIndex = itemIndex+1; + var focusItem; + var item = document.getElementById('Item'+itemIndex); + var elem = this.FindChildElement(item.parentNode.parentNode.id); + if (elem && elem.style.display == 'block') // children visible + { + focusItem = document.getElementById('Item'+itemIndex+'_c0'); + } + if (!focusItem) focusItem = this.NavNext(newIndex); + if (focusItem) focusItem.focus(); + } + else if (this.lastKey==39) // Right + { + var item = document.getElementById('Item'+itemIndex); + var elem = this.FindChildElement(item.parentNode.parentNode.id); + if (elem) elem.style.display = 'block'; + } + else if (this.lastKey==37) // Left + { + var item = document.getElementById('Item'+itemIndex); + var elem = this.FindChildElement(item.parentNode.parentNode.id); + if (elem) elem.style.display = 'none'; + } + else if (this.lastKey==27) // Escape + { + e.stopPropagation(); + searchBox.CloseResultsWindow(); + document.getElementById("MSearchField").focus(); + } + else if (this.lastKey==13) // Enter + { + return true; + } + return false; + } + + this.NavChild = function(evt,itemIndex,childIndex) + { + var e = (evt) ? evt : window.event; // for IE + if (e.keyCode==13) return true; + if (!this.ProcessKeys(e)) return false; + + if (this.lastKey==38) // Up + { + if (childIndex>0) + { + var newIndex = childIndex-1; + document.getElementById('Item'+itemIndex+'_c'+newIndex).focus(); + } + else // already at first child, jump to parent + { + document.getElementById('Item'+itemIndex).focus(); + } + } + else if (this.lastKey==40) // Down + { + var newIndex = childIndex+1; + var elem = document.getElementById('Item'+itemIndex+'_c'+newIndex); + if (!elem) // last child, jump to parent next parent + { + elem = this.NavNext(itemIndex+1); + } + if (elem) + { + elem.focus(); + } + } + else if (this.lastKey==27) // Escape + { + e.stopPropagation(); + searchBox.CloseResultsWindow(); + document.getElementById("MSearchField").focus(); + } + else if (this.lastKey==13) // Enter + { + return true; + } + return false; + } +} + +function setKeyActions(elem,action) +{ + elem.setAttribute('onkeydown',action); + elem.setAttribute('onkeypress',action); + elem.setAttribute('onkeyup',action); +} + +function setClassAttr(elem,attr) +{ + elem.setAttribute('class',attr); + elem.setAttribute('className',attr); +} + +function createResults(resultsPath) +{ + var results = document.getElementById("SRResults"); + results.innerHTML = ''; + for (var e=0; e + + + + + + +pulsar-client-cpp: include/pulsar/c/string_list.h Source File + + + + + + + + + + +
    +
    + + + + + + +
    +
    pulsar-client-cpp +
    +
    +
    + + + + + + + + + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + + +
    +
    +
    string_list.h
    +
    +
    +
    1
    +
    20#pragma once
    +
    21
    +
    22#include <pulsar/defines.h>
    +
    23
    +
    24#ifdef __cplusplus
    +
    25extern "C" {
    +
    26#endif
    +
    27
    +
    28typedef struct _pulsar_string_list pulsar_string_list_t;
    +
    29
    +
    30PULSAR_PUBLIC pulsar_string_list_t *pulsar_string_list_create();
    +
    31PULSAR_PUBLIC void pulsar_string_list_free(pulsar_string_list_t *list);
    +
    32
    +
    33PULSAR_PUBLIC int pulsar_string_list_size(pulsar_string_list_t *list);
    +
    34
    +
    35PULSAR_PUBLIC void pulsar_string_list_append(pulsar_string_list_t *list, const char *item);
    +
    36
    +
    37PULSAR_PUBLIC const char *pulsar_string_list_get(pulsar_string_list_t *map, int index);
    +
    38
    +
    39#ifdef __cplusplus
    +
    40}
    +
    41#endif
    +
    + +
    +Generated by doxygen 1.9.8 +
    + + diff --git a/static/api/cpp/3.5.x/string__map_8h_source.html b/static/api/cpp/3.5.x/string__map_8h_source.html new file mode 100644 index 000000000000..f348f632e476 --- /dev/null +++ b/static/api/cpp/3.5.x/string__map_8h_source.html @@ -0,0 +1,117 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/c/string_map.h Source File + + + + + + + + + + +
    +
    + + + + + + +
    +
    pulsar-client-cpp +
    +
    +
    + + + + + + + + + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + + +
    +
    +
    string_map.h
    +
    +
    +
    1
    +
    20#pragma once
    +
    21
    +
    22#include <pulsar/defines.h>
    +
    23
    +
    24#ifdef __cplusplus
    +
    25extern "C" {
    +
    26#endif
    +
    27
    +
    28typedef struct _pulsar_string_map pulsar_string_map_t;
    +
    29
    +
    30PULSAR_PUBLIC pulsar_string_map_t *pulsar_string_map_create();
    +
    31PULSAR_PUBLIC void pulsar_string_map_free(pulsar_string_map_t *map);
    +
    32
    +
    33PULSAR_PUBLIC int pulsar_string_map_size(pulsar_string_map_t *map);
    +
    34
    +
    35PULSAR_PUBLIC void pulsar_string_map_put(pulsar_string_map_t *map, const char *key, const char *value);
    +
    36
    +
    37PULSAR_PUBLIC const char *pulsar_string_map_get(pulsar_string_map_t *map, const char *key);
    +
    38
    +
    39PULSAR_PUBLIC const char *pulsar_string_map_get_key(pulsar_string_map_t *map, int idx);
    +
    40PULSAR_PUBLIC const char *pulsar_string_map_get_value(pulsar_string_map_t *map, int idx);
    +
    41
    +
    42#ifdef __cplusplus
    +
    43}
    +
    44#endif
    +
    + +
    +Generated by doxygen 1.9.8 +
    + + diff --git a/static/api/cpp/3.5.x/structpulsar_1_1_table_view_configuration-members.html b/static/api/cpp/3.5.x/structpulsar_1_1_table_view_configuration-members.html new file mode 100644 index 000000000000..6d5448cdc722 --- /dev/null +++ b/static/api/cpp/3.5.x/structpulsar_1_1_table_view_configuration-members.html @@ -0,0 +1,91 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    pulsar-client-cpp +
    +
    +
    + + + + + + + + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + + +
    +
    +
    pulsar::TableViewConfiguration Member List
    +
    +
    + +

    This is the complete list of members for pulsar::TableViewConfiguration, including all inherited members.

    + + + +
    schemaInfo (defined in pulsar::TableViewConfiguration)pulsar::TableViewConfiguration
    subscriptionName (defined in pulsar::TableViewConfiguration)pulsar::TableViewConfiguration
    + +
    +Generated by doxygen 1.9.8 +
    + + diff --git a/static/api/cpp/3.5.x/structpulsar_1_1_table_view_configuration.html b/static/api/cpp/3.5.x/structpulsar_1_1_table_view_configuration.html new file mode 100644 index 000000000000..6e45949c2497 --- /dev/null +++ b/static/api/cpp/3.5.x/structpulsar_1_1_table_view_configuration.html @@ -0,0 +1,102 @@ + + + + + + + +pulsar-client-cpp: pulsar::TableViewConfiguration Struct Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    pulsar-client-cpp +
    +
    +
    + + + + + + + + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + + +
    +
    +
    +Public Attributes | +List of all members
    +
    pulsar::TableViewConfiguration Struct Reference
    +
    +
    + + + + + + +

    +Public Attributes

    +SchemaInfo schemaInfo
     
    +std::string subscriptionName
     
    +
    The documentation for this struct was generated from the following file: +
    + +
    +Generated by doxygen 1.9.8 +
    + + diff --git a/static/api/cpp/3.5.x/structpulsar__consumer__batch__receive__policy__t-members.html b/static/api/cpp/3.5.x/structpulsar__consumer__batch__receive__policy__t-members.html new file mode 100644 index 000000000000..6d1c9acc4306 --- /dev/null +++ b/static/api/cpp/3.5.x/structpulsar__consumer__batch__receive__policy__t-members.html @@ -0,0 +1,88 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    pulsar-client-cpp +
    +
    +
    + + + + + + + + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + +
    +
    +
    pulsar_consumer_batch_receive_policy_t Member List
    +
    +
    + +

    This is the complete list of members for pulsar_consumer_batch_receive_policy_t, including all inherited members.

    + + + + +
    maxNumBytes (defined in pulsar_consumer_batch_receive_policy_t)pulsar_consumer_batch_receive_policy_t
    maxNumMessages (defined in pulsar_consumer_batch_receive_policy_t)pulsar_consumer_batch_receive_policy_t
    timeoutMs (defined in pulsar_consumer_batch_receive_policy_t)pulsar_consumer_batch_receive_policy_t
    + +
    +Generated by doxygen 1.9.8 +
    + + diff --git a/static/api/cpp/3.5.x/structpulsar__consumer__batch__receive__policy__t.html b/static/api/cpp/3.5.x/structpulsar__consumer__batch__receive__policy__t.html new file mode 100644 index 000000000000..dccc5b250ccb --- /dev/null +++ b/static/api/cpp/3.5.x/structpulsar__consumer__batch__receive__policy__t.html @@ -0,0 +1,101 @@ + + + + + + + +pulsar-client-cpp: pulsar_consumer_batch_receive_policy_t Struct Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    pulsar-client-cpp +
    +
    +
    + + + + + + + + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + +
    +
    +
    +Public Attributes | +List of all members
    +
    pulsar_consumer_batch_receive_policy_t Struct Reference
    +
    +
    + + + + + + + + +

    +Public Attributes

    +int maxNumMessages
     
    +long maxNumBytes
     
    +long timeoutMs
     
    +
    The documentation for this struct was generated from the following file: +
    + +
    +Generated by doxygen 1.9.8 +
    + + diff --git a/static/api/cpp/3.5.x/structpulsar__consumer__config__dead__letter__policy__t-members.html b/static/api/cpp/3.5.x/structpulsar__consumer__config__dead__letter__policy__t-members.html new file mode 100644 index 000000000000..979831a4be1f --- /dev/null +++ b/static/api/cpp/3.5.x/structpulsar__consumer__config__dead__letter__policy__t-members.html @@ -0,0 +1,88 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    pulsar-client-cpp +
    +
    +
    + + + + + + + + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + +
    +
    +
    pulsar_consumer_config_dead_letter_policy_t Member List
    +
    +
    + +

    This is the complete list of members for pulsar_consumer_config_dead_letter_policy_t, including all inherited members.

    + + + + +
    dead_letter_topic (defined in pulsar_consumer_config_dead_letter_policy_t)pulsar_consumer_config_dead_letter_policy_t
    initial_subscription_name (defined in pulsar_consumer_config_dead_letter_policy_t)pulsar_consumer_config_dead_letter_policy_t
    max_redeliver_count (defined in pulsar_consumer_config_dead_letter_policy_t)pulsar_consumer_config_dead_letter_policy_t
    + +
    +Generated by doxygen 1.9.8 +
    + + diff --git a/static/api/cpp/3.5.x/structpulsar__consumer__config__dead__letter__policy__t.html b/static/api/cpp/3.5.x/structpulsar__consumer__config__dead__letter__policy__t.html new file mode 100644 index 000000000000..accd77ded129 --- /dev/null +++ b/static/api/cpp/3.5.x/structpulsar__consumer__config__dead__letter__policy__t.html @@ -0,0 +1,101 @@ + + + + + + + +pulsar-client-cpp: pulsar_consumer_config_dead_letter_policy_t Struct Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    pulsar-client-cpp +
    +
    +
    + + + + + + + + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + +
    +
    +
    +Public Attributes | +List of all members
    +
    pulsar_consumer_config_dead_letter_policy_t Struct Reference
    +
    +
    + + + + + + + + +

    +Public Attributes

    +const char * dead_letter_topic
     
    +int max_redeliver_count
     
    +const char * initial_subscription_name
     
    +
    The documentation for this struct was generated from the following file: +
    + +
    +Generated by doxygen 1.9.8 +
    + + diff --git a/static/api/cpp/3.5.x/structpulsar__logger__t-members.html b/static/api/cpp/3.5.x/structpulsar__logger__t-members.html new file mode 100644 index 000000000000..73b016cd9be3 --- /dev/null +++ b/static/api/cpp/3.5.x/structpulsar__logger__t-members.html @@ -0,0 +1,88 @@ + + + + + + + +pulsar-client-cpp: Member List + + + + + + + + + + +
    +
    + + + + + + +
    +
    pulsar-client-cpp +
    +
    +
    + + + + + + + + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + +
    +
    +
    pulsar_logger_t Member List
    +
    +
    + +

    This is the complete list of members for pulsar_logger_t, including all inherited members.

    + + + + +
    ctx (defined in pulsar_logger_t)pulsar_logger_t
    is_enabled (defined in pulsar_logger_t)pulsar_logger_t
    log (defined in pulsar_logger_t)pulsar_logger_t
    + +
    +Generated by doxygen 1.9.8 +
    + + diff --git a/static/api/cpp/3.5.x/structpulsar__logger__t.html b/static/api/cpp/3.5.x/structpulsar__logger__t.html new file mode 100644 index 000000000000..829fc6a025c6 --- /dev/null +++ b/static/api/cpp/3.5.x/structpulsar__logger__t.html @@ -0,0 +1,101 @@ + + + + + + + +pulsar-client-cpp: pulsar_logger_t Struct Reference + + + + + + + + + + +
    +
    + + + + + + +
    +
    pulsar-client-cpp +
    +
    +
    + + + + + + + + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + +
    +
    +
    +Public Attributes | +List of all members
    +
    pulsar_logger_t Struct Reference
    +
    +
    + + + + + + + + +

    +Public Attributes

    +void * ctx
     
    +bool(* is_enabled )(pulsar_logger_level_t level, void *ctx)
     
    +pulsar_logger log
     
    +
    The documentation for this struct was generated from the following file: +
    + +
    +Generated by doxygen 1.9.8 +
    + + diff --git a/static/api/cpp/3.5.x/sync_off.png b/static/api/cpp/3.5.x/sync_off.png new file mode 100644 index 000000000000..3b443fc62892 Binary files /dev/null and b/static/api/cpp/3.5.x/sync_off.png differ diff --git a/static/api/cpp/3.5.x/sync_on.png b/static/api/cpp/3.5.x/sync_on.png new file mode 100644 index 000000000000..e08320fb64e6 Binary files /dev/null and b/static/api/cpp/3.5.x/sync_on.png differ diff --git a/static/api/cpp/3.5.x/tab_a.png b/static/api/cpp/3.5.x/tab_a.png new file mode 100644 index 000000000000..3b725c41c5a5 Binary files /dev/null and b/static/api/cpp/3.5.x/tab_a.png differ diff --git a/static/api/cpp/3.5.x/tab_ad.png b/static/api/cpp/3.5.x/tab_ad.png new file mode 100644 index 000000000000..e34850acfc24 Binary files /dev/null and b/static/api/cpp/3.5.x/tab_ad.png differ diff --git a/static/api/cpp/3.5.x/tab_b.png b/static/api/cpp/3.5.x/tab_b.png new file mode 100644 index 000000000000..e2b4a8638cb3 Binary files /dev/null and b/static/api/cpp/3.5.x/tab_b.png differ diff --git a/static/api/cpp/3.5.x/tab_bd.png b/static/api/cpp/3.5.x/tab_bd.png new file mode 100644 index 000000000000..91c25249869f Binary files /dev/null and b/static/api/cpp/3.5.x/tab_bd.png differ diff --git a/static/api/cpp/3.5.x/tab_h.png b/static/api/cpp/3.5.x/tab_h.png new file mode 100644 index 000000000000..fd5cb705488e Binary files /dev/null and b/static/api/cpp/3.5.x/tab_h.png differ diff --git a/static/api/cpp/3.5.x/tab_hd.png b/static/api/cpp/3.5.x/tab_hd.png new file mode 100644 index 000000000000..2489273d4ce1 Binary files /dev/null and b/static/api/cpp/3.5.x/tab_hd.png differ diff --git a/static/api/cpp/3.5.x/tab_s.png b/static/api/cpp/3.5.x/tab_s.png new file mode 100644 index 000000000000..ab478c95b673 Binary files /dev/null and b/static/api/cpp/3.5.x/tab_s.png differ diff --git a/static/api/cpp/3.5.x/tab_sd.png b/static/api/cpp/3.5.x/tab_sd.png new file mode 100644 index 000000000000..757a565ced47 Binary files /dev/null and b/static/api/cpp/3.5.x/tab_sd.png differ diff --git a/static/api/cpp/3.5.x/table__view_8h_source.html b/static/api/cpp/3.5.x/table__view_8h_source.html new file mode 100644 index 000000000000..85f689b82307 --- /dev/null +++ b/static/api/cpp/3.5.x/table__view_8h_source.html @@ -0,0 +1,136 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/c/table_view.h Source File + + + + + + + + + + +
    +
    + + + + + + +
    +
    pulsar-client-cpp +
    +
    +
    + + + + + + + + + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + + +
    +
    +
    table_view.h
    +
    +
    +
    1
    +
    19#pragma once
    +
    20
    +
    21#include <pulsar/defines.h>
    +
    22
    +
    23#ifdef __cplusplus
    +
    24extern "C" {
    +
    25#endif
    +
    26
    +
    27#include <pulsar/c/message.h>
    +
    28#include <pulsar/c/messages.h>
    +
    29#include <pulsar/c/result.h>
    +
    30#include <stdint.h>
    +
    31
    +
    32typedef struct _pulsar_table_view pulsar_table_view_t;
    +
    33
    +
    34typedef void (*pulsar_table_view_action)(const char *key, const void *value, size_t value_size, void *ctx);
    +
    35typedef void (*pulsar_result_callback)(pulsar_result, void *);
    +
    36
    +
    69PULSAR_PUBLIC bool pulsar_table_view_retrieve_value(pulsar_table_view_t *table_view, const char *key,
    +
    70 void **value, size_t *value_size);
    +
    71
    +
    85PULSAR_PUBLIC bool pulsar_table_view_get_value(pulsar_table_view_t *table_view, const char *key, void **value,
    +
    86 size_t *value_size);
    +
    87
    +
    94PULSAR_PUBLIC bool pulsar_table_view_contain_key(pulsar_table_view_t *table_view, const char *key);
    +
    95
    +
    101PULSAR_PUBLIC int pulsar_table_view_size(pulsar_table_view_t *table_view);
    +
    102
    +
    107PULSAR_PUBLIC void pulsar_table_view_for_each(pulsar_table_view_t *table_view,
    +
    108 pulsar_table_view_action action, void *ctx);
    +
    109
    +
    114PULSAR_PUBLIC void pulsar_table_view_for_each_add_listen(pulsar_table_view_t *table_view,
    +
    115 pulsar_table_view_action action, void *ctx);
    +
    116
    +
    121PULSAR_PUBLIC void pulsar_table_view_free(pulsar_table_view_t *table_view);
    +
    122
    +
    128PULSAR_PUBLIC pulsar_result pulsar_table_view_close(pulsar_table_view_t *table_view);
    +
    129
    +
    136PULSAR_PUBLIC void pulsar_table_view_close_async(pulsar_table_view_t *table_view,
    +
    137 pulsar_result_callback callback, void *ctx);
    +
    138
    +
    139#ifdef __cplusplus
    +
    140}
    +
    141#endif
    +
    + +
    +Generated by doxygen 1.9.8 +
    + + diff --git a/static/api/cpp/3.5.x/table__view__configuration_8h_source.html b/static/api/cpp/3.5.x/table__view__configuration_8h_source.html new file mode 100644 index 000000000000..57d8e66c3645 --- /dev/null +++ b/static/api/cpp/3.5.x/table__view__configuration_8h_source.html @@ -0,0 +1,121 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/c/table_view_configuration.h Source File + + + + + + + + + + +
    +
    + + + + + + +
    +
    pulsar-client-cpp +
    +
    +
    + + + + + + + + + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + + +
    +
    +
    table_view_configuration.h
    +
    +
    +
    1
    +
    20#pragma once
    +
    21
    +
    22#include <pulsar/defines.h>
    +
    23
    +
    24#include "producer_configuration.h"
    +
    25
    +
    26#ifdef __cplusplus
    +
    27extern "C" {
    +
    28#endif
    +
    29
    +
    30typedef struct _pulsar_table_view_configuration pulsar_table_view_configuration_t;
    +
    31
    +
    32PULSAR_PUBLIC pulsar_table_view_configuration_t *pulsar_table_view_configuration_create();
    +
    33
    +
    34PULSAR_PUBLIC void pulsar_table_view_configuration_free(pulsar_table_view_configuration_t *conf);
    +
    35
    +
    36PULSAR_PUBLIC void pulsar_table_view_configuration_set_schema_info(
    +
    37 pulsar_table_view_configuration_t *table_view_configuration_t, pulsar_schema_type schemaType,
    +
    38 const char *name, const char *schema, pulsar_string_map_t *properties);
    +
    39
    +
    40PULSAR_PUBLIC void pulsar_table_view_configuration_set_subscription_name(
    +
    41 pulsar_table_view_configuration_t *table_view_configuration_t, const char *subscription_name);
    +
    42
    +
    43PULSAR_PUBLIC const char *pulsar_table_view_configuration_get_subscription_name(
    +
    44 pulsar_table_view_configuration_t *table_view_configuration_t);
    +
    45
    +
    46#ifdef __cplusplus
    +
    47}
    +
    48#endif
    +
    + +
    +Generated by doxygen 1.9.8 +
    + + diff --git a/static/api/cpp/3.5.x/tabs.css b/static/api/cpp/3.5.x/tabs.css new file mode 100644 index 000000000000..71c8a4704c0e --- /dev/null +++ b/static/api/cpp/3.5.x/tabs.css @@ -0,0 +1 @@ +.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:var(--nav-menu-button-color);-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:var(--nav-gradient-image)}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:var(--font-family-nav);font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:var(--nav-text-normal-shadow);color:var(--nav-text-normal-color);outline:0}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:var(--nav-menu-toggle-color);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:var(--nav-menu-background-color)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:var(--nav-menu-background-color);background-image:none}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:var(--nav-gradient-image);line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:var(--nav-text-normal-color) transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:var(--nav-separator-image);background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox a:hover span.sub-arrow{border-color:var(--nav-text-hover-color) transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent var(--nav-menu-background-color) transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:var(--nav-menu-background-color);-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent var(--nav-menu-foreground-color);border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:var(--nav-menu-foreground-color);background-image:none;border:0 !important;color:var(--nav-menu-foreground-color);background-image:none}.sm-dox ul a:hover{background-image:var(--nav-gradient-active-image);background-repeat:repeat-x;color:var(--nav-text-hover-color);text-shadow:var(--nav-text-hover-shadow)}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent var(--nav-text-hover-color)}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:var(--nav-menu-background-color);height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent var(--nav-menu-foreground-color) transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:var(--nav-menu-foreground-color) transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:var(--nav-gradient-image)}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:var(--nav-menu-background-color)}} \ No newline at end of file diff --git a/static/api/cpp/3.5.x/version_8h_source.html b/static/api/cpp/3.5.x/version_8h_source.html new file mode 100644 index 000000000000..7caa76bcc6ca --- /dev/null +++ b/static/api/cpp/3.5.x/version_8h_source.html @@ -0,0 +1,95 @@ + + + + + + + +pulsar-client-cpp: include/pulsar/c/version.h Source File + + + + + + + + + + +
    +
    + + + + + + +
    +
    pulsar-client-cpp +
    +
    +
    + + + + + + + + + +
    +
    + + +
    +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    +
    + + +
    +
    +
    version.h
    +
    +
    +
    1
    +
    20#pragma once
    +
    21
    +
    22#include <pulsar/Version.h>
    +
    + +
    +Generated by doxygen 1.9.8 +
    + +