A mutex that has a timed try-lock. More...

#include <TimedMutex.h>

Inheritance diagram for honey::TimedMutex:

Collaboration diagram for honey::TimedMutex:

Public Types
typedef UniqueLock< TimedMutex >	Scoped

Public Types inherited from honey::Mutex
typedef Super::Handle	Handle

typedef UniqueLock< Mutex >	Scoped

Public Member Functions
	TimedMutex ()

	TimedMutex (const TimedMutex &)
	Can't copy, silently inits to default. More...

TimedMutex &	operator= (const TimedMutex &)
	Can't copy, silently does nothing. More...

void	lock ()
	Acquire the lock. Thread suspends until lock becomes available. More...

void	unlock ()
	Release the lock. More...

bool	tryLock ()
	Attempt to acquire the lock, returns immediately. Returns true if the lock was acquired, false otherwise. More...

bool	tryLock (MonoClock::Duration time)
	Attempt to acquire the lock for an amount of time. Returns true if the lock was acquired, false if timed out. More...

bool	tryLock (MonoClock::TimePoint time)
	Attempt to acquire the lock until a certain time. Returns true if the lock was acquired, false if timed out. More...

Public Member Functions inherited from honey::Mutex
	Mutex ()=default

	Mutex (const Mutex &)
	Can't copy, silently inits to default. More...

Mutex &	operator= (const Mutex &)
	Can't copy, silently does nothing. More...

void	lock ()
	Acquire the lock. Thread suspends until lock becomes available. More...

void	unlock ()
	Release the lock. More...

bool	tryLock ()
	Attempt to acquire the lock, returns immediately. Returns true if the lock was acquired, false otherwise. More...

Handle &	handle ()
	Get platform handle. More...

Detailed Description

A mutex that has a timed try-lock.

Member Typedef Documentation

honey::TimedMutex::TimedMutex ( )

inline

honey::TimedMutex::TimedMutex ( const TimedMutex & )

inline

Can't copy, silently inits to default.

void honey::TimedMutex::lock ( )

inline

Acquire the lock. Thread suspends until lock becomes available.

TimedMutex& honey::TimedMutex::operator= ( const TimedMutex & )

inline

Can't copy, silently does nothing.

bool honey::TimedMutex::tryLock ( )

inline

Attempt to acquire the lock, returns immediately. Returns true if the lock was acquired, false otherwise.

bool honey::TimedMutex::tryLock ( MonoClock::Duration time )

inline

Attempt to acquire the lock for an amount of time. Returns true if the lock was acquired, false if timed out.

bool honey::TimedMutex::tryLock ( MonoClock::TimePoint time )

Attempt to acquire the lock until a certain time. Returns true if the lock was acquired, false if timed out.

void honey::TimedMutex::unlock ( )

Release the lock.

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