bdlsb.h

Go to the documentation of this file.

/// @file bdlsb.h
///
///
/// @defgroup bdlsb Package bdlsb
/// @brief  Basic Development Library Stream Buffers (bdlsb)
/// @addtogroup bdl
/// @{
/// @addtogroup bdlsb
/// @{
/// * <a href="#bdlsb-purpose"> Purpose</a>
/// * <a href="#bdlsb-mnemonic"> Mnemonic </a>
/// * <a href="#bdlsb-description"> Description </a>
///   * <a href="#bdlsb-hierarchical-synopsis"> Hierarchical Synopsis </a>
///   * <a href="#bdlsb-component-synopsis"> Component Synopsis </a>
///
/// # Purpose {#bdlsb-purpose}
/// Provide concrete 'streambuf' implementations.
///
/// # Mnemonic {#bdlsb-mnemonic}
/// Basic Development Library Stream Buffers (bdlsb)
///
/// @see  bdlx
///
/// # Description {#bdlsb-description}
/// The 'bdlsb' package provides concrete implementations of the
/// 'std::streambuf' interface.  In particular, these implementations use either a
/// fixed-size user-supplied buffer or else manage a buffer obtained from a
/// user-supplied or default allocator.  Also, concrete implementations are
/// specialized to implement either the input ot the output portion of the
/// interface.
///
/// ## Hierarchical Synopsis {#bdlsb-hierarchical-synopsis}
///
/// The 'bdlsb' package currently has 7 components having 1 level 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
///  1. bdlsb_fixedmeminput
///     bdlsb_fixedmeminstreambuf
///     bdlsb_fixedmemoutput
///     bdlsb_fixedmemoutstreambuf
///     bdlsb_memoutstreambuf
///     bdlsb_overflowmemoutput
///     bdlsb_overflowmemoutstreambuf
/// @endcode
///
/// ## Component Synopsis {#bdlsb-component-synopsis}
///
///  @ref bdlsb_fixedmeminput :
///       Provide a basic input stream buffer using a client buffer.
/// 
///  @ref bdlsb_fixedmeminstreambuf :
///       Provide an input @ref basic_streambuf  using a client buffer.
/// 
///  @ref bdlsb_fixedmemoutput :
///       Provide a basic output stream buffer using a client buffer.
/// 
///  @ref bdlsb_fixedmemoutstreambuf :
///       Provide an output @ref basic_streambuf  using a client buffer.
/// 
///  @ref bdlsb_memoutstreambuf :
///       Provide an output @ref basic_streambuf  using managed memory.
/// 
///  @ref bdlsb_overflowmemoutput :
///       Provide an overflowable output `streambuf` using a client buffer.
/// 
///  @ref bdlsb_overflowmemoutstreambuf :
///       Provide an overflowable output `streambuf` using a client buffer.
///
/// @}
/** @} */