std::basic_syncbuf

 

C++

编译器支持

独立和宿主

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

输入/输出库

I/O 操纵符

打印函数 (C++23)

C 风格 I/O

缓冲区

basic_streambuf

basic_filebuf

basic_stringbuf

basic_spanbuf (C++23)

strstreambuf (C++98/26*)

basic_syncbuf (C++20)

流

抽象概念

ios_base

basic_ios

basic_istream

basic_ostream

basic_iostream

文件 I/O

basic_ifstream

basic_ofstream

basic_fstream

字符串 I/O

basic_istringstream

basic_ostringstream

basic_stringstream

数组 I/O

basic_ispanstream (C++23)

basic_ospanstream (C++23)

basic_spanstream (C++23)

istrstream (C++98/26*)

ostrstream (C++98/26*)

strstream (C++98/26*)

同步输出

basic_osyncstream (C++20)

类型

streamoff

streamsize

fpos

错误类别接口

iostream_category (C++11)

io_errc (C++11)

 

std::basic_syncbuf

公共成员函数

basic_syncbuf::basic_syncbuf (C++20)

basic_syncbuf::operator= (C++20)

basic_syncbuf::~basic_syncbuf (C++20)

basic_syncbuf::swap (C++20)

basic_syncbuf::emit (C++20)

basic_syncbuf::get_wrapped (C++20)

basic_syncbuf::get_allocator (C++20)

basic_syncbuf::set_emit_on_sync (C++20)

受保护成员函数

basic_syncbuf::sync (C++20)

非成员函数

swap(std::basic_syncbuf) (C++20)

 

在头文件 <syncstream> 中定义
template<     class CharT,     class Traits = std::char_traits<CharT>,     class Allocator = std::allocator<CharT> > class basic_syncbuf : public std::basic_streambuf<CharT, Traits>		(since C++20)

std::basic_syncbuf 是 std::basic_streambuf 的包装器（在构造时作为指针提供）。它在其内部缓冲区中累积输出，并在销毁时以及显式请求时原子地将其全部内容传输到被包装的缓冲区，以便它们显示为连续的字符序列。它保证只要对同一缓冲区的所有其他输出都是通过可能不同的 std::basic_syncbuf 实例进行的，就不会发生数据竞争，也不会发生发送到被包装缓冲区的字符的交错。

std::basic_syncbuf 的典型实现包含指向被包装的 std::basic_streambuf 的指针、一个布尔标志，指示缓冲区是否会在同步（刷新）时将其内容传输到被包装的缓冲区、一个布尔标志，指示当策略是不在同步时发射时，是否存在待处理的刷新、一个使用 Allocator 的内部缓冲区（例如 std::string），以及一个指向互斥锁的指针，该互斥锁用于同步访问同一被包装流缓冲区的多个线程之间的发射（这些互斥锁可能位于哈希映射中，其中指向 std::basic_streambuf 对象的指针用作键）。

与其他 streambuf 类一样，std::basic_syncbuf 通常仅通过相应的流 std::osyncstream 访问，而不是直接访问。

提供了几种常见字符类型的 typedef

在头文件 <syncstream> 中定义
类型	定义
std::syncbuf	std::basic_syncbuf<char>
std::wsyncbuf	std::basic_syncbuf<wchar_t>

成员类型

成员类型	定义
char_type	CharT
traits_type	Traits; 如果 Traits::char_type 不是 CharT，则程序是非良构的。
int_type	Traits::int_type
pos_type	Traits::pos_type
off_type	Traits::off_type
allocator_type	Allocator
streambuf_type	std::basic_streambuf<CharT, Traits>

成员函数

公共成员函数
(构造函数)	构造一个 basic_syncbuf 对象 (公共成员函数)
operator=	赋值一个 basic_syncbuf 对象 (公共成员函数)
swap	交换两个 basic_syncbuf 对象 (公共成员函数)
(析构函数)	销毁 basic_syncbuf 并发射其内部缓冲区 (公共成员函数)
emit	原子地将被包装的 streambuf 的整个内部缓冲区传输过去 (公共成员函数)
get_wrapped	检索被包装的 streambuf 指针 (公共成员函数)
get_allocator	检索此 basic_syncbuf 使用的分配器 (公共成员函数)
set_emit_on_sync	更改当前的同步时发射策略 (公共成员函数)
受保护成员函数
sync	根据当前的同步时发射策略，发射或记录待处理的刷新 (公共成员函数)

非成员函数

std::swap(std::basic_syncbuf) (C++20)

