diff options
| author | Clyne Sullivan <tullivan99@gmail.com> | 2016-11-08 20:09:05 -0500 |
|---|---|---|
| committer | Clyne Sullivan <tullivan99@gmail.com> | 2016-11-08 20:09:05 -0500 |
| commit | 92235fb259b0ebdfc99859c2c95fe1f8c163f411 (patch) | |
| tree | e90d9b5adddad8d0ae744eadb5d15313517cc71b /include/distortos/architecture/requestFunctionExecution.hpp | |
| parent | daad5eaa0296ff30624da5fbfaacdb88792b5fea (diff) | |
trying out distortos
Diffstat (limited to 'include/distortos/architecture/requestFunctionExecution.hpp')
| -rw-r--r-- | include/distortos/architecture/requestFunctionExecution.hpp | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/include/distortos/architecture/requestFunctionExecution.hpp b/include/distortos/architecture/requestFunctionExecution.hpp new file mode 100644 index 0000000..69c9eda --- /dev/null +++ b/include/distortos/architecture/requestFunctionExecution.hpp @@ -0,0 +1,53 @@ +/** + * \file + * \brief requestFunctionExecution() declaration + * + * \author Copyright (C) 2015 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info + * + * \par License + * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not + * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + +#ifndef INCLUDE_DISTORTOS_ARCHITECTURE_REQUESTFUNCTIONEXECUTION_HPP_ +#define INCLUDE_DISTORTOS_ARCHITECTURE_REQUESTFUNCTIONEXECUTION_HPP_ + +namespace distortos +{ + +namespace internal +{ + +class ThreadControlBlock; + +} // namespace internal + +namespace architecture +{ + +/** + * \brief Requests execution of provided function in the specified thread. + * + * Main use case for this function is to request execution of signals delivery function. In such case it is called when + * an unblocked signal, which is not ignored, is generated or queued for specified thread. + * + * It must arrange for given function to be executed in specified thread as soon as possible. This generally requires + * dealing with following scenarios: + * - current thread is sending the request to itself - in that case just execute function right away; + * - current thread is sending the request to non-current thread; + * - interrupt is sending the request to current thread; + * - interrupt is sending the request to non-current thread; + * + * \param [in] threadControlBlock is a reference to internal::ThreadControlBlock of thread in which \a function should + * be executed + * \param [in] function is a reference to function that should be executed in thread associated with + * \a threadControlBlock + */ + +void requestFunctionExecution(internal::ThreadControlBlock& threadControlBlock, void (& function)()); + +} // namespace architecture + +} // namespace distortos + +#endif // INCLUDE_DISTORTOS_ARCHITECTURE_REQUESTFUNCTIONEXECUTION_HPP_ |