std::basic_syncbuf

 

C++

编译器支持

自由（freestanding）与宿主（hosted）

语言

标准库

标准库头文件

具名要求

特性测试宏 (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>		(C++20 起)

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

std::basic_syncbuf 的典型实现包含一个指向被包装的 std::basic_streambuf 的指针，一个布尔标志指示缓冲区是否会在同步（flush）时将其内容传输到被包装的缓冲区，一个布尔标志指示当策略不是在同步时发出（emit）时存在挂起的 flush，一个使用 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 对象 (public 成员函数)
operator=	赋值 basic_syncbuf 对象 (public 成员函数)
swap	交换两个 basic_syncbuf 对象 (public 成员函数)
(析构函数)	销毁 basic_syncbuf 并发出其内部缓冲区 (public 成员函数)
emit	原子地将整个内部缓冲区传输到被包装的 streambuf (public 成员函数)
get_wrapped	检索被包装的 streambuf 指针 (public 成员函数)
get_allocator	检索此 basic_syncbuf 使用的分配器 (public 成员函数)
set_emit_on_sync	更改当前同步时发出策略 (public 成员函数)
受保护的成员函数
sync	根据当前同步时发出策略，要么发出，要么记录挂起的 flush (public 成员函数)

非成员函数

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

成员函数

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

注意

特性测试宏	值	标准	特性
__cpp_lib_syncbuf	201803L	(C++20)	同步缓冲输出流（std::syncbuf，std::osyncstream）和操纵符