MqttClient.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/IoTSDKMetrics.h>
#include <aws/crt/mqtt/MqttConnection.h>
#include <aws/iot/MqttCommon.h>

#if !BYO_CRYPTO

namespace Aws
{
    namespace Iot
    {
        class MqttClient;

        class AWS_CRT_CPP_API MqttClientConnectionConfig final
        {
          public:
            static MqttClientConnectionConfig CreateInvalid(int lastError) noexcept;

            MqttClientConnectionConfig(
                const Crt::String &endpoint,
                uint32_t port,
                const Crt::Io::SocketOptions &socketOptions,
                Crt::Io::TlsContext &&tlsContext,
                bool enableMetrics = true,
                const Crt::Optional<Crt::Mqtt::AWSIoTMetrics> &sdkMetrics = Crt::Optional<Crt::Mqtt::AWSIoTMetrics>());

            MqttClientConnectionConfig(
                const Crt::String &endpoint,
                uint32_t port,
                const Crt::Io::SocketOptions &socketOptions,
                Crt::Io::TlsContext &&tlsContext,
                Crt::Mqtt::OnWebSocketHandshakeIntercept &&interceptor,
                const Crt::Optional<Crt::Http::HttpClientConnectionProxyOptions> &proxyOptions,
                bool enableMetrics = true,
                const Crt::Optional<Crt::Mqtt::AWSIoTMetrics> &sdkMetrics = Crt::Optional<Crt::Mqtt::AWSIoTMetrics>());

            explicit operator bool() const noexcept { return m_context ? true : false; }

            int LastError() const noexcept { return m_lastError; }

          private:
            MqttClientConnectionConfig(int lastError) noexcept;

            MqttClientConnectionConfig(
                const Crt::String &endpoint,
                uint32_t port,
                const Crt::Io::SocketOptions &socketOptions,
                Crt::Io::TlsContext &&tlsContext,
                const Crt::Optional<Crt::Http::HttpClientConnectionProxyOptions> &proxyOptions,
                bool enableMetrics = true,
                const Crt::Optional<Crt::Mqtt::AWSIoTMetrics> &sdkMetrics = Crt::Optional<Crt::Mqtt::AWSIoTMetrics>());

            Crt::String m_endpoint;
            uint32_t m_port;
            Crt::Io::TlsContext m_context;
            Crt::Io::SocketOptions m_socketOptions;
            Crt::Mqtt::OnWebSocketHandshakeIntercept m_webSocketInterceptor;
            Crt::String m_username;
            Crt::String m_password;
            Crt::Optional<Crt::Http::HttpClientConnectionProxyOptions> m_proxyOptions;
            bool m_enableMetricsCollection;
            Crt::Optional<Crt::Mqtt::AWSIoTMetrics> m_sdkMetrics;
            int m_lastError;

            friend class MqttClient;
            friend class MqttClientConnectionConfigBuilder;
        };

        class AWS_CRT_CPP_API MqttClientConnectionConfigBuilder final
        {
          public:
            MqttClientConnectionConfigBuilder();

            MqttClientConnectionConfigBuilder(
                const char *certPath,
                const char *pkeyPath,
                Crt::Allocator *allocator = Crt::ApiAllocator()) noexcept;

            MqttClientConnectionConfigBuilder(
                const Crt::ByteCursor &cert,
                const Crt::ByteCursor &pkey,
                Crt::Allocator *allocator = Crt::ApiAllocator()) noexcept;

            MqttClientConnectionConfigBuilder(
                const Crt::Io::TlsContextPkcs11Options &pkcs11Options,
                Crt::Allocator *allocator = Crt::ApiAllocator()) noexcept;

            MqttClientConnectionConfigBuilder(
                const struct Pkcs12Options &options,
                Crt::Allocator *allocator = Crt::ApiAllocator()) noexcept;

            MqttClientConnectionConfigBuilder(
                const char *windowsCertStorePath,
                Crt::Allocator *allocator = Crt::ApiAllocator()) noexcept;

            MqttClientConnectionConfigBuilder(
                const WebsocketConfig &config,
                Crt::Allocator *allocator = Crt::ApiAllocator()) noexcept;

