Forward declaration of basic_syncbuf.

Synopsis

Declared in <bslstl_syncbuf.h>

template<
    class CHAR_TYPE,
    class CHAR_TRAITS = char_traits<CHAR_TYPE>,
    class ALLOCATOR = allocator<CHAR_TYPE>>
class basic_syncbuf
    : public std::basic_streambuf<CHAR_TYPE, CHAR_TRAITS>
    , public BloombergLP::bslstl::SyncBufBase

Base Classes

Name

Description

std::basic_streambuf<CHAR_TYPE, CHAR_TRAITS>

The actual work of input and output (interface).

BloombergLP::bslstl::SyncBufBase

Allocator‐independent base of basic_syncbuf.

Type Aliases

Name

Description

__streambuf_type

@{ This is a non‐standard type.

allocator_type

Allocator type used by this stream buffer.

char_type

Character type manipulated by this stream buffer.

int_type

Integer type returned by stream operations.

off_type

Offset type used by the character traits.

pos_type

Position type used by the character traits.

streambuf_type

Stream buffer type wrapped by this synchronized buffer.

traits_type

Character traits type used by this stream buffer.

Member Functions

Name

Description

basic_syncbuf [constructor]

Constructors

~basic_syncbuf [destructor] [virtual]

Call emit. Any exceptions thrown by emit are ignored.

operator=

Move‐assign from the specified original.

emit

Atomically emit buffered characters to the wrapped stream buffer.

get_allocator

Return the allocator used to supply memory.

get_wrapped

Return the wrapped buffer supplied at construction.

getloc

Locale access.

in_avail

Looking ahead into the stream.

pubimbue

Entry point for imbue().

pubseekoff

Alters the stream position.

pubseekpos

Alters the stream position.

pubsetbuf

Entry points for derived buffer functions.

pubsync

Calls virtual sync function.

sbumpc

Getting the next character.

set_emit_on_sync

Call the emit function by each sync call if the specified value is true.

sgetc

Getting the next character.

sgetn

Entry point for xsgetn.

snextc

Getting the next character.

sputbackc

Pushing characters back into the input stream.

sputc

Entry point for all single‐character output functions.

sputn

Entry point for all single‐character output functions.

sungetc

Moving backwards in the input stream.

swap

Exchange the value of this object with other.

Using Declarations

Name

Description

getloc

Return the currently imbued locale (inherited).

in_avail

Return how many characters are available in the get area (inherited).

pubimbue

Imbue the stream buffer with a locale (inherited).

pubseekoff

Seek relative to a position in the sequence (inherited).

pubseekpos

Seek to an absolute position in the sequence (inherited).

pubsetbuf

Associate a character buffer with this stream buffer (inherited).

pubsync

Synchronize the put and/or get area with the underlying sequence (inherited).

sbumpc

Return the current get character and advance the get pointer (inherited).

sgetc

Return the current get character without advancing (inherited).

sgetn

Read a sequence of characters from the get area (inherited).

snextc

Advance the get pointer and return the next character (inherited).

sputbackc

Put a character back into the get area (inherited).

sputc

Write a character to the put area (inherited).

sputn

Write a sequence of characters to the put area (inherited).

sungetc

Move the get pointer back by one character (inherited).

Protected Member Functions

Name

Description

operator=

__safe_gbump

__safe_pbump

eback

Access to the get area.

egptr

epptr

gbump

Moving the read position.

gptr

imbue [virtual]

Changes translations.

overflow

overflow overloads

pbackfail [virtual]

Tries to back up the input sequence.

pbase

Access to the put area.

pbump

Moving the write position.

pptr

seekoff [virtual]

Alters the stream positions.

seekpos [virtual]

Alters the stream positions.

setbuf [virtual]

Manipulates the buffer.

setg

Setting the three read area pointers.

setp

Setting the three write area pointers.

showmanyc [virtual]

Investigating the data available.

swap

sync

Request a flush on the next emit, optionally emitting now.

uflow [virtual]

Fetches more data from the controlled sequence.

underflow [virtual]

Fetches more data from the controlled sequence.

xsgetn [virtual]

Multiple character extraction.

xsputn

xsputn overloads

Protected Data Members

Name

Description

_M_buf_locale

Current locale setting.

_M_in_beg

Start of get area.

_M_in_cur

Current read area.

_M_in_end

End of get area.

_M_out_beg

Start of put area.

_M_out_cur

Current put area.

_M_out_end

End of put area.

Protected Using Declarations

Name

Description

eback

Return the start of the get area (inherited).

egptr

Return the end of the get area (inherited).

epptr

Return the end of the put area (inherited).

gbump

Advance the get pointer by n characters (inherited).

gptr

Return the current get pointer (inherited).

imbue

Imbue this stream buffer with a locale (inherited).

operator=

Assign from a base basic_streambuf (inherited).

pbackfail

Put a character back into the get area, or fail (inherited).

pbase

Return the start of the put area (inherited).

pbump

Advance the put pointer by n characters (inherited).

pptr

Return the current put pointer (inherited).

seekoff

Seek relative to a position in the controlled sequence (inherited).

seekpos

Seek to an absolute position in the controlled sequence (inherited).

setbuf

Set an external character buffer (inherited).

setg

Set the get area pointers (inherited).

setp

Set the put area pointers (inherited).

showmanyc

Estimate how many characters can be extracted (inherited).

swap

Exchange this buffer with another basic_streambuf (inherited).

uflow

Return the current get character and advance the get pointer (inherited).

underflow

Return the current get character without advancing (inherited).

xsgetn

Extract a sequence of characters from the get area (inherited).

Non-Member Functions

Name

Description

swap

Swap the specified a with the specified b using a.swap(b) expression.

Created with MrDocs