This class implements handling PANID Query Requests. More...

Inheritance diagram for ot::EnergyScanClient:

Public Member Functions
	EnergyScanClient (otInstance &aInstance)
	This constructor initializes the object.

otError	SendQuery (uint32_t aChannelMask, uint8_t aCount, uint16_t aPeriod, uint16_t aScanDuration, const Ip6::Address &aAddress, otCommissionerEnergyReportCallback aCallback, void *aContext)
	This method sends an Energy Scan Query message. More...

Public Member Functions inherited from ot::InstanceLocator
otInstance &	GetInstance (void) const
	This method returns a reference to the parent otInstance structure. More...

Ip6::Ip6 &	GetIp6 (void) const
	This method returns a reference to the Ip6. More...

ThreadNetif &	GetNetif (void) const
	This method returns a reference to the thread network interface. More...

Additional Inherited Members
Protected Member Functions inherited from ot::InstanceLocator
	InstanceLocator (otInstance &aInstance)
	This constructor initializes the object. More...

Detailed Description

This class implements handling PANID Query Requests.

Member Function Documentation

otError ot::EnergyScanClient::SendQuery	(	uint32_t	aChannelMask,
		uint8_t	aCount,
		uint16_t	aPeriod,
		uint16_t	aScanDuration,
		const Ip6::Address &	aAddress,
		otCommissionerEnergyReportCallback	aCallback,
		void *	aContext
	)

This method sends an Energy Scan Query message.

Parameters

[in]	aChannelMask	The channel mask value.
[in]	aCount	The number of energy measurements per channel.
[in]	aPeriod	The time between energy measurements (milliseconds).
[in]	aScanDuration	The scan duration for each energy measurement (milliseconds).
[in]	aAddress	A pointer to the IPv6 destination.
[in]	aCallback	A pointer to a function called on receiving an Energy Report message.
[in]	aContext	A pointer to application-specific context.

Return values

OT_ERROR_NONE	Successfully enqueued the Energy Scan Query message.
OT_ERROR_NO_BUFS	Insufficient buffers to generate an Energy Scan Query message.

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