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::SubAckPacket Class Reference

#include <Mqtt5Packets.h>

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

Public Member Functions

 SubAckPacket (const aws_mqtt5_packet_suback_view &packet, Allocator *allocator=ApiAllocator()) noexcept
 
PacketType getType () override
 
const Crt::Optional< Crt::String > & getReasonString () const noexcept
 
const Crt::Vector< UserProperty > & getUserProperties () const noexcept
 
const Crt::Vector< SubAckReasonCode > & getReasonCodes () const noexcept
 
virtual ~SubAckPacket ()
 
 SubAckPacket (const SubAckPacket &) noexcept=delete
 
 SubAckPacket (SubAckPacket &&) noexcept=delete
 
SubAckPacketoperator= (const SubAckPacket &) noexcept=delete
 
SubAckPacketoperator= (SubAckPacket &&) noexcept=delete
 

Detailed Description

Data model of an MQTT5 SUBACK packet.

Constructor & Destructor Documentation

◆ SubAckPacket() [1/3]

Aws::Crt::Mqtt5::SubAckPacket::SubAckPacket ( const aws_mqtt5_packet_suback_view &  packet,
Allocator allocator = ApiAllocator() 
)
noexcept

◆ ~SubAckPacket()

virtual Aws::Crt::Mqtt5::SubAckPacket::~SubAckPacket ( )
inlinevirtual

◆ SubAckPacket() [2/3]

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

◆ SubAckPacket() [3/3]

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

Member Function Documentation

◆ getReasonCodes()

const Crt::Vector< SubAckReasonCode > & Aws::Crt::Mqtt5::SubAckPacket::getReasonCodes ( ) const
noexcept

Returns list of reason codes indicating the result of each individual subscription entry in the associated SUBSCRIBE packet.

See MQTT5 Suback Payload

Returns
list of reason codes indicating the result of each individual subscription entry in the associated SUBSCRIBE packet.

◆ getReasonString()

const Crt::Optional< Crt::String > & Aws::Crt::Mqtt5::SubAckPacket::getReasonString ( ) const
noexcept

Returns additional diagnostic information about the result of the SUBSCRIBE attempt.

See MQTT5 Reason String

Returns
Additional diagnostic information about the result of the SUBSCRIBE attempt.

◆ getType()

PacketType Aws::Crt::Mqtt5::SubAckPacket::getType ( )
inlineoverridevirtual

◆ getUserProperties()

const Crt::Vector< UserProperty > & Aws::Crt::Mqtt5::SubAckPacket::getUserProperties ( ) const
noexcept

Returns list of MQTT5 user properties included with the packet.

See MQTT5 User Property

Returns
List of MQTT5 user properties included with the packet.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

The documentation for this class was generated from the following files: