Child Supervision#
This module includes functions for Child Supervision feature.
Functions#
Gets the Child Supervision interval (in seconds) on a child.
Sets the child supervision interval (in seconds) on the child.
Gets the supervision check timeout interval (in seconds) on the child.
Sets the supervision check timeout interval (in seconds) on the child.
Get the value of supervision check timeout failure counter.
Reset the supervision check timeout failure counter to zero.
Function Documentation#
otChildSupervisionGetInterval#
uint16_t otChildSupervisionGetInterval (otInstance * aInstance)
Gets the Child Supervision interval (in seconds) on a child.
[in] | aInstance | A pointer to an OpenThread instance. |
Child Supervision feature provides a mechanism for parent to ensure that a message is sent to each sleepy child within the supervision interval. If there is no transmission to the child within the supervision interval, OpenThread enqueues and sends a Child Supervision Message to the child.
Returns
The child supervision interval. Zero indicates that supervision is disabled.
66
of file include/openthread/child_supervision.h
otChildSupervisionSetInterval#
void otChildSupervisionSetInterval (otInstance * aInstance, uint16_t aInterval)
Sets the child supervision interval (in seconds) on the child.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aInterval | The supervision interval (in seconds). Zero to disable supervision. |
75
of file include/openthread/child_supervision.h
otChildSupervisionGetCheckTimeout#
uint16_t otChildSupervisionGetCheckTimeout (otInstance * aInstance)
Gets the supervision check timeout interval (in seconds) on the child.
[in] | aInstance | A pointer to an OpenThread instance. |
If the device is a sleepy child and it does not hear from its parent within the specified check timeout, it initiates the re-attach process (MLE Child Update Request/Response exchange with its parent).
Returns
The supervision check timeout. Zero indicates that supervision check on the child is disabled.
88
of file include/openthread/child_supervision.h
otChildSupervisionSetCheckTimeout#
void otChildSupervisionSetCheckTimeout (otInstance * aInstance, uint16_t aTimeout)
Sets the supervision check timeout interval (in seconds) on the child.
[in] | aInstance | A pointer to an OpenThread instance. |
[in] | aTimeout | The check timeout (in seconds). Zero to disable supervision check on the child. |
97
of file include/openthread/child_supervision.h
otChildSupervisionGetCheckFailureCounter#
uint16_t otChildSupervisionGetCheckFailureCounter (otInstance * aInstance)
Get the value of supervision check timeout failure counter.
N/A | aInstance |
The counter tracks the number of supervision check failures on the child. It is incremented when the child does not hear from its parent within the specified check timeout interval.
106
of file include/openthread/child_supervision.h
otChildSupervisionResetCheckFailureCounter#
void otChildSupervisionResetCheckFailureCounter (otInstance * aInstance)
Reset the supervision check timeout failure counter to zero.
N/A | aInstance |
112
of file include/openthread/child_supervision.h