sptk::UniqueLockInt Class Reference

#include <Locks.h>

Public Member Functions
	UniqueLockInt (SharedMutex &mutex)
	UniqueLockInt (const UniqueLockInt &)=delete
	UniqueLockInt (SharedMutex &mutex, std::chrono::milliseconds timeout, const char *file, size_t line)
virtual	~UniqueLockInt ()

Detailed Description

Unique lock

Lock is acquired by constructor. For timed lock, waiting for longer than timeout, throws an exception.

Constructor & Destructor Documentation

UniqueLockInt() [1/2]

sptk::UniqueLockInt::UniqueLockInt ( SharedMutex &  mutex )

explicit

Constructor Waits until lock is acquired.

Parameters

mutex

Shared mutex that controls lock

UniqueLockInt() [2/2]

sptk::UniqueLockInt::UniqueLockInt	(	SharedMutex &	mutex,
		std::chrono::milliseconds	timeout,
		const char *	file,
		size_t	line
	)

Constructor Waits until lock is acquired, or until timeout, and then exception is thrown.

Parameters

mutex	Shared mutex that controls lock
timeout	Lock timeout
file	Source file name where lock is attempted
line	Source file line number where lock is attempted

~UniqueLockInt()

virtual sptk::UniqueLockInt::~UniqueLockInt ( )

inlinevirtual

Destructor Unlocks lock if it was acquired.

---

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

• Locks.h