Mqtt5Client.h

Go to the documentation of this file.

#pragma once

#include <aws/crt/Config.h>
#include <aws/crt/Exports.h>
#include <aws/crt/auth/Sigv4Signing.h>
#include <aws/crt/mqtt/Mqtt5Client.h>
#include <aws/iot/MqttCommon.h>

#if !BYO_CRYPTO

namespace Aws
{
    using namespace Crt::Mqtt5;

    namespace Io
    {
        class ClientBootstrap;
        class SocketOptions;
        class TlsContextOptions;
        class WebsocketConfig;
    } // namespace Io

    namespace Iot
    {

        class AWS_CRT_CPP_API Mqtt5CustomAuthConfig
        {
          public:
            Mqtt5CustomAuthConfig(Crt::Allocator *allocator = Crt::ApiAllocator()) noexcept;
            virtual ~Mqtt5CustomAuthConfig();

            Mqtt5CustomAuthConfig(const Mqtt5CustomAuthConfig &rhs);
            Mqtt5CustomAuthConfig(Mqtt5CustomAuthConfig &&rhs) = delete;

            Mqtt5CustomAuthConfig &operator=(const Mqtt5CustomAuthConfig &rhs);
            Mqtt5CustomAuthConfig &operator=(Mqtt5CustomAuthConfig &&rhs) = delete;

            Mqtt5CustomAuthConfig &WithAuthorizerName(Crt::String authName);
            Mqtt5CustomAuthConfig &WithUsername(Crt::String username);
            Mqtt5CustomAuthConfig &WithPassword(Crt::ByteCursor password);
            Mqtt5CustomAuthConfig &WithTokenKeyName(Crt::String tokenKeyName);
            Mqtt5CustomAuthConfig &WithTokenValue(Crt::String tokenValue);
            Mqtt5CustomAuthConfig &WithTokenSignature(Crt::String tokenSignature);

            const Crt::Optional<Crt::String> &GetAuthorizerName();
            const Crt::Optional<Crt::String> &GetUsername();
            const Crt::Optional<Crt::ByteCursor> &GetPassword();
            const Crt::Optional<Crt::String> &GetTokenKeyName();
            const Crt::Optional<Crt::String> &GetTokenValue();
            const Crt::Optional<Crt::String> &GetTokenSignature();

          private:
            Crt::Optional<Crt::String> m_authorizerName;

            Crt::Optional<Crt::String> m_username;

            Crt::Optional<Crt::ByteCursor> m_password;

            Crt::Optional<Crt::String> m_tokenKeyName;

            Crt::Optional<Crt::String> m_tokenValue;

            Crt::Optional<Crt::String> m_tokenSignature;

            Crt::ByteBuf m_passwordStorage;
            Crt::Allocator *m_allocator;
        };

        class AWS_CRT_CPP_API Mqtt5ClientBuilder final
        {
          public:
            static std::shared_ptr<Mqtt5ClientBuilder> CreateMqtt5ClientBuilderWithMtlsFromPath(
                const Crt::String &hostName,
                const char *certPath,
                const char *pkeyPath,
                Crt::Allocator *allocator = Crt::ApiAllocator()) noexcept;

            static std::shared_ptr<Mqtt5ClientBuilder> CreateMqtt5ClientBuilderWithMtlsFromMemory(
                const Crt::String &hostName,
                const Crt::ByteCursor &cert,
                const Crt::ByteCursor &pkey,
                Crt::Allocator *allocator = Crt::ApiAllocator()) noexcept;

            static std::shared_ptr<Mqtt5ClientBuilder> CreateMqtt5ClientBuilderWithMtlsPkcs11(
                const Crt::String &hostName,
                const Crt::Io::TlsContextPkcs11Options &pkcs11Options,
                Crt::Allocator *allocator = Crt::ApiAllocator()) noexcept;

            static std::shared_ptr<Mqtt5ClientBuilder> CreateMqtt5ClientBuilderWithMtlsPkcs12(
                const Crt::String &hostName,
                const struct Pkcs12Options &options,
                Crt::Allocator *allocator = Crt::ApiAllocator()) noexcept;

            static std::shared_ptr<Mqtt5ClientBuilder> CreateMqtt5ClientBuilderWithWindowsCertStorePath(
                const Crt::String &hostName,
                const char *windowsCertStorePath,
                Crt::Allocator *allocator = Crt::ApiAllocator()) noexcept;

