bsl::basic_syncbuf::overflow

Consumes data from the buffer; writes to the controlled sequence.

Synopsis

Declared in <bslstl_syncbuf.h>

virtual
int_type
overflow(int_type __c = traits_type::eof());

Description

Informally, this function is called when the output buffer is full (or does not exist, as buffering need not actually be done). If a buffer exists, it is consumed, with some effect on the controlled sequence. (Typically, the buffer is written out to the sequence verbatim.) In either case, the character c is also written out, if __c is not eof().

For a formal definition of this function, see a good text such as Langer & Kreft, or [27.5.2.4.5]/3-7.

A functioning output streambuf can be created by overriding only this function (no buffer area will be used).

NOTE

Base class version does nothing, returns eof().

Return Value

eof() to indicate failure, something else (usually __c, or not_eof())

Parameters

NameDescription
__cAn additional character to consume.