std::basic_osyncstream

 

C++

言語

標準ライブラリヘッダ

フリースタンディング処理系とホスト処理系

名前付き要件

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

ユーティリティライブラリ

文字列ライブラリ

コンテナライブラリ

イテレータライブラリ

範囲ライブラリ (C++20)

アルゴリズムライブラリ

数値演算ライブラリ

入出力ライブラリ

ローカライゼーションライブラリ

正規表現ライブラリ (C++11)

アトミック操作ライブラリ (C++11)

スレッドサポートライブラリ (C++11)

ファイルシステムライブラリ (C++17)

技術仕様書

 

入出力ライブラリ

入出力マニピュレータ

Cスタイルの入出力

バッファ

basic_streambuf

basic_filebuf

basic_stringbuf

strstreambuf (C++98で非推奨)

basic_syncbuf (C++20)

ストリーム

抽象

ios_base

basic_ios

basic_istream

basic_ostream

basic_iostream

ファイル入出力

basic_ifstream

basic_ofstream

basic_fstream

文字列入出力

basic_istringstream

basic_ostringstream

basic_stringstream

配列入出力

istrstream (C++98で非推奨)

ostrstream (C++98で非推奨)

strstream (C++98で非推奨)

同期化出力

basic_osyncstream (C++20)

型

streamoff

streamsize

fpos

エラーカテゴリインタフェース

iostream_category (C++11)

io_errc (C++11)

 

std::basic_osyncstream

パブリックメンバ関数

basic_osyncstream::basic_osyncstream

basic_osyncstream::operator=

basic_osyncstream::~basic_osyncstream

basic_osyncstream::rdbuf

basic_osyncstream::get_wrapped

basic_osyncstream::emit

 

ヘッダ <syncstream> で定義
template<     class CharT,     class Traits = std::char_traits<CharT>,     class Allocator = std::allocator<CharT> > class basic_osyncstream: public std::basic_ostream<CharT, Traits>		(C++20以上)

クラステンプレート std::basic_osyncstream は std::basic_syncbuf のための便利なラッパーです。 同じストリームに書き込む複数のスレッドを同期する仕組みを提供します。

名前付きの変数で使用することができます。

{
    std::osyncstream synced_out(std::cout); // std::cout に対する同期化ラッパー。
    synced_out << "Hello, ";
    synced_out << "World!";
    synced_out << std::endl; // フラッシュは記憶されますが、まだ実行されません。
    synced_out << "and more!\n";
} // 文字が転送され、 std::cout がフラッシュされます。

また、一時オブジェクトで使用することもできます。

std::osyncstream(std::cout) << "Hello, " << "World!" << '\n';

最終宛先バッファへのすべての書き込みが std::basic_osyncstream のインスタンス (異なるインスタンスでも構いません) を通して行われる限り、同じ最終宛先バッファ (上の例では std::cout) に行われるすべての出力が、データ競合を起こさず、インターリーブまたは文字化けしないことが保証されます。

一般的な std::basic_osyncstream の実装はひとつのメンバ、ラップされた std::basic_syncbuf のみを保持します。

一般的な文字型に対して2つの特殊化が定義されます。

ヘッダ <syncstream> で定義
型	定義
osyncstream	basic_osyncstream<char>
wosyncstream	basic_osyncstream<wchar_t>

メンバ型

メンバ型	定義
char_type	CharT
traits_type	Traits。 Traits::char_type が CharT でない場合、プログラムは ill-formed です
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>
syncbuf_type	std::basic_syncbuf<CharT, Traits, Allocator>

メンバ関数

コンストラクタ	basic_osyncstream を構築します (パブリックメンバ関数)
operator=	basic_osyncstream を代入します (パブリックメンバ関数)
デストラクタ	basic_osyncstream を破棄し、その内部バッファを排出します (パブリックメンバ関数)
rdbuf	ベースとなる basic_syncbuf へのポインタを取得します (パブリックメンバ関数)
get_wrapped	最終宛先ストリームバッファへのポインタを取得します (パブリックメンバ関数)
emit	内部データを最終宛先に転送するためにベースとなる basic_syncbuf に対して emit を呼びます (パブリックメンバ関数)

