VOX
A little voxel engine
Loading...
Searching...
No Matches
Status Class Reference

#include <Status.hpp>

Collaboration diagram for Status:
Collaboration graph

Public Member Functions

 Status ()
 
 ~Status ()
 
 Status (const Status &other)
 
Statusoperator= (const Status &other)
 
 Status (Status &&other)
 
Statusoperator= (Status &&other)
 
void lock_shared ()
 adds a reader to the status More...
 
bool try_lock_shared ()
 Tries to add a reader to the status, will NOT block. More...
 
void unlock_shared ()
 removes a reader from the status More...
 
void lock ()
 adds a writer to the status More...
 
bool try_lock ()
 Tries to add a writer to the status, will NOT block. More...
 
void unlock ()
 removes a writer from the status More...
 
bool isLocked () const
 
bool isShareLocked () const
 
bool isLockable () const
 
bool isShareLockable () const
 

Constructor & Destructor Documentation

◆ Status() [1/3]

Status::Status ( )

◆ ~Status()

Status::~Status ( )

◆ Status() [2/3]

Status::Status ( const Status other)

◆ Status() [3/3]

Status::Status ( Status &&  other)

Member Function Documentation

◆ isLockable()

bool Status::isLockable ( ) const

◆ isLocked()

bool Status::isLocked ( ) const

◆ isShareLockable()

bool Status::isShareLockable ( ) const

◆ isShareLocked()

bool Status::isShareLocked ( ) const

◆ lock()

void Status::lock ( )

adds a writer to the status

Warning
WILL BLOCK until it can add a writer

◆ lock_shared()

void Status::lock_shared ( )

adds a reader to the status

Warning
WILL BLOCK until it can add a reader

◆ operator=() [1/2]

Status & Status::operator= ( const Status other)

◆ operator=() [2/2]

Status & Status::operator= ( Status &&  other)

◆ try_lock()

bool Status::try_lock ( )

Tries to add a writer to the status, will NOT block.

Returns
true if it added a writer \
false if it did not add a writer

◆ try_lock_shared()

bool Status::try_lock_shared ( )

Tries to add a reader to the status, will NOT block.

Returns
true if it added a reader \
false if it did not add a reader

◆ unlock()

void Status::unlock ( )

removes a writer from the status

◆ unlock_shared()

void Status::unlock_shared ( )

removes a reader from the status


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