#include <MqttConnection.h>
Static Public Member Functions | |
| static std::shared_ptr< Crt::Mqtt::MqttConnection > | NewConnectionFromMqtt5Client (std::shared_ptr< Mqtt5::Mqtt5Client > mqtt5client) noexcept |
Friends | |
| class | MqttClient |
| class | Mqtt5::Mqtt5ClientCore |
Detailed Description
Represents a persistent Mqtt Connection. The memory is owned by MqttClient or Mqtt5Client.
To get a new instance of this class, use MqttClient::NewConnection or Mqtt5Client::NewConnection. Unless specified all function arguments need only to live through the duration of the function call.
- See also
- MqttClient::NewConnection
- Mqtt5Client::NewConnection
Constructor & Destructor Documentation
◆ ~MqttConnection()
| Aws::Crt::Mqtt::MqttConnection::~MqttConnection | ( | ) |
◆ MqttConnection() [1/2]
|
delete |
◆ MqttConnection() [2/2]
|
delete |
Member Function Documentation
◆ Connect()
|
noexcept |
Initiates the connection, OnConnectionCompleted will be invoked in an event-loop thread.
- Parameters
-
clientId client identifier to use when establishing the mqtt connection cleanSession false to attempt to rejoin an existing session for the client id, true to skip and start with a new session keepAliveTimeSecs time interval to space mqtt pings apart by pingTimeoutMs timeout in milliseconds before the keep alive ping is considered to have failed protocolOperationTimeoutMs timeout in milliseconds to give up waiting for a response packet for an operation. Necessary due to throttling properties on certain server implementations that do not return an ACK for throttled operations.
- Returns
- true if the connection attempt was successfully started (implying a callback will be invoked with the eventual result), false if it could not be started (no callback will happen)
◆ Disconnect()
|
noexcept |
Initiates disconnect, OnDisconnectHandler will be invoked in an event-loop thread.
- Returns
- success/failure in initiating disconnect
◆ GetOperationStatistics()
|
noexcept |
Get the statistics about the current state of the connection's queue of operations
◆ LastError()
|
noexcept |
- Returns
- the value of the last aws error encountered by operations on this instance.
◆ NewConnectionFromMqtt5Client()
|
staticnoexcept |
Create a new MqttConnection object from the Mqtt5Client.
- Parameters
-
mqtt5client The shared ptr of Mqtt5Client
- Returns
- std::shared_ptr<Crt::Mqtt::MqttConnection>
As we passed the std::shared_ptr<Mqtt5Client> by value, this function scope would keep a reference of the Mqtt5Client thus the underlying c client. Therefore we directly access the c client here. Other than that, we should never directly access the underlying c client without acquire the reference.
◆ operator bool()
|
noexcept |
- Returns
- true if the instance is in a valid state, false otherwise.
◆ operator=() [1/2]
|
delete |
◆ operator=() [2/2]
|
delete |
◆ Publish()
|
noexcept |
Publishes to a topic.
- Parameters
-
topic topic to publish to qos QOS to publish the message with retain should this message replace the current retained message of the topic? payload payload of the message onOpComplete completion callback to invoke when the operation is complete. If QoS is 0, then the callback is invoked when the message is passed to the tls handler, otherwise it's invoked on receipt of the final response from the server.
- Returns
- packet id of the publish request, or 0 if the attempt failed synchronously
◆ SetHttpProxyOptions()
|
noexcept |
Sets http proxy options. In order to use an http proxy with mqtt either (1) Websockets are used (2) Mqtt-over-tls is used and the ALPN list of the tls context contains a tag that resolves to mqtt
- Parameters
-
proxyOptions proxy configuration for making the mqtt connection
- Returns
- success/failure
◆ SetLogin()
|
noexcept |
Sets login credentials for the connection. The must get set before the Connect call if it is to be used.
- Parameters
-
username user name to add to the MQTT CONNECT packet password password to add to the MQTT CONNECT packet
- Returns
- success/failure
◆ SetOnMessageHandler() [1/2]
|
noexcept |
Installs a handler for all incoming publish messages, regardless of if Subscribe has been called on the topic.
- Parameters
-
onMessage callback to invoke for all received messages
- Returns
- success/failure
◆ SetOnMessageHandler() [2/2]
|
noexcept |
- Deprecated:
- Use alternate SetOnMessageHandler()
◆ SetReconnectTimeout()
|
noexcept |
Customize time to wait between reconnect attempts. The time will start at min and multiply by 2 until max is reached. The time resets back to min after a successful connection. This function should only be called before Connect().
- Parameters
-
min_seconds minimum time to wait before attempting a reconnect max_seconds maximum time to wait before attempting a reconnect
- Returns
- success/failure
◆ SetWebsocketProxyOptions()
|
noexcept |
- Deprecated:
- Sets websocket proxy options. Replaced by SetHttpProxyOptions.
◆ SetWill()
|
noexcept |
Sets LastWill for the connection.
- Parameters
-
topic topic the will message should be published to qos QOS the will message should be published with retain true if the will publish should be treated as a retained publish payload payload of the will message
- Returns
- success/failure in setting the will
◆ Subscribe() [1/4]
|
noexcept |
Subscribes to topicFilter. OnMessageReceivedHandler will be invoked from an event-loop thread upon an incoming Publish message. OnSubAckHandler will be invoked upon receipt of a suback message.
- Parameters
-
topicFilter topic filter to subscribe to qos maximum qos client is willing to receive matching messages on onMessage callback to invoke when a message is received based on matching this filter onSubAck callback to invoke with the server's response to the subscribe request
- Returns
- packet id of the subscribe request, or 0 if the attempt failed synchronously
◆ Subscribe() [2/4]
|
noexcept |
- Deprecated:
- Use alternate Subscribe()
◆ Subscribe() [3/4]
|
noexcept |
Subscribes to multiple topicFilters. OnMessageReceivedHandler will be invoked from an event-loop thread upon an incoming Publish message. OnMultiSubAckHandler will be invoked upon receipt of a suback message.
- Parameters
-
topicFilters list of pairs of topic filters and message callbacks to invoke on a matching publish qos maximum qos client is willing to receive matching messages on onOpComplete callback to invoke with the server's response to the subscribe request
- Returns
- packet id of the subscribe request, or 0 if the attempt failed synchronously
◆ Subscribe() [4/4]
|
noexcept |
- Deprecated:
- Use alternate Subscribe()
◆ Unsubscribe()
|
noexcept |
Unsubscribes from topicFilter. OnOperationCompleteHandler will be invoked upon receipt of an unsuback message.
- Parameters
-
topicFilter topic filter to unsubscribe the session from onOpComplete callback to invoke on receipt of the server's UNSUBACK message
- Returns
- packet id of the unsubscribe request, or 0 if the attempt failed synchronously
Friends And Related Symbol Documentation
◆ Mqtt5::Mqtt5ClientCore
◆ MqttClient
|
friend |
Member Data Documentation
◆ OnConnectionClosed
| OnConnectionClosedHandler Aws::Crt::Mqtt::MqttConnection::OnConnectionClosed |
Invoked when a connection is disconnected and shutdown successfully.
- Note
- Currently callbackData will always be nullptr, but this may change in the future to send additional data.
- From the user perspective, this callback is indistinguishable from OnDisconnect.
◆ OnConnectionCompleted
| OnConnectionCompletedHandler Aws::Crt::Mqtt::MqttConnection::OnConnectionCompleted |
Invoked when a connack message is received, or an error occurred.
◆ OnConnectionFailure
| OnConnectionFailureHandler Aws::Crt::Mqtt::MqttConnection::OnConnectionFailure |
Invoked whenever the connection fails to connect.
This callback is invoked for every failed connect and every failed reconnect.
◆ OnConnectionInterrupted
| OnConnectionInterruptedHandler Aws::Crt::Mqtt::MqttConnection::OnConnectionInterrupted |
A callback invoked every time the connections is interrupted.
◆ OnConnectionResumed
| OnConnectionResumedHandler Aws::Crt::Mqtt::MqttConnection::OnConnectionResumed |
A callback invoked every time the connection is resumed.
◆ OnConnectionSuccess
| OnConnectionSuccessHandler Aws::Crt::Mqtt::MqttConnection::OnConnectionSuccess |
Invoked whenever the connection successfully connects.
This callback is invoked for every successful connect and every successful reconnect.
◆ OnDisconnect
| OnDisconnectHandler Aws::Crt::Mqtt::MqttConnection::OnDisconnect |
A callback invoked on disconnect.
◆ WebsocketInterceptor
| OnWebSocketHandshakeIntercept Aws::Crt::Mqtt::MqttConnection::WebsocketInterceptor |
Invoked during websocket handshake to give users opportunity to transform an http request for purposes such as signing/authorization etc... Returning from this function does not continue the websocket handshake since some work flows may be asynchronous. To accommodate that, onComplete must be invoked upon completion of the signing process.
The documentation for this class was generated from the following files:
- include/aws/crt/mqtt/MqttConnection.h
- source/mqtt/MqttConnection.cpp
