std::basic_syncbuf
来自cppreference.com
| 定义于头文件 <syncstream>
|
||
| template< class CharT, |
(C++20 起) | |
std::basic_syncbuf 是 std::basic_streambuf （在构造时作为指针提供）的包装。它在其自身的缓冲区中积累输出，然后在析构和显式请求时将其整个内容原子地传输给被包装缓冲，故而它们作为相接的字符序列出现。保证无数据竞争，而且发送给被包装缓冲的字符无穿插，只要所有其他对同一流缓冲的输出都通过可能不同的 std::basic_syncbuf 实例。
std::basic_syncbuf 的典型实现保有指向一个被包装的 std::basic_streambuf 的指针、一个指示是否在同步（冲入）时将传输其内容给被包装缓冲的布尔标志、一个指示策略非同步时发射（ emit on sync ）时的待决冲入的布尔标志、一个使用 Allocator 的内部缓冲区（如 std::string ）和一个指向互斥的指针，该互斥用于在多个访问同一被包装流缓冲的线程间同步发射（这些互斥可以在以指向 basic_streambuf 对象的指针为关键的哈希映射中）。
同其他 streambuf 类，通常仅通过对应的流 std::osyncstream 而非直接访问 std::basic_syncbuf 。
亦定义对二个常用字符类型的特化：
| 定义于头文件
<syncstream> | |
| 类型 | 定义 |
syncbuf
|
basic_syncbuf<char> |
wsyncbuf
|
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 对象 (公开成员函数) | |
| 赋值 basic_syncbuf 对象 (公开成员函数) | |
| 交换二个 basic_syncbuf 对象 (公开成员函数) | |
| 析构 basic_syncbuf 并发射其内部缓冲区 (公开成员函数) | |
| 原子地传输整个内部缓冲区给被包装 streambuf (公开成员函数) | |
| 获得被包装的 streambuf 指针 (公开成员函数) | |
| 获得此 basic_syncbuf 所用的分配器 (公开成员函数) | |
| 更改当前同步时发射策略 (公开成员函数) | |
受保护成员函数 | |
| 依赖于当前的同步时发射策略，发射或记录待决的冲入 (公开成员函数) | |
非成员函数
| 特化 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> 的虚公开成员函数) |
本地环境 | |
| 调用 imbue() ( std::basic_streambuf<CharT,Traits> 的公开成员函数) | |
| 获得相关本地环境的副本 ( 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> 的公开成员函数) | |
获取区 | |
| 获得获取区中立即可用的字符数 ( std::basic_streambuf<CharT,Traits> 的公开成员函数) | |
| 令输入序列前进，读取一个字符而不再次前进 ( std::basic_streambuf<CharT,Traits> 的公开成员函数) | |
| (C++17 中移除) |
从输入序列读取一个字符并令序列前进 ( std::basic_streambuf<CharT,Traits> 的公开成员函数) |
| 从输入序列读取一个字符，而不令序列前进 ( std::basic_streambuf<CharT,Traits> 的公开成员函数) | |
| 调用 xsgetn() ( std::basic_streambuf<CharT,Traits> 的公开成员函数) | |
放置区 | |
| 写一个字符到放置区域，并令 next 指针前进 ( std::basic_streambuf<CharT,Traits> 的公开成员函数) | |
| 调用 xsputn() ( std::basic_streambuf<CharT,Traits> 的公开成员函数) | |
回放 | |
| 在输入序列中放回一个字符 ( std::basic_streambuf<CharT,Traits> 的公开成员函数) | |
| 回移一位输出序列中的下一位置指针 ( std::basic_streambuf<CharT,Traits> 的公开成员函数) | |
受保护成员函数
| 构造 basic_streambuf 对象 (受保护成员函数) | |
| (C++11) |
替换 basic_streambuf 对象 (受保护成员函数) |
| (C++11) |
交换二个 basic_streambuf 对象 (受保护成员函数) |
本地环境 | |
| [虚] |
更改关联的本地环境 ( std::basic_streambuf<CharT,Traits> 的虚受保护成员函数) |
寻位 | |
| [虚] |
若容许则以用户定义数组替换缓冲区 ( std::basic_streambuf<CharT,Traits> 的虚受保护成员函数) |
| [虚] |
用相对寻址重定位输入序列、输出序列或两者中的下一位置指针 ( std::basic_streambuf<CharT,Traits> 的虚受保护成员函数) |
| [虚] |
用绝对寻址重定位输入序列、输出序列或两者中的下一位置指针 ( std::basic_streambuf<CharT,Traits> 的虚受保护成员函数) |
| [虚] |
将缓冲与关联的字符序列同步 ( std::basic_streambuf<CharT,Traits> 的虚受保护成员函数) |
获取区 | |
| [虚] |
若已知，则获得关联输入序列中可用于输入的字符数 ( std::basic_streambuf<CharT,Traits> 的虚受保护成员函数) |
| [虚] |
从关联输入序列读取字符到获取区 ( std::basic_streambuf<CharT,Traits> 的虚受保护成员函数) |
| [虚] |
从输入序列读取字符到获取区，并令下一位置指针前进 ( std::basic_streambuf<CharT,Traits> 的虚受保护成员函数) |
| [虚] |
从输入序列读取多个字符 ( std::basic_streambuf<CharT,Traits> 的虚受保护成员函数) |
| 返回指向获取区起始、当前字符和末尾的指针 (受保护成员函数) | |
| 令输出序列中的下一位置指针前进 (受保护成员函数) | |
| 重定位输出序列的起始、下一位置和终止指针 (受保护成员函数) | |
放置区 | |
| [虚] |
将多个字符写到输出序列 ( std::basic_streambuf<CharT,Traits> 的虚受保护成员函数) |
| [虚] |
从放置区写入字符到关联的输出序列 ( std::basic_streambuf<CharT,Traits> 的虚受保护成员函数) |
| 返回指向放置区的起始、当前字符和末尾的指针 (受保护成员函数) | |
| 令输出序列中的下一位置指针前进 (受保护成员函数) | |
| 重定位输出序列的起始、下一位置和终止指针 (受保护成员函数) | |
回放 | |
| [虚] |
将字符放回输入序列，可能修改输入序列 ( std::basic_streambuf<CharT,Traits> 的虚受保护成员函数) |