1 /*
2  *  Copyright (c) 2017, The OpenThread Authors.
3  *  All rights reserved.
4  *
5  *  Redistribution and use in source and binary forms, with or without
6  *  modification, are permitted provided that the following conditions are met:
7  *  1. Redistributions of source code must retain the above copyright
8  *     notice, this list of conditions and the following disclaimer.
9  *  2. Redistributions in binary form must reproduce the above copyright
10  *     notice, this list of conditions and the following disclaimer in the
11  *     documentation and/or other materials provided with the distribution.
12  *  3. Neither the name of the copyright holder nor the
13  *     names of its contributors may be used to endorse or promote products
14  *     derived from this software without specific prior written permission.
15  *
16  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  *  POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 /**
30  * @file
31  * @brief
32  *   This file includes the OpenThread API for child supervision feature.
33  */
34 
35 #ifndef OPENTHREAD_CHILD_SUPERVISION_H_
36 #define OPENTHREAD_CHILD_SUPERVISION_H_
37 
38 #include <openthread/instance.h>
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 /**
45  * @addtogroup api-child-supervision
46  *
47  * @brief
48  *   This module includes functions for Child Supervision feature.
49  *
50  * @{
51  *
52  */
53 
54 /**
55  * Gets the Child Supervision interval (in seconds) on a child.
56  *
57  * Child Supervision feature provides a mechanism for parent to ensure that a message is sent to each sleepy child
58  * within the supervision interval. If there is no transmission to the child within the supervision interval, OpenThread
59  * enqueues and sends a Child Supervision Message to the child.
60  *
61  * @param[in]  aInstance       A pointer to an OpenThread instance.
62  *
63  * @returns  The child supervision interval. Zero indicates that supervision is disabled.
64  *
65  */
66 uint16_t otChildSupervisionGetInterval(otInstance *aInstance);
67 
68 /**
69  * Sets the child supervision interval (in seconds) on the child.
70  *
71  * @param[in]  aInstance       A pointer to an OpenThread instance.
72  * @param[in]  aInterval       The supervision interval (in seconds). Zero to disable supervision.
73  *
74  */
75 void otChildSupervisionSetInterval(otInstance *aInstance, uint16_t aInterval);
76 
77 /**
78  * Gets the supervision check timeout interval (in seconds) on the child.
79  *
80  * If the device is a sleepy child and it does not hear from its parent within the specified check timeout, it initiates
81  * the re-attach process (MLE Child Update Request/Response exchange with its parent).
82  *
83  * @param[in]  aInstance       A pointer to an OpenThread instance.
84  *
85  * @returns  The supervision check timeout. Zero indicates that supervision check on the child is disabled.
86  *
87  */
88 uint16_t otChildSupervisionGetCheckTimeout(otInstance *aInstance);
89 
90 /**
91  * Sets the supervision check timeout interval (in seconds) on the child.
92  *
93  * @param[in]  aInstance       A pointer to an OpenThread instance.
94  * @param[in]  aTimeout        The check timeout (in seconds). Zero to disable supervision check on the child.
95  *
96  */
97 void otChildSupervisionSetCheckTimeout(otInstance *aInstance, uint16_t aTimeout);
98 
99 /**
100  * Get the value of supervision check timeout failure counter.
101  *
102  * The counter tracks the number of supervision check failures on the child. It is incremented when the child does
103  * not hear from its parent within the specified check timeout interval.
104  *
105  */
106 uint16_t otChildSupervisionGetCheckFailureCounter(otInstance *aInstance);
107 
108 /**
109  * Reset the supervision check timeout failure counter to zero.
110  *
111  */
112 void otChildSupervisionResetCheckFailureCounter(otInstance *aInstance);
113 
114 /**
115  * @}
116  *
117  */
118 
119 #ifdef __cplusplus
120 } // extern "C"
121 #endif
122 
123 #endif // OPENTHREAD_CHILD_SUPERVISION_H_
124