Namensräume
Varianten
Aktionen

std::basic_osyncstream

Von cppreference.com
< cpp‎ | io
 
 
 
 
Definiert in Header <syncstream>
template<

    class CharT,
    Klasse Traits = std::char_traits<CharT>,
    Klasse Allocator = std::allocator<CharT>

> class basic_osyncstream : public std::basic_ostream<CharT, Traits>
(seit C++20)

Die Klassenschablone std::basic_osyncstream ist ein Komfort-Wrapper für std::basic_syncbuf. Sie bietet einen Mechanismus zur Synchronisierung von Threads, die in denselben Stream schreiben.

Sie kann mit einer benannten Variablen verwendet werden

{
    std::osyncstream synced_out(std::cout); // synchronized wrapper for std::cout
    synced_out << "Hello, ";
    synced_out << "World!";
    synced_out << std::endl; // flush is noted, but not yet performed
    synced_out << "and more!\n";
} // characters are transferred and std::cout is flushed

sowie mit einem Temporär-Objekt

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

Sie bietet die Garantie, dass alle Ausgaben an denselben endgültigen Zielpuffer (std::cout in den obigen Beispielen) frei von Datenrennen sind und in keiner Weise verschachtelt oder verfälscht werden, solange jeder Schreibvorgang auf diesen endgültigen Zielpuffer über (möglicherweise verschiedene) Instanzen von std::basic_osyncstream erfolgt.

Die typische Implementierung von std::basic_osyncstream enthält nur ein Mitglied: den umwickelten std::basic_syncbuf.

cpp/io/ios basecpp/io/basic ioscpp/io/basic ostreamstd-basic osyncstream-inheritance.svg

Vererbungdiagramm

Mehrere Typedefs für gängige Zeichentypen werden bereitgestellt

Definiert in Header <syncstream>
Typ Definition
std::osyncstream std::basic_osyncstream<char>
std::wosyncstream std::basic_osyncstream<wchar_t>

Inhalt

[bearbeiten] Mitgliedstypen

Mitgliedertyp Definition
char_type CharT[bearbeiten]
traits_type Traits; das Programm ist fehlerhaft, wenn Traits::char_type nicht CharT ist.[bearbeiten]
int_type Traits::int_type[bearbeiten]
pos_type Traits::pos_type[bearbeiten]
off_type Traits::off_type[bearbeiten]
allocator_type Allocator
streambuf_type std::basic_streambuf<CharT, Traits>
syncbuf_type std::basic_syncbuf<CharT, Traits, Allocator>

[bearbeiten] Mitgliederfunktionen

konstruiert ein basic_osyncstream-Objekt
(public member function) [bearbeiten]
weist ein basic_osyncstream-Objekt zu
(public member function) [bearbeiten]
zerstört das basic_osyncstream-Objekt und gibt seinen internen Puffer aus
(public member function) [bearbeiten]
erhält einen Zeiger auf den zugrunde liegenden basic_syncbuf
(public member function) [bearbeiten]
erhält einen Zeiger auf den endgültigen Ziel-Stream-Puffer
(public member function) [bearbeiten]
ruft emit() auf dem zugrunde liegenden basic_syncbuf auf, um dessen interne Daten an das endgültige Ziel zu übertragen
(public member function) [bearbeiten]

Erbt von std::basic_ostream

Memberfunktionen

Formatierte Ausgabe
fügt formatierte Daten ein
(public member function of std::basic_ostream<CharT,Traits>) [bearbeiten]
Unformatierte Ausgabe
fügt ein Zeichen ein
(public member function of std::basic_ostream<CharT,Traits>) [bearbeiten]
fügt Zeichenblöcke ein
(public member function of std::basic_ostream<CharT,Traits>) [bearbeiten]
Positionierung
gibt den Ausgabepositionsindikator zurück
(public member function of std::basic_ostream<CharT,Traits>) [bearbeiten]
setzt den Ausgabepositionsindikator
(public member function of std::basic_ostream<CharT,Traits>) [bearbeiten]
Sonstiges
synchronisiert mit dem zugrunde liegenden Speichermedium
(public member function of std::basic_ostream<CharT,Traits>) [bearbeiten]

Member-Klassen

implementiert grundlegende Logik zur Vorbereitung des Streams für Ausgabeoperationen
(public member class of std::basic_ostream<CharT,Traits>) [bearbeiten]

