Files
openthread/include/openthread-tasklet.h
T
Nick Banks 74a95f042d Windows API DLL (#882)
* VS Solution files and minor fixes.

* Move Tasklet into platform include file

* Refactor data path APIs into openthread-ip6.h
2016-11-04 09:28:17 -07:00

89 lines
2.7 KiB
C

/*
* Copyright (c) 2016, The OpenThread Authors.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the copyright holder nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/**
* @file
* @brief
* This file includes the platform abstraction for the tasklet service.
*/
#ifndef OPENTHREAD_TASKLET_H_
#define OPENTHREAD_TASKLET_H_
#include <openthread-types.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @addtogroup execution Execution
*
* @brief
* This module includes functions that control the Thread stack's execution.
*
* @{
*
*/
/**
* Run all queued OpenThread tasklets at the time this is called.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*/
void otProcessQueuedTasklets(otInstance *aInstance);
/**
* Indicates whether or not OpenThread has tasklets pending.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
* @retval TRUE If there are tasklets pending.
* @retval FALSE If there are no tasklets pending.
*/
bool otAreTaskletsPending(otInstance *aInstance);
/**
* OpenThread calls this function when the tasklet queue transitions from empty to non-empty.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
*/
extern void otSignalTaskletPending(otInstance *aInstance);
/**
* @}
*
*/
#ifdef __cplusplus
} // extern "C"
#endif
#endif // OPENTHREAD_TASKLET_H_