diff options
Diffstat (limited to 'include/distortos/internal/synchronization/SemaphoreFunctor.hpp')
-rw-r--r-- | include/distortos/internal/synchronization/SemaphoreFunctor.hpp | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/include/distortos/internal/synchronization/SemaphoreFunctor.hpp b/include/distortos/internal/synchronization/SemaphoreFunctor.hpp new file mode 100644 index 0000000..0b937ff --- /dev/null +++ b/include/distortos/internal/synchronization/SemaphoreFunctor.hpp @@ -0,0 +1,43 @@ +/** + * \file + * \brief SemaphoreFunctor class header + * + * \author Copyright (C) 2014-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_INTERNAL_SYNCHRONIZATION_SEMAPHOREFUNCTOR_HPP_ +#define INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SEMAPHOREFUNCTOR_HPP_ + +#include "estd/TypeErasedFunctor.hpp" + +namespace distortos +{ + +class Semaphore; + +namespace internal +{ + +/** + * \brief SemaphoreFunctor is a type-erased interface for functors which execute some action on semaphore (wait(), + * tryWait(), tryWaitFor(), tryWaitUntil(), ...). + * + * The functor will be called with one argument - \a semaphore - which is a reference to Semaphore object on which the + * action will be executed. Functor's operator should return zero if the action was executed successfully, error code + * otherwise. + */ + +class SemaphoreFunctor : public estd::TypeErasedFunctor<int(Semaphore&)> +{ + +}; + +} // namespace internal + +} // namespace distortos + +#endif // INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SEMAPHOREFUNCTOR_HPP_ |