Geerbt von std::basic_ios

Membertypen

Mitgliedertyp Definition
char_type CharT
traits_type Traits
int_type Traits::int_type
pos_type Traits::pos_type
off_type Traits::off_type

Memberfunktionen

Zustandsfunktionen
prüft, ob kein Fehler aufgetreten ist, d.h. I/O-Operationen verfügbar sind
(public member function of std::basic_ios<CharT,Traits>) [bearbeiten]
prüft, ob das Dateiende erreicht wurde
(public member function of std::basic_ios<CharT,Traits>) [bearbeiten]
prüft, ob ein Fehler aufgetreten ist
(public member function of std::basic_ios<CharT,Traits>) [bearbeiten]
prüft, ob ein nicht behebbbarer Fehler aufgetreten ist
(public member function of std::basic_ios<CharT,Traits>) [bearbeiten]
prüft, ob ein Fehler aufgetreten ist (Synonym für fail())
(public member function of std::basic_ios<CharT,Traits>) [bearbeiten]
prüft, ob kein Fehler aufgetreten ist (Synonym für !fail())
(public member function of std::basic_ios<CharT,Traits>) [bearbeiten]
gibt Zustandsflags zurück
(public member function of std::basic_ios<CharT,Traits>) [bearbeiten]
setzt Zustandsflags
(public member function of std::basic_ios<CharT,Traits>) [bearbeiten]
modifiziert Zustandsflags
(public member function of std::basic_ios<CharT,Traits>) [bearbeiten]
Formatierung
kopiert Formatierungsinformationen
(public member function of std::basic_ios<CharT,Traits>) [bearbeiten]
verwaltet das Füllzeichen
(public member function of std::basic_ios<CharT,Traits>) [bearbeiten]
Sonstiges
verwaltet die Exception-Maske
(public member function of std::basic_ios<CharT,Traits>) [bearbeiten]
setzt die Locale
(public member function of std::basic_ios<CharT,Traits>) [bearbeiten]
verwaltet den zugehörigen Stream-Puffer
(public member function of std::basic_ios<CharT,Traits>) [bearbeiten]
verwaltet den gebundenen Stream
(public member function of std::basic_ios<CharT,Traits>) [bearbeiten]
verengt Zeichen
(public member function of std::basic_ios<CharT,Traits>) [bearbeiten]
erweitert Zeichen
(public member function of std::basic_ios<CharT,Traits>) [bearbeiten]

Geerbt von std::ios_base

Memberfunktionen

Formatierung
verwaltet Formatierungsflags
(public member function of std::ios_base) [bearbeiten]
setzt spezifische Formatierungsflags
(public member function of std::ios_base) [bearbeiten]
löscht spezifische Formatierungsflags
(public member function of std::ios_base) [bearbeiten]
verwaltet die Dezimalgenauigkeit von Fließkommaoperationen
(public member function of std::ios_base) [bearbeiten]
verwaltet die Feldbreite
(public member function of std::ios_base) [bearbeiten]
Lokale
setzt Locale
(public member function of std::ios_base) [bearbeiten]
gibt die aktuelle Locale zurück
(public member function of std::ios_base) [bearbeiten]
Internes erweiterbares Array
[static]
gibt eine programmweite eindeutige Ganzzahl zurück, die sicher als Index für pword() und iword() verwendet werden kann
(public static member function of std::ios_base) [bearbeiten]
vergrößert den privaten Speicher bei Bedarf und greift auf das long-Element am gegebenen Index zu
(public member function of std::ios_base) [bearbeiten]
vergrößert den privaten Speicher bei Bedarf und greift auf das void*-Element am gegebenen Index zu
(public member function of std::ios_base) [bearbeiten]
Sonstiges
registriert eine Callback-Funktion für Ereignisse
(public member function of std::ios_base) [bearbeiten]
legt fest, ob C++ und C E/A-Bibliotheken interoperabel sind
(public static member function of std::ios_base) [bearbeiten]
Member-Klassen
Stream-Exception
(public member class of std::ios_base) [bearbeiten]
initialisiert Standard-Stream-Objekte
(public member class of std::ios_base) [bearbeiten]

Member-Typen und Konstanten

Typ Erklärung
Stream-Öffnungsmodus-Typ

Folgende Konstanten sind ebenfalls definiert