特化 std::swap 算法 (函数模板)

继承自 std::basic_streambuf

成员类型

成员类型	定义
char_type	CharT
traits_type	Traits; 如果 Traits::char_type 不是 CharT，则程序是非良构的。
int_type	Traits::int_type
pos_type	Traits::pos_type
off_type	Traits::off_type

成员函数

(析构函数) [虚函数]	销毁 basic_streambuf 对象 (std::basic_streambuf<CharT,Traits> 的虚公共成员函数)
区域设置
pubimbue	更改关联的区域设置并调用 imbue() (std::basic_streambuf<CharT,Traits> 的公共成员函数)
getloc	获取关联区域设置的副本 (std::basic_streambuf<CharT,Traits> 的公共成员函数)
定位
pubsetbuf	调用 setbuf() (std::basic_streambuf<CharT,Traits> 的公共成员函数)
pubseekoff	调用 seekoff() (std::basic_streambuf<CharT,Traits> 的公共成员函数)
pubseekpos	调用 seekpos() (std::basic_streambuf<CharT,Traits> 的公共成员函数)
pubsync	调用 sync() (std::basic_streambuf<CharT,Traits> 的公共成员函数)
Get 区域
in_avail	获取 get 区域中立即可用的字符数 (std::basic_streambuf<CharT,Traits> 的公共成员函数)
snextc	推进输入序列，然后读取一个字符而不再次推进 (std::basic_streambuf<CharT,Traits> 的公共成员函数)
sbumpcstossc (在 C++17 中移除)	从输入序列读取一个字符并推进序列 (std::basic_streambuf<CharT,Traits> 的公共成员函数)
sgetc	从输入序列读取一个字符，而不推进序列 (std::basic_streambuf<CharT,Traits> 的公共成员函数)
sgetn	调用 xsgetn() (std::basic_streambuf<CharT,Traits> 的公共成员函数)
Put 区域
sputc	将一个字符写入 put 区域并推进下一个指针 (std::basic_streambuf<CharT,Traits> 的公共成员函数)
sputn	调用 xsputn() (std::basic_streambuf<CharT,Traits> 的公共成员函数)
放回
sputbackc	将一个字符放回输入序列 (std::basic_streambuf<CharT,Traits> 的公共成员函数)
sungetc	将输入序列中的下一个指针向后移动一位 (std::basic_streambuf<CharT,Traits> 的公共成员函数)

受保护成员函数

(构造函数)	构造一个 basic_streambuf 对象 (受保护成员函数)
operator= (C++11)	替换 basic_streambuf 对象 (受保护成员函数)
swap (C++11)	交换两个 basic_streambuf 对象 (受保护成员函数)
区域设置
imbue [虚函数]	对关联的区域设置的更改做出反应 (std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
定位
setbuf [虚函数]	如果允许，用用户定义的数组替换缓冲区 (std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
seekoff [虚函数]	使用相对寻址重新定位输入序列、输出序列或两者的下一个指针 (std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
seekpos [虚函数]	使用绝对寻址重新定位输入序列、输出序列或两者的下一个指针 (std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
sync [虚函数]	将缓冲区与关联的字符序列同步 (std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
Get 区域
showmanyc [虚函数]	获取关联的输入序列中可用于输入的字符数（如果已知） (std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
underflow [虚函数]	从关联的输入序列读取字符到 get 区域 (std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
uflow [虚函数]	从关联的输入序列读取字符到 get 区域并推进下一个指针 (std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
xsgetn [虚函数]	从输入序列读取多个字符 (std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
ebackgptregptr	返回指向 get 区域的开始、当前字符和结尾的指针 (受保护成员函数)
gbump	推进输入序列中的下一个指针 (受保护成员函数)
setg	重新定位输入序列的开始、下一个和结束指针 (受保护成员函数)
Put 区域
xsputn [虚函数]	将多个字符写入输出序列 (std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
overflow [虚函数]	将字符从 put 区域写入关联的输出序列 (std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
pbasepptrepptr	返回指向 put 区域的开始、当前字符和结尾的指针 (受保护成员函数)
pbump	推进输出序列的下一个指针 (受保护成员函数)
setp	重新定位输出序列的开始、下一个和结束指针 (受保护成员函数)
放回
pbackfail [虚函数]	将字符放回到输入序列中，可能会修改输入序列 (std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)

注释

特性测试 宏	值	Std	特性
__cpp_lib_syncbuf	201803L	(C++20)	同步缓冲 ostream (std::syncbuf, std::osyncstream) 和操纵符