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

Maintains a pair of associated locks, one for read-only operations and one for writing. The read lock may be held simultaneously by multiple reader. More...

#include <RWLock.h>

Public Member Functions

uint04 numOfReadLocks () const
 
uint04 numOfReadLocksHeld () const
 
uint04 numOfWriteLocks () const
 
uint04 numOfWriteLocksHeld () const
 
bool ReadLock ()
 
void ReadUnlock ()
 
 RWLock ()
 
 RWLock (const RWLock &lock)=delete
 
bool TryReadLock ()
 
bool TryReadLock (uint08 time)
 
bool TryWriteLock ()
 
bool TryWriteLock (uint08 time)
 
bool WriteLock ()
 
void WriteUnlock ()
 
 ~RWLock ()
 

Static Public Member Functions

static RWLockgetEntry (const void *entry)
 

Detailed Description

Maintains a pair of associated locks, one for read-only operations and one for writing. The read lock may be held simultaneously by multiple reader.


threads, so long as there are no writers. The write lock is exclusive.

Constructor & Destructor Documentation

◆ RWLock() [1/2]

RWLock ( )

◆ RWLock() [2/2]

RWLock ( const RWLock & lock)
delete

◆ ~RWLock()

~RWLock ( )

Member Function Documentation

◆ getEntry()

static RWLock * getEntry ( const void * entry)
static

◆ numOfReadLocks()

uint04 numOfReadLocks ( ) const
nodiscard

◆ numOfReadLocksHeld()

uint04 numOfReadLocksHeld ( ) const
nodiscard

◆ numOfWriteLocks()

uint04 numOfWriteLocks ( ) const
nodiscard

◆ numOfWriteLocksHeld()

uint04 numOfWriteLocksHeld ( ) const
nodiscard

◆ ReadLock()

bool ReadLock ( )

◆ ReadUnlock()

void ReadUnlock ( )

◆ TryReadLock() [1/2]

bool TryReadLock ( )

◆ TryReadLock() [2/2]

bool TryReadLock ( uint08 time)

◆ TryWriteLock() [1/2]

bool TryWriteLock ( )

◆ TryWriteLock() [2/2]

bool TryWriteLock ( uint08 time)

◆ WriteLock()

bool WriteLock ( )

◆ WriteUnlock()

void WriteUnlock ( )

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