| /* |
| * 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 |
| * This file includes definitions for tasklets and the tasklet scheduler. |
| */ |
| |
| #ifndef TASKLET_HPP_ |
| #define TASKLET_HPP_ |
| |
| #include "openthread-core-config.h" |
| |
| #include <stdio.h> |
| |
| #include <openthread/tasklet.h> |
| |
| #include "common/locator.hpp" |
| #include "common/non_copyable.hpp" |
| |
| namespace ot { |
| |
| class TaskletScheduler; |
| |
| /** |
| * @addtogroup core-tasklet |
| * |
| * @brief |
| * This module includes definitions for tasklets and the tasklet scheduler. |
| * |
| * @{ |
| * |
| */ |
| |
| /** |
| * This class is used to represent a tasklet. |
| * |
| */ |
| class Tasklet : public InstanceLocator, public OwnerLocator |
| { |
| friend class TaskletScheduler; |
| |
| public: |
| /** |
| * This function reference is called when the tasklet is run. |
| * |
| * @param[in] aTasklet A reference to the tasklet being run. |
| * |
| */ |
| typedef void (&Handler)(Tasklet &aTasklet); |
| |
| /** |
| * This constructor creates a tasklet instance. |
| * |
| * @param[in] aInstance A reference to the OpenThread instance object. |
| * @param[in] aHandler A pointer to a function that is called when the tasklet is run. |
| * @param[in] aOwner A pointer to owner of this `Tasklet` object. |
| * |
| */ |
| Tasklet(Instance &aInstance, Handler aHandler, void *aOwner); |
| |
| /** |
| * This method puts the tasklet on the tasklet scheduler run queue. |
| * |
| * If the tasklet is already posted, no change is made and run queue stays as before. |
| * |
| */ |
| void Post(void); |
| |
| /** |
| * This method indicates whether the tasklet is posted or not. |
| * |
| * @retval TRUE The tasklet is posted. |
| * @retval FALSE The tasklet is not posted. |
| * |
| */ |
| bool IsPosted(void) const { return (mNext != nullptr); } |
| |
| private: |
| void RunTask(void) { mHandler(*this); } |
| |
| Handler mHandler; |
| Tasklet *mNext; |
| }; |
| |
| /** |
| * This class defines a tasklet that also maintains a user context pointer. |
| * |
| * In typical `Tasklet` use, in the handler callback, the owner of the tasklet is determined using `GetOwner<Type>` |
| * method. This method works if there is a single instance of `Type` within OpenThread instance hierarchy. The |
| * `TaskletContext` is intended for cases where there may be multiple instances of the same class/type using a `Tasklet` |
| * object. `TaskletContext` will store a context `void *` information. |
| * |
| */ |
| class TaskletContext : public Tasklet |
| { |
| public: |
| /** |
| * This constructor creates a tasklet instance. |
| * |
| * @param[in] aInstance A reference to the OpenThread instance. |
| * @param[in] aHandler A pointer to a function that is called when the tasklet is run. |
| * @param[in] aContext A pointer to an arbitrary context information. |
| * |
| */ |
| TaskletContext(Instance &aInstance, Handler aHandler, void *aContext) |
| : Tasklet(aInstance, aHandler, aContext) |
| , mContext(aContext) |
| { |
| } |
| |
| /** |
| * This method returns the pointer to the arbitrary context information. |
| * |
| * @returns Pointer to the arbitrary context information. |
| * |
| */ |
| void *GetContext(void) { return mContext; } |
| |
| private: |
| void *mContext; |
| }; |
| |
| /** |
| * This class implements the tasklet scheduler. |
| * |
| */ |
| class TaskletScheduler : private NonCopyable |
| { |
| friend class Tasklet; |
| |
| public: |
| /** |
| * This constructor initializes the object. |
| * |
| */ |
| TaskletScheduler(void); |
| |
| /** |
| * This method indicates whether or not there are tasklets pending. |
| * |
| * @retval TRUE If there are tasklets pending. |
| * @retval FALSE If there are no tasklets pending. |
| * |
| */ |
| bool AreTaskletsPending(void) const { return mTail != nullptr; } |
| |
| /** |
| * This method processes all tasklets queued when this is called. |
| * |
| */ |
| void ProcessQueuedTasklets(void); |
| |
| private: |
| void PostTasklet(Tasklet &aTasklet); |
| |
| Tasklet *mTail; // A circular singly linked-list |
| }; |
| |
| /** |
| * @} |
| * |
| */ |
| |
| } // namespace ot |
| |
| #endif // TASKLET_HPP_ |