AWS IoT C++ SDK
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Data Fields
awsiotsdk::ActionData Class Referenceabstract

Action Data Class. More...

#include <Action.hpp>

Inheritance diagram for awsiotsdk::ActionData:
awsiotsdk::discovery::DiscoverRequestData awsiotsdk::mqtt::Packet awsiotsdk::mqtt::ConnectPacket awsiotsdk::mqtt::DisconnectPacket awsiotsdk::mqtt::PingreqPacket awsiotsdk::mqtt::PubackPacket awsiotsdk::mqtt::PublishPacket awsiotsdk::mqtt::SubackPacket awsiotsdk::mqtt::SubscribePacket awsiotsdk::mqtt::UnsubackPacket awsiotsdk::mqtt::UnsubscribePacket

Public Types

typedef std::function< void(uint16_t action_id, ResponseCode rc)> AsyncAckNotificationHandlerPtr
 

Public Member Functions

 ActionData (const ActionData &)=default
 
 ActionData (ActionData &&)=default
 
ActionDataoperator= (const ActionData &) &=default
 
ActionDataoperator= (ActionData &&) &=default
 
virtual uint16_t GetActionId ()=0
 Get ID of the current run of this Action. More...
 
virtual void SetActionId (uint16_t action_id)=0
 Set the Action ID for this run of the Action. More...
 

Data Fields

AsyncAckNotificationHandlerPtr p_async_ack_handler_
 Handler to call when response is received for this action.
 

Detailed Description

Defines an Action Data class which contains dynamic information to be used by the action Instance of concrete implementation of this class is passed as argument each time Perform Action is called This is a pure virtual class, cannot be instantiated

Member Typedef Documentation

◆ AsyncAckNotificationHandlerPtr

typedef std::function<void(uint16_t action_id, ResponseCode rc)> awsiotsdk::ActionData::AsyncAckNotificationHandlerPtr

Define a type for the Async Ack notification handler Clients can provide an instance of this to receive notification on status of Async API calls

Member Function Documentation

◆ GetActionId()

virtual uint16_t awsiotsdk::ActionData::GetActionId ( )
pure virtual

◆ SetActionId()

virtual void awsiotsdk::ActionData::SetActionId ( uint16_t  action_id)
pure virtual
Parameters
action_id- new Action ID

Implemented in awsiotsdk::discovery::DiscoverRequestData, and awsiotsdk::mqtt::Packet.