std::basic_syncbuf

 

C++

编译器支持

独立和托管

语言

标准库

标准库头文件

命名要求

功能测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用实用程序库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (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 的指针，一个布尔标志，指示缓冲区是否将在同步（刷新）时将其内容传输到包装的缓冲区，一个布尔标志，指示当策略是不要在同步时发出时，一个内部缓冲区，使用 Allocator（例如 std::string），以及一个指向用于同步多个线程之间发出操作的互斥锁的指针（这些互斥锁可能位于一个哈希映射中，指向 std::basic_streambuf 对象，作为键使用）。

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

为常见字符类型提供了一些类型定义

定义在头文件 <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	更改当前的 emit-on-sync 策略 (公共成员函数)
受保护的成员函数
sync	根据当前的 emit-on-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> 的公共成员函数)
获取区域
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 对象 (受保护的成员函数)
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> 的虚拟受保护的成员函数)
获取区域
showmanyc [虚拟]	获取关联的输入序列中可用于输入的字符数（如果已知） (std::basic_streambuf<CharT,Traits> 的虚拟受保护的成员函数)
underflow [虚拟]	从关联的输入序列读取字符到获取区域 (std::basic_streambuf<CharT,Traits> 的虚拟受保护的成员函数)
uflow [虚拟]	从关联的输入序列读取字符到获取区域并前进下一个指针 (std::basic_streambuf<CharT,Traits> 的虚拟受保护的成员函数)
xsgetn [虚拟]	从输入序列读取多个字符 (std::basic_streambuf<CharT,Traits> 的虚拟受保护的成员函数)
ebackgptregptr	返回指向获取区域的开头、当前字符和结尾的指针 (受保护的成员函数)
gbump	前进输入序列中的下一个指针 (受保护的成员函数)
setg	重新定位输入序列的开头、下一个和结尾指针 (受保护的成员函数)
放置区域
xsputn [虚拟]	将多个字符写入输出序列 (std::basic_streambuf<CharT,Traits> 的虚拟受保护的成员函数)
overflow [虚拟]	从放置区域将字符写入关联的输出序列 (std::basic_streambuf<CharT,Traits> 的虚拟受保护的成员函数)
pbasepptrepptr	返回指向放置区域的开头、当前字符和结尾的指针 (受保护的成员函数)
pbump	前进输出序列中的下一个指针 (受保护的成员函数)
setp	重新定位输出序列的开头、下一个和结尾指针 (受保护的成员函数)
回退
pbackfail [虚拟]	将一个字符放回输入序列，可能修改输入序列 (std::basic_streambuf<CharT,Traits> 的虚拟受保护的成员函数)

备注

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