bslstl_syncbufbase.h

Go to the documentation of this file.

/// @file bslstl_syncbufbase.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// bslstl_syncbufbase.h                                               -*-C++-*-
#ifndef INCLUDED_BSLSTL_SYNCBUFBASE
#define INCLUDED_BSLSTL_SYNCBUFBASE
 
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
 
/// @defgroup bslstl_syncbufbase bslstl_syncbufbase
/// @brief  Provide an allocator-independent base-class for `basic_syncbuf`.
/// @addtogroup bsl
/// @{
/// @addtogroup bslstl
/// @{
/// @addtogroup bslstl_syncbufbase
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#bslstl_syncbufbase-purpose"> Purpose</a>
/// * <a href="#bslstl_syncbufbase-classes"> Classes </a>
/// * <a href="#bslstl_syncbufbase-description"> Description </a>
///
/// # Purpose {#bslstl_syncbufbase-purpose}
/// Provide an allocator-independent base-class for @ref basic_syncbuf .
///
/// # Classes {#bslstl_syncbufbase-classes}
///
/// -  bsl::SyncBufBase: allocator-independent base of @ref basic_syncbuf .
///
/// @see  bslstl_syncbuf
///
/// # Description {#bslstl_syncbufbase-description}
/// This component is for internal use only.  Please don't use it
/// directly.
///
/// This component provides a protocol class, `SyncBufBase`, that is intended
/// for use as a base class for synchronized stream buffers. The `SyncBufBase`
/// protocol provides methods to emit the synchronized buffer, and mark the
/// buffer to be emitted on a call to `sync` on an associated stream. This
/// operations are exposed by `SyncBufBaseUtil` for use by standard functions,
/// like `bsl::emit_on_flush`, `bsl::noemit_on_flush`, and `bsl::flush_emit`,
/// while not exposing them into the public interface of derived types (like
/// @ref basic_syncbuf ) whose interface in defined by an external standard.
///
/// Factoring these operations into a non-templatized base class allows
/// operations (like `bsl::emit_on_flush` etc) to applied to derived objects in
/// contexts where it is impossible to deduce the `ALLOCATOR` type of the
/// inheriting synchornized buffer.
/// @}
/** @} */
/** @} */
 
/** @addtogroup bsl
 * @{
 */
/** @addtogroup bslstl
 * @{
 */
/** @addtogroup bslstl_syncbufbase
 * @{
 */
 
#include <bslscm_version.h>
 
#include <bsls_assert.h>
#include <bsls_keyword.h>
 
 
namespace bslstl {
 
struct SyncBufBaseUtil;  // forward
 
                            // =================
                            // class SyncBufBase
                            // =================
 
/// Allocator-independent base of @ref basic_syncbuf .  Also this is used by the
/// manipulators: @ref emit_on_flush , @ref noemit_on_flush , @ref flush_emit  (the
/// `ALLOCATOR` template argument cannot be deduced from
/// `basic_ostream<CHAR_TYPE, CHAR_TRAITS>`).
///
/// See @ref bslstl_syncbufbase 
class SyncBufBase {
 
    // PRIVATE MANIPULATORS
 
    /// Atomically transfer any characters buffered by this object to the
    /// wrapped stream buffer, so that it appears in the output stream as a
    /// contiguous sequence of characters.  The wrapped stream buffer is
    /// flushed if and only if a call was made to `sync` since the most
    /// recent call to `emit` or construction.  Return `true` if
    /// `get_wrapped() != nullptr`, and all of the characters in the
    /// associated output were successfully transferred, and the flush (if
    /// any) succeeded; return `false` otherwise.
    virtual bool emitInternal() = 0;
 
    /// Set the "emit-on-sync" property of the synchronized buffer to the
    /// specified `value`.  If "emit-on-sync" is `true`, the synchronized
    /// buffer will emit (see `emitInternal`) its buffered contents on a
    /// call to `sync` (or `pubsync`); otherwise the synchronized buffer
    /// will not be emitted on a `sync`.
    virtual void setEmitOnSync(bool value) BSLS_KEYWORD_NOEXCEPT = 0;
 
    // FRIENDS
    friend struct SyncBufBaseUtil;
 
  public:
    // CREATORS
 
    /// Destroy this object.
    virtual ~SyncBufBase();
};
 
                            // =====================
                            // class SyncBufBaseUtil
                            // =====================
 
/// Internal utils.
///
/// See @ref bslstl_syncbufbase 
struct SyncBufBaseUtil {
 
    // CLASS METHODS
 
    /// Atomically transfer any characters buffered by the specified
    /// `syncBuf` object to the wrapped stream buffer, so that it appears in
    /// the output stream as a contiguous sequence of characters.  The
    /// wrapped stream buffer is flushed if and only if a call was made to
    /// `sync` since the most recent call to `emit` or construction.  Return
    /// `true` if `get_wrapped() != nullptr`, and all of the characters in
    /// the associated output were successfully transferred, and the flush
    /// (if any) succeeded; return `false` otherwise.  
    /// 
    /// \pre The behavior is undefined   unless `syncBuf` is not null.
    static bool emitInternal(SyncBufBase *syncBuf);
 
    /// Set the "emit-on-sync" property of the synchronized buffer to the
    /// specified `value`.  If "emit-on-sync" is `true`, the synchronized
    /// buffer will emit (see `emitInternal`) its buffered contents on a
    /// call to `sync` (or `pubsync`); otherwise the synchronized buffer will not be emitted on a `sync`.  
    /// 
    /// \pre The behavior is undefined   unless
    /// `syncBuf` is not null.
    static void setEmitOnSync(SyncBufBase *syncBuf, bool value);
};
 
 
                            // ---------------------
                            // class SyncBufBaseUtil
                            // ---------------------
 
// CLASS METHODS
inline
bool SyncBufBaseUtil::emitInternal(SyncBufBase *syncBuf)
{
    BSLS_ASSERT(syncBuf);
    return syncBuf->emitInternal();
}
 
inline
void SyncBufBaseUtil::setEmitOnSync(SyncBufBase *syncBuf, bool value)
{
    BSLS_ASSERT(syncBuf);
    syncBuf->setEmitOnSync(value);
}
 
}  // close package namespace
 
 
#endif
 
// ----------------------------------------------------------------------------
// Copyright 2023 Bloomberg Finance L.P.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ----------------------------- END-OF-FILE ----------------------------------
 
/** @} */
/** @} */
/** @} */