Aws::Crt::Mqtt::AWSIoTMetrics Class Reference

#include <IoTSDKMetrics.h>

Public Member Functions
	AWSIoTMetrics ()
	~AWSIoTMetrics ()=default
	AWSIoTMetrics (const AWSIoTMetrics &other)
AWSIoTMetrics &	operator= (const AWSIoTMetrics &other)
	AWSIoTMetrics (AWSIoTMetrics &&other) noexcept
AWSIoTMetrics &	operator= (AWSIoTMetrics &&other) noexcept
void	SetLibraryName (Aws::Crt::String name)
const Aws::Crt::String &	GetLibraryName () const
void	SetMetadataEntry (const Crt::String &key, const Crt::String &value)
void	RemoveMetadataEntry (const Crt::String &key)
const Crt::Map< Crt::String, Crt::String > &	GetMetadata () const

Friends
class	Mqtt5::Mqtt5ClientOptions
class	MqttConnectionCore
class	IoTSDKMetricsEncoder

Detailed Description

IoT Device SDK Metrics Structure.

Holds the library name and a list of metadata key-value pairs to be appended to the MQTT CONNECT packet's username field.

Constructor & Destructor Documentation

Aws::Crt::Mqtt::AWSIoTMetrics::AWSIoTMetrics

(

)

Aws::Crt::Mqtt::AWSIoTMetrics::~AWSIoTMetrics ( )

default

Aws::Crt::Mqtt::AWSIoTMetrics::AWSIoTMetrics

(

const AWSIoTMetrics &

other

)

Aws::Crt::Mqtt::AWSIoTMetrics::AWSIoTMetrics ( AWSIoTMetrics &&  other )

noexcept

Member Function Documentation

const Aws::Crt::String & Aws::Crt::Mqtt::AWSIoTMetrics::GetLibraryName

(

)

const

Returns a const reference to the library name.

const Crt::Map< Crt::String, Crt::String > & Aws::Crt::Mqtt::AWSIoTMetrics::GetMetadata

(

)

const

Returns a const reference to the metadata map.

AWSIoTMetrics & Aws::Crt::Mqtt::AWSIoTMetrics::operator=

(

const AWSIoTMetrics &

other

)

AWSIoTMetrics & Aws::Crt::Mqtt::AWSIoTMetrics::operator= ( AWSIoTMetrics &&  other )

noexcept

void Aws::Crt::Mqtt::AWSIoTMetrics::RemoveMetadataEntry

(

const Crt::String &

key

)

Removes a single metadata entry by key. No-op if the key does not exist.

Parameters

key	The metadata key to remove.

void Aws::Crt::Mqtt::AWSIoTMetrics::SetLibraryName

(

Aws::Crt::String

name

)

Sets the library name identifier.

Parameters

name	The library name

void Aws::Crt::Mqtt::AWSIoTMetrics::SetMetadataEntry	(	const Crt::String &	key,
		const Crt::String &	value
	)

Sets or updates a single metadata entry.

Parameters

key	The metadata key.
value	The metadata value.

Friends And Related Function Documentation

friend class IoTSDKMetricsEncoder

friend

friend class Mqtt5::Mqtt5ClientOptions

friend

friend class MqttConnectionCore

friend

---

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

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