#include <Mqtt5Packets.h>

Inheritance diagram for Aws::Crt::Mqtt5::ConnAckPacket:

Public Member Functions
	ConnAckPacket (const aws_mqtt5_packet_connack_view &packet, Allocator *allocator=ApiAllocator()) noexcept

PacketType	getType () override

bool	getSessionPresent () const noexcept

ConnectReasonCode	getReasonCode () const noexcept

const Crt::Optional< uint32_t > &	getSessionExpiryIntervalSec () const noexcept

const Crt::Optional< uint32_t > &	getSessionExpiryInterval () const noexcept

const Crt::Optional< uint16_t > &	getReceiveMaximum () const noexcept

const Crt::Optional< QOS > &	getMaximumQOS () const noexcept

const Crt::Optional< bool > &	getRetainAvailable () const noexcept

const Crt::Optional< uint32_t > &	getMaximumPacketSize () const noexcept

const Crt::Optional< String > &	getAssignedClientIdentifier () const noexcept

const Crt::Optional< uint16_t >	getTopicAliasMaximum () const noexcept

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

const Vector< UserProperty > &	getUserProperty () const noexcept

const Crt::Optional< bool > &	getWildcardSubscriptionsAvailable () const noexcept

const Crt::Optional< bool > &	getSubscriptionIdentifiersAvailable () const noexcept

const Crt::Optional< bool > &	getSharedSubscriptionsAvailable () const noexcept

const Crt::Optional< uint16_t > &	getServerKeepAliveSec () const noexcept

const Crt::Optional< uint16_t > &	getServerKeepAlive () const noexcept

const Crt::Optional< String > &	getResponseInformation () const noexcept

const Crt::Optional< String > &	getServerReference () const noexcept

virtual	~ConnAckPacket ()

	ConnAckPacket (const ConnAckPacket &)=delete

	ConnAckPacket (ConnAckPacket &&) noexcept=delete

ConnAckPacket &	operator= (const ConnAckPacket &)=delete

ConnAckPacket &	operator= (ConnAckPacket &&) noexcept=delete

Detailed Description

Data model of an MQTT5 CONNACK packet.

Constructor & Destructor Documentation

◆ ConnAckPacket() [1/3]

Aws::Crt::Mqtt5::ConnAckPacket::ConnAckPacket	(	const aws_mqtt5_packet_connack_view &	packet,
		Allocator *	allocator = `ApiAllocator()`
	)

noexcept

◆ ~ConnAckPacket()

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

inlinevirtual

◆ ConnAckPacket() [2/3]

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

delete

◆ ConnAckPacket() [3/3]

Aws::Crt::Mqtt5::ConnAckPacket::ConnAckPacket ( ConnAckPacket && )

deletenoexcept

Member Function Documentation

◆ getAssignedClientIdentifier()

const Crt::Optional< String > & Aws::Crt::Mqtt5::ConnAckPacket::getAssignedClientIdentifier ( ) const

noexcept

Specifies a client identifier assigned to this connection by the server. Only valid when the client id of the preceding CONNECT packet was left empty.

See MQTT5 Assigned Client Identifier

Returns: Client identifier assigned to this connection by the server

◆ getMaximumPacketSize()

const Crt::Optional< uint32_t > & Aws::Crt::Mqtt5::ConnAckPacket::getMaximumPacketSize ( ) const

noexcept

Specifies the maximum packet size, in bytes, that the server is willing to accept. If null, there is no limit beyond what is imposed by the MQTT spec itself.

See MQTT5 Maximum Packet Size

Returns: The maximum packet size, in bytes, that the server is willing to accept.

◆ getMaximumQOS()

const Crt::Optional< QOS > & Aws::Crt::Mqtt5::ConnAckPacket::getMaximumQOS ( ) const

noexcept

The maximum message delivery quality of service that the server will allow on this connection.

See MQTT5 Maximum QoS

Returns: The maximum message delivery quality of service that the server will allow on this connection.

◆ getReasonCode()

ConnectReasonCode Aws::Crt::Mqtt5::ConnAckPacket::getReasonCode ( ) const

noexcept

Indicates either success or the reason for failure for the connection attempt.

See MQTT5 Connect Reason Code

Returns: Code indicating either success or the reason for failure for the connection attempt.

◆ getReasonString()

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

noexcept

Additional diagnostic information about the result of the connection attempt.

See MQTT5 Reason String

Returns: Additional diagnostic information about the result of the connection attempt.

◆ getReceiveMaximum()

const Crt::Optional< uint16_t > & Aws::Crt::Mqtt5::ConnAckPacket::getReceiveMaximum ( ) const

noexcept

The maximum amount of in-flight QoS 1 or 2 messages that the server is willing to handle at once. If omitted or null, the limit is based on the valid MQTT packet id space (65535).

See MQTT5 Receive Maximum

Returns: The maximum amount of in-flight QoS 1 or 2 messages that the server is willing to handle at once.

◆ getResponseInformation()

const Crt::Optional< String > & Aws::Crt::Mqtt5::ConnAckPacket::getResponseInformation ( ) const

noexcept

A value that can be used in the creation of a response topic associated with this connection. MQTT5-based request/response is outside the purview of the MQTT5 spec and this client.

See MQTT5 Response Information

Returns: A value that can be used in the creation of a response topic associated with this connection.

◆ getRetainAvailable()

const Crt::Optional< bool > & Aws::Crt::Mqtt5::ConnAckPacket::getRetainAvailable ( ) const

noexcept

Indicates whether the server supports retained messages. If null, retained messages are supported.

See MQTT5 Retain Available

