This class provides a common implementation of formatting‐related methods for observer components that support scheme‐based log record formatting. It manages a log record formatter, format configuration strings, and time zone preferences. This implementation is intended to be used as a data member in concrete observer classes to provide consistent formatting behavior across different observer types.

Synopsis

Declared in <ball_observerformatterimp.h>

class ObserverFormatterImp;

Type Aliases

Name

Description

RecordFormatter

RecordFormatter is an alias for the type of the functor used for formatting log records to a stream.

allocator_type

This typedef is an alias for the allocator used by this object.

Member Functions

Name

Description

ObserverFormatterImp [constructor]

Create a ObserverFormatterImp instance that formats log records using the specified format and timezoneDefault. It is strongly advised to specify UTC for timezoneDefault. Optionally specify an allocator (e.g., the address of a bslma::Allocator object) to supply memory; otherwise, the default allocator is used. The behavior is undefined unless format is a valid format string (either one that starts with a scheme or a "text" scheme format). Note that not giving a valid default format string by the observer will result in no logging output if no valid format is set afterwards, so it is a serious error.

formatLogRecord

Format the specified log record into the specified output stream using the current record formatter functor.

getFormat

Return the currently active format configuration string of this object.

getTimezoneDefault

Return the currently active time zone default of this object.

get_allocator

Return the allocator used by this object to supply memory. Note that if no allocator was supplied at construction the default allocator in effect at construction is used.

setFormat

Set the log record format specifications for this object according to the specified format. Return 0 on success, and a non‐zero value otherwise. This method has no effect on format if format is not a valid format specification. If format does not start with a scheme (it has no "://" in it) use the default "text" scheme.

setFormatFunctor

Set the formatting functor used when writing records to the specified formatter functor. Note that this method is not able to communicate the timezone default settings to the formatter, prefer setFormat.

setTimezoneDefault

Set the default time zone used for timestamps that have no timezone preference specified in the format config string. This method recreates the formatter used with the new timezone setting and the last successfully‐set format config string. Note that (at the time of writing) the printf‐style format strings do not have syntax to specify the time zone so for such‐configured formatters all timestamps will use this time zone default.

Created with MrDocs