ContinuedChannel.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2000-2005, 2018, 2020, 2023, 2026 Carlo Wood
// SPDX-License-Identifier: MIT
 
#pragma once

 
#ifndef LIBCWD_CLASS_CONTINUED_CHANNEL_H
#define LIBCWD_CLASS_CONTINUED_CHANNEL_H
 
#include "control_flag.h"
#include "libcwd/config.h"
 
namespace libcwd {
 
//===================================================================================================
// class ContinuedChannel
//
// A debug channel with a special characteristic: It uses the same label and
// flags as the previous Dout() call (no prefix is printed unless other
// debug output interrupted the start, indicated with `continued_cf').
//
 
class ContinuedChannel
{
 private:
  control_flag_t maskbit_;
  // Written during initialization before this channel is made visible to other threads.
  // The mask that contains the control bit.
 
 public:
  //-------------------------------------------------------------------------------------------------
  // Constructor
  //
 
  // MT: All channel objects must be global so that `maskbit_' is zero
  //     at the start of the program and initialization occurs before other
  //     threads share the object.
  explicit ContinuedChannel(control_flag_t maskbit);
  // Construct a continued debug channel with extra control bit `cb'.
 
  // MT: May only be called from the constructors of global objects (or single threaded functions).
  void NS_initialize(control_flag_t maskbit);
  // Force initialization in case the constructor of this global object
  // wasn't called yet.  Does nothing when the object was already initialized.
 
 public:
  control_flag_t get_maskbit() const;
};
 
} // namespace libcwd
 
#endif // LIBCWD_CLASS_CONTINUED_CHANNEL_H