BloombergLP::bslstl::SyncBufBaseUtil

Synopsis

Declared in <bslstl_syncbufbase.h>

struct SyncBufBaseUtil;

Static Member Functions

Name Description

emitInternal Atomically transfer any characters buffered by the specified syncBuf object to the wrapped stream buffer, so that it appears in the output stream as a contiguous sequence of characters. The wrapped stream buffer is flushed if and only if a call was made to sync since the most recent call to emit or construction. Return true if get_wrapped() != nullptr, and all of the characters in the associated output were successfully transferred, and the flush (if any) succeeded; return false otherwise. The behavior is undefined unless syncBuf is not null.

setEmitOnSync Set the "emit-on-sync" property of the synchronized buffer to the specified value. If "emit-on-sync" is true, the synchronized buffer will emit (see emitInternal) its buffered contents on a call to sync (or pubsync); otherwise the synchronized buffer will not be emitted on a sync. The behavior is undefined unless syncBuf is not null.

Name	Description
`emitInternal`	Atomically transfer any characters buffered by the specified `syncBuf` object to the wrapped stream buffer, so that it appears in the output stream as a contiguous sequence of characters. The wrapped stream buffer is flushed if and only if a call was made to `sync` since the most recent call to `emit` or construction. Return `true` if `get_wrapped() != nullptr`, and all of the characters in the associated output were successfully transferred, and the flush (if any) succeeded; return `false` otherwise. The behavior is undefined unless `syncBuf` is not null.
`setEmitOnSync`	Set the "emit-on-sync" property of the synchronized buffer to the specified `value`. If "emit-on-sync" is `true`, the synchronized buffer will emit (see `emitInternal`) its buffered contents on a call to `sync` (or `pubsync`); otherwise the synchronized buffer will not be emitted on a `sync`. The behavior is undefined unless `syncBuf` is not null.