bslmt::ReaderWriterMutex Class Reference

#include <bslmt_readerwritermutex.h>

Public Member Functions
	ReaderWriterMutex ()
	Construct a reader/writer lock initialized to an unlocked state.
	~ReaderWriterMutex ()
	Destroy this object.
void	lockRead ()
void	lockWrite ()
int	tryLockRead ()
int	tryLockWrite ()
void	unlock ()
void	unlockRead ()
void	unlockWrite ()
bool	isLocked () const
bool	isLockedRead () const
bool	isLockedWrite () const

Detailed Description

This class provides a multi-reader/single-writer lock mechanism.

See bslmt_readerwritermutex

Constructor & Destructor Documentation

ReaderWriterMutex()

bslmt::ReaderWriterMutex::ReaderWriterMutex ( )

inline

~ReaderWriterMutex()

bslmt::ReaderWriterMutex::~ReaderWriterMutex

(

)

Member Function Documentation

isLocked()

bool bslmt::ReaderWriterMutex::isLocked ( ) const

inline

Return true if this reader-write mutex is currently read locked or write locked, and false otherwise.

isLockedRead()

bool bslmt::ReaderWriterMutex::isLockedRead ( ) const

inline

Return true if this reader-write mutex is currently read locked, and false otherwise.

isLockedWrite()

bool bslmt::ReaderWriterMutex::isLockedWrite ( ) const

inline

Return true if this reader-write mutex is currently write locked, and false otherwise.

lockRead()

void bslmt::ReaderWriterMutex::lockRead ( )

inline

Lock this reader-writer mutex for reading. If there are no active or pending write locks, lock this mutex for reading and return immediately. Otherwise, block until the read lock on this mutex is acquired. Use unlockRead or unlock to release the lock on this mutex. The behavior is undefined if this method is called from a thread that already has a lock on this mutex.

lockWrite()

void bslmt::ReaderWriterMutex::lockWrite ( )

inline

Lock this reader-writer mutex for writing. If there are no active or pending locks on this mutex, lock this mutex for writing and return immediately. Otherwise, block until the write lock on this mutex is acquired. Use unlockWrite or unlock to release the lock on this mutex. The behavior is undefined if this method is called from a thread that already has a lock on this mutex.

tryLockRead()

int bslmt::ReaderWriterMutex::tryLockRead ( )

inline

Attempt to lock this reader-writer mutex for reading. Immediately return 0 on success, and a non-zero value if there are active or pending writers. If successful, unlockRead or unlock must be used to release the lock on this mutex. The behavior is undefined if this method is called from a thread that already has a lock on this mutex.

tryLockWrite()

int bslmt::ReaderWriterMutex::tryLockWrite ( )

inline

Attempt to lock this reader-writer mutex for writing. Immediately return 0 on success, and a non-zero value if there are active or pending locks on this mutex. If successful, unlockWrite or unlock must be used to release the lock on this mutex. The behavior is undefined if this method is called from a thread that already has a lock on this mutex.

unlock()

void bslmt::ReaderWriterMutex::unlock ( )

inline

Release the lock that the calling thread holds on this reader-writer mutex. The behavior is undefined unless the calling thread currently has a lock on this mutex.

unlockRead()

void bslmt::ReaderWriterMutex::unlockRead ( )

inline

Release the read lock that the calling thread holds on this reader-writer mutex. The behavior is undefined unless the calling thread currently has a read lock on this mutex.

unlockWrite()

void bslmt::ReaderWriterMutex::unlockWrite ( )

inline

Release the write lock that the calling thread holds on this reader-writer mutex. The behavior is undefined unless the calling thread currently has a write lock on this mutex.

---

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

• bslmt_readerwritermutex.h