AWS IoT Device SDK C++ v2  1.36.0
AWS IoT Device SDK C++ v2
Classes | Typedefs | Functions
Aws::Iotshadow Namespace Reference

Classes

class  ClientV2
 
class  DeleteNamedShadowRequest
 
class  DeleteNamedShadowSubscriptionRequest
 
class  DeleteShadowRequest
 
class  DeleteShadowResponse
 
class  DeleteShadowSubscriptionRequest
 
class  ErrorResponse
 
class  GetNamedShadowRequest
 
class  GetNamedShadowSubscriptionRequest
 
class  GetShadowRequest
 
class  GetShadowResponse
 
class  GetShadowSubscriptionRequest
 
class  IClientV2
 
class  IotShadowClient
 
class  NamedShadowDeltaUpdatedSubscriptionRequest
 
class  NamedShadowUpdatedSubscriptionRequest
 
class  ServiceErrorV2
 
class  ServiceStreamingOperation
 
class  ShadowDeltaUpdatedEvent
 
class  ShadowDeltaUpdatedSubscriptionRequest
 
class  ShadowMetadata
 
class  ShadowState
 
class  ShadowStateWithDelta
 
class  ShadowUpdatedEvent
 
class  ShadowUpdatedSnapshot
 
class  ShadowUpdatedSubscriptionRequest
 
class  UpdateNamedShadowRequest
 
class  UpdateNamedShadowSubscriptionRequest
 
class  UpdateShadowRequest
 
class  UpdateShadowResponse
 
class  UpdateShadowSubscriptionRequest
 
class  V2ErrorResponse
 

Typedefs

using OnSubscribeComplete = std::function< void(int ioErr)>
 
using OnPublishComplete = std::function< void(int ioErr)>
 
using OnSubscribeToDeleteNamedShadowAcceptedResponse = std::function< void(Aws::Iotshadow::DeleteShadowResponse *, int ioErr)>
 
using OnSubscribeToDeleteNamedShadowRejectedResponse = std::function< void(Aws::Iotshadow::ErrorResponse *, int ioErr)>
 
using OnSubscribeToDeleteShadowAcceptedResponse = std::function< void(Aws::Iotshadow::DeleteShadowResponse *, int ioErr)>
 
using OnSubscribeToDeleteShadowRejectedResponse = std::function< void(Aws::Iotshadow::ErrorResponse *, int ioErr)>
 
using OnSubscribeToGetNamedShadowAcceptedResponse = std::function< void(Aws::Iotshadow::GetShadowResponse *, int ioErr)>
 
using OnSubscribeToGetNamedShadowRejectedResponse = std::function< void(Aws::Iotshadow::ErrorResponse *, int ioErr)>
 
using OnSubscribeToGetShadowAcceptedResponse = std::function< void(Aws::Iotshadow::GetShadowResponse *, int ioErr)>
 
using OnSubscribeToGetShadowRejectedResponse = std::function< void(Aws::Iotshadow::ErrorResponse *, int ioErr)>
 
using OnSubscribeToNamedShadowDeltaUpdatedEventsResponse = std::function< void(Aws::Iotshadow::ShadowDeltaUpdatedEvent *, int ioErr)>
 
using OnSubscribeToNamedShadowUpdatedEventsResponse = std::function< void(Aws::Iotshadow::ShadowUpdatedEvent *, int ioErr)>
 
using OnSubscribeToShadowDeltaUpdatedEventsResponse = std::function< void(Aws::Iotshadow::ShadowDeltaUpdatedEvent *, int ioErr)>
 
using OnSubscribeToShadowUpdatedEventsResponse = std::function< void(Aws::Iotshadow::ShadowUpdatedEvent *, int ioErr)>
 
using OnSubscribeToUpdateNamedShadowAcceptedResponse = std::function< void(Aws::Iotshadow::UpdateShadowResponse *, int ioErr)>
 
using OnSubscribeToUpdateNamedShadowRejectedResponse = std::function< void(Aws::Iotshadow::ErrorResponse *, int ioErr)>
 
using OnSubscribeToUpdateShadowAcceptedResponse = std::function< void(Aws::Iotshadow::UpdateShadowResponse *, int ioErr)>
 
using OnSubscribeToUpdateShadowRejectedResponse = std::function< void(Aws::Iotshadow::ErrorResponse *, int ioErr)>
 
using DeleteNamedShadowResult = Aws::Iot::RequestResponse::Result< DeleteShadowResponse, ServiceErrorV2< V2ErrorResponse > >
 
using DeleteNamedShadowResultHandler = std::function< void(DeleteNamedShadowResult &&)>
 
using DeleteShadowResult = Aws::Iot::RequestResponse::Result< DeleteShadowResponse, ServiceErrorV2< V2ErrorResponse > >
 
using DeleteShadowResultHandler = std::function< void(DeleteShadowResult &&)>
 
using GetNamedShadowResult = Aws::Iot::RequestResponse::Result< GetShadowResponse, ServiceErrorV2< V2ErrorResponse > >
 
using GetNamedShadowResultHandler = std::function< void(GetNamedShadowResult &&)>
 