std::basic_ostream から継承

メンバ関数

書式付き出力
operator<<	書式付きデータを挿入します (std::basic_ostream<CharT,Traits>のパブリックメンバ関数)
書式なし出力
put	文字を挿入します (std::basic_ostream<CharT,Traits>のパブリックメンバ関数)
write	文字のブロックを挿入します (std::basic_ostream<CharT,Traits>のパブリックメンバ関数)
位置設定
tellp	出力位置指示子を返します (std::basic_ostream<CharT,Traits>のパブリックメンバ関数)
seekp	出力位置指示子を設定します (std::basic_ostream<CharT,Traits>のパブリックメンバ関数)
その他
flush	ベースとなるストレージデバイスと同期します (std::basic_ostream<CharT,Traits>のパブリックメンバ関数)

メンバクラス

sentry

出力操作用にストリームを準備するための基本ロジックを実装します (std::basic_ostream<CharT,Traits>のパブリックメンバクラス)

std::basic_ios から継承

メンバ型

メンバ型	定義
char_type	CharT
traits_type	Traits
int_type	Traits::int_type
pos_type	Traits::pos_type
off_type	Traits::off_type

メンバ関数

状態関数
good	エラーが発生していない (すなわち入出力操作が使用可能) かどうか調べます (std::basic_ios<CharT,Traits>のパブリックメンバ関数)
eof	ファイル終端に達したかどうか調べます (std::basic_ios<CharT,Traits>のパブリックメンバ関数)
fail	エラーが発生したかどうか調べます (std::basic_ios<CharT,Traits>のパブリックメンバ関数)
bad	回復不可能なエラーが発生したかどうか調べます (std::basic_ios<CharT,Traits>のパブリックメンバ関数)
operator!	エラーが発生したかどうか調べます (fail() の同義語です) (std::basic_ios<CharT,Traits>のパブリックメンバ関数)
operator void*operator bool (C++11未満)(C++11以上)	エラーが発生していないかどうか調べます (!fail() の同義語です) (std::basic_ios<CharT,Traits>のパブリックメンバ関数)
rdstate	状態フラグを返します (std::basic_ios<CharT,Traits>のパブリックメンバ関数)
setstate	状態フラグを設定します (std::basic_ios<CharT,Traits>のパブリックメンバ関数)
clear	状態フラグを変更します (std::basic_ios<CharT,Traits>のパブリックメンバ関数)
書式
copyfmt	書式情報をコピーします (std::basic_ios<CharT,Traits>のパブリックメンバ関数)
fill	フィル文字を管理します (std::basic_ios<CharT,Traits>のパブリックメンバ関数)
その他
exceptions	例外マスクを管理します (std::basic_ios<CharT,Traits>のパブリックメンバ関数)
imbue	ロケールを設定します (std::basic_ios<CharT,Traits>のパブリックメンバ関数)
rdbuf	紐付けられているストリームバッファを管理します (std::basic_ios<CharT,Traits>のパブリックメンバ関数)
tie	結び付けられているストリームを管理します (std::basic_ios<CharT,Traits>のパブリックメンバ関数)
narrow	文字をナロー化します (std::basic_ios<CharT,Traits>のパブリックメンバ関数)
widen	文字をワイド化します (std::basic_ios<CharT,Traits>のパブリックメンバ関数)

std::ios_base から継承

メンバ関数

