AWS IoT Device SDK C++ v2 1.44.2
AWS IoT Device SDK C++ v2
Loading...
Searching...
No Matches
Aws::Greengrass::MQTTMessage Class Reference

#include <GreengrassCoreIpcModel.h>

Inheritance diagram for Aws::Greengrass::MQTTMessage:
Aws::Eventstreamrpc::AbstractShapeBase

Public Member Functions

 MQTTMessage () noexcept
 MQTTMessage (const MQTTMessage &)=default
void SetTopicName (const Aws::Crt::String &topicName) noexcept
Aws::Crt::Optional< Aws::Crt::StringGetTopicName () const noexcept
void SetPayload (const Aws::Crt::Vector< uint8_t > &payload) noexcept
Aws::Crt::Optional< Aws::Crt::Vector< uint8_t > > GetPayload () const noexcept
void SetRetain (const bool &retain) noexcept
Aws::Crt::Optional< bool > GetRetain () const noexcept
void SetUserProperties (const Aws::Crt::Vector< UserProperty > &userProperties) noexcept
Aws::Crt::Optional< Aws::Crt::Vector< UserProperty > > GetUserProperties () const noexcept
void SetMessageExpiryIntervalSeconds (const int64_t &messageExpiryIntervalSeconds) noexcept
Aws::Crt::Optional< int64_t > GetMessageExpiryIntervalSeconds () const noexcept
void SetCorrelationData (const Aws::Crt::Vector< uint8_t > &correlationData) noexcept
Aws::Crt::Optional< Aws::Crt::Vector< uint8_t > > GetCorrelationData () const noexcept
void SetResponseTopic (const Aws::Crt::String &responseTopic) noexcept
Aws::Crt::Optional< Aws::Crt::StringGetResponseTopic () const noexcept
void SetPayloadFormat (PayloadFormat payloadFormat) noexcept
Aws::Crt::Optional< PayloadFormatGetPayloadFormat () const noexcept
void SetContentType (const Aws::Crt::String &contentType) noexcept
Aws::Crt::Optional< Aws::Crt::StringGetContentType () const noexcept
void SerializeToJsonObject (Aws::Crt::JsonObject &payloadObject) const noexcept override
bool operator< (const MQTTMessage &) const noexcept
Public Member Functions inherited from Aws::Eventstreamrpc::AbstractShapeBase
 AbstractShapeBase () noexcept
virtual ~AbstractShapeBase () noexcept=default

Static Public Member Functions

static void s_loadFromJsonView (MQTTMessage &, const Aws::Crt::JsonView &) noexcept
static Aws::Crt::ScopedResource< AbstractShapeBases_allocateFromPayload (Aws::Crt::StringView, Aws::Crt::Allocator *) noexcept
static void s_customDeleter (MQTTMessage *) noexcept
Static Public Member Functions inherited from Aws::Eventstreamrpc::AbstractShapeBase
static void s_customDeleter (AbstractShapeBase *shape) noexcept

Static Public Attributes

static const char * MODEL_NAME = "aws.greengrass#MQTTMessage"

Protected Member Functions

Aws::Crt::String GetModelName () const noexcept override

Additional Inherited Members

Protected Attributes inherited from Aws::Eventstreamrpc::AbstractShapeBase
Crt::Allocatorm_allocator

Constructor & Destructor Documentation

◆ MQTTMessage() [1/2]

Aws::Greengrass::MQTTMessage::MQTTMessage ( )
inlinenoexcept

◆ MQTTMessage() [2/2]

Aws::Greengrass::MQTTMessage::MQTTMessage ( const MQTTMessage & )
default

Member Function Documentation

◆ GetContentType()

Aws::Crt::Optional< Aws::Crt::String > Aws::Greengrass::MQTTMessage::GetContentType ( ) const
inlinenoexcept

(Optional) Message content type.

◆ GetCorrelationData()

Aws::Crt::Optional< Aws::Crt::Vector< uint8_t > > Aws::Greengrass::MQTTMessage::GetCorrelationData ( ) const
inlinenoexcept

(Optional) Correlation data blob for request/response.

◆ GetMessageExpiryIntervalSeconds()

Aws::Crt::Optional< int64_t > Aws::Greengrass::MQTTMessage::GetMessageExpiryIntervalSeconds ( ) const
inlinenoexcept

(Optional) Message expiry interval in seconds.

◆ GetModelName()

Aws::Crt::String Aws::Greengrass::MQTTMessage::GetModelName ( ) const
overrideprotectedvirtualnoexcept

