This class provides constrained configuration parameters for a logger manager.

Synopsis

Declared in <ball_loggermanagerconfiguration.h>

class LoggerManagerConfiguration;

Description

The constraints are maintained as class invariants; it is not possible to obtain an invalid object through this interface.

This class support in‐core value‐semantic operations, including copy construction, assignment, and equality comparison; ostream printing is supported, but in a modified form to handle functors, and BDEX serialization cannot be supported at all. (A precise operational definition of when two instances have the same (in‐core) value can be found in the description of operator== for the class.) This class is exception neutral with no guarantee of rollback: If an exception is thrown during the invocation of a method on a pre‐existing instance, the object is left in a valid state, but its value is undefined. In no event is memory leaked. Finally, aliasing (e.g., using all or part of an object as both source and destination) is supported in all cases.

Type Aliases

Name

Description

CategoryNameFilterCallback

CategoryNameFilterCallback is the type of the user‐supplied functor that translates external category names to internal names.

DefaultThresholdLevelsCallback

Functor type that supplies default threshold levels for categories.

UserFieldsPopulatorCallback

UserFieldsPopulatorCallback is the type of a user‐supplied callback functor used to populate the user‐defined fields in each log record.

Enums

Name

Description

LogOrder

The LogOrder enumeration defines the order in which messages will be published to the underlying observer in the case of Trigger and Trigger‐All events.

TriggerMarkers

The TriggerMarkers enumeration defines whether marker text is written around log records published due to Trigger or Trigger‐All events.

Member Functions

Name

Description

LoggerManagerConfiguration [constructor]

Constructors

operator=

Assign to this object the in‐core value of the specified rhs.

categoryNameFilterCallback

Return a reference to the non‐modifiable category name filter functor attribute of this object.

defaultLoggerBufferSize

Return the default logger‐message‐buffer size attribute of the LoggerManagerDefaults attribute of this object.

defaultPassLevel

Return the default Pass threshold level attribute of the LoggerManagerDefaults attribute of this object.

defaultRecordBufferSize

Return the default‐logger record‐buffer size attribute of the LoggerManagerDefaults attribute of this object.

defaultRecordLevel

Return the default Record threshold level attribute of the LoggerManagerDefaults attribute of this object.

defaultThresholdLevelsCallback

Return a reference to the non‐modifiable default severity‐level thresholds functor attribute of this object.

defaultTriggerAllLevel

Return the default Trigger‐All threshold level attribute of the LoggerManagerDefaults attribute of this object.

defaultTriggerLevel

Return the default Trigger threshold level attribute of the LoggerManagerDefaults attribute of this object.

defaults

Return a reference to the non‐modifiable defaults object attribute of this object.

logOrder

Return the log order attribute of this object. See attributes description for effects of the log order.

print

Format this object to the specified output stream.

setCategoryNameFilterCallback

Set the category name‐filter callback attribute of this object.

setDefaultLoggerBufferSizeIfValid

Set the default logger‐message‐buffer size if numBytes is valid.

setDefaultRecordBufferSizeIfValid

Set the default record‐buffer size if numBytes is valid.

setDefaultThresholdLevelsCallback

Set the default thresholds callback attribute of this object.

setDefaultThresholdLevelsIfValid

setDefaultThresholdLevelsIfValid overloads

setDefaultValues

Set the default values attribute of this object to defaults.

setLogOrder

Set the log order attribute of this object to the specified value.

setTriggerMarkers

Set the trigger marker attribute of this object to value.

setUserFieldsPopulatorCallback

Set the user‐fields populator callback attribute of this object.

triggerMarkers

Return the trigger marker attribute of this object. See attributes description for effects of the trigger markers.

userFieldsPopulatorCallback

Return a reference providing non‐modifiable access to the user‐fields populator functor attribute of this object.

operator BloombergLP::bslmf::NestedTraitDeclaration<LoggerManagerConfiguration, UsesBslmaAllocator>

Declare that this type uses a bslma allocator.

Static Member Functions

Name

Description

areValidDefaultThresholdLevels

Return whether the specified threshold levels are each valid.

isValidDefaultLoggerBufferSize

Return whether numBytes is a valid default logger‐buffer size.

isValidDefaultRecordBufferSize

Return whether numBytes is a valid default record‐buffer size.

Friends

Name

Description

BloombergLP::ball::operator==

Return true if lhs and rhs have the same in‐core value.

BloombergLP::ball::operator<<

Write a representation of configuration to the specified stream.

Non-Member Functions

Name

Description

operator!=

Return true if lhs and rhs do not have the same in‐core value.

Created with MrDocs