bdlbb.h

Go to the documentation of this file.

/// @file bdlbb.h
///
///
/// @defgroup bdlbb Package bdlbb
/// @brief  Basic Development Library Blobs (bdlbb)
/// @addtogroup bdl
/// @{
/// @addtogroup bdlbb
/// @{
/// * <a href="#bdlbb-purpose"> Purpose</a>
/// * <a href="#bdlbb-mnemonic"> Mnemonic </a>
/// * <a href="#bdlbb-description"> Description </a>
///   * <a href="#bdlbb-hierarchical-synopsis"> Hierarchical Synopsis </a>
///   * <a href="#bdlbb-component-synopsis"> Component Synopsis </a>
///
/// # Purpose {#bdlbb-purpose}
/// Provide flexible, efficient management of message buffers.
///
/// # Mnemonic {#bdlbb-mnemonic}
/// Basic Development Library Blobs (bdlbb)
///
/// @see  bslma
///
/// # Description {#bdlbb-description}
/// This package defines, 'bdlbb::Blob', a vocabulary type for
/// other 'bdl' packages.  A 'bdlbb::Blob' object consists of a sequence of
/// 'bdlbb::BlobBuffer' objects, each of which have a shared pointer to
/// underlying memory.  A protocol is defined for factories to manage
/// 'bdlbb::BlobBuffer' objects, and a concrete implementation is provided.
/// Other components define non-primitive operations on 'bdlbb::Blob's.
///
/// ## Hierarchical Synopsis {#bdlbb-hierarchical-synopsis}
///
/// The 'bdlbb' package currently has 5 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. bdlbb_blobstreambuf
///     bdlbb_blobutil
///     bdlbb_pooledblobbufferfactory
///     bdlbb_simpleblobbufferfactory
///
///  1. bdlbb_blob
/// @endcode
///
/// ## Component Synopsis {#bdlbb-component-synopsis}
///
///  @ref bdlbb_blob :
///       Provide an indexed set of buffers from multiple sources.
/// 
///  @ref bdlbb_blobstreambuf :
///       Provide blob implementing the `streambuf` interface.
/// 
///  @ref bdlbb_blobutil :
///       Provide a suite of utilities for I/O operations on `bdlbb::Blob`.
/// 
///  @ref bdlbb_pooledblobbufferfactory :
///       Provide a concrete implementation of `bdlbb::BlobBufferFactory`.
/// 
///  @ref bdlbb_simpleblobbufferfactory :
///       Provide a simple implementation of `bdlbb::BlobBufferFactory`.
///
/// @}
/** @} */