MqttTypes.h

Go to the documentation of this file.

#pragma once

#include <aws/crt/Types.h>
#include <aws/crt/io/SocketOptions.h>
#include <aws/crt/io/TlsOptions.h>
#include <aws/crt/mqtt/IoTSDKMetrics.h>

#include <aws/mqtt/client.h>
#include <aws/mqtt/v5/mqtt5_client.h>

#include <functional>

namespace Aws
{
    namespace Crt
    {
        namespace Mqtt
        {
            class MqttConnection;

            struct MqttConnectionOptions
            {
                const char *hostName = nullptr;
                uint32_t port = 0;
                Io::SocketOptions socketOptions;
                Crt::Io::TlsContext tlsContext;
                Crt::Io::TlsConnectionOptions tlsConnectionOptions;
                bool useWebsocket = false;
                bool useTls = false;
                bool enableMetrics = true;
                Crt::Optional<AWSIoTMetrics> sdkMetrics;
                Allocator *allocator = nullptr;
            };

            using OnMessageReceivedHandler = std::function<void(
                MqttConnection &connection,
                const String &topic,
                const ByteBuf &payload,
                bool dup,
                QOS qos,
                bool retain)>;

            using OnSubAckHandler = std::function<
                void(MqttConnection &connection, uint16_t packetId, const String &topic, QOS qos, int errorCode)>;

            using OnMultiSubAckHandler = std::function<void(
                MqttConnection &connection,
                uint16_t packetId,
                const Vector<String> &topics,
                QOS qos,
                int errorCode)>;

            using OnOperationCompleteHandler =
                std::function<void(MqttConnection &connection, uint16_t packetId, int errorCode)>;

            struct AWS_CRT_CPP_API MqttConnectionOperationStatistics
            {
                /*
                 * Total number of operations submitted to the connection that have not yet been completed. Unacked
                 * operations are a subset of this.
                 */
                uint64_t incompleteOperationCount;

                /*
                 * Total packet size of operations submitted to the connection that have not yet been completed. Unacked
                 * operations are a subset of this.
                 */
                uint64_t incompleteOperationSize;

                /*
                 * Total number of operations that have been sent to the server and are waiting for a corresponding ACK
                 * before they can be completed.
                 */
                uint64_t unackedOperationCount;

                /*
                 * Total packet size of operations that have been sent to the server and are waiting for a corresponding
                 * ACK before they can be completed.
                 */
                uint64_t unackedOperationSize;
            };
        } // namespace Mqtt
    } // namespace Crt
} // namespace Aws