            static std::shared_ptr<Mqtt5ClientBuilder> CreateMqtt5ClientBuilderWithWebsocket(
                const Crt::String &hostName,
                const WebsocketConfig &config,
                Crt::Allocator *allocator = Crt::ApiAllocator()) noexcept;

            static std::shared_ptr<Mqtt5ClientBuilder> CreateMqtt5ClientBuilderWithCustomAuthorizer(
                const Crt::String &hostName,
                const Mqtt5CustomAuthConfig &customAuthConfig,
                Crt::Allocator *allocator) noexcept;

            static std::shared_ptr<Mqtt5ClientBuilder> CreateMqtt5ClientBuilderWithCustomAuthorizerWebsocket(
                const Crt::String &hostName,
                const Mqtt5CustomAuthConfig &customAuthConfig,
                const WebsocketConfig &config,
                Crt::Allocator *allocator) noexcept;

            Mqtt5ClientBuilder &WithHostName(Crt::String hostname);

            Mqtt5ClientBuilder &WithPort(uint32_t port) noexcept;

            Mqtt5ClientBuilder &WithBootstrap(Crt::Io::ClientBootstrap *bootStrap) noexcept;

            Mqtt5ClientBuilder &WithCertificateAuthority(const char *caPath) noexcept;

            Mqtt5ClientBuilder &WithCertificateAuthority(const Crt::ByteCursor &cert) noexcept;

            Mqtt5ClientBuilder &WithTlsCipherPreference(aws_tls_cipher_pref cipherPref) noexcept;

            Mqtt5ClientBuilder &WithSocketOptions(Crt::Io::SocketOptions socketOptions) noexcept;

            Mqtt5ClientBuilder &WithHttpProxyOptions(
                const Crt::Http::HttpClientConnectionProxyOptions &proxyOptions) noexcept;

            Mqtt5ClientBuilder &WithCustomAuthorizer(const Iot::Mqtt5CustomAuthConfig &config) noexcept;

            Mqtt5ClientBuilder &WithConnectOptions(std::shared_ptr<ConnectPacket> packetConnect) noexcept;

            Mqtt5ClientBuilder &WithSessionBehavior(ClientSessionBehaviorType sessionBehavior) noexcept;

            Mqtt5ClientBuilder &WithClientExtendedValidationAndFlowControl(
                ClientExtendedValidationAndFlowControl clientExtendedValidationAndFlowControl) noexcept;

            Mqtt5ClientBuilder &WithOfflineQueueBehavior(
                ClientOperationQueueBehaviorType offlineQueueBehavior) noexcept;

            Mqtt5ClientBuilder &WithReconnectOptions(ReconnectOptions reconnectOptions) noexcept;

            Mqtt5ClientBuilder &WithTopicAliasingOptions(TopicAliasingOptions topicAliasingOptions) noexcept;

            Mqtt5ClientBuilder &WithMinConnectedTimeToResetReconnectDelayMs(
                uint64_t minConnectedTimeToResetReconnectDelayMs) noexcept;

            Mqtt5ClientBuilder &WithPingTimeoutMs(uint32_t pingTimeoutMs) noexcept;

            Mqtt5ClientBuilder &WithConnackTimeoutMs(uint32_t connackTimeoutMs) noexcept;

            Mqtt5ClientBuilder &WithAckTimeoutSec(uint32_t ackTimeoutSec) noexcept;

            Mqtt5ClientBuilder &WithAckTimeoutSeconds(uint32_t ackTimeoutSec) noexcept;

            Mqtt5ClientBuilder &WithSdkName(const Crt::String &sdkName);

            Mqtt5ClientBuilder &WithSdkVersion(const Crt::String &sdkVersion);

            std::shared_ptr<Mqtt5Client> Build() noexcept;

            explicit operator bool() const noexcept { return m_lastError == 0; }

            int LastError() const noexcept { return m_lastError ? m_lastError : AWS_ERROR_UNKNOWN; }

            ~Mqtt5ClientBuilder()
            {
                if (m_options)
                {
                    delete m_options;
                }
            };
            Mqtt5ClientBuilder(const Mqtt5ClientBuilder &) = delete;
            Mqtt5ClientBuilder(Mqtt5ClientBuilder &&) = delete;
            Mqtt5ClientBuilder &operator=(const Mqtt5ClientBuilder &) = delete;
            Mqtt5ClientBuilder &operator=(Mqtt5ClientBuilder &&) = delete;