◆ GetPayload()

Aws::Crt::Optional< Aws::Crt::Vector< uint8_t > > Aws::Greengrass::MQTTMessage::GetPayload ( ) const
inlinenoexcept

(Optional) The message payload as a blob.

◆ GetPayloadFormat()

Aws::Crt::Optional< PayloadFormat > Aws::Greengrass::MQTTMessage::GetPayloadFormat ( ) const
noexcept

(Optional) Message payload format.

◆ GetResponseTopic()

Aws::Crt::Optional< Aws::Crt::String > Aws::Greengrass::MQTTMessage::GetResponseTopic ( ) const
inlinenoexcept

(Optional) Response topic for request/response.

◆ GetRetain()

Aws::Crt::Optional< bool > Aws::Greengrass::MQTTMessage::GetRetain ( ) const
inlinenoexcept

(Optional) The value of the retain flag.

◆ GetTopicName()

Aws::Crt::Optional< Aws::Crt::String > Aws::Greengrass::MQTTMessage::GetTopicName ( ) const
inlinenoexcept

The topic to which the message was published.

◆ GetUserProperties()

Aws::Crt::Optional< Aws::Crt::Vector< UserProperty > > Aws::Greengrass::MQTTMessage::GetUserProperties ( ) const
inlinenoexcept

(Optional) MQTT user properties associated with the message.

◆ operator<()

bool Aws::Greengrass::MQTTMessage::operator< ( const MQTTMessage & ) const
noexcept

◆ s_allocateFromPayload()

Aws::Crt::ScopedResource< AbstractShapeBase > Aws::Greengrass::MQTTMessage::s_allocateFromPayload ( Aws::Crt::StringView stringView,
Aws::Crt::Allocator * allocator )
staticnoexcept

◆ s_customDeleter()

void Aws::Greengrass::MQTTMessage::s_customDeleter ( MQTTMessage * shape)
staticnoexcept

◆ s_loadFromJsonView()

void Aws::Greengrass::MQTTMessage::s_loadFromJsonView ( MQTTMessage & mQTTMessage,
const Aws::Crt::JsonView & jsonView )
staticnoexcept

◆ SerializeToJsonObject()

void Aws::Greengrass::MQTTMessage::SerializeToJsonObject ( Aws::Crt::JsonObject & payloadObject) const
overridevirtualnoexcept

◆ SetContentType()

void Aws::Greengrass::MQTTMessage::SetContentType ( const Aws::Crt::String & contentType)
inlinenoexcept

(Optional) Message content type.

◆ SetCorrelationData()

void Aws::Greengrass::MQTTMessage::SetCorrelationData ( const Aws::Crt::Vector< uint8_t > & correlationData)
inlinenoexcept

(Optional) Correlation data blob for request/response.

◆ SetMessageExpiryIntervalSeconds()

void Aws::Greengrass::MQTTMessage::SetMessageExpiryIntervalSeconds ( const int64_t & messageExpiryIntervalSeconds)
inlinenoexcept

(Optional) Message expiry interval in seconds.

◆ SetPayload()

void Aws::Greengrass::MQTTMessage::SetPayload ( const Aws::Crt::Vector< uint8_t > & payload)
inlinenoexcept

(Optional) The message payload as a blob.

◆ SetPayloadFormat()

void Aws::Greengrass::MQTTMessage::SetPayloadFormat ( PayloadFormat payloadFormat)
noexcept

(Optional) Message payload format.

◆ SetResponseTopic()

void Aws::Greengrass::MQTTMessage::SetResponseTopic ( const Aws::Crt::String & responseTopic)
inlinenoexcept

(Optional) Response topic for request/response.

◆ SetRetain()

void Aws::Greengrass::MQTTMessage::SetRetain ( const bool & retain)
inlinenoexcept

(Optional) The value of the retain flag.

◆ SetTopicName()

void Aws::Greengrass::MQTTMessage::SetTopicName ( const Aws::Crt::String & topicName)
inlinenoexcept

The topic to which the message was published.

◆ SetUserProperties()

void Aws::Greengrass::MQTTMessage::SetUserProperties ( const Aws::Crt::Vector< UserProperty > & userProperties)
inlinenoexcept

(Optional) MQTT user properties associated with the message.

Member Data Documentation

◆ MODEL_NAME

const char * Aws::Greengrass::MQTTMessage::MODEL_NAME = "aws.greengrass#MQTTMessage"
static

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