Aws::Crt::Mqtt5::Subscription Class Reference

#include <Mqtt5Packets.h>

Public Member Functions
	Subscription (Allocator *allocator=ApiAllocator())
	Subscription (Crt::String topicFilter, Mqtt5::QOS qos, Allocator *allocator=ApiAllocator())
Subscription &	WithTopicFilter (Crt::String topicFilter) noexcept
Subscription &	WithQOS (Mqtt5::QOS QOS) noexcept
Subscription &	WithNoLocal (bool noLocal) noexcept
Subscription &	WithRetainAsPublished (bool retain) noexcept
Subscription &	WithRetain (bool retain) noexcept
Subscription &	WithRetainHandlingType (RetainHandlingType retainHandlingType) noexcept
bool	initializeRawOptions (aws_mqtt5_subscription_view &raw_options) const noexcept
virtual	~Subscription ()
	Subscription (const Subscription &) noexcept
	Subscription (Subscription &&) noexcept
Subscription &	operator= (const Subscription &) noexcept
Subscription &	operator= (Subscription &&) noexcept

Detailed Description

Configures a single subscription within a Subscribe operation

See MQTT5 Subscription Options

Constructor & Destructor Documentation

Subscription() [1/4]

Aws::Crt::Mqtt5::Subscription::Subscription

(

Allocator *

allocator = ApiAllocator()

)

Subscription() [2/4]

Aws::Crt::Mqtt5::Subscription::Subscription	(	Crt::String	topicFilter,
		Mqtt5::QOS	qos,
		Allocator *	allocator = ApiAllocator()
	)

~Subscription()

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

inlinevirtual

Subscription() [3/4]

Aws::Crt::Mqtt5::Subscription::Subscription ( const Subscription &  toCopy )

noexcept

Subscription() [4/4]

Aws::Crt::Mqtt5::Subscription::Subscription ( Subscription &&  toMove )

noexcept

Member Function Documentation

initializeRawOptions()

bool Aws::Crt::Mqtt5::Subscription::initializeRawOptions ( aws_mqtt5_subscription_view &  raw_options ) const

noexcept

operator=() [1/2]

Subscription & Aws::Crt::Mqtt5::Subscription::operator= ( const Subscription &  toCopy )

noexcept

operator=() [2/2]

Subscription & Aws::Crt::Mqtt5::Subscription::operator= ( Subscription &&  toMove )

noexcept

WithNoLocal()

Subscription & Aws::Crt::Mqtt5::Subscription::WithNoLocal ( bool  noLocal )

noexcept

Sets should the server not send publishes to a client when that client was the one who sent the publish? The value will be default to false.

See MQTT5 Subscription Options

Parameters

noLocal

bool

Returns

The Subscription Object after setting the reason string.

WithQOS()

Subscription & Aws::Crt::Mqtt5::Subscription::WithQOS ( Mqtt5::QOS  QOS )

noexcept

Sets Maximum QoS on which the subscriber will accept publish messages. Negotiated QoS may be different.

See MQTT5 Subscription Options

Parameters

QOS

Returns

The Subscription Object after setting the reason string.

WithRetain()

Subscription & Aws::Crt::Mqtt5::Subscription::WithRetain ( bool  retain )

noexcept

Deprecated:

The function is deprecated, please use Subscription::WithRetainAsPublished(bool).

Sets should the server not send publishes to a client when that client was the one who sent the publish? The value will be default to false.

See MQTT5 Subscription Options

Parameters

retain

bool

Returns

The Subscription Object after setting the reason string.

WithRetainAsPublished()

Subscription & Aws::Crt::Mqtt5::Subscription::WithRetainAsPublished ( bool  retain )

noexcept

Sets should the server not send publishes to a client when that client was the one who sent the publish? The value will be default to false.

See MQTT5 Subscription Options

Parameters

retain

bool

Returns

The Subscription Object after setting the reason string.

WithRetainHandlingType()

Subscription & Aws::Crt::Mqtt5::Subscription::WithRetainHandlingType ( RetainHandlingType  retainHandlingType )

noexcept

Sets should messages sent due to this subscription keep the retain flag preserved on the message? The value will be default to false.

See MQTT5 Subscription Options

Parameters

retainHandlingType

Returns

The Subscription Object after setting the reason string.

WithTopicFilter()

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

noexcept

Sets topic filter to subscribe to

See MQTT5 Subscription Options

Parameters

topicFilter

string

Returns

The Subscription Object after setting the reason string.

---

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

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