1 /* 2 * Copyright (c) 2016, 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 defines the OpenThread API for Tasklets. 33 */ 34 35 #ifndef OPENTHREAD_TASKLET_H_ 36 #define OPENTHREAD_TASKLET_H_ 37 38 #include <openthread/instance.h> 39 40 #ifdef __cplusplus 41 extern "C" { 42 #endif 43 44 /** 45 * @addtogroup api-tasklets 46 * 47 * @brief 48 * This module includes functions that control the Thread stack's execution. 49 * 50 * @{ 51 */ 52 53 /** 54 * Run all queued OpenThread tasklets at the time this is called. 55 * 56 * @param[in] aInstance A pointer to an OpenThread instance. 57 */ 58 void otTaskletsProcess(otInstance *aInstance); 59 60 /** 61 * Indicates whether or not OpenThread has tasklets pending. 62 * 63 * @param[in] aInstance A pointer to an OpenThread instance. 64 * 65 * @retval TRUE If there are tasklets pending. 66 * @retval FALSE If there are no tasklets pending. 67 */ 68 bool otTaskletsArePending(otInstance *aInstance); 69 70 /** 71 * OpenThread calls this function when the tasklet queue transitions from empty to non-empty. 72 * 73 * @param[in] aInstance A pointer to an OpenThread instance. 74 */ 75 extern void otTaskletsSignalPending(otInstance *aInstance); 76 77 /** 78 * @} 79 */ 80 81 #ifdef __cplusplus 82 } // extern "C" 83 #endif 84 85 #endif // OPENTHREAD_TASKLET_H_ 86