#include <Mqtt5Packets.h>
Data model of an MQTT5 SUBSCRIBE packet.
◆ SubscribePacket() [1/3]
◆ ~SubscribePacket()
Aws::Crt::Mqtt5::SubscribePacket::~SubscribePacket |
( |
| ) |
|
|
virtual |
◆ SubscribePacket() [2/3]
Aws::Crt::Mqtt5::SubscribePacket::SubscribePacket |
( |
const SubscribePacket & |
| ) |
|
|
deletenoexcept |
◆ SubscribePacket() [3/3]
◆ getType()
PacketType Aws::Crt::Mqtt5::SubscribePacket::getType |
( |
| ) |
|
|
inlineoverridevirtual |
◆ initializeRawOptions()
bool Aws::Crt::Mqtt5::SubscribePacket::initializeRawOptions |
( |
aws_mqtt5_packet_subscribe_view & |
raw_options | ) |
|
|
noexcept |
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ WithSubscription()
Sets a single subscription within the SUBSCRIBE packet.
- Parameters
-
subscription | The subscription to add within the SUBSCRIBE packet. |
- Returns
- The SubscribePacket Object after setting the subscription.
◆ WithSubscriptionIdentifier()
SubscribePacket & Aws::Crt::Mqtt5::SubscribePacket::WithSubscriptionIdentifier |
( |
uint32_t |
subscriptionIdentifier | ) |
|
|
noexcept |
Sets the value to associate with all subscriptions in this request. Publish packets that match a subscription in this request should include this identifier in the resulting message.
See MQTT5 Subscription Identifier
- Parameters
-
subscriptionIdentifier | A positive long to associate with all subscriptions in this request. |
- Returns
- The SubscribePacket Object after setting the subscription identifier.
◆ WithSubscriptions() [1/2]
Sets a list of subscriptions within the SUBSCRIBE packet.
- Parameters
-
subscriptions | vector of subscriptions to add within the SUBSCRIBE packet. |
- Returns
- The SubscribePacket Object after setting the subscription.
◆ WithSubscriptions() [2/2]
Sets a list of subscriptions within the SUBSCRIBE packet.
- Parameters
-
subscriptions | vector of subscriptions to add within the SUBSCRIBE packet. |
- Returns
- The SubscribePacket Object after setting the subscription.
◆ WithUserProperties() [1/2]
Sets the list of MQTT5 user properties included with the packet.
See MQTT5 User Property
- Parameters
-
userProperties | List of MQTT5 user properties included with the packet. |
- Returns
- the SubscribePacket Object after setting the reason string.
◆ WithUserProperties() [2/2]
Sets the list of MQTT5 user properties included with the packet.
See MQTT5 User Property
- Parameters
-
userProperties | List of MQTT5 user properties included with the packet. |
- Returns
- the SubscribePacket Object after setting the reason string.
◆ WithUserProperty()
Put a MQTT5 user property to the back of the packet user property vector/list
See MQTT5 User Property
- Parameters
-
property | userProperty of MQTT5 user properties included with the packet. |
- Returns
- The SubscribePacket Object after setting the user property
The documentation for this class was generated from the following files: