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

#include <Mqtt5Packets.h>

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

Public Member Functions

 PubAckPacket (const aws_mqtt5_packet_puback_view &packet, Allocator *allocator=ApiAllocator()) noexcept
 
PacketType getType () override
 
PubAckReasonCode getReasonCode () const noexcept
 
const Crt::Optional< Crt::String > & getReasonString () const noexcept
 
const Crt::Vector< UserProperty > & getUserProperties () const noexcept
 
virtual ~PubAckPacket ()
 
 PubAckPacket (const PubAckPacket &toCopy) noexcept=delete
 
 PubAckPacket (PubAckPacket &&toMove) noexcept=delete
 
PubAckPacketoperator= (const PubAckPacket &toCopy) noexcept=delete
 
PubAckPacketoperator= (PubAckPacket &&toMove) noexcept=delete
 

Detailed Description

Data model of an MQTT5 PUBACK packet

Constructor & Destructor Documentation

◆ PubAckPacket() [1/3]

Aws::Crt::Mqtt5::PubAckPacket::PubAckPacket ( const aws_mqtt5_packet_puback_view &  packet,
Allocator allocator = ApiAllocator() 
)
noexcept

◆ ~PubAckPacket()

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

◆ PubAckPacket() [2/3]

Aws::Crt::Mqtt5::PubAckPacket::PubAckPacket ( const PubAckPacket toCopy)
deletenoexcept

◆ PubAckPacket() [3/3]

Aws::Crt::Mqtt5::PubAckPacket::PubAckPacket ( PubAckPacket &&  toMove)
deletenoexcept

Member Function Documentation

◆ getReasonCode()

PubAckReasonCode Aws::Crt::Mqtt5::PubAckPacket::getReasonCode ( ) const
noexcept

Success indicator or failure reason for the associated PUBLISH packet.

See MQTT5 PUBACK Reason Code

Returns
Success indicator or failure reason for the associated PUBLISH packet.

◆ getReasonString()

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

Additional diagnostic information about the result of the PUBLISH attempt.

See MQTT5 Reason String

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

◆ getType()

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

◆ getUserProperties()

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

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]

PubAckPacket& Aws::Crt::Mqtt5::PubAckPacket::operator= ( const PubAckPacket toCopy)
deletenoexcept

◆ operator=() [2/2]

PubAckPacket& Aws::Crt::Mqtt5::PubAckPacket::operator= ( PubAckPacket &&  toMove)
deletenoexcept

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