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