Aws::Iotdevicedefenderv1::ReportTask Class Reference

#include <DeviceDefender.h>

Public Member Functions
	~ReportTask ()
	ReportTask (const ReportTask &)=delete
ReportTask &	operator= (const ReportTask &)=delete
void	StopTask () noexcept
int	StartTask () noexcept
ReportTaskStatus	GetStatus () noexcept
int	LastError () const noexcept
void	RegisterCustomMetricNumber (const Crt::String metricName, CustomMetricNumberFunction metricFunc) noexcept
void	RegisterCustomMetricNumberList (const Crt::String metricName, CustomMetricNumberListFunction metricFunc) noexcept
void	RegisterCustomMetricStringList (const Crt::String metricName, CustomMetricStringListFunction metricFunc) noexcept
void	RegisterCustomMetricIpAddressList (const Crt::String metricName, CustomMetricIpListFunction metricFunc) noexcept

Public Attributes
OnTaskCancelledHandler	OnTaskCancelled
void *	cancellationUserdata

Detailed Description

Represents a persistent DeviceDefender V1 task.

Constructor & Destructor Documentation

~ReportTask()

Aws::Iotdevicedefenderv1::ReportTask::~ReportTask

(

)

ReportTask()

Aws::Iotdevicedefenderv1::ReportTask::ReportTask ( const ReportTask &  )

delete

Member Function Documentation

GetStatus()

ReportTaskStatus Aws::Iotdevicedefenderv1::ReportTask::GetStatus ( )

noexcept

Returns the task status.

LastError()

int Aws::Iotdevicedefenderv1::ReportTask::LastError ( ) const

inlinenoexcept

Returns

the value of the last aws error encountered by operations on this instance.

operator=()

ReportTask& Aws::Iotdevicedefenderv1::ReportTask::operator= ( const ReportTask &  )

delete

RegisterCustomMetricIpAddressList()

void Aws::Iotdevicedefenderv1::ReportTask::RegisterCustomMetricIpAddressList ( const Crt::String  metricName, CustomMetricIpListFunction  metricFunc  )

noexcept

Registers a custom metric IP address list function to the Device Defender result. Will call the "metricFunc" function that is passed in each time a report is generated so it's data can be passed along with the other device defender payload data with the metric name of "metricName".

Parameters

metricName	The key name for the data.
metricFunc	The function that is called to get the IP address list data.

RegisterCustomMetricNumber()

void Aws::Iotdevicedefenderv1::ReportTask::RegisterCustomMetricNumber ( const Crt::String  metricName, CustomMetricNumberFunction  metricFunc  )

noexcept

Registers a custom metric number function to the Device Defender result. Will call the "metricFunc" function that is passed in each time a report is generated so it's data can be passed along with the other device defender payload data with the metric name of "metricName".

Parameters

metricName	The key name for the data.
metricFunc	The function that is called to get the number data.

RegisterCustomMetricNumberList()

void Aws::Iotdevicedefenderv1::ReportTask::RegisterCustomMetricNumberList ( const Crt::String  metricName, CustomMetricNumberListFunction  metricFunc  )

noexcept

Registers a custom metric number list function to the Device Defender result. Will call the "metricFunc" function that is passed in each time a report is generated so it's data can be passed along with the other device defender payload data with the metric name of "metricName".

Parameters

metricName	The key name for the data.
metricFunc	The function that is called to get the number list data.

RegisterCustomMetricStringList()

void Aws::Iotdevicedefenderv1::ReportTask::RegisterCustomMetricStringList ( const Crt::String  metricName, CustomMetricStringListFunction  metricFunc  )

noexcept

Registers a custom metric string list function to the Device Defender result. Will call the "metricFunc" function that is passed in each time a report is generated so it's data can be passed along with the other device defender payload data with the metric name of "metricName".

Only valid IP addresses will show up in the Device Defender metrics even if it sends correctly.

Parameters

metricName	The key name for the data.
metricFunc	The function that is called to get the string list data.

StartTask()

int Aws::Iotdevicedefenderv1::ReportTask::StartTask ( )

noexcept

Initiates Defender V1 reporting task.

StopTask()

void Aws::Iotdevicedefenderv1::ReportTask::StopTask ( )

noexcept

Initiates stopping of the Defender V1 task.

Member Data Documentation

cancellationUserdata

void* Aws::Iotdevicedefenderv1::ReportTask::cancellationUserdata

OnTaskCancelled

OnTaskCancelledHandler Aws::Iotdevicedefenderv1::ReportTask::OnTaskCancelled

---

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

• devicedefender/include/aws/iotdevicedefender/DeviceDefender.h
• devicedefender/source/DeviceDefender.cpp