ClientConfiguration.h

 
#ifndef PULSAR_CLIENTCONFIGURATION_H_
#define PULSAR_CLIENTCONFIGURATION_H_
 
#include <pulsar/Authentication.h>
#include <pulsar/Logger.h>
#include <pulsar/defines.h>
 
#include <cstdint>
 
namespace pulsar {
class PulsarWrapper;
struct ClientConfigurationImpl;
class PULSAR_PUBLIC ClientConfiguration {
   public:
    ClientConfiguration();
    ~ClientConfiguration();
    ClientConfiguration(const ClientConfiguration&);
    ClientConfiguration& operator=(const ClientConfiguration&);
    enum ProxyProtocol : uint8_t
    {
        SNI = 0
    };
 
    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;
 
    ClientConfiguration& setKeepAliveIntervalInSeconds(unsigned int keepAliveIntervalInSeconds);
 
    unsigned int getKeepAliveIntervalInSeconds() const;
 
    friend class ClientImpl;
    friend class PulsarWrapper;
 
   private:
    const AuthenticationPtr& getAuthPtr() const;
    std::shared_ptr<ClientConfigurationImpl> impl_;
 
    // By default, when the client connects to the broker, a version string like "Pulsar-CPP-v<x.y.z>" will be
    // carried and saved by the broker. The client version string could be queried from the topic stats.
    //
    // This method provides a way to add more description to a specific `Client` instance. If it's configured,
    // the description will be appended to the original client version string, with '-' as the separator.
    //
    // For example, if the client version is 3.2.0, and the description is "forked", the final client version
    // string will be "Pulsar-CPP-v3.2.0-forked".
    //
    // NOTE: This method should only be called by the PulsarWrapper and the length should not exceed 64.
    //
    // For example, you can add a PulsarWrapper class like:
    //
    // ```c++
    // namespace pulsar {
    // class PulsarWrapper {
    //     static ClientConfiguration clientConfig() {
    //         ClientConfiguration conf;
    //         conf.setDescription("forked");
    //         return conf;
    //     }
    // };
    // }
    // ```
    //
    // Then, call the method before passing the `conf` to the constructor of `Client`:
    //
    // ```c++
    // auto conf = PulsarWrapper::clientConfig();
    // // Set other attributes of `conf` here...
    // Client client{"pulsar://localhost:6650", conf);
    // ```
    ClientConfiguration& setDescription(const std::string& description);
 
    const std::string& getDescription() const noexcept;
};
}  // namespace pulsar
 
#endif /* PULSAR_CLIENTCONFIGURATION_H_ */