#include <thread_event.h>
Public Member Functions | |
| ThreadEvent (const std::string &name) | |
| ~ThreadEvent () override | |
| T | GetValue () |
| std::shared_future< T > | future () |
| template<typename _Mutex > | |
| T | ResetAndWaitWhileUnlocked (std::unique_lock< _Mutex > &lock) |
| void | Reset () |
| void | SignalAll () |
| template<typename U > | |
| void | SignalAll (U &&value) |
| bool | SignalAllIfNotSet () |
| template<typename U > | |
| bool | SignalAllIfNotSet (U &&value) |
 Public Member Functions inherited from shaka::ThreadEventBase | |
| ThreadEventBase (const std::string &name) | |
| ~ThreadEventBase () override | |
| std::thread::id | GetProvider () const override |
| void | SetProvider (Thread *thread) |
| Public Member Functions inherited from shaka::Waitable | |
| Waitable (const std::string &name) | |
| virtual | ~Waitable () |
| std::string | name () const |
Detailed Description
template<typename T>
class shaka::ThreadEvent< T >
Describes something that needs to happen on a different thread. One (or more) threads will wait for this event; another thread will be "providing" the event. The event will only complete on the providing thread.
This object is internally thread-safe. To safely manage memory, it is suggested to use std::shared_ptr<T> to share this object.
Definition at line 70 of file thread_event.h.
Constructor & Destructor Documentation
§ ThreadEvent()
|
inlineexplicit |
Definition at line 72 of file thread_event.h.
§ ~ThreadEvent()
|
inlineoverride |
Definition at line 74 of file thread_event.h.
Member Function Documentation
§ future()
|
inline |
Gets the future that is used for this event. It is not advised to use this as this won't include deadlock detection.
Definition at line 93 of file thread_event.h.
§ GetValue()
|
inline |
Definition at line 76 of file thread_event.h.
§ Reset()
|
inline |
Resets the internal future so it can be used again. This asserts that there are no waiting threads, so it is important to call SignalAll() before this so any waiting threads will get the value.
Calls to get() after this call will need to wait until the next call to SignalAll().
Definition at line 180 of file thread_event.h.
§ ResetAndWaitWhileUnlocked()
|
inline |
Resets this object, unlocks the given lock, and waits for this event to get another signal from another thread. This is similar to how the wait() method works on a std::condition_variable.
When this returns, the lock will be acquired again.
Definition at line 106 of file thread_event.h.
§ SignalAll() [1/2]
|
inline |
Sets the result of the event. This can only be called once per-Reset(). Calling Reset() will allow this to be called again.
Definition at line 128 of file thread_event.h.
§ SignalAll() [2/2]
|
inline |
Sets the result of the event. This can only be called once per-Reset(). Calling Reset() will allow this to be called again.
Definition at line 132 of file thread_event.h.
§ SignalAllIfNotSet() [1/2]
|
inline |
Sets the result of the event if it has not already been set. If this has already been set, this has no effect.
- Returns
- True if a signal was set, false if we were already set.
Definition at line 143 of file thread_event.h.
§ SignalAllIfNotSet() [2/2]
|
inline |
Sets the result of the event if it has not already been set. If this has already been set, this has no effect.
- Returns
- True if a signal was set, false if we were already set.
Definition at line 158 of file thread_event.h.
The documentation for this class was generated from the following file:
- shaka/src/debug/thread_event.h
