Berserk
Thread.hpp
Go to the documentation of this file.
1 /**********************************************************************************/
2 /* This file is part of Berserk Engine project */
3 /* https://github.com/EgorOrachyov/Berserk */
4 /**********************************************************************************/
5 /* MIT License */
6 /* */
7 /* Copyright (c) 2018 - 2021 Egor Orachyov */
8 /* */
9 /* Permission is hereby granted, free of charge, to any person obtaining a copy */
10 /* of this software and associated documentation files (the "Software"), to deal */
11 /* in the Software without restriction, including without limitation the rights */
12 /* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell */
13 /* copies of the Software, and to permit persons to whom the Software is */
14 /* furnished to do so, subject to the following conditions: */
15 /* */
16 /* The above copyright notice and this permission notice shall be included in all */
17 /* copies or substantial portions of the Software. */
18 /* */
19 /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR */
20 /* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, */
21 /* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE */
22 /* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER */
23 /* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, */
24 /* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE */
25 /* SOFTWARE. */
26 /**********************************************************************************/
27 
28 #ifndef BERSERK_THREAD_HPP
29 #define BERSERK_THREAD_HPP
30 
31 #include <core/Config.hpp>
32 #include <core/Typedefs.hpp>
33 
34 #include <functional>
35 #include <mutex>
36 #include <thread>
37 #include <vector>
38 
39 #include <ttas_spin_mutex.hpp>
40 
42 
54 class Thread final {
55 public:
57  enum class Flag {
59  Before,
61  Update,
63  After
64  };
65 
66  BRK_API Thread() = default;
67  BRK_API ~Thread();
68 
70  using Callable = std::function<void()>;
71 
73  BRK_API void Enqueue(Callable callable, Flag flag);
74 
76  BRK_API void EnqueueBefore(Callable callable) { Enqueue(std::move(callable), Flag::Before); }
77 
79  BRK_API void EnqueueUpdate(Callable callable) { Enqueue(std::move(callable), Flag::Update); }
80 
82  BRK_API void EnqueueAfter(Callable callable) { Enqueue(std::move(callable), Flag::After); }
83 
85  BRK_API void Update();
86 
88  BRK_API void ExecuteBefore();
89 
91  BRK_API void ExecuteUpdate();
92 
94  BRK_API void ExecuteAfter();
95 
97  BRK_API bool OnThread() const;
98 
99 private:
101  std::vector<Callable> mQueueBefore;
102  std::vector<Callable> mQueueUpdate;
103  std::vector<Callable> mQueueAfter;
104 
106  std::vector<Callable> mExecuteBefore;
107  std::vector<Callable> mExecuteUpdate;
108  std::vector<Callable> mExecuteAfter;
109 
111  std::thread::id mThreadId = std::this_thread::get_id();
112 
113  mutable yamc::spin_ttas::mutex mMutex;
114 };
115 
121 
122 #endif//BERSERK_THREAD_HPP
#define BRK_NS_END
Definition: Config.hpp:48
#define BRK_API
Definition: Config.hpp:32
Represents thread wrapper used to enqueue commands to execute.
Definition: Thread.hpp:54
BRK_API void Enqueue(Callable callable, Flag flag)
Definition: Thread.cpp:47
BRK_API ~Thread()
Definition: Thread.cpp:36
std::function< void()> Callable
Thread callback function type.
Definition: Thread.hpp:70
BRK_API bool OnThread() const
Definition: Thread.cpp:86
BRK_API void ExecuteUpdate()
Definition: Thread.cpp:74
BRK_API void Update()
Definition: Thread.cpp:60
BRK_API Thread()=default
BRK_API void ExecuteBefore()
Definition: Thread.cpp:68
BRK_API void EnqueueUpdate(Callable callable)
Definition: Thread.hpp:79
BRK_API void ExecuteAfter()
Definition: Thread.cpp:80
Flag
Flag to enqueue callback.
Definition: Thread.hpp:57
@ Update
Execute middle thread main update
@ After
Execute after thread main update
@ Before
Execute before thread main update
BRK_API void EnqueueAfter(Callable callable)
Definition: Thread.hpp:82
BRK_API void EnqueueBefore(Callable callable)
Definition: Thread.hpp:76
Definition: GLDevice.cpp:46