Aws::Crt::Mqtt5::UnsubscribePacket Class Reference

#include <Mqtt5Packets.h>

Inheritance diagram for Aws::Crt::Mqtt5::UnsubscribePacket:

Public Member Functions
	UnsubscribePacket (Allocator *allocator=ApiAllocator()) noexcept
PacketType	getType () override
UnsubscribePacket &	WithTopicFilter (Crt::String topicFilter) noexcept
UnsubscribePacket &	WithTopicFilters (Crt::Vector< String > topicFilters) noexcept
UnsubscribePacket &	WithUserProperties (const Vector< UserProperty > &userProperties) noexcept
UnsubscribePacket &	WithUserProperties (Vector< UserProperty > &&userProperties) noexcept
UnsubscribePacket &	WithUserProperty (UserProperty &&property) noexcept
bool	initializeRawOptions (aws_mqtt5_packet_unsubscribe_view &raw_options) noexcept
virtual	~UnsubscribePacket ()
	UnsubscribePacket (const UnsubscribePacket &) noexcept=delete
	UnsubscribePacket (UnsubscribePacket &&) noexcept=delete
UnsubscribePacket &	operator= (const UnsubscribePacket &) noexcept=delete
UnsubscribePacket &	operator= (UnsubscribePacket &&) noexcept=delete
Public Member Functions inherited from Aws::Crt::Mqtt5::IPacket
virtual	~IPacket ()=default

Detailed Description

Data model of an MQTT5 UNSUBSCRIBE packet.

Constructor & Destructor Documentation

UnsubscribePacket() [1/3]

Aws::Crt::Mqtt5::UnsubscribePacket::UnsubscribePacket ( Allocator * allocator = ApiAllocator() )

noexcept

~UnsubscribePacket()

Aws::Crt::Mqtt5::UnsubscribePacket::~UnsubscribePacket ( )

virtual

UnsubscribePacket() [2/3]

Aws::Crt::Mqtt5::UnsubscribePacket::UnsubscribePacket ( const UnsubscribePacket & )

deletenoexcept

UnsubscribePacket() [3/3]

Aws::Crt::Mqtt5::UnsubscribePacket::UnsubscribePacket ( UnsubscribePacket && )

deletenoexcept

Member Function Documentation

getType()

PacketType Aws::Crt::Mqtt5::UnsubscribePacket::getType ( )

inlineoverridevirtual

Implements Aws::Crt::Mqtt5::IPacket.

initializeRawOptions()

bool Aws::Crt::Mqtt5::UnsubscribePacket::initializeRawOptions ( aws_mqtt5_packet_unsubscribe_view & raw_options )

noexcept

operator=() [1/2]

UnsubscribePacket & Aws::Crt::Mqtt5::UnsubscribePacket::operator= ( const UnsubscribePacket & )

deletenoexcept

operator=() [2/2]

UnsubscribePacket & Aws::Crt::Mqtt5::UnsubscribePacket::operator= ( UnsubscribePacket && )

deletenoexcept

WithTopicFilter()

UnsubscribePacket & Aws::Crt::Mqtt5::UnsubscribePacket::WithTopicFilter ( Crt::String topicFilter )

noexcept

Push back a topic filter that the client wishes to unsubscribe from.

Parameters

topicFilter

that the client wishes to unsubscribe from

Returns

The UnsubscribePacket Object after setting the subscription.

WithTopicFilters()

UnsubscribePacket & Aws::Crt::Mqtt5::UnsubscribePacket::WithTopicFilters ( Crt::Vector< String > topicFilters )

noexcept

Sets list of topic filter that the client wishes to unsubscribe from.

Parameters

topicFilters

vector of subscription topic filters that the client wishes to unsubscribe from

Returns

The UnsubscribePacket Object after setting the subscription.

WithUserProperties() [1/2]

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

noexcept

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 UnsubscribePacketBuilder after setting the user properties.

WithUserProperties() [2/2]

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

noexcept

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 UnsubscribePacketBuilder after setting the user properties.

WithUserProperty()

UnsubscribePacket & Aws::Crt::Mqtt5::UnsubscribePacket::WithUserProperty ( UserProperty && property )

noexcept

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

See MQTT5 User Property

Parameters

property

set of userProperty of MQTT5 user properties included with the packet.

Returns

The PublishPacket Object after setting the user property

---

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

• crt/aws-crt-cpp/include/aws/crt/mqtt/Mqtt5Packets.h
• crt/aws-crt-cpp/source/mqtt/Mqtt5Packets.cpp