View source for cpp/io/basic syncbuf

You do not have permission to edit this page, for the following reasons:

The action you have requested is limited to users in one of the groups: Users, Administrators.

Due to recent vandalism, editing of this page is temporarily disabled for new users.If you want to suggest a change, please leave a message on the suggestions page for new users instead (don't be surprised if that page appears vandalized!).

You can view and copy the source of this page.

{{cpp/title|basic_syncbuf}}
{{cpp/io/basic_syncbuf/navbar}}
{{ddcl|header=syncstream|since=c++20|1=
template<
    class CharT,
    class Traits = std::char_traits<CharT>,
    class Allocator = std::allocator<CharT>
> class basic_syncbuf : public std::basic_streambuf<CharT, Traits>
}}

{{tt|std::basic_syncbuf}} is a wrapper for a {{lc|std::basic_streambuf}} (provided at construction time as a pointer). It accumulates output in its own internal buffer, and atomically transmits its entire contents to the wrapped buffer on destruction and when explicitly requested, so that they appear as a contiguous sequence of characters. It guarantees that there are no data races and no interleaving of characters sent to the wrapped buffer as long as all other outputs made to the same buffer are made through, possibly different, instances of {{tt|std::basic_syncbuf}}.

Typical implementation of {{tt|std::basic_syncbuf}} holds a pointer to the wrapped {{lc|std::basic_streambuf}}, a boolean flag indicating whether the buffer will transmit its contents to the wrapped buffer on sync (flush), a boolean flag indicating a pending flush when the policy is to not emit on sync, an internal buffer that uses {{tt|Allocator}} (such as {{lc|std::string}}), and a pointer to a mutex used to synchronize emit between multiple threads accessing the same wrapped stream buffer (these mutexes may be in a hash map with pointers to {{lc|std::basic_streambuf}} objects used as keys).

Like other streambuf classes, {{tt|std::basic_syncbuf}} is normally only accessed through the corresponding stream, {{ltt|cpp/io/basic_osyncstream|std::osyncstream}}, not directly.

{{cpp/basic char typedefs|syncbuf|syncstream}}

===Member types===
{{dsc begin}}
{{dsc hitem|Member type|Definition}}
{{dsc inc|cpp/io/dsc char_type}}
{{dsc inc|cpp/io/dsc traits_type}}
{{dsc inc|cpp/io/dsc int_type}}
{{dsc inc|cpp/io/dsc pos_type}}
{{dsc inc|cpp/io/dsc off_type}}
{{dsc|{{tt|allocator_type}}|{{tt|Allocator}}}}
{{dsc|{{tt|streambuf_type}}|{{c/core|std::basic_streambuf<CharT, Traits>}}}}
{{dsc end}}

===Member functions===
{{dsc begin}}
{{dsc h1|Public member functions}}
{{dsc inc|cpp/io/basic_syncbuf/dsc constructor}}
{{dsc inc|cpp/io/basic_syncbuf/dsc operator{{=}}}}
{{dsc inc|cpp/io/basic_syncbuf/dsc swap}}
{{dsc inc|cpp/io/basic_syncbuf/dsc destructor}}
{{dsc inc|cpp/io/basic_syncbuf/dsc emit}}
{{dsc inc|cpp/io/basic_syncbuf/dsc get_wrapped}}
{{dsc inc|cpp/io/basic_syncbuf/dsc get_allocator}}
{{dsc inc|cpp/io/basic_syncbuf/dsc set_emit_on_sync}}

{{dsc h1|Protected member functions}}
{{dsc inc|cpp/io/basic_syncbuf/dsc sync}}
{{dsc end}}

===Non-member functions===
{{dsc begin}}
{{dsc inc|cpp/io/basic_syncbuf/dsc swap2}}
{{dsc end}}

{{cpp/io/basic_streambuf/inherit}}

===Notes===
{{feature test macro|__cpp_lib_syncbuf|std=C++20|value=201803L|Synchronized buffered ostream ([[#Top|{{tt|std::syncbuf}}]], {{lc|std::osyncstream}}) and manipulators}}


{{langlinks|de|es|fr|it|ja|pt|ru|zh}}

Templates used on this page:

Template:c (view source) (protected)
Template:c/core (view source) (protected)
Template:cmark (view source) (protected)
Template:cmark virtual (view source) (protected)
Template:cpp/basic char typedefs (view source)
Template:cpp/io/basic streambuf/dsc basic streambuf (view source)
Template:cpp/io/basic streambuf/dsc gbump (view source)
Template:cpp/io/basic streambuf/dsc getloc (view source)
Template:cpp/io/basic streambuf/dsc gptr (view source)
Template:cpp/io/basic streambuf/dsc imbue (view source)
Template:cpp/io/basic streambuf/dsc in avail (view source)
Template:cpp/io/basic streambuf/dsc operator= (view source)
Template:cpp/io/basic streambuf/dsc overflow (view source)
Template:cpp/io/basic streambuf/dsc pbackfail (view source)
Template:cpp/io/basic streambuf/dsc pbump (view source)
Template:cpp/io/basic streambuf/dsc pptr (view source)
Template:cpp/io/basic streambuf/dsc pubimbue (view source)
Template:cpp/io/basic streambuf/dsc pubseekoff (view source)
Template:cpp/io/basic streambuf/dsc pubseekpos (view source)
Template:cpp/io/basic streambuf/dsc pubsetbuf (view source)
Template:cpp/io/basic streambuf/dsc pubsync (view source)
Template:cpp/io/basic streambuf/dsc sbumpc (view source)
Template:cpp/io/basic streambuf/dsc seekoff (view source)
Template:cpp/io/basic streambuf/dsc seekpos (view source)
Template:cpp/io/basic streambuf/dsc setbuf (view source)
Template:cpp/io/basic streambuf/dsc setg (view source)
Template:cpp/io/basic streambuf/dsc setp (view source)
Template:cpp/io/basic streambuf/dsc sgetc (view source)
Template:cpp/io/basic streambuf/dsc sgetn (view source)
Template:cpp/io/basic streambuf/dsc showmanyc (view source)
Template:cpp/io/basic streambuf/dsc snextc (view source)
Template:cpp/io/basic streambuf/dsc sputbackc (view source)
Template:cpp/io/basic streambuf/dsc sputc (view source)
Template:cpp/io/basic streambuf/dsc sputn (view source)
Template:cpp/io/basic streambuf/dsc sungetc (view source)
Template:cpp/io/basic streambuf/dsc swap (view source)
Template:cpp/io/basic streambuf/dsc sync (view source)
Template:cpp/io/basic streambuf/dsc uflow (view source)
Template:cpp/io/basic streambuf/dsc underflow (view source)
Template:cpp/io/basic streambuf/dsc xsgetn (view source)
Template:cpp/io/basic streambuf/dsc xsputn (view source)
Template:cpp/io/basic streambuf/dsc ~basic streambuf (view source)
Template:cpp/io/basic streambuf/inherit (view source)
Template:cpp/io/basic streambuf/title (view source)
Template:cpp/io/basic syncbuf/dsc constructor (view source)
Template:cpp/io/basic syncbuf/dsc destructor (view source)
Template:cpp/io/basic syncbuf/dsc emit (view source)
Template:cpp/io/basic syncbuf/dsc get allocator (view source)
Template:cpp/io/basic syncbuf/dsc get wrapped (view source)
Template:cpp/io/basic syncbuf/dsc operator= (view source)
Template:cpp/io/basic syncbuf/dsc set emit on sync (view source)
Template:cpp/io/basic syncbuf/dsc swap (view source)
Template:cpp/io/basic syncbuf/dsc swap2 (view source)
Template:cpp/io/basic syncbuf/dsc sync (view source)
Template:cpp/io/basic syncbuf/navbar (view source)
Template:cpp/io/basic syncbuf/navbar content (view source)
Template:cpp/io/basic syncbuf/navbar heading (view source)
Template:cpp/io/dsc char type (view source)
Template:cpp/io/dsc int type (view source)
Template:cpp/io/dsc off type (view source)
Template:cpp/io/dsc pos type (view source)
Template:cpp/io/dsc traits type (view source)
Template:cpp/io/navbar content (view source)
Template:cpp/io/navbar heading (view source)
Template:cpp/navbar content (view source)
Template:cpp/navbar heading (view source)
Template:cpp/title (view source) (protected)
Template:ctitle (view source) (protected)
Template:dcl (view source) (protected)
Template:dcl/std (view source) (semi-protected)
Template:dcl begin (view source) (protected)
Template:dcl end (view source) (protected)
Template:dcl header (view source) (protected)
Template:dcl list header/link (view source)
Template:dcl sep (view source) (protected)
Template:ddcl (view source) (protected)
Template:dsc (view source) (protected)
Template:dsc begin (view source) (protected)
Template:dsc editlink (view source)
Template:dsc end (view source) (protected)
Template:dsc guard (view source) (protected)
Template:dsc h1 (view source) (protected)
Template:dsc h2 (view source) (protected)
Template:dsc header (view source) (protected)
Template:dsc header/link (view source)
Template:dsc hitem (view source) (protected)
Template:dsc inc (view source) (protected)
Template:dsc mark mem (view source) (protected)
Template:dsc mem ctor (view source) (protected)
Template:dsc mem dtor (view source) (protected)
Template:dsc mem fun (view source) (protected)
Template:dsc mem vdtor (view source) (protected)
Template:dsc member (view source) (protected)
Template:dsc prot mem ctor (view source) (protected)
Template:dsc prot mem fun (view source) (protected)
Template:dsc prot mem vfun (view source) (protected)
Template:dsc small (view source)
Template:dsc tfun (view source) (protected)
Template:feature test macro (view source)
Template:ftm link (view source)
Template:get lang (view source) (protected)
Template:inherited (view source) (protected)
Template:l2tt/core (view source) (protected)
Template:langlinks (view source) (protected)
Template:langlinks/one (view source) (protected)
Template:lc (view source) (protected)
Template:lines (view source) (protected)
Template:ltt (view source) (protected)
Template:ltt/core (view source) (protected)
Template:mark (view source) (protected)
Template:mark c++11 (view source) (protected)
Template:mark c++17 (view source) (protected)
Template:mark c++20 (view source)
Template:mark c++23 (view source) (protected)
Template:mark c++26 (view source)
Template:mark mem fun (view source) (protected)
Template:mark mem vfun (view source) (protected)
Template:mark prot mem fun (view source) (protected)
Template:mark prot mem vfun (view source) (protected)
Template:mark rev (view source) (protected)
Template:mark since c++20 (view source)
Template:mark tfun (view source) (protected)
Template:mark tooltip (view source)
Template:mark until c++17 (view source)
Template:navbar (view source)
Template:navbar editlink (view source) (protected)
Template:nv (view source) (protected)
Template:nv begin (view source) (protected)
Template:nv end (view source) (protected)
Template:nv h1 (view source) (protected)
Template:nv h2 (view source) (protected)
Template:nv ln (view source) (protected)
Template:nv mem ln (view source) (protected)
Template:small (view source) (protected)
Template:title (view source) (protected)
Template:tooltip (view source)
Template:trim (view source) (protected)
Template:tt (view source) (protected)

Return to cpp/io/basic syncbuf.

cppreference.com

Search

Namespaces

Variants

Views

Actions

View source for cpp/io/basic syncbuf

Navigation

Tools