            Mqtt5ClientBuilder &WithClientConnectionSuccessCallback(OnConnectionSuccessHandler callback) noexcept;

            Mqtt5ClientBuilder &WithClientConnectionFailureCallback(OnConnectionFailureHandler callback) noexcept;

            Mqtt5ClientBuilder &WithClientDisconnectionCallback(OnDisconnectionHandler callback) noexcept;

            Mqtt5ClientBuilder &WithClientStoppedCallback(OnStoppedHandler callback) noexcept;

            Mqtt5ClientBuilder &WithClientAttemptingConnectCallback(OnAttemptingConnectHandler callback) noexcept;

            Mqtt5ClientBuilder &WithPublishReceivedCallback(OnPublishReceivedHandler callback) noexcept;

            static Mqtt5ClientBuilder *NewMqtt5ClientBuilderWithMtlsFromPath(
                const Crt::String hostName,
                const char *certPath,
                const char *pkeyPath,
                Crt::Allocator *allocator = Crt::ApiAllocator()) noexcept;

            static Mqtt5ClientBuilder *NewMqtt5ClientBuilderWithMtlsFromMemory(
                const Crt::String hostName,
                const Crt::ByteCursor &cert,
                const Crt::ByteCursor &pkey,
                Crt::Allocator *allocator = Crt::ApiAllocator()) noexcept;

            static Mqtt5ClientBuilder *NewMqtt5ClientBuilderWithMtlsPkcs11(
                const Crt::String hostName,
                const Crt::Io::TlsContextPkcs11Options &pkcs11Options,
                Crt::Allocator *allocator = Crt::ApiAllocator()) noexcept;

            static Mqtt5ClientBuilder *NewMqtt5ClientBuilderWithMtlsPkcs12(
                const Crt::String hostName,
                const struct Pkcs12Options &options,
                Crt::Allocator *allocator = Crt::ApiAllocator()) noexcept;

            static Mqtt5ClientBuilder *NewMqtt5ClientBuilderWithWindowsCertStorePath(
                const Crt::String hostName,
                const char *windowsCertStorePath,
                Crt::Allocator *allocator = Crt::ApiAllocator()) noexcept;

            static Mqtt5ClientBuilder *NewMqtt5ClientBuilderWithWebsocket(
                const Crt::String hostName,
                const WebsocketConfig &config,
                Crt::Allocator *allocator = Crt::ApiAllocator()) noexcept;

            static Mqtt5ClientBuilder *NewMqtt5ClientBuilderWithCustomAuthorizer(
                const Crt::String hostName,
                const Mqtt5CustomAuthConfig &customAuthConfig,
                Crt::Allocator *allocator) noexcept;

            static Mqtt5ClientBuilder *NewMqtt5ClientBuilderWithCustomAuthorizerWebsocket(
                const Crt::String hostName,
                const Mqtt5CustomAuthConfig &customAuthConfig,
                const WebsocketConfig &config,
                Crt::Allocator *allocator) noexcept;

          private:
            // Common setup shared by all valid constructors
            Mqtt5ClientBuilder(Crt::Allocator *allocator) noexcept;
            // Common setup shared by all valid constructors
            Mqtt5ClientBuilder(int error, Crt::Allocator *allocator) noexcept;

            /*
             * Creates a new Mqtt5ClientBuilder instance with default values.
             */
            static std::shared_ptr<Mqtt5ClientBuilder> CreateMqtt5ClientBuilder(
                Crt::Allocator *allocator = Crt::ApiAllocator()) noexcept;

            Crt::Allocator *m_allocator;

            uint32_t m_port;

            Crt::Optional<Crt::Io::TlsContextOptions> m_tlsConnectionOptions;

            Crt::Optional<Crt::Http::HttpClientConnectionProxyOptions> m_proxyOptions;

            Crt::Optional<WebsocketConfig> m_websocketConfig;

            Crt::Optional<Mqtt5CustomAuthConfig> m_customAuthConfig;

            std::shared_ptr<ConnectPacket> m_connectOptions;

            Crt::Mqtt5::Mqtt5ClientOptions *m_options;

            /* Error */
            int m_lastError;

            bool m_enableMetricsCollection;
            Crt::String m_sdkName = "IoTDeviceSDK/CPP";
            Crt::String m_sdkVersion = AWS_CRT_CPP_VERSION;
        };

    } // namespace Iot
} // namespace Aws

#endif // !BYO_CRYPTO