            static MqttClientConnectionConfigBuilder NewDefaultBuilder() noexcept;

            MqttClientConnectionConfigBuilder &WithEndpoint(const Crt::String &endpoint);

            MqttClientConnectionConfigBuilder &WithEndpoint(Crt::String &&endpoint);

            MqttClientConnectionConfigBuilder &WithPortOverride(uint32_t port) noexcept;

            MqttClientConnectionConfigBuilder &WithCertificateAuthority(const char *caPath) noexcept;

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

            MqttClientConnectionConfigBuilder &WithTcpKeepAlive() noexcept;

            MqttClientConnectionConfigBuilder &WithTcpConnectTimeout(uint32_t connectTimeoutMs) noexcept;

            MqttClientConnectionConfigBuilder &WithTcpKeepAliveTimeout(uint16_t keepAliveTimeoutSecs) noexcept;

            MqttClientConnectionConfigBuilder &WithTcpKeepAliveInterval(uint16_t keepAliveIntervalSecs) noexcept;

            MqttClientConnectionConfigBuilder &WithTcpKeepAliveMaxProbes(uint16_t maxProbes) noexcept;

            MqttClientConnectionConfigBuilder &WithMinimumTlsVersion(aws_tls_versions minimumTlsVersion) noexcept;

            MqttClientConnectionConfigBuilder &WithTlsCipherPreference(aws_tls_cipher_pref cipherPref) noexcept;

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

            MqttClientConnectionConfigBuilder &WithMetricsCollection(bool enabled);

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

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

            MqttClientConnectionConfigBuilder &WithCustomAuthorizer(
                const Crt::String &username,
                const Crt::String &authorizerName,
                const Crt::String &authorizerSignature,
                const Crt::String &password) noexcept;

            MqttClientConnectionConfigBuilder &WithCustomAuthorizer(
                const Crt::String &username,
                const Crt::String &authorizerName,
                const Crt::String &authorizerSignature,
                const Crt::String &password,
                const Crt::String &tokenKeyName,
                const Crt::String &tokenValue) noexcept;

            MqttClientConnectionConfigBuilder &WithUsername(const Crt::String &username) noexcept;

            MqttClientConnectionConfigBuilder &WithPassword(const Crt::String &password) noexcept;

            MqttClientConnectionConfig Build() noexcept;

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

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

          private:
            // Common setup shared by all valid constructors
            MqttClientConnectionConfigBuilder(Crt::Allocator *allocator) noexcept;

            // Helper function to add parameters to the username in the WithCustomAuthorizer function
            Crt::String AddToUsernameParameter(
                Crt::String currentUsername,
                Crt::String parameterValue,
                Crt::String parameterPreText);

            Crt::Allocator *m_allocator;
            Crt::String m_endpoint;
            uint32_t m_portOverride;
            Crt::Io::SocketOptions m_socketOptions;
            Crt::Io::TlsContextOptions m_contextOptions;
            Crt::Optional<WebsocketConfig> m_websocketConfig;
            Crt::Optional<Crt::Http::HttpClientConnectionProxyOptions> m_proxyOptions;
            bool m_enableMetricsCollection = true;
            Crt::String m_sdkName;
            Crt::String m_sdkVersion;
            Crt::String m_username = "";
            Crt::String m_password = "";
            bool m_isUsingCustomAuthorizer = false;

            int m_lastError;
        };

        class AWS_CRT_CPP_API MqttClient final
        {
          public:
            MqttClient(Crt::Io::ClientBootstrap &bootstrap, Crt::Allocator *allocator = Crt::ApiAllocator()) noexcept;

            MqttClient(Crt::Allocator *allocator = Crt::ApiAllocator()) noexcept;

            std::shared_ptr<Crt::Mqtt::MqttConnection> NewConnection(const MqttClientConnectionConfig &config) noexcept;

            int LastError() const noexcept { return m_client.LastError(); }

            explicit operator bool() const noexcept { return m_client ? true : false; }

          private:
            Crt::Mqtt::MqttClient m_client;
            int m_lastError;
        };
    } // namespace Iot
} // namespace Aws

#endif // !BYO_CRYPTO