Counters#
API and Callbacks for the Counters Component.
This component provides support for reading and manipulating counters that record different events in the stack.
API#
Macros#
API Documentation#
emberAfPluginCountersSendRequest#
EmberStatus emberAfPluginCountersSendRequest (EmberNodeId destination, bool clearCounters)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberNodeId | N/A | destination | the address of the node to send the request to. |
| bool | N/A | clearCounters | whether or not the destination should reset its counters to zero after successfully reporting them back to the requester. Because of technical constraints, counters are always cleared on a network coprocessor, such as the EM260. |
Send an request to the specified destination to send back a report of the non-zero counters.
Returns
EMBER_SUCCESS if the request was successfully submitted for sending. See ::emberSendUnicast() or ::ezspSendUnicast for possible failure statuses.
88 of file app/framework/plugin/counters/counters-ota.hemberAfPluginCountersIsIncomingRequest#
bool emberAfPluginCountersIsIncomingRequest (EmberApsFrame * apsFrame, EmberNodeId sender)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberApsFrame * | N/A | apsFrame | the APS frame passed to the incoming message handler. |
| EmberNodeId | N/A | sender | the node ID of the sender of the request. |
Call this function at the beginning of the incoming message handler. It returns true if the incoming message was a counter's request and should be ignored by the rest of the incoming message handler.
Returns
true if the message was a counters request and should be ignored by the rest of the incoming message handler.
101 of file app/framework/plugin/counters/counters-ota.hemberAfPluginCountersIsIncomingResponse#
bool emberAfPluginCountersIsIncomingResponse (EmberApsFrame * apsFrame)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberApsFrame * | N/A | apsFrame | the APS frame passed to the incoming message handler. |
Call this function within the incoming message handler to determine if the message is a counter's response. If so, it is up to the application to decode the payload whose format is described above.
Returns
true if the message is a counters response.
112 of file app/framework/plugin/counters/counters-ota.hemberAfPluginCountersIsOutgoingResponse#
bool emberAfPluginCountersIsOutgoingResponse (EmberApsFrame * apsFrame, EmberStatus status, return)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberApsFrame * | N/A | apsFrame | the APS frame passed to the message sent handler. |
| EmberStatus | N/A | status | the status passed to the message sent handler. |
| N/A | return | true if the message was a counters response and should be ignored by the rest of the message sent handler. |
Call this function at the beginning of the message sent handler. It returns true if the message was a counters response and should be ignored by the rest of the handler.
123 of file app/framework/plugin/counters/counters-ota.h