ball_recordformatteroptions

Detailed Description

Provides log record formatter option values.

Outline

• Purpose
• Classes
• Description
  • Usage
    • Example 1: Configuring Formatter Options

Purpose

Provides log record formatter option values.

Classes

• ball::RecordFormatterOptions: record formatter option values

See also

ball_recordformatterregistryutil

Description

This component provides a value-semantic attribute class, RecordFormatterOptions, that represents the options that are in addition to the format string for configuring a log record formatter "plugin".

Usage

This section illustrates intended use of this component.

Example 1: Configuring Formatter Options

Suppose we are configuring a log record formatter and want to specify options for how timestamps should be rendered. We can use ball::RecordFormatterOptions to specify these configuration values.

First, we create a RecordFormatterOptions object with default settings, which uses UTC timezone:

 ball::RecordFormatterOptions options;
 assert(ball::RecordFormatterTimezone::e_UTC == options.timezoneDefault());

Then, if we want to configure the formatter to use local time instead, we can either create the options object with the desired timezone:

 ball::RecordFormatterOptions localOptions(
                                    ball::RecordFormatterTimezone::e_LOCAL);
 assert(ball::RecordFormatterTimezone::e_LOCAL ==
                                            localOptions.timezoneDefault());

Or we can modify an existing options object:

 options.setTimezoneDefault(ball::RecordFormatterTimezone::e_LOCAL);
 assert(
       ball::RecordFormatterTimezone::e_LOCAL == options.timezoneDefault());

Finally, we can pass these options to a formatter configuration function (such as ball::RecordJsonFormatter::loadJsonSchemeFormatter) to configure how timestamps are rendered in the log output.