using GetShadowResult = Aws::Iot::RequestResponse::Result< GetShadowResponse, ServiceErrorV2< V2ErrorResponse > >
 
using GetShadowResultHandler = std::function< void(GetShadowResult &&)>
 
using UpdateNamedShadowResult = Aws::Iot::RequestResponse::Result< UpdateShadowResponse, ServiceErrorV2< V2ErrorResponse > >
 
using UpdateNamedShadowResultHandler = std::function< void(UpdateNamedShadowResult &&)>
 
using UpdateShadowResult = Aws::Iot::RequestResponse::Result< UpdateShadowResponse, ServiceErrorV2< V2ErrorResponse > >
 
using UpdateShadowResultHandler = std::function< void(UpdateShadowResult &&)>
 

Functions

AWS_IOTSHADOW_API std::shared_ptr< IClientV2NewClientFrom5 (const Aws::Crt::Mqtt5::Mqtt5Client &protocolClient, const Aws::Iot::RequestResponse::RequestResponseClientOptions &options, Aws::Crt::Allocator *allocator=Aws::Crt::ApiAllocator())
 
AWS_IOTSHADOW_API std::shared_ptr< IClientV2NewClientFrom311 (const Aws::Crt::Mqtt::MqttConnection &protocolClient, const Aws::Iot::RequestResponse::RequestResponseClientOptions &options, Aws::Crt::Allocator *allocator=Aws::Crt::ApiAllocator())
 
template<typename R , typename E >
static void s_applyUnmodeledErrorToHandler (const std::function< void(R &&)> &handler, int errorCode)
 
template<typename R , typename E >
static void s_applyModeledErrorToHandler (const std::function< void(R &&)> &handler, E &&modeledError)
 
static void s_DeleteNamedShadowResponseHandler (Aws::Iot::RequestResponse::UnmodeledResult &&result, const DeleteNamedShadowResultHandler &handler, const Aws::Crt::String &successPathTopic, const Aws::Crt::String &failurePathTopic)
 
static void s_DeleteShadowResponseHandler (Aws::Iot::RequestResponse::UnmodeledResult &&result, const DeleteShadowResultHandler &handler, const Aws::Crt::String &successPathTopic, const Aws::Crt::String &failurePathTopic)
 
static void s_GetNamedShadowResponseHandler (Aws::Iot::RequestResponse::UnmodeledResult &&result, const GetNamedShadowResultHandler &handler, const Aws::Crt::String &successPathTopic, const Aws::Crt::String &failurePathTopic)
 
static void s_GetShadowResponseHandler (Aws::Iot::RequestResponse::UnmodeledResult &&result, const GetShadowResultHandler &handler, const Aws::Crt::String &successPathTopic, const Aws::Crt::String &failurePathTopic)
 
static void s_UpdateNamedShadowResponseHandler (Aws::Iot::RequestResponse::UnmodeledResult &&result, const UpdateNamedShadowResultHandler &handler, const Aws::Crt::String &successPathTopic, const Aws::Crt::String &failurePathTopic)
 
static void s_UpdateShadowResponseHandler (Aws::Iot::RequestResponse::UnmodeledResult &&result, const UpdateShadowResultHandler &handler, const Aws::Crt::String &successPathTopic, const Aws::Crt::String &failurePathTopic)
 
static bool s_initModeledEvent (const Aws::Iot::RequestResponse::IncomingPublishEvent &publishEvent, ShadowUpdatedEvent &modeledEvent)
 
static bool s_initModeledEvent (const Aws::Iot::RequestResponse::IncomingPublishEvent &publishEvent, ShadowDeltaUpdatedEvent &modeledEvent)
 

Typedef Documentation

◆ DeleteNamedShadowResult

◆ DeleteNamedShadowResultHandler

◆ DeleteShadowResult

◆ DeleteShadowResultHandler

using Aws::Iotshadow::DeleteShadowResultHandler = typedef std::function<void(DeleteShadowResult &&)>

◆ GetNamedShadowResult

◆ GetNamedShadowResultHandler

using Aws::Iotshadow::GetNamedShadowResultHandler = typedef std::function<void(GetNamedShadowResult &&)>

◆ GetShadowResult

◆ GetShadowResultHandler

using Aws::Iotshadow::GetShadowResultHandler = typedef std::function<void(GetShadowResult &&)>

◆ OnPublishComplete

using Aws::Iotshadow::OnPublishComplete = typedef std::function<void(int ioErr)>

◆ OnSubscribeComplete

using Aws::Iotshadow::OnSubscribeComplete = typedef std::function<void(int ioErr)>

◆ OnSubscribeToDeleteNamedShadowAcceptedResponse

◆ OnSubscribeToDeleteNamedShadowRejectedResponse

◆ OnSubscribeToDeleteShadowAcceptedResponse

◆ OnSubscribeToDeleteShadowRejectedResponse

◆ OnSubscribeToGetNamedShadowAcceptedResponse

◆ OnSubscribeToGetNamedShadowRejectedResponse

◆ OnSubscribeToGetShadowAcceptedResponse

◆ OnSubscribeToGetShadowRejectedResponse

