[#BloombergLP-bslmt-ReaderWriterLock]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslmt.adoc[bslmt]::ReaderWriterLock
:relfileprefix: ../../
:mrdocs:

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

== Synopsis

Declared in `<bslmt_readerwriterlock.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class ReaderWriterLock;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslmt/ReaderWriterLock/2constructor.adoc[`ReaderWriterLock`]         [.small]#[constructor]#
| Construct a reader/writer lock initialized to an unlocked state.
| xref:BloombergLP/bslmt/ReaderWriterLock/2destructor.adoc[`~ReaderWriterLock`] [.small]#[destructor]#
| Destroy this reader/writer lock.
| xref:BloombergLP/bslmt/ReaderWriterLock/isLocked.adoc[`isLocked`] 
| Return `true` if this reader‐write lock is currently read locked or write locked, and `false` otherwise.
| xref:BloombergLP/bslmt/ReaderWriterLock/isLockedRead.adoc[`isLockedRead`] 
| Return `true` if this reader‐write lock is currently read locked, and `false` otherwise.
| xref:BloombergLP/bslmt/ReaderWriterLock/isLockedWrite.adoc[`isLockedWrite`] 
| Return `true` if this reader‐write lock is currently write locked, and `false` otherwise.
| xref:BloombergLP/bslmt/ReaderWriterLock/lockRead.adoc[`lockRead`] 
| Lock this reader/writer lock for read.
| xref:BloombergLP/bslmt/ReaderWriterLock/lockReadReserveWrite.adoc[`lockReadReserveWrite`] 
| Lock this reader/writer lock for read and reserve a write lock.
| xref:BloombergLP/bslmt/ReaderWriterLock/lockWrite.adoc[`lockWrite`] 
| Lock this reader/writer lock for write.
| xref:BloombergLP/bslmt/ReaderWriterLock/tryLockRead.adoc[`tryLockRead`] 
| Attempt to lock this reader/writer lock for read.
| xref:BloombergLP/bslmt/ReaderWriterLock/tryLockWrite.adoc[`tryLockWrite`] 
| Attempt to lock this reader/writer lock for write.
| xref:BloombergLP/bslmt/ReaderWriterLock/tryUpgradeToWriteLock.adoc[`tryUpgradeToWriteLock`] 
| Attempt to atomically convert a held read lock to a write lock.
| xref:BloombergLP/bslmt/ReaderWriterLock/unlock.adoc[`unlock`] 
| Release a previously acquired read or write lock.
| xref:BloombergLP/bslmt/ReaderWriterLock/unlockRead.adoc[`unlockRead`] 
| DEPRECATED: Use `unlock` instead. Note that calls to this function are simply forwarded to `unlock`.
| xref:BloombergLP/bslmt/ReaderWriterLock/unlockReadUnreserveWrite.adoc[`unlockReadUnreserveWrite`] 
| DEPRECATED: Use `unlock` instead. Note that calls to this function are simply forwarded to `unlock`.
| xref:BloombergLP/bslmt/ReaderWriterLock/unlockWrite.adoc[`unlockWrite`] 
| DEPRECATED: Use `unlock` instead. Note that calls to this function are simply forwarded to `unlock`.
| xref:BloombergLP/bslmt/ReaderWriterLock/upgradeToWriteLock.adoc[`upgradeToWriteLock`] 
| Convert a held read lock to a write lock.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#