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

Package namespace for basic application library components.

== Types

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balb/Choice1.adoc[`Choice1`] 
| 
| xref:BloombergLP/balb/Choice2.adoc[`Choice2`] 
| 
| xref:BloombergLP/balb/Choice3.adoc[`Choice3`] 
| 
| xref:BloombergLP/balb/Choice4.adoc[`Choice4`] 
| 
| xref:BloombergLP/balb/Choice5.adoc[`Choice5`] 
| 
| xref:BloombergLP/balb/ControlManager.adoc[`ControlManager`] 
| Dispatch control messages to callbacks by name.
| xref:BloombergLP/balb/CustomInt.adoc[`CustomInt`] 
| This class provides a customized integer type used by test messages.
| xref:BloombergLP/balb/CustomString.adoc[`CustomString`] 
| This class provides a customized string type used by test messages.
| xref:BloombergLP/balb/Enumerated.adoc[`Enumerated`] 
| This struct provides a test enumeration type used by test messages.
| xref:BloombergLP/balb/FeatureTestMessage.adoc[`FeatureTestMessage`] 
| 
| xref:BloombergLP/balb/FileCleanerConfiguration.adoc[`FileCleanerConfiguration`] 
| This simply constrained (value‐semantic) attribute class characterizes configuration parameters for a file cleaner. See the  for information on the class attributes. Note that the class invariants are identically the constraints on the individual attributes.
| xref:BloombergLP/balb/FileCleanerUtil.adoc[`FileCleanerUtil`] 
| This utility class provides functions relating to file clean up.
| xref:BloombergLP/balb/LeakyBucket.adoc[`LeakyBucket`] 
| This mechanism implements a leaky bucket that allows clients to monitor whether a resource is being consumed at a particular rate. The behavior of a leak bucket is determined by two properties: the drain rate (in units/s) and capacity (in units), both of which can be specified at construction or using the `setRateAndCapacity` method.
| xref:BloombergLP/balb/PerformanceMonitor.adoc[`PerformanceMonitor`] 
| Provides a mechanism to collect performance statistics for an arbitrary number of processes running on the local machine.
| xref:BloombergLP/balb/PerformanceMonitor_LinuxProcStatistics.adoc[`PerformanceMonitor_LinuxProcStatistics`] 
| Describes the fields present in /proc/<pid>/stat. For a complete description of each field, see `man proc`.
| xref:BloombergLP/balb/PipeControlChannel.adoc[`PipeControlChannel`] 
| This class is a mechanism for reading control messages from a named pipe. Use `start` to spawn a thread that handles messages arriving at the pipe, and `shutdown` to stop reading. `stop` blocks until the processing thread has been terminated by a call to `shutdown` (either before `stop` is called, or from some other thread).
| xref:BloombergLP/balb/PipeControlChannel_CStringUtil.adoc[`PipeControlChannel_CStringUtil`] 
| This component‐private utility `struct` provides a namespace for the `flatten` overload set intended to be used in concert with an overload set consisting of a function template with a deduced argument and an non‐template overload accepting a `const char *`. The actual implementation of the functionality would be in the `const char *` overload whereas the purpose of the function template is to invoke the `const char *` overload with a null‐terminated string.
| xref:BloombergLP/balb/PipeTaskManager.adoc[`PipeTaskManager`] 
| This class provides a mechanism route messages received on a named pipe to the registered handler (functor).
| xref:BloombergLP/balb/RateLimiter.adoc[`RateLimiter`] 
| This mechanism implements a rate limiter that allows clients to monitor and control the usage of a resource such that the rate of consumption stays within configured limits. The behavior of a rate limiter is determined by four properties: the sustained rate (in units/s), the sustained‐rate time‐window (in seconds), the peak rate (in units/s), and the peak‐rate time‐window (in seconds). All of these properties can be specified at construction or using the `setRateLimits` method.
| xref:BloombergLP/balb/Request.adoc[`Request`] 
| 
| xref:BloombergLP/balb/ReservationGuard.adoc[`ReservationGuard`] 
| This class template implements a proctor for reserving and cancelling units in a rate controlling object.
| xref:BloombergLP/balb/Response.adoc[`Response`] 
| 
| xref:BloombergLP/balb/Sequence1.adoc[`Sequence1`] 
| 
| xref:BloombergLP/balb/Sequence2.adoc[`Sequence2`] 
| 
| xref:BloombergLP/balb/Sequence3.adoc[`Sequence3`] 
| 
| xref:BloombergLP/balb/Sequence4.adoc[`Sequence4`] 
| 
| xref:BloombergLP/balb/Sequence5.adoc[`Sequence5`] 
| 
| xref:BloombergLP/balb/Sequence6.adoc[`Sequence6`] 
| 
| xref:BloombergLP/balb/SequenceWithAnonymity.adoc[`SequenceWithAnonymity`] 
| 
| xref:BloombergLP/balb/SequenceWithAnonymityChoice.adoc[`SequenceWithAnonymityChoice`] 
| 
| xref:BloombergLP/balb/SequenceWithAnonymityChoice1.adoc[`SequenceWithAnonymityChoice1`] 
| 
| xref:BloombergLP/balb/SequenceWithAnonymityChoice2.adoc[`SequenceWithAnonymityChoice2`] 
| 
| xref:BloombergLP/balb/SimpleRequest.adoc[`SimpleRequest`] 
| 
| xref:BloombergLP/balb/Testmessages.adoc[`Testmessages`] 
| This class serves as a place holder to reserve a type having the same name as this component. Doing so ensures that such a type cannot be defined outside of this component in the current namespace.
| xref:BloombergLP/balb/UnsignedSequence.adoc[`UnsignedSequence`] 
| 
| xref:BloombergLP/balb/VoidSequence.adoc[`VoidSequence`] 
| 
|===


== Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balb/operator_lshift-0b3.adoc[`operator<<`] 
| Stream insertion operators
| xref:BloombergLP/balb/operator_eq-02.adoc[`operator==`] 
| Equality operators
| xref:BloombergLP/balb/operator_not_eq-012.adoc[`operator!=`] 
| Inequality operators
|===



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