condition.h

Go to the documentation of this file.

// MIT License
//
// Copyright (c) 2019 Oleksandr Tkachenko
// Cryptography and Privacy Engineering Group (ENCRYPTO)
// TU Darmstadt, Germany
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
 
#pragma once
 
#include <condition_variable>
#include <functional>
#include <mutex>
 
namespace encrypto::motion {
 
class Condition {
 public:
  ~Condition() = default;
  Condition() = delete;
  Condition(Condition&) = delete;
 
  Condition(const std::function<bool()> condition_function)
      : condition_function_(condition_function) {}
 
  bool operator()() {
    std::scoped_lock lock(mutex_);
    return condition_function_();
  }
 
  bool Wait();
 
  template <typename Tick, typename Period>
  bool WaitFor(std::chrono::duration<Tick, Period> duration) {
    std::unique_lock<std::mutex> lock(mutex_);
    condition_variable_.wait_for(lock, duration, condition_function_);
    return condition_function_();
  }
 
  void NotifyOne() noexcept { condition_variable_.notify_one(); }
 
  void NotifyAll() noexcept { condition_variable_.notify_all(); }
 
  std::mutex& GetMutex() noexcept { return mutex_; }
 
 private:
  std::condition_variable condition_variable_;
  std::mutex mutex_;
  const std::function<bool()> condition_function_;
};
 
}  // namespace encrypto::motion