BCLog::Logger Class Reference

#include <logging.h>

Public Member Functions
void	LogPrintStr (const std::string &str)
bool	Enabled () const
bool	StartLogging ()
void	DisconnectTestLogger ()
void	ShrinkDebugFile ()
uint32_t	GetCategoryMask () const
void	EnableCategory (LogFlags flag)
bool	EnableCategory (const std::string &str)
void	DisableCategory (LogFlags flag)
bool	DisableCategory (const std::string &str)
bool	WillLogCategory (LogFlags category) const
bool	DefaultShrinkDebugFile () const

Public Attributes
bool	m_print_to_console = false
bool	m_print_to_file = false
bool	m_log_timestamps = DEFAULT_LOGTIMESTAMPS
bool	m_log_time_micros = DEFAULT_LOGTIMEMICROS
bool	m_log_threadnames = DEFAULT_LOGTHREADNAMES
fs::path	m_file_path
std::atomic< bool >	m_reopen_file {false}

Private Member Functions
std::string	LogTimestampStr (const std::string &str)

Private Attributes
std::mutex	m_cs
FILE *	m_fileout = nullptr
std::list< std::string >	m_msgs_before_open
bool	m_buffering {true}
	Buffer messages before logging can be started. GUARDED_BY(m_cs) More...
std::atomic_bool	m_started_new_line {true}
std::atomic< uint32_t >	m_categories {0}

Member Function Documentation

DefaultShrinkDebugFile()

bool BCLog::Logger::DefaultShrinkDebugFile

(

)

const

DisableCategory() [1/2]

void BCLog::Logger::DisableCategory

(

BCLog::LogFlags

flag

)

DisableCategory() [2/2]

bool BCLog::Logger::DisableCategory

(

const std::string &

str

)

DisconnectTestLogger()

void BCLog::Logger::DisconnectTestLogger

(

)

Only for testing

EnableCategory() [1/2]

void BCLog::Logger::EnableCategory

(

BCLog::LogFlags

flag

)

EnableCategory() [2/2]

bool BCLog::Logger::EnableCategory

(

const std::string &

str

)

Enabled()

bool BCLog::Logger::Enabled ( ) const

inline

Returns whether logs will be written to any output

GetCategoryMask()

uint32_t BCLog::Logger::GetCategoryMask ( ) const

inline

LogPrintStr()

void BCLog::Logger::LogPrintStr

(

const std::string &

str

)

Send a string to the log output

LogTimestampStr()

std::string BCLog::Logger::LogTimestampStr ( const std::string &  str )

private

ShrinkDebugFile()

void BCLog::Logger::ShrinkDebugFile

(

)

StartLogging()

bool BCLog::Logger::StartLogging

(

)

Start logging (and flush all buffered messages)

WillLogCategory()

bool BCLog::Logger::WillLogCategory

(

BCLog::LogFlags

category

)

const

Member Data Documentation

m_buffering

bool BCLog::Logger::m_buffering {true}

private

Buffer messages before logging can be started. GUARDED_BY(m_cs)

m_categories

std::atomic<uint32_t> BCLog::Logger::m_categories {0}

private

Log categories bitfield.

m_cs

std::mutex BCLog::Logger::m_cs

mutableprivate

m_file_path

fs::path BCLog::Logger::m_file_path

m_fileout

FILE* BCLog::Logger::m_fileout = nullptr

private

m_log_threadnames

bool BCLog::Logger::m_log_threadnames = DEFAULT_LOGTHREADNAMES

m_log_time_micros

bool BCLog::Logger::m_log_time_micros = DEFAULT_LOGTIMEMICROS

m_log_timestamps

bool BCLog::Logger::m_log_timestamps = DEFAULT_LOGTIMESTAMPS

m_msgs_before_open

std::list<std::string> BCLog::Logger::m_msgs_before_open

private

m_print_to_console

bool BCLog::Logger::m_print_to_console = false

m_print_to_file

bool BCLog::Logger::m_print_to_file = false

m_reopen_file

std::atomic<bool> BCLog::Logger::m_reopen_file {false}

m_started_new_line

std::atomic_bool BCLog::Logger::m_started_new_line {true}

private

m_started_new_line is a state variable that will suppress printing of the timestamp when multiple calls are made that don't end in a newline.

---

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

• src/logging.h
• src/logging.cpp