AWS IoT Device SDK C++ v2  1.34.0
AWS IoT Device SDK C++ v2
Public Member Functions | List of all members
Aws::Crt::Mqtt5::SubscribePacket Class Reference

#include <Mqtt5Packets.h>

Inheritance diagram for Aws::Crt::Mqtt5::SubscribePacket:
Aws::Crt::Mqtt5::IPacket

Public Member Functions

 SubscribePacket (Allocator *allocator=ApiAllocator()) noexcept
 
PacketType getType () override
 
SubscribePacketWithUserProperties (const Vector< UserProperty > &userProperties) noexcept
 
SubscribePacketWithUserProperties (Vector< UserProperty > &&userProperties) noexcept
 
SubscribePacketWithUserProperty (UserProperty &&property) noexcept
 
SubscribePacketWithSubscriptionIdentifier (uint32_t subscriptionIdentifier) noexcept
 
SubscribePacketWithSubscriptions (const Vector< Subscription > &subscriptions) noexcept
 
SubscribePacketWithSubscriptions (Crt::Vector< Subscription > &&subscriptions) noexcept
 
SubscribePacketWithSubscription (Subscription &&subscription) noexcept
 
bool initializeRawOptions (aws_mqtt5_packet_subscribe_view &raw_options) noexcept
 
virtual ~SubscribePacket ()
 
 SubscribePacket (const SubscribePacket &) noexcept=delete
 
 SubscribePacket (SubscribePacket &&) noexcept=delete
 
SubscribePacketoperator= (const SubscribePacket &) noexcept=delete
 
SubscribePacketoperator= (SubscribePacket &&) noexcept=delete
 

Detailed Description

Data model of an MQTT5 SUBSCRIBE packet.

Constructor & Destructor Documentation

◆ SubscribePacket() [1/3]

Aws::Crt::Mqtt5::SubscribePacket::SubscribePacket ( Allocator allocator = ApiAllocator())
noexcept

◆ ~SubscribePacket()

Aws::Crt::Mqtt5::SubscribePacket::~SubscribePacket ( )
virtual

◆ SubscribePacket() [2/3]

Aws::Crt::Mqtt5::SubscribePacket::SubscribePacket ( const SubscribePacket )
deletenoexcept

◆ SubscribePacket() [3/3]

Aws::Crt::Mqtt5::SubscribePacket::SubscribePacket ( SubscribePacket &&  )
deletenoexcept

Member Function Documentation

◆ 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]

SubscribePacket& Aws::Crt::Mqtt5::SubscribePacket::operator= ( const SubscribePacket )
deletenoexcept

◆ operator=() [2/2]

SubscribePacket& Aws::Crt::Mqtt5::SubscribePacket::operator= ( SubscribePacket &&  )
deletenoexcept

◆ WithSubscription()

SubscribePacket & Aws::Crt::Mqtt5::SubscribePacket::WithSubscription ( Subscription &&  subscription)
noexcept

Sets a single subscription within the SUBSCRIBE packet.

Parameters
subscriptionThe 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
subscriptionIdentifierA positive long to associate with all subscriptions in this request.
Returns
The SubscribePacket Object after setting the subscription identifier.

◆ WithSubscriptions() [1/2]

SubscribePacket & Aws::Crt::Mqtt5::SubscribePacket::WithSubscriptions ( const Vector< Subscription > &  subscriptions)
noexcept

Sets a list of subscriptions within the SUBSCRIBE packet.

Parameters
subscriptionsvector of subscriptions to add within the SUBSCRIBE packet.
Returns
The SubscribePacket Object after setting the subscription.

◆ WithSubscriptions() [2/2]

SubscribePacket & Aws::Crt::Mqtt5::SubscribePacket::WithSubscriptions ( Crt::Vector< Subscription > &&  subscriptions)
noexcept

Sets a list of subscriptions within the SUBSCRIBE packet.

Parameters
subscriptionsvector of subscriptions to add within the SUBSCRIBE packet.
Returns
The SubscribePacket Object after setting the subscription.

◆ WithUserProperties() [1/2]

SubscribePacket & Aws::Crt::Mqtt5::SubscribePacket::WithUserProperties ( const Vector< UserProperty > &  userProperties)
noexcept

Sets the list of MQTT5 user properties included with the packet.

See MQTT5 User Property

Parameters
userPropertiesList of MQTT5 user properties included with the packet.
Returns
the SubscribePacket Object after setting the reason string.

◆ WithUserProperties() [2/2]

SubscribePacket & Aws::Crt::Mqtt5::SubscribePacket::WithUserProperties ( Vector< UserProperty > &&  userProperties)
noexcept

Sets the list of MQTT5 user properties included with the packet.

See MQTT5 User Property

Parameters
userPropertiesList of MQTT5 user properties included with the packet.
Returns
the SubscribePacket Object after setting the reason string.

◆ WithUserProperty()

SubscribePacket & Aws::Crt::Mqtt5::SubscribePacket::WithUserProperty ( UserProperty &&  property)
noexcept

Put a MQTT5 user property to the back of the packet user property vector/list

See MQTT5 User Property

Parameters
propertyuserProperty 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: