Modules#
EmberAfPluginScanDispatchScanResults
EmberAfPluginScanDispatchScanData
Scan Dispatch#
API and Callbacks for the scan-dispatch Component.
This component allows existence of multiple consumers of the stack 802.15.4 scan results.
This plugin allows for multiple consumers of stack 802.15.4 scan callbacks.
API#
Get the scan type.
Get whether the originally requested scan has completed.
Result in a failure.
Schedule a scan.
Remove all consumers in the queue.
Typedefs#
Handle scan results.
Macros#
The size of the dispatch queue.
API Documentation#
emberAfPluginScanDispatchScanResultsGetScanType#
EmberNetworkScanType emberAfPluginScanDispatchScanResultsGetScanType (EmberAfPluginScanDispatchScanResults * results)
Get the scan type.
| N/A | results | The EmberAfPluginScanDispatchScanResults for which the scan type will be found. |
Gets the scan type from an EmberAfPluginScanDispatchScanResults. This value will either be ::EMBER_ENERGY_SCAN, ::EMBER_ACTIVE_SCAN or ::EMBER_ACTIVE_SCAN_ROUTER
Returns
The ::EmberNetworkScanType of the scan results.
141 of file app/framework/plugin/scan-dispatch/scan-dispatch.hemberAfPluginScanDispatchScanResultsAreComplete#
bool emberAfPluginScanDispatchScanResultsAreComplete (EmberAfPluginScanDispatchScanResults * results)
Get whether the originally requested scan has completed.
| N/A | results | The EmberAfPluginScanDispatchScanResults that belong to a potentially complete scan. |
This can happen either when the dispatcher asks the stack for a scan (see ::emberStartScan) or after all of the scan results have been delivered to the consumer (see emberAfScanCompleteCallback).
Returns
Indicates whether or not the scan for the scan results is complete.
162 of file app/framework/plugin/scan-dispatch/scan-dispatch.hemberAfPluginScanDispatchScanResultsAreFailure#
bool emberAfPluginScanDispatchScanResultsAreFailure (EmberAfPluginScanDispatchScanResults * results)
Result in a failure.
| N/A | results | The EmberAfPluginScanDispatchScanResults for which the call to ::emberStartScan may have failed. |
Gets whether or not the scan results are from a failed call to ::emberStartScan.
Returns
Indicates whether or not the call to ::emberStartScan failed for these results.
182 of file app/framework/plugin/scan-dispatch/scan-dispatch.hemberAfPluginScanDispatchScheduleScan#
EmberStatus emberAfPluginScanDispatchScheduleScan (EmberAfPluginScanDispatchScanData * data)
Schedule a scan.
| N/A | data | An EmberAfPluginScanDispatchScanData that holds the scanType, channelMask, duration, and EmberAfPluginScanDispatchScanResultsHandler for the scan. |
This API schedules an 802.15.4 scan. The results will be delivered to the consumer via a handler in the passed EmberAfPluginScanDispatchScanData.
Returns
An ::EmberStatus value describing the result of the scheduling of a scan.
201 of file app/framework/plugin/scan-dispatch/scan-dispatch.hemberAfPluginScanDispatchClear#
void emberAfPluginScanDispatchClear (void )
Remove all consumers in the queue.
| N/A |
A call to this function will remove all consumers in the queue for scan results. It will also cancel any 802.15.4 scan that the stack is currently performing.
209 of file app/framework/plugin/scan-dispatch/scan-dispatch.hTypedef Documentation#
EmberAfPluginScanDispatchScanResultsHandler#
typedef void(* EmberAfPluginScanDispatchScanResultsHandler) (EmberAfPluginScanDispatchScanResults *results) )(EmberAfPluginScanDispatchScanResults *results)
Handle scan results.
107 of file app/framework/plugin/scan-dispatch/scan-dispatch.h