◆ OnSubscribeToNamedShadowDeltaUpdatedEventsResponse

◆ OnSubscribeToNamedShadowUpdatedEventsResponse

◆ OnSubscribeToShadowDeltaUpdatedEventsResponse

◆ OnSubscribeToShadowUpdatedEventsResponse

◆ OnSubscribeToUpdateNamedShadowAcceptedResponse

◆ OnSubscribeToUpdateNamedShadowRejectedResponse

◆ OnSubscribeToUpdateShadowAcceptedResponse

◆ OnSubscribeToUpdateShadowRejectedResponse

◆ UpdateNamedShadowResult

◆ UpdateNamedShadowResultHandler

◆ UpdateShadowResult

◆ UpdateShadowResultHandler

using Aws::Iotshadow::UpdateShadowResultHandler = typedef std::function<void(UpdateShadowResult &&)>

Function Documentation

◆ NewClientFrom311()

std::shared_ptr< IClientV2 > Aws::Iotshadow::NewClientFrom311 ( const Aws::Crt::Mqtt::MqttConnection protocolClient,
const Aws::Iot::RequestResponse::RequestResponseClientOptions options,
Aws::Crt::Allocator allocator = Aws::Crt::ApiAllocator() 
)

Creates a new service client that uses an SDK MQTT311 client for transport.

Parameters
protocolClientMQTT client to use as transport
optionsrequest-response MQTT client configuration options
allocatormemory allocator to use for all client functionality
Returns
a new service client

◆ NewClientFrom5()

std::shared_ptr< IClientV2 > Aws::Iotshadow::NewClientFrom5 ( const Aws::Crt::Mqtt5::Mqtt5Client protocolClient,
const Aws::Iot::RequestResponse::RequestResponseClientOptions options,
Aws::Crt::Allocator allocator = Aws::Crt::ApiAllocator() 
)

Creates a new service client that uses an SDK MQTT5 client for transport.

Parameters
protocolClientMQTT client to use as transport
optionsrequest-response MQTT client configuration options
allocatormemory allocator to use for all client functionality
Returns
a new service client

◆ s_applyModeledErrorToHandler()

template<typename R , typename E >
static void Aws::Iotshadow::s_applyModeledErrorToHandler ( const std::function< void(R &&)> &  handler,
E &&  modeledError 
)
static

◆ s_applyUnmodeledErrorToHandler()

template<typename R , typename E >
static void Aws::Iotshadow::s_applyUnmodeledErrorToHandler ( const std::function< void(R &&)> &  handler,
int  errorCode 
)
static

◆ s_DeleteNamedShadowResponseHandler()

static void Aws::Iotshadow::s_DeleteNamedShadowResponseHandler ( Aws::Iot::RequestResponse::UnmodeledResult &&  result,
const DeleteNamedShadowResultHandler handler,
const Aws::Crt::String successPathTopic,
const Aws::Crt::String failurePathTopic 
)
static

◆ s_DeleteShadowResponseHandler()

static void Aws::Iotshadow::s_DeleteShadowResponseHandler ( Aws::Iot::RequestResponse::UnmodeledResult &&  result,
const DeleteShadowResultHandler handler,
const Aws::Crt::String successPathTopic,
const Aws::Crt::String failurePathTopic 
)
static

◆ s_GetNamedShadowResponseHandler()

static void Aws::Iotshadow::s_GetNamedShadowResponseHandler ( Aws::Iot::RequestResponse::UnmodeledResult &&  result,
const GetNamedShadowResultHandler handler,
const Aws::Crt::String successPathTopic,
const Aws::Crt::String failurePathTopic 
)
static

◆ s_GetShadowResponseHandler()

static void Aws::Iotshadow::s_GetShadowResponseHandler ( Aws::Iot::RequestResponse::UnmodeledResult &&  result,
const GetShadowResultHandler handler,
const Aws::Crt::String successPathTopic,
const Aws::Crt::String failurePathTopic 
)
static

◆ s_initModeledEvent() [1/2]

static bool Aws::Iotshadow::s_initModeledEvent ( const Aws::Iot::RequestResponse::IncomingPublishEvent publishEvent,
ShadowDeltaUpdatedEvent modeledEvent 
)
static

◆ s_initModeledEvent() [2/2]

static bool Aws::Iotshadow::s_initModeledEvent ( const Aws::Iot::RequestResponse::IncomingPublishEvent publishEvent,
ShadowUpdatedEvent modeledEvent 
)
static

◆ s_UpdateNamedShadowResponseHandler()

static void Aws::Iotshadow::s_UpdateNamedShadowResponseHandler ( Aws::Iot::RequestResponse::UnmodeledResult &&  result,
const UpdateNamedShadowResultHandler handler,
const Aws::Crt::String successPathTopic,
const Aws::Crt::String failurePathTopic 
)
static

◆ s_UpdateShadowResponseHandler()

static void Aws::Iotshadow::s_UpdateShadowResponseHandler ( Aws::Iot::RequestResponse::UnmodeledResult &&  result,
const UpdateShadowResultHandler handler,
const Aws::Crt::String successPathTopic,
const Aws::Crt::String failurePathTopic 
)
static