Aws::Iot::DeviceClient::Feature Class Reference

Common interface for orchestration of Device Client features. More...

#include <Feature.h>

Inheritance diagram for Aws::Iot::DeviceClient::Feature:

Public Member Functions
virtual int	start ()=0
	Start the feature. More...
virtual int	stop ()=0
	Stop the feature. More...
virtual std::string	getName ()=0
	For a given feature, returns its name. More...

Static Public Attributes
static constexpr int	SUCCESS = 0
	Status code returned when feature is successfully started or stopped.

Detailed Description

Common interface for orchestration of Device Client features.

The Feature interface provides some basic methods for orchestrating the individual features running as part of the Device Client (DC). The start() and stop() methods allow the agent base (main.cpp) to either start operation of the feature after performing initialization or to stop a feature in the event that it receives a signal indicating that the program must shut down as soon as possible.

Member Function Documentation

getName()

virtual std::string Aws::Iot::DeviceClient::Feature::getName ( )

pure virtual

For a given feature, returns its name.

Returns

a string value representing the feature's name

Implemented in Aws::Iot::DeviceClient::SecureTunneling::SecureTunnelingFeature, Aws::Iot::DeviceClient::Shadow::SampleShadowFeature, Aws::Iot::DeviceClient::SensorPublish::SensorPublishFeature, Aws::Iot::DeviceClient::Samples::PubSubFeature, Aws::Iot::DeviceClient::Jobs::JobsFeature, and Aws::Iot::DeviceClient::DeviceDefender::DeviceDefenderFeature.

start()

virtual int Aws::Iot::DeviceClient::Feature::start ( )

pure virtual

Start the feature.

Returns

an integer representing the SUCCESS or FAILURE of the start() operation on the feature

Implemented in Aws::Iot::DeviceClient::SecureTunneling::SecureTunnelingFeature, Aws::Iot::DeviceClient::Shadow::SampleShadowFeature, Aws::Iot::DeviceClient::SensorPublish::SensorPublishFeature, Aws::Iot::DeviceClient::Samples::PubSubFeature, Aws::Iot::DeviceClient::Jobs::JobsFeature, and Aws::Iot::DeviceClient::DeviceDefender::DeviceDefenderFeature.

stop()

virtual int Aws::Iot::DeviceClient::Feature::stop ( )

pure virtual

Stop the feature.

Returns

an integer representing the SUCCESS or FAILURE of the stop() operation on the feature

Implemented in Aws::Iot::DeviceClient::SecureTunneling::SecureTunnelingFeature, Aws::Iot::DeviceClient::Shadow::SampleShadowFeature, Aws::Iot::DeviceClient::SensorPublish::SensorPublishFeature, Aws::Iot::DeviceClient::Samples::PubSubFeature, Aws::Iot::DeviceClient::Jobs::JobsFeature, and Aws::Iot::DeviceClient::DeviceDefender::DeviceDefenderFeature.

---

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

• /home/runner/work/aws-iot-device-client/aws-iot-device-client/source/Feature.h
• /home/runner/work/aws-iot-device-client/aws-iot-device-client/source/sensor-publish/SensorPublishFeature.cpp