std::basic_osyncstream - cppreference.com (original) (raw)

The class template std::basic_osyncstream is a convenience wrapper for std::basic_syncbuf. It provides a mechanism to synchronize threads writing to the same stream.

It can be used with a named variable:

{ std::osyncstream synced_out(std::cout); // synchronized wrapper for std::cout synced_out << "Hello, "; synced_out << "World!"; synced_out << std::endl; // flush is noted, but not yet performed synced_out << "and more!\n"; } // characters are transferred and std::cout is flushed

as well as with a temporary:

std::osyncstream(std::cout) << "Hello, " << "World!" << '\n';

It provides the guarantee that all output made to the same final destination buffer (std::cout in the examples above) will be free of data races and will not be interleaved or garbled in any way, as long as every write to that final destination buffer is made through (possibly different) instances of std::basic_osyncstream.

Typical implementation of std::basic_osyncstream holds only one member: the wrapped std::basic_syncbuf.

std-basic osyncstream-inheritance.svg

Inheritance diagram

Several typedefs for common character types are provided:

Type Definition
std::osyncstream std::basic_osyncstream<char>
std::wosyncstream std::basic_osyncstream<wchar_t>

Contents

[edit] Member types

Member type Definition
char_type CharT[edit]
traits_type Traits; the program is ill-formed if Traits::char_type is not CharT.[edit]
int_type Traits::int_type[edit]
pos_type Traits::pos_type[edit]
off_type Traits::off_type[edit]
allocator_type Allocator
streambuf_type std::basic_streambuf<CharT, Traits>
syncbuf_type std::basic_syncbuf<CharT, Traits, Allocator>

[edit] Member functions

(constructor) constructs a basic_osyncstream object (public member function) [edit]
operator= assigns a basic_osyncstream object (public member function) [edit]
(destructor) destroys the basic_osyncstream and emits its internal buffer (public member function) [edit]
rdbuf obtains a pointer to the underlying basic_syncbuf (public member function) [edit]
get_wrapped obtains a pointer to the final destination stream buffer (public member function) [edit]
emit calls emit() on the underlying basic_syncbuf to transmit its internal data to the final destination (public member function) [edit]

Inherited from std::basic_ostream

Member functions

Formatted output
operator<< inserts formatted data (public member function of std::basic_ostream<CharT,Traits>) [edit]
Unformatted output
put inserts a character (public member function of std::basic_ostream<CharT,Traits>) [edit]
write inserts blocks of characters (public member function of std::basic_ostream<CharT,Traits>) [edit]
Positioning
tellp returns the output position indicator (public member function of std::basic_ostream<CharT,Traits>) [edit]
seekp sets the output position indicator (public member function of std::basic_ostream<CharT,Traits>) [edit]
Miscellaneous
flush synchronizes with the underlying storage device (public member function of std::basic_ostream<CharT,Traits>) [edit]

Member classes

| | implements basic logic for preparation of the stream for output operations (public member class of std::basic_ostream<CharT,Traits>) [edit] | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

Inherited from std::basic_ios

Member types

Member type Definition
char_type CharT
traits_type Traits
int_type Traits::int_type
pos_type Traits::pos_type
off_type Traits::off_type

Member functions

State functions
good checks if no error has occurred i.e. I/O operations are available (public member function of std::basic_ios<CharT,Traits>) [edit]
eof checks if end-of-file has been reached (public member function of std::basic_ios<CharT,Traits>) [edit]
fail checks if an error has occurred (public member function of std::basic_ios<CharT,Traits>) [edit]
bad checks if a non-recoverable error has occurred (public member function of std::basic_ios<CharT,Traits>) [edit]
operator! checks if an error has occurred (synonym of fail()) (public member function of std::basic_ios<CharT,Traits>) [edit]
operator bool checks if no error has occurred (synonym of fail()) (public member function of std::basic_ios<CharT,Traits>) [edit]
rdstate returns state flags (public member function of std::basic_ios<CharT,Traits>) [edit]
setstate sets state flags (public member function of std::basic_ios<CharT,Traits>) [edit]
clear modifies state flags (public member function of std::basic_ios<CharT,Traits>) [edit]
Formatting
copyfmt copies formatting information (public member function of std::basic_ios<CharT,Traits>) [edit]
fill manages the fill character (public member function of std::basic_ios<CharT,Traits>) [edit]
Miscellaneous
exceptions manages exception mask (public member function of std::basic_ios<CharT,Traits>) [edit]
imbue sets the locale (public member function of std::basic_ios<CharT,Traits>) [edit]
rdbuf manages associated stream buffer (public member function of std::basic_ios<CharT,Traits>) [edit]
tie manages tied stream (public member function of std::basic_ios<CharT,Traits>) [edit]
narrow narrows characters (public member function of std::basic_ios<CharT,Traits>) [edit]
widen widens characters (public member function of std::basic_ios<CharT,Traits>) [edit]

Inherited from std::ios_base

Member functions

Formatting
flags manages format flags (public member function of std::ios_base) [edit]
setf sets specific format flag (public member function of std::ios_base) [edit]
unsetf clears specific format flag (public member function of std::ios_base) [edit]
precision manages decimal precision of floating point operations (public member function of std::ios_base) [edit]
width manages field width (public member function of std::ios_base) [edit]
Locales
imbue sets locale (public member function of std::ios_base) [edit]
getloc returns current locale (public member function of std::ios_base) [edit]
Internal extensible array
xalloc[static] returns a program-wide unique integer that is safe to use as index to pword() and iword() (public static member function of std::ios_base) [edit]
iword resizes the private storage if necessary and access to the long element at the given index (public member function of std::ios_base) [edit]
pword resizes the private storage if necessary and access to the void* element at the given index (public member function of std::ios_base) [edit]
Miscellaneous
register_callback registers event callback function (public member function of std::ios_base) [edit]
sync_with_stdio[static] sets whether C++ and C I/O libraries are interoperable (public static member function of std::ios_base) [edit]
Member classes
failure stream exception (public member class of std::ios_base) [edit]
Init initializes standard stream objects (public member class of std::ios_base) [edit]

[edit] Notes

Feature-test macro Value Std Feature
__cpp_lib_syncbuf 201803L (C++20) Synchronized buffered ostream (std::osyncstream, std::syncbuf) and manipulators