balb.h

Go to the documentation of this file.

/// @file balb.h
///
///
/// @defgroup balb Package balb
/// @brief  Basic Application Library Basis (balb)
/// @addtogroup bal
/// @{
/// @addtogroup balb
/// @{
/// * <a href="#balb-purpose"> Purpose</a>
/// * <a href="#balb-mnemonic"> Mnemonic </a>
/// * <a href="#balb-description"> Description </a>
///   * <a href="#balb-hierarchical-synopsis"> Hierarchical Synopsis </a>
///   * <a href="#balb-component-synopsis"> Component Synopsis </a>
///
/// # Purpose {#balb-purpose}
/// Provide common application-level facilities.
///
/// # Mnemonic {#balb-mnemonic}
/// Basic Application Library Basis (balb)
///
/// @see  balm
///
/// # Description {#balb-description}
/// The 'balb' package provides support for an assortment of common
/// application-level services (e.g., command-line processing).  In particular,
/// 'balb' includes the following:
///
///  * A mechanism for monitoring and reporting the observable performance of a
///    process.
/// 
///  * Classes for (1) defining commands (as short strings), (2) passing these
///    commands through a pipe-channel to a running process, and (3) registering
///    callback functions to be invoked upon reception of such commands.
/// 
///  * A multi-process performance reporting mechanism and a value-semantic type
///    to represent metrics.  Note that the entire {'balm'} package is dedicated
///    to metrics gathering.
/// 
///  * A mechanism that allows clients to monitor whether a resource is being
///    consumed at a particular rate.
/// 
///  * A mechanism that enables clients to monitor and control the use of a
///    resource such that the peak consumption rate and the sustained consumption
///    rate do not exceed their respective configured limits.
/// 
///  * Generic proctor to automatically reserve and release units from a rate
///    controlling object.
///
/// ## Hierarchical Synopsis {#balb-hierarchical-synopsis}
///
/// The 'balb' package currently has 10 components having 2 levels of physical
/// dependency.  The list below shows the hierarchical ordering of the components.
/// The order of components within each level is not architecturally significant,
/// just alphabetical.
/// @code
///  2. balb_filecleanerutil
///     balb_pipetaskmanager
///     balb_ratelimiter
///     balb_reservationguard
///
///  1. balb_controlmanager
///     balb_filecleanerconfiguration
///     balb_leakybucket
///     balb_performancemonitor
///     balb_pipecontrolchannel
///     balb_testmessages
/// @endcode
///
/// ## Component Synopsis {#balb-component-synopsis}
///
///  @ref balb_controlmanager :
///       Provide a mechanism for mapping control messages to callbacks.
/// 
///  @ref balb_filecleanerconfiguration :
///       Provide an attribute class for file cleaner configuration.
/// 
///  @ref balb_filecleanerutil :
///       Provide a utility class for configuration-based file removal.
/// 
///  @ref balb_leakybucket :
///       Provide a mechanism to monitor the consumption rate of a resource.
/// 
///  @ref balb_performancemonitor :
///       Provide a mechanism to collect process performance measures.
/// 
///  @ref balb_pipecontrolchannel :
///       Provide a mechanism for reading control messages from a named pipe.
/// 
///  @ref balb_pipetaskmanager :
///       Provide a pipe-based mechanism to process task control messages.
/// 
///  @ref balb_ratelimiter :
///       Provide a mechanism to limit peak and sustained consumption rates.
/// 
///  @ref balb_reservationguard :
///       Provide a generic proctor for rate controlling objects.
/// 
///  @ref balb_testmessages :
///       Provide value-semantic attribute classes.
///
/// @}
/** @} */