書式
flags	書式フラグを管理します (std::ios_baseのパブリックメンバ関数)
setf	特定の書式フラグをセットします (std::ios_baseのパブリックメンバ関数)
unsetf	特定の書式フラグをクリアします (std::ios_baseのパブリックメンバ関数)
precision	浮動小数点操作の10進精度を管理します (std::ios_baseのパブリックメンバ関数)
width	フィールド幅を管理します (std::ios_baseのパブリックメンバ関数)
ロケール
imbue	ロケールを設定します (std::ios_baseのパブリックメンバ関数)
getloc	現在のロケールを返します (std::ios_baseのパブリックメンバ関数)
内部の拡張可能な配列
xalloc [静的]	pword() および iword() へのインデックスとして使用するのに安全な、プログラム全体で一意な整数を返します (std::ios_baseのパブリック静的メンバ関数)
iword	必要であればプライベートな記憶域をリサイズし、指定されたインデックスの long 要素にアクセスします (std::ios_baseのパブリックメンバ関数)
pword	必要であればプライベートな記憶域をリサイズし、指定されたインデックスの void* 要素にアクセスします (std::ios_baseのパブリックメンバ関数)
その他
register_callback	イベントのコールバック関数を登録します (std::ios_baseのパブリックメンバ関数)
sync_with_stdio [静的]	C++ と C の入出力ライブラリが相互運用可能であるかどうかを設定します (std::ios_baseのパブリック静的メンバ関数)
メンバクラス
failure	ストリームの例外 (std::ios_baseのパブリックメンバクラス)
Init	標準ストリームオブジェクトを初期化します (std::ios_baseのパブリックメンバクラス)

メンバ型および定数
型	説明
openmode	ストリームのオープンモードの型 以下の定数が定義されます。 定数 説明 app 各書き込み前にストリームの終端へシークします binary バイナリモードで開きます in 読み込み用に開きます out 書き込み用に開きます trunc 開くときにストリームの内容を破棄します ate 開いた直後にストリームの終端へシークします (typedef)
fmtflags	書式フラグの型 以下の定数が定義されます。 定数 説明 dec 整数の入出力に対して10進数を使用します。 std::dec を参照してください oct 整数の入出力に対して8進数を使用します。 std::oct を参照してください hex 整数の入出力に対して16進数を使用します。 std::hex を参照してください basefield dec|oct|hex。 マスク操作に便利です left 左詰め (フィル文字を右に追加します)。 std::left を参照してください right 右詰め (フィル文字を左に追加します)。 std::right を参照してください internal 内部詰め (フィル文字を内部の指定された位置に追加します)。 std::internal を参照してください adjustfield left|right|internal。 マスク操作に便利です scientific 科学表記を使用して浮動小数点型を生成します (fixed と組み合わせた場合は16進表記)。 std::scientific を参照してください fixed 固定表記を使用して浮動小数点型を生成します (scientific と組み合わせた場合は16進表記)。 std::fixed を参照してください floatfield scientific|fixed。 マスク操作に便利です boolalpha bool 型をアルファベット形式で挿入および抽出します。 std::boolalpha を参照してください showbase 整数の出力に対して数値の基数を表す接頭辞を生成し、金額の入出力に対して金額指示子を要求します。 std::showbase を参照してください showpoint 浮動小数点数の出力に対して小数点を無条件に生成します。 std::showpoint を参照してください showpos 非負の数値の出力に対して + 文字を出力します。 std::showpos を参照してください skipws 特定の入力操作の前に先行するホワイトスペースをスキップします。 std::skipws を参照してください unitbuf 各出力操作の後に出力をフラッシュします。 std::unitbuf を参照してください uppercase 特定の出力操作で特定の小文字を同等な大文字に置き換えます。 std::uppercase を参照してください (typedef)
iostate	ストリーム状態の型 以下の定数が定義されます。 定数 説明 goodbit エラーなし badbit 回復不可能なストリームのエラー failbit 入出力操作が失敗しました (書式エラーまたは抽出エラー) eofbit 紐付けられている入力シーケンスがファイル終端に達しました (typedef)
seekdir	シーク方向の型 以下の定数が定義されます。 定数 説明 beg ストリームの先頭 end ストリームの終端 cur ストリームの位置指示子の現在位置 (typedef)
event	イベントの種類を規定します (列挙)
event_callback	コールバック関数の型 (typedef)