Namespaces
Variants

std:: basic_syncbuf

From cppreference.net
< cpp ‎ | io
定义于头文件 <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 对象指针作为键值)。

与其他流缓冲区类类似, 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 对象
(公共成员函数)
赋值 basic_syncbuf 对象
(公共成员函数)
交换两个 basic_syncbuf 对象
(公共成员函数)
销毁 basic_syncbuf 并发送其内部缓冲区
(公共成员函数)
原子地将整个内部缓冲区传输到包装的流缓冲区
(公共成员函数)
获取包装的流缓冲区指针
(公共成员函数)
获取此 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> 的公开成员函数)
放置区域
向放置区域写入一个字符并前进下一个指针
( 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 对象
(受保护的成员函数)
区域设置
[virtual]
响应关联区域设置的变更
( std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
定位
[virtual]
若允许则用用户自定义数组替换缓冲区
( std::basic_streambuf<CharT,Traits> 的虚保护成员函数)
[virtual]
使用相对寻址重新定位输入序列、输出序列或两者中的下一个指针
std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
[virtual]
使用绝对寻址重新定位输入序列、输出序列或两者中的下一个指针
( std::basic_streambuf<CharT,Traits> 的虚保护成员函数)
[virtual]
同步缓冲区与关联的字符序列
std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
获取面积
[virtual]
获取关联输入序列中可供输入的字符数量(若已知)
std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
[virtual]
从关联的输入序列读取字符到获取区
( std::basic_streambuf<CharT,Traits> 的虚保护成员函数)
[virtual]
从关联输入序列读取字符到获取区并推进下一个指针
( std::basic_streambuf<CharT,Traits> 的虚保护成员函数)
[virtual]
从输入序列读取多个字符
std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
返回指向获取区域起始位置、当前字符和结束位置的指针
(受保护的成员函数)
推进输入序列中的下一个指针
(受保护成员函数)
重新定位输入序列的起始指针、下一个指针和结束指针
(受保护成员函数)
放置区域
[virtual]
向输出序列写入多个字符
std::basic_streambuf<CharT,Traits> 的虚保护成员函数)
[virtual]
将字符从放置区写入到关联的输出序列
( std::basic_streambuf<CharT,Traits> 的虚受保护成员函数)
返回指向输出区域起始位置、当前字符和末尾的指针
(受保护的成员函数)
推进输出序列的下一指针
(受保护成员函数)
重新定位输出序列的起始指针、下一个指针和结束指针
(受保护的成员函数)
Putback
[virtual]
将字符放回输入序列,可能修改输入序列
( std::basic_streambuf<CharT,Traits> 的虚保护成员函数)

注释

功能测试 标准 功能
__cpp_lib_syncbuf 201803L (C++20) 同步缓冲输出流 ( std::syncbuf , std::osyncstream ) 及其操纵器