CppLogging::Trigger Class Reference

Logging trigger. More...

#include <trigger.h>

Inheritance diagram for CppLogging::Trigger:

Public Member Functions
	Trigger (bool state=true)
	Initialize trigger with an initial logging state (enabled or disabled)
	Trigger (const Trigger &)=delete
	Trigger (Trigger &&)=delete
virtual	~Trigger ()=default
Trigger &	operator= (const Trigger &)=delete
Trigger &	operator= (Trigger &&)=delete
bool	IsEnabled () noexcept
	Is logging enabled?
void	Enable () noexcept
	Enable logging.
void	Disable () noexcept
	Disable logging.
void	Toggle () noexcept
	Toggle logging.
bool	FilterRecord (Record &record) override
	Filter the given logging record.
Public Member Functions inherited from CppLogging::Element
virtual bool	IsStarted () const noexcept
	Is the logging element started?
virtual bool	Start ()
	Start the logging element.
virtual bool	Stop ()
	Stop the logging element.

Detailed Description

Logging trigger.

Logging trigger is a special filter that allows to enable or disable logging.

Thread-safe.

Definition at line 24 of file trigger.h.

Constructor & Destructor Documentation

Trigger() [1/3]

CppLogging::Trigger::Trigger ( bool  state = true )

inlineexplicit

Initialize trigger with an initial logging state (enabled or disabled)

Parameters

state

- Initial logging state (default is true)

Definition at line 31 of file trigger.h.

Trigger() [2/3]

CppLogging::Trigger::Trigger ( const Trigger &  )

delete

Trigger() [3/3]

CppLogging::Trigger::Trigger ( Trigger &&  )

delete

~Trigger()

virtual CppLogging::Trigger::~Trigger ( )

virtualdefault

Member Function Documentation

Disable()

void CppLogging::Trigger::Disable ( )

inlinenoexcept

Disable logging.

Definition at line 45 of file trigger.h.

Enable()

void CppLogging::Trigger::Enable ( )

inlinenoexcept

Enable logging.

Definition at line 43 of file trigger.h.

FilterRecord()

bool CppLogging::Trigger::FilterRecord ( Record &  record )

inlineoverridevirtual

Filter the given logging record.

Parameters

record

- Logging record

Returns

'true' if the logging record should be processed, 'false' if the logging record was filtered out

Implements CppLogging::Filter.

Definition at line 50 of file trigger.h.

IsEnabled()

bool CppLogging::Trigger::IsEnabled ( )

inlinenoexcept

Is logging enabled?

Definition at line 40 of file trigger.h.

operator=() [1/2]

Trigger & CppLogging::Trigger::operator= ( const Trigger &  )

delete

operator=() [2/2]

Trigger & CppLogging::Trigger::operator= ( Trigger &&  )

delete

Toggle()

void CppLogging::Trigger::Toggle ( )

inlinenoexcept

Toggle logging.

Definition at line 47 of file trigger.h.

---

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

• include/logging/trigger.h