summaryrefslogtreecommitdiff
path: root/src/buildtool/multithreading/task.hpp
blob: 49eb20a9191741b13a8b334cdc75cc7ef0b51998 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
#ifndef INCLUDED_SRC_BUILDTOOL_MULTITHREADING_TASK_HPP
#define INCLUDED_SRC_BUILDTOOL_MULTITHREADING_TASK_HPP

#include <functional>
#include <type_traits>

class Task {
  public:
    using TaskFunc = std::function<void()>;

    Task() noexcept = default;

    // NOLINTNEXTLINE(modernize-pass-by-value)
    explicit Task(TaskFunc const& function) noexcept : f_{function} {}
    explicit Task(TaskFunc&& function) noexcept : f_{std::move(function)} {}

    void operator()() { f_(); }

    // To be able to discern whether the internal f_ has been set or not,
    // allowing us to write code such as:
    /*
    Task t;
    while (!t) {
        t = TryGetTaskFromQueue(); // (*)
    }
    t(); // (**)
    */
    // (*) does `return Task();` or `return {};` if queue is empty or locked)
    // (**) we can now surely execute the task (and be sure it won't throw any
    // exception) (for the sake of the example, imagine we are sure that the
    // queue wasn't empty, otherwise this would be an infinite loop)
    explicit operator bool() const noexcept { return f_.operator bool(); }

  private:
    TaskFunc f_{};
};

#endif  // INCLUDED_SRC_BUILDTOOL_MULTITHREADING_TASK_HPP