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 * Gets the Child Supervision interval (in seconds) on a child. 55 * 56 * Child Supervision feature provides a mechanism for parent to ensure that a message is sent to each sleepy child 57 * within the supervision interval. If there is no transmission to the child within the supervision interval, OpenThread 58 * enqueues and sends a Child Supervision Message to the child. 59 * 60 * @param[in] aInstance A pointer to an OpenThread instance. 61 * 62 * @returns The child supervision interval. Zero indicates that supervision is disabled. 63 */ 64 uint16_t otChildSupervisionGetInterval(otInstance *aInstance); 65 66 /** 67 * Sets the child supervision interval (in seconds) on the child. 68 * 69 * @param[in] aInstance A pointer to an OpenThread instance. 70 * @param[in] aInterval The supervision interval (in seconds). Zero to disable supervision. 71 */ 72 void otChildSupervisionSetInterval(otInstance *aInstance, uint16_t aInterval); 73 74 /** 75 * Gets the supervision check timeout interval (in seconds) on the child. 76 * 77 * If the device is a sleepy child and it does not hear from its parent within the specified check timeout, it initiates 78 * the re-attach process (MLE Child Update Request/Response exchange with its parent). 79 * 80 * @param[in] aInstance A pointer to an OpenThread instance. 81 * 82 * @returns The supervision check timeout. Zero indicates that supervision check on the child is disabled. 83 */ 84 uint16_t otChildSupervisionGetCheckTimeout(otInstance *aInstance); 85 86 /** 87 * Sets the supervision check timeout interval (in seconds) on the child. 88 * 89 * @param[in] aInstance A pointer to an OpenThread instance. 90 * @param[in] aTimeout The check timeout (in seconds). Zero to disable supervision check on the child. 91 */ 92 void otChildSupervisionSetCheckTimeout(otInstance *aInstance, uint16_t aTimeout); 93 94 /** 95 * Get the value of supervision check timeout failure counter. 96 * 97 * The counter tracks the number of supervision check failures on the child. It is incremented when the child does 98 * not hear from its parent within the specified check timeout interval. 99 */ 100 uint16_t otChildSupervisionGetCheckFailureCounter(otInstance *aInstance); 101 102 /** 103 * Reset the supervision check timeout failure counter to zero. 104 */ 105 void otChildSupervisionResetCheckFailureCounter(otInstance *aInstance); 106 107 /** 108 * @} 109 */ 110 111 #ifdef __cplusplus 112 } // extern "C" 113 #endif 114 115 #endif // OPENTHREAD_CHILD_SUPERVISION_H_ 116