[#BloombergLP-ball-LoggerManagerConfiguration]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/ball.adoc[ball]::LoggerManagerConfiguration
:relfileprefix: ../../
:mrdocs:

This class provides constrained configuration parameters for a logger manager.

== Synopsis

Declared in `<ball_loggermanagerconfiguration.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
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

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/ball/LoggerManagerConfiguration/CategoryNameFilterCallback-02.adoc[`CategoryNameFilterCallback`] 
| `CategoryNameFilterCallback` is the type of the user‐supplied functor that translates external category names to internal names.
| xref:BloombergLP/ball/LoggerManagerConfiguration/DefaultThresholdLevelsCallback-05.adoc[`DefaultThresholdLevelsCallback`] 
| Functor type that supplies default threshold levels for categories.
| xref:BloombergLP/ball/LoggerManagerConfiguration/UserFieldsPopulatorCallback-09.adoc[`UserFieldsPopulatorCallback`] 
| `UserFieldsPopulatorCallback` is the type of a user‐supplied callback functor used to populate the user‐defined fields in each log record.
|===


== Enums

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/ball/LoggerManagerConfiguration/LogOrder-0bf.adoc[`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.
| xref:BloombergLP/ball/LoggerManagerConfiguration/TriggerMarkers-00.adoc[`TriggerMarkers`] 
| The `TriggerMarkers` enumeration defines whether marker text is written around log records published due to Trigger or Trigger‐All events.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/ball/LoggerManagerConfiguration/2constructor-0b.adoc[`LoggerManagerConfiguration`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/ball/LoggerManagerConfiguration/operator_assign.adoc[`operator=`] 
| Assign to this object the in‐core value of the specified `rhs`.
| xref:BloombergLP/ball/LoggerManagerConfiguration/categoryNameFilterCallback-0f.adoc[`categoryNameFilterCallback`] 
| Return a reference to the non‐modifiable category name filter functor attribute of this object.
| xref:BloombergLP/ball/LoggerManagerConfiguration/defaultLoggerBufferSize.adoc[`defaultLoggerBufferSize`] 
| Return the default logger‐message‐buffer size attribute of the `LoggerManagerDefaults` attribute of this object.
| xref:BloombergLP/ball/LoggerManagerConfiguration/defaultPassLevel.adoc[`defaultPassLevel`] 
| Return the default Pass threshold level attribute of the `LoggerManagerDefaults` attribute of this object.
| xref:BloombergLP/ball/LoggerManagerConfiguration/defaultRecordBufferSize.adoc[`defaultRecordBufferSize`] 
| Return the default‐logger record‐buffer size attribute of the `LoggerManagerDefaults` attribute of this object.
| xref:BloombergLP/ball/LoggerManagerConfiguration/defaultRecordLevel.adoc[`defaultRecordLevel`] 
| Return the default Record threshold level attribute of the `LoggerManagerDefaults` attribute of this object.
| xref:BloombergLP/ball/LoggerManagerConfiguration/defaultThresholdLevelsCallback-0f.adoc[`defaultThresholdLevelsCallback`] 
| Return a reference to the non‐modifiable default severity‐level thresholds functor attribute of this object.
| xref:BloombergLP/ball/LoggerManagerConfiguration/defaultTriggerAllLevel.adoc[`defaultTriggerAllLevel`] 
| Return the default Trigger‐All threshold level attribute of the `LoggerManagerDefaults` attribute of this object.
| xref:BloombergLP/ball/LoggerManagerConfiguration/defaultTriggerLevel.adoc[`defaultTriggerLevel`] 
| Return the default Trigger threshold level attribute of the `LoggerManagerDefaults` attribute of this object.
| xref:BloombergLP/ball/LoggerManagerConfiguration/defaults.adoc[`defaults`] 
| Return a reference to the non‐modifiable defaults object attribute of this object.
| xref:BloombergLP/ball/LoggerManagerConfiguration/logOrder-0b2.adoc[`logOrder`] 
| Return the log order attribute of this object. See attributes description for effects of the log order.
| xref:BloombergLP/ball/LoggerManagerConfiguration/print.adoc[`print`] 
| Format this object to the specified output `stream`.
| xref:BloombergLP/ball/LoggerManagerConfiguration/setCategoryNameFilterCallback.adoc[`setCategoryNameFilterCallback`] 
| Set the category name‐filter callback attribute of this object.
| xref:BloombergLP/ball/LoggerManagerConfiguration/setDefaultLoggerBufferSizeIfValid.adoc[`setDefaultLoggerBufferSizeIfValid`] 
| Set the default logger‐message‐buffer size if `numBytes` is valid.
| xref:BloombergLP/ball/LoggerManagerConfiguration/setDefaultRecordBufferSizeIfValid.adoc[`setDefaultRecordBufferSizeIfValid`] 
| Set the default record‐buffer size if `numBytes` is valid.
| xref:BloombergLP/ball/LoggerManagerConfiguration/setDefaultThresholdLevelsCallback.adoc[`setDefaultThresholdLevelsCallback`] 
| Set the default thresholds callback attribute of this object.
| xref:BloombergLP/ball/LoggerManagerConfiguration/setDefaultThresholdLevelsIfValid-0f3.adoc[`setDefaultThresholdLevelsIfValid`] 
| `setDefaultThresholdLevelsIfValid` overloads
| xref:BloombergLP/ball/LoggerManagerConfiguration/setDefaultValues.adoc[`setDefaultValues`] 
| Set the default values attribute of this object to `defaults`.
| xref:BloombergLP/ball/LoggerManagerConfiguration/setLogOrder.adoc[`setLogOrder`] 
| Set the log order attribute of this object to the specified `value`.
| xref:BloombergLP/ball/LoggerManagerConfiguration/setTriggerMarkers.adoc[`setTriggerMarkers`] 
| Set the trigger marker attribute of this object to `value`.
| xref:BloombergLP/ball/LoggerManagerConfiguration/setUserFieldsPopulatorCallback.adoc[`setUserFieldsPopulatorCallback`] 
| Set the user‐fields populator callback attribute of this object.
| xref:BloombergLP/ball/LoggerManagerConfiguration/triggerMarkers-03.adoc[`triggerMarkers`] 
| Return the trigger marker attribute of this object. See attributes description for effects of the trigger markers.
| xref:BloombergLP/ball/LoggerManagerConfiguration/userFieldsPopulatorCallback-0e.adoc[`userFieldsPopulatorCallback`] 
| Return a reference providing non‐modifiable access to the user‐fields populator functor attribute of this object.
| xref:BloombergLP/ball/LoggerManagerConfiguration/2conversion.adoc[`operator BloombergLP::bslmf::NestedTraitDeclaration<LoggerManagerConfiguration, UsesBslmaAllocator>`] 
| Declare that this type uses a `bslma` allocator.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/ball/LoggerManagerConfiguration/areValidDefaultThresholdLevels.adoc[`areValidDefaultThresholdLevels`] 
| Return whether the specified threshold levels are each valid.
| xref:BloombergLP/ball/LoggerManagerConfiguration/isValidDefaultLoggerBufferSize.adoc[`isValidDefaultLoggerBufferSize`] 
| Return whether `numBytes` is a valid default logger‐buffer size.
| xref:BloombergLP/ball/LoggerManagerConfiguration/isValidDefaultRecordBufferSize.adoc[`isValidDefaultRecordBufferSize`] 
| Return whether `numBytes` is a valid default record‐buffer size.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/ball/operator_eq-085.adoc[BloombergLP::ball::operator==]`
| Return `true` if `lhs` and `rhs` have the same in‐core value.
| `xref:BloombergLP/ball/operator_lshift-012.adoc[BloombergLP::ball::operator<<]`
| Write a representation of `configuration` to the specified `stream`.
|===

== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/ball/operator_not_eq-061.adoc[`operator!=`]
| Return `true` if `lhs` and `rhs` do not have the same in‐core value.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#