Shaka Player Embedded
Public Member Functions | List of all members
shaka::Waitable Class Referenceabstract

#include <waitable.h>

Inheritance diagram for shaka::Waitable:
shaka::DebugMutex< _Mutex > shaka::ThreadEventBase shaka::ThreadEvent< T > shaka::ThreadEvent< void >

Public Member Functions

 Waitable (const std::string &name)
 
virtual ~Waitable ()
 
std::string name () const
 
virtual std::thread::id GetProvider () const =0
 

Detailed Description

The base class for objects that a thread can wait on. These represent resources that a thread needs to block for another thread to provide. This can be an explicit event (like a seek event) or it could be a lock that another thread needs to release.

Definition at line 31 of file waitable.h.

Constructor & Destructor Documentation

§ Waitable()

shaka::Waitable::Waitable ( const std::string &  name)
explicit

Definition at line 21 of file waitable.cc.

§ ~Waitable()

shaka::Waitable::~Waitable ( )
virtual

Definition at line 23 of file waitable.cc.

Member Function Documentation

§ GetProvider()

virtual std::thread::id shaka::Waitable::GetProvider ( ) const
pure virtual
Returns
The thread that will be providing the thing. This can return id() if it is unknown.

Implemented in shaka::DebugMutex< _Mutex >, and shaka::ThreadEventBase.

§ name()

std::string shaka::Waitable::name ( ) const
inline
Returns
The name of this thing, used for debugging.

Definition at line 37 of file waitable.h.


The documentation for this class was generated from the following files: