serenity::experimental::Flush_Policy Class Reference

This class controls when and how logging target contents should be flushed.

Public Member Functions
	Flush_Policy (Flush primaryOpt)
	This constructor will set the primary mode of flushing to use, however, all other settings are initialized to their defaults. More...
	Flush_Policy (Flush primaryOpt, PeriodicOptions secondaryOpt, PeriodicSettings settings)
	This constructor will set all the relevant options and offers full control on how the flush policy is setup. More...
	Flush_Policy (Flush primaryOpt, PeriodicOptions secondaryOpt)
	This constructor sets up the primary and secondary flush options but leaves the periodic settings as their defaults. More...
	Flush_Policy (PeriodicOptions secondaryOpt, PeriodicSettings settings)
	This constructoy will set both the secondary option and the periodic settings to use for that option. More...
	Flush_Policy (const Flush_Policy &p)
	Copy constructor that will intialize a Flush_Policy instance by copy-intializing options and settings from p.
Flush_Policy &	operator= (const Flush_Policy &p)
	copy assignment operator used in the copy constructor. Copies the Primary mode, Secondary mode, and periodic settings from p.
void	SetPrimaryMode (Flush primary)
	Changes the primary mode of the policy to primary.
void	SetSecondaryMode (PeriodicOptions secondary)
	Changes the secondary mode to secondary.
void	SetSecondarySettings (PeriodicSettings subSettings)
	Changes the setting values used to the values of subSettings.
const Flush	PrimarySetting ()
	Returns the primary mode in effect.
const PeriodicOptions	SubSetting ()
	Returns the secondary setting in effect.
const Flush_Policy	Policy ()
	Returns the Flush_Policy instance being used.
const PeriodicSettings	SecondarySettings ()
	Returns the periodic settings in effect.

Constructor & Destructor Documentation

Flush_Policy() [1/4]

serenity::experimental::Flush_Policy::Flush_Policy ( Flush  primaryOpt )

explicit

Initializes to the following:

Option	Value
Primary Option	primaryOpt
Secondary Option	PeriodicOptions::undef
Secondary Settings	flushOn = LoggerLevel::trace
	flushEvery = 500ms

Flush_Policy() [2/4]

serenity::experimental::Flush_Policy::Flush_Policy ( Flush  primaryOpt, PeriodicOptions  secondaryOpt, PeriodicSettings  settings  )

explicit

Initializes to the following:

Option	Value
Primary Option	primaryOpt
Secondary Option	secondaryOpt
Secondary Settings	flushOn = settings.flushOn
	timeBased = settings.flushEvery

Flush_Policy() [3/4]

serenity::experimental::Flush_Policy::Flush_Policy ( Flush  primaryOpt, PeriodicOptions  secondaryOpt  )

explicit

Initializes to the following:

Option	Value
Primary Option	primaryOpt
Secondary Option	secondaryOpt
Secondary Settings	flushOn = LoggerLevel::trace
	flushEvery = 500ms

Flush_Policy() [4/4]

serenity::experimental::Flush_Policy::Flush_Policy ( PeriodicOptions  secondaryOpt, PeriodicSettings  settings  )

explicit

Initializes to the following:

Option	Value
Primary Option	Default Initialized to Flush::periodically
Secondary Option	secondaryOpt
Secondary Settings	flushOn = settings.flushOn
	timeBased = settings.flushEvery

---

The documentation for this class was generated from the following files:

• FlushPolicy.h
• Documentation.h
• FlushPolicy.cpp