Bitcoin Core  0.19.99
P2P Digital Currency
Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
BCLog::Logger Class Reference

#include <logging.h>

Public Member Functions

void LogPrintStr (const std::string &str)
 Send a string to the log output. More...
 
bool Enabled () const
 Returns whether logs will be written to any output. More...
 
std::list< std::function< void(const std::string &)> >::iterator PushBackCallback (std::function< void(const std::string &)> fun)
 Connect a slot to the print signal and return the connection. More...
 
void DeleteCallback (std::list< std::function< void(const std::string &)>>::iterator it)
 Delete a connection. More...
 
bool StartLogging ()
 Start logging (and flush all buffered messages) More...
 
void DisconnectTestLogger ()
 Only for testing. More...
 
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}
 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. More...
 
std::atomic< uint32_t > m_categories {0}
 Log categories bitfield. More...
 
std::list< std::function< void(const std::string &)> > m_print_callbacks {}
 Slots that connect to the print signal. More...
 

Detailed Description

Definition at line 61 of file logging.h.

Member Function Documentation

◆ DefaultShrinkDebugFile()

bool BCLog::Logger::DefaultShrinkDebugFile ( ) const

Definition at line 129 of file logging.cpp.

◆ DeleteCallback()

void BCLog::Logger::DeleteCallback ( std::list< std::function< void(const std::string &)>>::iterator  it)
inline

Delete a connection.

Definition at line 114 of file logging.h.

◆ DisableCategory() [1/2]

void BCLog::Logger::DisableCategory ( BCLog::LogFlags  flag)

Definition at line 111 of file logging.cpp.

Here is the caller graph for this function:

◆ DisableCategory() [2/2]

bool BCLog::Logger::DisableCategory ( const std::string &  str)

Definition at line 116 of file logging.cpp.

Here is the call graph for this function:

◆ DisconnectTestLogger()

void BCLog::Logger::DisconnectTestLogger ( )

Only for testing.

Definition at line 81 of file logging.cpp.

◆ EnableCategory() [1/2]

void BCLog::Logger::EnableCategory ( BCLog::LogFlags  flag)

Definition at line 90 of file logging.cpp.

Here is the caller graph for this function:

◆ EnableCategory() [2/2]

bool BCLog::Logger::EnableCategory ( const std::string &  str)

Definition at line 95 of file logging.cpp.

Here is the call graph for this function:

◆ Enabled()

bool BCLog::Logger::Enabled ( ) const
inline

Returns whether logs will be written to any output.

Definition at line 99 of file logging.h.

◆ GetCategoryMask()

uint32_t BCLog::Logger::GetCategoryMask ( ) const
inline

Definition at line 127 of file logging.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ LogPrintStr()

void BCLog::Logger::LogPrintStr ( const std::string &  str)

Send a string to the log output.

Definition at line 262 of file logging.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ LogTimestampStr()

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

Definition at line 215 of file logging.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ PushBackCallback()

std::list<std::function<void(const std::string&)> >::iterator BCLog::Logger::PushBackCallback ( std::function< void(const std::string &)>  fun)
inline

Connect a slot to the print signal and return the connection.

Definition at line 106 of file logging.h.

◆ ShrinkDebugFile()

void BCLog::Logger::ShrinkDebugFile ( )

Definition at line 306 of file logging.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ StartLogging()

bool BCLog::Logger::StartLogging ( )

Start logging (and flush all buffered messages)

Definition at line 42 of file logging.cpp.

Here is the call graph for this function:

◆ WillLogCategory()

bool BCLog::Logger::WillLogCategory ( BCLog::LogFlags  category) const

Definition at line 124 of file logging.cpp.

Here is the caller graph for this function:

Member Data Documentation

◆ m_buffering

bool BCLog::Logger::m_buffering {true}
private

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

Definition at line 67 of file logging.h.

◆ m_categories

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

Log categories bitfield.

Definition at line 77 of file logging.h.

◆ m_cs

std::mutex BCLog::Logger::m_cs
mutableprivate

Definition at line 64 of file logging.h.

◆ m_file_path

fs::path BCLog::Logger::m_file_path

Definition at line 92 of file logging.h.

◆ m_fileout

FILE* BCLog::Logger::m_fileout = nullptr
private

Definition at line 65 of file logging.h.

◆ m_log_threadnames

bool BCLog::Logger::m_log_threadnames = DEFAULT_LOGTHREADNAMES

Definition at line 90 of file logging.h.

◆ m_log_time_micros

bool BCLog::Logger::m_log_time_micros = DEFAULT_LOGTIMEMICROS

Definition at line 89 of file logging.h.

◆ m_log_timestamps

bool BCLog::Logger::m_log_timestamps = DEFAULT_LOGTIMESTAMPS

Definition at line 88 of file logging.h.

◆ m_msgs_before_open

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

Definition at line 66 of file logging.h.

◆ m_print_callbacks

std::list<std::function<void(const std::string&)> > BCLog::Logger::m_print_callbacks {}
private

Slots that connect to the print signal.

Definition at line 82 of file logging.h.

◆ m_print_to_console

bool BCLog::Logger::m_print_to_console = false

Definition at line 85 of file logging.h.

◆ m_print_to_file

bool BCLog::Logger::m_print_to_file = false

Definition at line 86 of file logging.h.

◆ m_reopen_file

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

Definition at line 93 of file logging.h.

◆ 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.

Definition at line 74 of file logging.h.


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