Debug Class Reference

#include <Debug.h>

Collaboration diagram for Debug:

Classes
class	Context
	meta-information for debugs() or a similar debugging call More...

Static Public Member Functions
static bool	Enabled (const int section, const int level)
	whether debugging the given section and the given level produces output More...
static void	parseOptions (char const *)
static int	Level ()
	minimum level required by the current debugs() call More...
static int	SectionLevel ()
	maximum level currently allowed More...
static std::ostringstream &	Start (const int section, const int level)
	opens debugging context and returns output buffer More...
static void	Finish ()
	logs output buffer created in Start() and closes debugging context More...
static void	ForceAlert ()
	configures the active debugging context to write syslog ALERT More...
static std::ostream &	Extra (std::ostream &os)
	prefixes each grouped debugs() line after the first one in the group More...

Static Public Attributes
static char *	debugOptions = NULL
static char *	cache_log = NULL
static int	rotateNumber = -1
static int	Levels [MAX_DEBUG_SECTIONS]
static int	override_X = 0
static int	log_stderr = -1
static bool	log_syslog = false

Static Private Attributes
static Context *	Current = nullptr
	deepest active context; nil outside debugs() More...

Detailed Description

Definition at line 47 of file Debug.h.

Member Function Documentation

Enabled()

static bool Debug::Enabled ( const int  section, const int  level  )

inlinestatic

Definition at line 70 of file Debug.h.

References Levels.

Referenced by clientNegotiateSSL(), Ftp::Server::handleRequest(), Adaptation::Ecap::Host::openDebug(), Security::NegotiationHistory::retrieveNegotiatedInfo(), and Security::PeerConnector::sslCrtvdHandleReply().

Extra()

static std::ostream& Debug::Extra ( std::ostream &  os )

inlinestatic

Definition at line 99 of file Debug.h.

Referenced by clientHttpConnectionsOpen(), clientListenerConnectionOpened(), htcpSpecifier::detailCodeContext(), AccessLogEntry::detailCodeContext(), AnyP::PortCfg::detailCodeContext(), Comm::Connection::detailCodeContext(), Ssl::CertValidationHelper::Init(), ConnStateData::lifetimeTimeout(), neighbors_init(), FormattedLog::parseOptions(), TextException::print(), Rock::Rebuild::progressDescription(), Ipc::Port::receiveOrIgnore(), Ipc::QuestionerId::rejectAnswerIfStale(), storeCleanup(), storeRebuildComplete(), and testCacheManager::testParseUrl().

Finish()

void Debug::Finish ( )

static

Definition at line 690 of file debug.cc.

References _db_print(), Debug::Context::buf, Current, CurrentCodeContextDetail(), DBG_IMPORTANT, Debug::Context::forceAlert, Debug::Context::level, and Debug::Context::upper.

Referenced by Adaptation::Ecap::Host::closeDebug().

ForceAlert()

void Debug::ForceAlert ( )

static

Definition at line 709 of file debug.cc.

References Current, and Debug::Context::forceAlert.

Referenced by ForceAlert().

Level()

static int Debug::Level ( )

inlinestatic

Definition at line 86 of file Debug.h.

References Current, and Debug::Context::level.

Referenced by _db_print_stderr(), and debugLogTime().

parseOptions()

void Debug::parseOptions ( char const *  options )

static

Definition at line 468 of file debug.cc.

References debugArg(), debugs, Levels, MAX_DEBUG_SECTIONS, NULL, override_X, s, w_space, xfree, and xstrdup.

Referenced by _db_init(), mainHandleCommandLineOption(), sigusr2_handle(), and SquidMain().

SectionLevel()

static int Debug::SectionLevel ( )

inlinestatic

Definition at line 88 of file Debug.h.

References Current, and Debug::Context::sectionLevel.

Referenced by Raw::print().

Start()

std::ostringstream & Debug::Start ( const int  section, const int  level  )

static

Definition at line 669 of file debug.cc.

References Debug::Context::buf, Current, and Debug::Context::rewind().

Referenced by Adaptation::Ecap::Host::openDebug().

Member Data Documentation

cache_log

char * Debug::cache_log = NULL

static

Definition at line 76 of file Debug.h.

Referenced by _db_rotate_log(), ConfigureDebugging(), mainReconfigureFinish(), and DebugFile::reset().

Current

Debug::Context * Debug::Current = nullptr

staticprivate

Definition at line 102 of file Debug.h.

Referenced by Finish(), ForceAlert(), Level(), Debug::Context::rewind(), SectionLevel(), and Start().

debugOptions

char * Debug::debugOptions = NULL

static

Definition at line 75 of file Debug.h.

Referenced by ConfigureDebugging(), mainReconfigureFinish(), PutEnvironment(), sigusr2_handle(), and snmp_confFn().

Levels

int Debug::Levels

static

Definition at line 78 of file Debug.h.

Referenced by testAuthConfig::create(), debugArg(), Enabled(), main(), parseOptions(), Debug::Context::rewind(), and testAuthUserRequest::scheme().

log_stderr

int Debug::log_stderr = -1

static

Definition at line 80 of file Debug.h.

Referenced by _db_print_stderr(), mainHandleCommandLineOption(), and watch_child().

log_syslog

bool Debug::log_syslog = false

static

Definition at line 81 of file Debug.h.

Referenced by _db_init().

override_X

int Debug::override_X = 0

static

Definition at line 79 of file Debug.h.

Referenced by mainHandleCommandLineOption(), and parseOptions().

rotateNumber

int Debug::rotateNumber = -1

static

Definition at line 77 of file Debug.h.

Referenced by _db_rotate_log(), configDoConfigure(), and debugArg().

---

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

• src/Debug.h
• src/debug.cc
• src/tests/stub_debug.cc