API Documentation
Loading...
Searching...
No Matches
RLock Class Reference

Used to lock a particular variable for reading. Any number of readers can be created when no write locks are on a variable, otherwise will wait. More...

#include <RWLock.h>

Public Member Functions

bool isLocked () const
 
void operator= (const RLock &)=delete
 
 RLock (const RLock &)=delete
 
 RLock (const UUID &lock)
 
 RLock (const void *lock)
 
 RLock (const void *lock, bool &didAquire)
 
 RLock (const void *lock, uint08 timeout)
 
 RLock (RLock &&lock) noexcept
 
 RLock (RWLock &lock)
 
 ~RLock ()
 

Static Public Member Functions

static bool HasLock (const RWLock &lock)
 
static bool HasLock (const void *lock)
 

Detailed Description

Used to lock a particular variable for reading. Any number of readers can be created when no write locks are on a variable, otherwise will wait.


Note: Automatically unlocks on destruction.

Constructor & Destructor Documentation

◆ RLock() [1/7]

RLock ( const void * lock)
explicit

◆ RLock() [2/7]

RLock ( const UUID & lock)
explicit

◆ RLock() [3/7]

RLock ( RWLock & lock)
explicit

◆ RLock() [4/7]

RLock ( RLock && lock)
noexcept

◆ RLock() [5/7]

RLock ( const RLock & )
delete

◆ RLock() [6/7]

RLock ( const void * lock,
uint08 timeout )

◆ RLock() [7/7]

RLock ( const void * lock,
bool & didAquire )

◆ ~RLock()

~RLock ( )

Member Function Documentation

◆ HasLock() [1/2]

static bool HasLock ( const RWLock & lock)
static

◆ HasLock() [2/2]

static bool HasLock ( const void * lock)
static

◆ isLocked()

bool isLocked ( ) const

◆ operator=()

void operator= ( const RLock & )
delete

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