diff options
Diffstat (limited to 'include/distortos/internal/synchronization/SemaphoreTryWaitForFunctor.hpp')
-rw-r--r-- | include/distortos/internal/synchronization/SemaphoreTryWaitForFunctor.hpp | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/include/distortos/internal/synchronization/SemaphoreTryWaitForFunctor.hpp b/include/distortos/internal/synchronization/SemaphoreTryWaitForFunctor.hpp new file mode 100644 index 0000000..88580de --- /dev/null +++ b/include/distortos/internal/synchronization/SemaphoreTryWaitForFunctor.hpp @@ -0,0 +1,62 @@ +/** + * \file + * \brief SemaphoreTryWaitForFunctor 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_SEMAPHORETRYWAITFORFUNCTOR_HPP_ +#define INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SEMAPHORETRYWAITFORFUNCTOR_HPP_ + +#include "distortos/internal/synchronization/SemaphoreFunctor.hpp" + +#include "distortos/TickClock.hpp" + +namespace distortos +{ + +namespace internal +{ + +/// SemaphoreTryWaitForFunctor class is a SemaphoreFunctor which calls Semaphore::tryWaitFor() with bounded duration +class SemaphoreTryWaitForFunctor : public SemaphoreFunctor +{ +public: + + /** + * \brief SemaphoreTryWaitForFunctor's constructor + * + * \param [in] duration is the bounded duration for Semaphore::tryWaitFor() call + */ + + constexpr explicit SemaphoreTryWaitForFunctor(const TickClock::duration duration) : + duration_{duration} + { + + } + + /** + * \brief Calls Semaphore::tryWaitFor() with bounded duration + * + * \param [in] semaphore is a reference to Semaphore object for which Semaphore::tryWaitFor() will be called + * + * \return value returned by Semaphore::tryWaitFor() + */ + + int operator()(Semaphore& semaphore) const override; + +private: + + /// bounded duration for Semaphore::tryWaitFor() call + const TickClock::duration duration_; +}; + +} // namespace internal + +} // namespace distortos + +#endif // INCLUDE_DISTORTOS_INTERNAL_SYNCHRONIZATION_SEMAPHORETRYWAITFORFUNCTOR_HPP_ |