[#BloombergLP-bsls-BslLock]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bsls.adoc[bsls]::BslLock
:relfileprefix: ../../
:mrdocs:

Light‐weight, portable wrapper of an OS‐level mutex.

== Synopsis

Declared in `<bsls_bsllock.h>`

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

== Description

This `class` implements a light‐weight, portable wrapper of an OS‐level mutex to support intra‐process synchronization. The mutex implemented by this class is _non_‐recursive. Note that `BslLock` is _not_ intended for direct use by client code; it is meant for internal use only.

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bsls/BslLock/2constructor.adoc[`BslLock`]         [.small]#[constructor]#
| Create a lock object initialized to the unlocked state.
| xref:BloombergLP/bsls/BslLock/2destructor.adoc[`~BslLock`] [.small]#[destructor]#
| Destroy this lock object. The behavior is undefined unless this object is in the unlocked state.
| xref:BloombergLP/bsls/BslLock/lock.adoc[`lock`] 
| Acquire the lock on this object.
| xref:BloombergLP/bsls/BslLock/unlock.adoc[`unlock`] 
| Release the lock on this object.
|===



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