ttv::StandardMutex Class Reference

#include <standardmutex.h>

Inheritance diagram for ttv::StandardMutex:

Public Member Functions
	StandardMutex ()
virtual	~StandardMutex ()
virtual TTV_ErrorCode	Lock () override
virtual TTV_ErrorCode	TryLock () override
virtual TTV_ErrorCode	Unlock () override

Private Attributes
std::mutex	mMutex

Constructor & Destructor Documentation

StandardMutex()

ttv::StandardMutex::StandardMutex

(

)

~StandardMutex()

virtual ttv::StandardMutex::~StandardMutex ( )

virtual

Member Function Documentation

Lock()

virtual TTV_ErrorCode ttv::StandardMutex::Lock ( )

overridevirtual

Block/wait until the mutex is free to take, and then acquire the mutex.

Returns

• TTV_EC_SUCCESS: Mutex has been successfully acquired.

Implements ttv::IMutex.

TryLock()

virtual TTV_ErrorCode ttv::StandardMutex::TryLock ( )

overridevirtual

Attempt to acquire the mutex, without waiting for the lock to be available.

Returns

• TTV_EC_SUCCESS: Mutex has been successfully acquired.
• TTV_WRN_MUTEX_NOT_ACQUIRED: Lock has failed and mutex has not been acquired.

Implements ttv::IMutex.

Unlock()

virtual TTV_ErrorCode ttv::StandardMutex::Unlock ( )

overridevirtual

Release the previously acquired mutex (through Lock()).

Returns

• TTV_EC_SUCCESS: Mutex has been sucessfully released.

Implements ttv::IMutex.

Member Data Documentation

mMutex

std::mutex ttv::StandardMutex::mMutex

private

---

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

• modules/core/core_std/include/twitchsdk/core/standardmutex.h