BS::synced_stream Class Reference

A utility class to synchronize printing to one or more output streams by different threads. More...

#include <BS_thread_pool.hpp>

Collaboration diagram for BS::synced_stream:

Public Member Functions
	synced_stream ()
	Construct a new synced stream which prints to std::cout.
template<typename... T>
	synced_stream (T &... streams)
	Construct a new synced stream which prints to the given output stream(s).
void	add_stream (std::ostream &stream)
	Add a stream to the list of output streams to print to.
std::vector< std::ostream * > &	get_streams () noexcept
	Get a reference to a vector containing pointers to the output streams to print to.
template<typename... T>
void	print (const T &... items)
	Print any number of items into each output stream. Ensures that no other threads print to the streams simultaneously, as long as they all exclusively use the same BS::synced_stream object to print.
template<typename... T>
void	println (T &&... items)
	Print any number of items into each output stream, followed by a newline character. Ensures that no other threads print to the streams simultaneously, as long as they all exclusively use the same BS::synced_stream object to print.
void	remove_stream (std::ostream &stream)
	Remove a stream from the list of output streams to print to.

Static Public Attributes
static std::ostream &(&)	endl (std::ostream &) = static_cast<std::ostream& (&)(std::ostream&)>(std::endl)
	A stream manipulator to pass to a BS::synced_stream (an explicit cast of std::endl). Prints a newline character to the stream, and then flushes it. Should only be used if flushing is desired, otherwise a newline character should be used instead.
static std::ostream &(&)	flush (std::ostream &) = static_cast<std::ostream& (&)(std::ostream&)>(std::flush)
	A stream manipulator to pass to a BS::synced_stream (an explicit cast of std::flush). Used to flush the stream.

Private Attributes
std::mutex	stream_mutex
	A mutex to synchronize printing.
std::vector< std::ostream * >	out_streams
	The output streams to print to.

Detailed Description

A utility class to synchronize printing to one or more output streams by different threads.

Constructor & Destructor Documentation

synced_stream() [1/2]

BS::synced_stream::synced_stream ( )

inlineexplicit

Construct a new synced stream which prints to std::cout.

    {
        add_stream(std::cout);
    }

synced_stream() [2/2]

template<typename... T>

BS::synced_stream::synced_stream ( T &...  streams )

inlineexplicit

Construct a new synced stream which prints to the given output stream(s).

Template Parameters

T	The types of the output streams to print to.

Parameters

streams

The output streams to print to.

    {
        (add_stream(streams), ...);
    }

Member Function Documentation

add_stream()

void BS::synced_stream::add_stream ( std::ostream &  stream )

inline

Add a stream to the list of output streams to print to.

Parameters

stream

The stream.

    {
        out_streams.push_back(&stream);
    }

get_streams()

std::vector< std::ostream * > & BS::synced_stream::get_streams ( )

inlinenoexcept

Get a reference to a vector containing pointers to the output streams to print to.

Returns

The output streams.

    {
        return out_streams;
    }

print()

template<typename... T>

void BS::synced_stream::print ( const T &...  items )

inline

Print any number of items into each output stream. Ensures that no other threads print to the streams simultaneously, as long as they all exclusively use the same BS::synced_stream object to print.

Template Parameters

T	The types of the items.

Parameters

items

The items to print.

    {
        const std::scoped_lock stream_lock(stream_mutex);
        for (std::ostream* const stream : out_streams)
            (*stream << ... << items);
    }

println()

template<typename... T>

void BS::synced_stream::println ( T &&...  items )

inline

Print any number of items into each output stream, followed by a newline character. Ensures that no other threads print to the streams simultaneously, as long as they all exclusively use the same BS::synced_stream object to print.

Template Parameters

T	The types of the items.

Parameters

items

The items to print.

    {
        print(std::forward<T>(items)..., '\n');
    }

remove_stream()

void BS::synced_stream::remove_stream ( std::ostream &  stream )

inline

Remove a stream from the list of output streams to print to.

Parameters

stream

The stream.

    {
        out_streams.erase(std::remove(out_streams.begin(), out_streams.end(), &stream), out_streams.end());
    }

---

The documentation for this class was generated from the following file:

• external/threadpool/include/BS_thread_pool.hpp