[#BloombergLP-bdlcc-StripedUnorderedContainerImpl_TestUtil]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlcc.adoc[bdlcc]::StripedUnorderedContainerImpl_TestUtil
:relfileprefix: ../../
:mrdocs:

Test utility exposing stripe lock/unlock for the test driver.

== Synopsis

Declared in `<bdlcc_stripedunorderedcontainerimpl.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class KEY,
    class VALUE,
    class HASH = xref:bsl/hash-06.adoc[bsl::hash<KEY>],
    class EQUAL = xref:bsl/equal_to-0d.adoc[bsl::equal_to<KEY>]>
class StripedUnorderedContainerImpl_TestUtil;
----

== Description

This class implements a test utility that gives the test driver access to the lock / unlock method of the Read/Write mutex. Its purpose is to allow testing that the locking actually happens as planned.

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlcc/StripedUnorderedContainerImpl_TestUtil/2constructor.adoc[`StripedUnorderedContainerImpl_TestUtil`]         [.small]#[constructor]#
| Create a test utility for locking in the specified `hash`.
| xref:BloombergLP/bdlcc/StripedUnorderedContainerImpl_TestUtil/lockRead.adoc[`lockRead`] 
| Acquire a read lock on the stripe for the specified `key`.
| xref:BloombergLP/bdlcc/StripedUnorderedContainerImpl_TestUtil/lockWrite.adoc[`lockWrite`] 
| Acquire a write lock on the stripe for the specified `key`.
| xref:BloombergLP/bdlcc/StripedUnorderedContainerImpl_TestUtil/unlockRead.adoc[`unlockRead`] 
| Release the read lock on the stripe for the specified `key`.
| xref:BloombergLP/bdlcc/StripedUnorderedContainerImpl_TestUtil/unlockWrite.adoc[`unlockWrite`] 
| Release the write lock on the stripe for the specified `key`.
|===



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