awsiotsdk::discovery::DiscoverRequestData Class Reference

Discover Request Packet Type. More...

#include <Discovery.hpp>

Inheritance diagram for awsiotsdk::discovery::DiscoverRequestData:

Public Member Functions
	DiscoverRequestData (const DiscoverRequestData &)=delete
	DiscoverRequestData (DiscoverRequestData &&)=delete
DiscoverRequestData &	operator= (const DiscoverRequestData &) &=delete
DiscoverRequestData &	operator= (DiscoverRequestData &&) &=delete
	DiscoverRequestData (std::unique_ptr< Utf8String > p_thing_name, std::chrono::milliseconds max_response_wait_time)
	Constructor. More...
util::String	ToString ()
	Serialize this packet into a String. More...
std::chrono::milliseconds	GetMaxResponseWaitTime ()
	return the max time for which it will wait for a discovery reply More...
virtual uint16_t	GetActionId ()
	returns the action ID (currently unused in Discovery) More...
virtual void	SetActionId (uint16_t action_id)
	sets the action ID (currently unused in Discovery) More...
Public Member Functions inherited from awsiotsdk::ActionData
	ActionData (const ActionData &)=default
	ActionData (ActionData &&)=default
ActionData &	operator= (const ActionData &) &=default
ActionData &	operator= (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...

Static Public Member Functions
static std::shared_ptr< DiscoverRequestData >	Create (std::unique_ptr< Utf8String > p_thing_name, std::chrono::milliseconds max_response_wait_time)
	Create Factory method. More...

Data Fields
DiscoveryResponse	discovery_response_
	Response received in Discover request.
Data Fields inherited from awsiotsdk::ActionData
AsyncAckNotificationHandlerPtr	p_async_ack_handler_
	Handler to call when response is received for this action.

Protected Attributes
std::unique_ptr< Utf8String >	p_thing_name_
	Utf8 string defining the Thing name.
util::String	discovery_request_data_
	Packet data.
std::chrono::milliseconds	max_response_wait_time_
	Maximum time the device should wait for response.

Additional Inherited Members
Public Types inherited from awsiotsdk::ActionData
typedef std::function< void(uint16_t action_id, ResponseCode rc)>	AsyncAckNotificationHandlerPtr

Detailed Description

Defines a type for Discover Request Packet message

Constructor & Destructor Documentation

DiscoverRequestData()

awsiotsdk::discovery::DiscoverRequestData::DiscoverRequestData	(	std::unique_ptr< Utf8String >	p_thing_name,
		std::chrono::milliseconds	max_response_wait_time
	)

Warning

This constructor can throw exceptions, it is recommended to use Factory create method Constructor is kept public to not restrict usage possibilities (eg. make_shared)

Parameters

p_thing_name_	- Thing name to use to perform discovery
max_response_wait_time	- discovery reply timeout in milliseconds

Member Function Documentation

Create()

std::shared_ptr< DiscoverRequestData > awsiotsdk::discovery::DiscoverRequestData::Create ( std::unique_ptr< Utf8String >  p_thing_name, std::chrono::milliseconds  max_response_wait_time  )

static

Parameters

p_thing_name_	- Thing name to use to perform discovery
max_response_wait_time	- max time for which it will wait for a discovery reply, in milliseconds

Returns

nullptr on error, shared_ptr pointing to a created DiscoverRequestData instance if successful

GetActionId()

virtual uint16_t awsiotsdk::discovery::DiscoverRequestData::GetActionId ( )

inlinevirtual

Returns

uint16_t

Implements awsiotsdk::ActionData.

GetMaxResponseWaitTime()

std::chrono::milliseconds awsiotsdk::discovery::DiscoverRequestData::GetMaxResponseWaitTime ( )

inline

Returns

wait time in milliseconds

SetActionId()

virtual void awsiotsdk::discovery::DiscoverRequestData::SetActionId ( uint16_t  action_id )

inlinevirtual

Parameters

action_id

Implements awsiotsdk::ActionData.

ToString()

util::String awsiotsdk::discovery::DiscoverRequestData::ToString

(

)

Returns

String containing serialized packet