Konstante Erklärung[bearbeiten]
app an das Ende des Streams gehen vor jedem Schreibvorgang[bearbeiten]
binary im Binärmodus öffnen[bearbeiten]
in zum Lesen öffnen[bearbeiten]
out zum Schreiben öffnen[bearbeiten]
trunc den Inhalt des Streams beim Öffnen verwerfen[bearbeiten]
ate sofort nach dem Öffnen zum Ende des Streams gehen[bearbeiten]
noreplace (C++23) im exklusiven Modus öffnen[bearbeiten]

(typedef) [bearbeiten]
Typ der Formatierungsflags

Folgende Konstanten sind ebenfalls definiert

Konstante Erklärung[bearbeiten]
dez dezimales Basis für Ganzzahl-E/A verwenden: siehe std::dec[bearbeiten]
okt oktal-Basis für Ganzzahl-E/A verwenden: siehe std::oct[bearbeiten]
hex hexadezimal-Basis für Ganzzahl-E/A verwenden: siehe std::hex[bearbeiten]
basefield dec | oct | hex. Nützlich für Maskierungsoperationen[bearbeiten]
left linksbündige Ausrichtung (fügt Füllzeichen rechts hinzu): siehe std::left[bearbeiten]
right rechtsbündige Ausrichtung (fügt Füllzeichen links hinzu): siehe std::right[bearbeiten]
internal interne Ausrichtung (fügt Füllzeichen an der intern definierten Stelle ein): siehe std::internal[bearbeiten]
adjustfield left | right | internal. Nützlich für Maskierungsoperationen[bearbeiten]
scientific erzeugt Fließkommatypen in wissenschaftlicher Notation oder in Hex-Notation, wenn mit fixed kombiniert: siehe std::scientific[bearbeiten]
fixed erzeugt Fließkommatypen in fester Notation oder in Hex-Notation, wenn mit scientific kombiniert: siehe std::fixed[bearbeiten]
floatfield scientific | fixed. Nützlich für Maskierungsoperationen[bearbeiten]
boolalpha fügt bool-Typen im alphanumerischen Format ein und extrahiert sie: siehe std::boolalpha[bearbeiten]
showbase erzeugt ein Präfix, das die numerische Basis für die Ganzzahl-Ausgabe angibt, erfordert den Währungsindikator bei monetären E/A: siehe std::showbase[bearbeiten]
showpoint erzeugt bedingungslos ein Dezimaltrennzeichen für die Ausgabe von Fließkommazahlen: siehe std::showpoint[bearbeiten]
showpos erzeugt ein + Zeichen für nicht-negative numerische Ausgaben: siehe std::showpos[bearbeiten]
skipws überspringt führende Leerzeichen vor bestimmten Eingabeoperationen: siehe std::skipws[bearbeiten]
unitbuf leert den Ausgabepuffer nach jeder Ausgabeoperation: siehe std::unitbuf[bearbeiten]
uppercase ersetzt bestimmte Kleinbuchstaben durch ihre Großbuchstaben-Äquivalente bei bestimmten Ausgabeoperationen: siehe std::uppercase[bearbeiten]

(typedef) [bearbeiten]
Zustand des Stream-Typs

Folgende Konstanten sind ebenfalls definiert

Konstante Erklärung[bearbeiten]
goodbit kein Fehler[bearbeiten]
badbit irreparabler Stream-Fehler[bearbeiten]
failbit Eingabe-/Ausgabeoperation fehlgeschlagen (Formatierungs- oder Extraktionsfehler)[bearbeiten]
eofbit zugeordnete Eingabesequenz hat das Dateiende erreicht[bearbeiten]

(typedef) [bearbeiten]
Typ der Suchrichtung

Folgende Konstanten sind ebenfalls definiert

Konstante Erklärung[bearbeiten]
beg der Anfang eines Streams[bearbeiten]
end das Ende eines Streams[bearbeiten]
cur die aktuelle Position des Stream-Positionsindikators[bearbeiten]

(typedef) [bearbeiten]
spezifiziert den Ereignistyp
(enum) [bearbeiten]
Callback-Funktionstyp
(typedef) [bearbeiten]

[bearbeiten] Anmerkungen

Feature-Test-Makro Wert Std Feature
__cpp_lib_syncbuf 201803L (C++20) Synchronisierter gepufferter ostream (std::osyncstream, std::syncbuf) und Manipulatoren