Returns: Whether the server supports retained messages

◆ getServerKeepAlive()

const Crt::Optional< uint16_t > & Aws::Crt::Mqtt5::ConnAckPacket::getServerKeepAlive ( ) const

noexcept

Deprecated:: The function is deprecated, please use ConnAckPacket::getServerKeepAliveSec(). Server-requested override of the keep alive interval, in seconds. If null, the keep alive value sent by the client should be used.

See MQTT5 Server Keep Alive

Returns: Server-requested override of the keep alive interval, in seconds

◆ getServerKeepAliveSec()

const Crt::Optional< uint16_t > & Aws::Crt::Mqtt5::ConnAckPacket::getServerKeepAliveSec ( ) const

noexcept

Server-requested override of the keep alive interval, in seconds. If null, the keep alive value sent by the client should be used.

See MQTT5 Server Keep Alive

Returns: Server-requested override of the keep alive interval, in seconds

◆ getServerReference()

const Crt::Optional< String > & Aws::Crt::Mqtt5::ConnAckPacket::getServerReference ( ) const

noexcept

Property indicating an alternate server that the client may temporarily or permanently attempt to connect to instead of the configured endpoint. Will only be set if the reason code indicates another server may be used (ServerMoved, UseAnotherServer).

See MQTT5 Server Reference

Returns: Property indicating an alternate server that the client may temporarily or permanently attempt to connect to instead of the configured endpoint.

◆ getSessionExpiryInterval()

const Crt::Optional< uint32_t > & Aws::Crt::Mqtt5::ConnAckPacket::getSessionExpiryInterval ( ) const

noexcept

Deprecated:: The function is deprecated, please use ConnAckPacket::getSessionExpiryIntervalSec().

A time interval, in seconds, that the server will persist this connection's MQTT session state for. If present, this value overrides any session expiry specified in the preceding CONNECT packet.

See MQTT5 Session Expiry Interval

Returns: A time interval, in seconds, that the server will persist this connection's MQTT session state for.

◆ getSessionExpiryIntervalSec()

const Crt::Optional< uint32_t > & Aws::Crt::Mqtt5::ConnAckPacket::getSessionExpiryIntervalSec ( ) const

noexcept

A time interval, in seconds, that the server will persist this connection's MQTT session state for. If present, this value overrides any session expiry specified in the preceding CONNECT packet.

See MQTT5 Session Expiry Interval

Returns: A time interval, in seconds, that the server will persist this connection's MQTT session state for.

◆ getSessionPresent()

bool Aws::Crt::Mqtt5::ConnAckPacket::getSessionPresent ( ) const

noexcept

True if the client rejoined an existing session on the server, false otherwise.

See MQTT5 Session Present

Returns: True if the client rejoined an existing session on the server, false otherwise.

◆ getSharedSubscriptionsAvailable()

const Crt::Optional< bool > & Aws::Crt::Mqtt5::ConnAckPacket::getSharedSubscriptionsAvailable ( ) const

noexcept

Indicates whether the server supports shared subscription topic filters. If null, shared subscriptions are supported.

See MQTT5 Shared Subscriptions Available

Returns: whether the server supports shared subscription topic filters.

◆ getSubscriptionIdentifiersAvailable()

const Crt::Optional< bool > & Aws::Crt::Mqtt5::ConnAckPacket::getSubscriptionIdentifiersAvailable ( ) const

noexcept

Indicates whether the server supports subscription identifiers. If null, subscription identifiers are supported.

See MQTT5 Subscription Identifiers Available

Returns: whether the server supports subscription identifiers.

◆ getTopicAliasMaximum()

const Crt::Optional< uint16_t > Aws::Crt::Mqtt5::ConnAckPacket::getTopicAliasMaximum ( ) const

noexcept

Specifies the maximum topic alias value that the server will accept from the client.

See MQTT5 Topic Alias Maximum

Returns: maximum topic alias

◆ getType()

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

inlineoverridevirtual

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

◆ getUserProperty()

const Vector< UserProperty > & Aws::Crt::Mqtt5::ConnAckPacket::getUserProperty ( ) 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.

◆ getWildcardSubscriptionsAvailable()

const Crt::Optional< bool > & Aws::Crt::Mqtt5::ConnAckPacket::getWildcardSubscriptionsAvailable ( ) const

noexcept

Indicates whether the server supports wildcard subscriptions. If null, wildcard subscriptions are supported.

See MQTT5 Wildcard Subscriptions Available

Returns: Whether the server supports wildcard subscriptions.

◆ operator=() [1/2]

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

deletenoexcept

◆ operator=() [2/2]

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

delete

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ConnAckPacket() [1/3]

◆ ~ConnAckPacket()

◆ ConnAckPacket() [2/3]

◆ ConnAckPacket() [3/3]

Member Function Documentation

◆ getAssignedClientIdentifier()

◆ getMaximumPacketSize()

◆ getMaximumQOS()

◆ getReasonCode()

◆ getReasonString()

◆ getReceiveMaximum()

◆ getResponseInformation()

◆ getRetainAvailable()

◆ getServerKeepAlive()

◆ getServerKeepAliveSec()

◆ getServerReference()

◆ getSessionExpiryInterval()

◆ getSessionExpiryIntervalSec()

◆ getSessionPresent()

◆ getSharedSubscriptionsAvailable()

◆ getSubscriptionIdentifiersAvailable()

◆ getTopicAliasMaximum()

◆ getType()

◆ getUserProperty()

◆ getWildcardSubscriptionsAvailable()

◆ operator=() [1/2]

◆ operator=() [2/2]