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

#include <Mqtt5Packets.h>

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

Public Member Functions

 UnSubAckPacket (const aws_mqtt5_packet_unsuback_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< UnSubAckReasonCode > & getReasonCodes () const noexcept
 
virtual ~UnSubAckPacket ()
 
 UnSubAckPacket (const UnSubAckPacket &) noexcept=delete
 
 UnSubAckPacket (UnSubAckPacket &&) noexcept=delete
 
UnSubAckPacketoperator= (const UnSubAckPacket &) noexcept=delete
 
UnSubAckPacketoperator= (UnSubAckPacket &&) noexcept=delete
 
- Public Member Functions inherited from Aws::Crt::Mqtt5::IPacket
virtual ~IPacket ()=default
 

Detailed Description

Data model of an MQTT5 UNSUBACK packet.

Constructor & Destructor Documentation

◆ UnSubAckPacket() [1/3]

Aws::Crt::Mqtt5::UnSubAckPacket::UnSubAckPacket ( const aws_mqtt5_packet_unsuback_view &  packet,
Allocator allocator = ApiAllocator() 
)
noexcept

◆ ~UnSubAckPacket()

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

◆ UnSubAckPacket() [2/3]

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

◆ UnSubAckPacket() [3/3]

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

Member Function Documentation

◆ getReasonCodes()

const Crt::Vector< UnSubAckReasonCode > & Aws::Crt::Mqtt5::UnSubAckPacket::getReasonCodes ( ) const
noexcept

Returns a list of reason codes indicating the result of unsubscribing from each individual topic filter entry in the associated UNSUBSCRIBE packet.

See MQTT5 Unsuback Payload

Returns
A list of reason codes indicating the result of unsubscribing from each individual topic filter entry in the associated UNSUBSCRIBE packet.

◆ getReasonString()

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

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

See MQTT5 Reason String

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

◆ getType()

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

◆ getUserProperties()

const Crt::Vector< UserProperty > & Aws::Crt::Mqtt5::UnSubAckPacket::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]

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

◆ operator=() [2/2]

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

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