XrdCl::Log Class Reference

Handle diagnostics. More...

#include <XrdClLog.hh>

Collaboration diagram for XrdCl::Log:

Public Types
enum	LogLevel {   NoMsg = 0, ErrorMsg = 1, WarningMsg = 2, InfoMsg = 3,   DebugMsg = 4, DumpMsg = 5 }
	Log levels. More...

Public Member Functions
	Log ()
	Constructor. More...
	~Log ()
void	Error (uint64_t topic, const char *format,...)
	Report an error. More...
void	Warning (uint64_t topic, const char *format,...)
	Report a warning. More...
void	Info (uint64_t topic, const char *format,...)
	Print an info. More...
void	Debug (uint64_t topic, const char *format,...)
	Print a debug message. More...
void	Dump (uint64_t topic, const char *format,...)
	Print a dump message. More...
void	Say (LogLevel level, uint64_t topic, const char *format, va_list list)
void	SetLevel (LogLevel level)
	Set the level of the messages that should be sent to the destination. More...
void	SetLevel (const std::string &level)
	Set the level of the messages that should be sent to the destination. More...
void	SetOutput (LogOut *output)
	Set the output that should be used. More...
void	SetMask (LogLevel level, uint64_t mask)
	Sets the mask for the topics of messages that should be printed. More...
void	SetMask (const std::string &level, uint64_t mask)
	Sets the mask for the topics of messages that should be printed. More...
void	SetTopicName (uint64_t topic, std::string name)
	Map a topic number to a string. More...
uint64_t	RegisterTopic (const std::string &topic)
	Register new topic. More...
LogLevel	GetLevel () const
	Get the log level. More...
void	SetPid (pid_t pid)
	Set pid. More...

Private Types
typedef std::map< uint64_t, std::string >	TopicMap

Private Member Functions
std::string	LogLevelToString (LogLevel level)
bool	StringToLogLevel (const std::string &strLevel, LogLevel &level)
std::string	TopicToString (uint64_t topic)

Private Attributes
std::atomic< LogLevel >	pLevel
uint64_t	pMask [DumpMsg+1]
LogOut *	pOutput
TopicMap	pTopicMap
uint32_t	pTopicMaxLength
pid_t	pPid

Detailed Description

Handle diagnostics.

Member Typedef Documentation

typedef std::map<uint64_t, std::string> XrdCl::Log::TopicMap

private

Member Enumeration Documentation

enum XrdCl::Log::LogLevel

Log levels.

Enumerator
NoMsg	report nothing
ErrorMsg	report errors
WarningMsg	report warnings
InfoMsg	print info
DebugMsg	print debug info
DumpMsg	print details of the request and responses

Constructor & Destructor Documentation

XrdCl::Log::Log ( )

inline

Constructor.

References DumpMsg, pMask, and pOutput.

XrdCl::Log::~Log ( )

inline

References pOutput.

Member Function Documentation

void XrdCl::Log::Debug	(	uint64_t	topic,
		const char *	format,
			...
	)

Print a debug message.

Referenced by XrdCl::XRootDMsgHandler::XRootDMsgHandler(), and XrdCl::XRootDMsgHandler::~XRootDMsgHandler().

void XrdCl::Log::Dump	(	uint64_t	topic,
		const char *	format,
			...
	)

Print a dump message.

Referenced by XrdCl::AsyncVectorReader::Read(), XrdCl::AsyncHSReader::Read(), XrdCl::AsyncMsgReader::Read(), and XrdCl::AsyncMsgWriter::Write().

void XrdCl::Log::Error	(	uint64_t	topic,
		const char *	format,
			...
	)

Report an error.

Referenced by XrdCl::RecorderFactory::CreateFileSystem(), XrdCl::CheckSumHelper::Initialize(), XrdCl::Recorder::Output::Instance(), XrdCl::AsyncVectorReader::Read(), XrdCl::AsyncRawReader::Read(), XrdCl::AsyncDiscardReader::Read(), XrdCl::AsyncMsgWriter::Write(), and XrdCl::AsyncHSWriter::Write().

LogLevel XrdCl::Log::GetLevel ( ) const

inline

Get the log level.

References pLevel.

void XrdCl::Log::Info	(	uint64_t	topic,
		const char *	format,
			...
	)

Print an info.

std::string XrdCl::Log::LogLevelToString ( LogLevel  level )

private

uint64_t XrdCl::Log::RegisterTopic ( const std::string &  topic )

inline

Register new topic.

References pTopicMap, and SetTopicName().

void XrdCl::Log::Say	(	LogLevel	level,
		uint64_t	topic,
		const char *	format,
		va_list	list
	)

Always print the message

Parameters

level	log level
topic	topic of the message
format	format string - the same as in printf
list	list of arguments

void XrdCl::Log::SetLevel ( LogLevel  level )

inline

Set the level of the messages that should be sent to the destination.

References pLevel.

Referenced by SetLevel().

void XrdCl::Log::SetLevel ( const std::string &  level )

inline

Set the level of the messages that should be sent to the destination.

References SetLevel(), and StringToLogLevel().

void XrdCl::Log::SetMask ( LogLevel  level, uint64_t  mask  )

inline

Sets the mask for the topics of messages that should be printed.

References pMask.

void XrdCl::Log::SetMask ( const std::string &  level, uint64_t  mask  )

inline

Sets the mask for the topics of messages that should be printed.

References pMask, and StringToLogLevel().

void XrdCl::Log::SetOutput ( LogOut *  output )

inline

Set the output that should be used.

References pOutput.

void XrdCl::Log::SetPid ( pid_t  pid )

inline

Set pid.

References pPid.

void XrdCl::Log::SetTopicName	(	uint64_t	topic,
		std::string	name
	)

Map a topic number to a string.

Referenced by RegisterTopic().

bool XrdCl::Log::StringToLogLevel ( const std::string &  strLevel, LogLevel &  level  )

private

Referenced by SetLevel(), and SetMask().

std::string XrdCl::Log::TopicToString ( uint64_t  topic )

private

void XrdCl::Log::Warning	(	uint64_t	topic,
		const char *	format,
			...
	)

Report a warning.

Referenced by XrdCl::Recorder::Output::Open(), XrdCl::Recorder::Output::Write(), and XrdCl::Recorder::Output::~Output().

Member Data Documentation

std::atomic<LogLevel> XrdCl::Log::pLevel

private

Referenced by GetLevel(), and SetLevel().

uint64_t XrdCl::Log::pMask[DumpMsg+1]

private

Referenced by Log(), and SetMask().

LogOut* XrdCl::Log::pOutput

private

Referenced by Log(), SetOutput(), and ~Log().

pid_t XrdCl::Log::pPid

private

Referenced by SetPid().

TopicMap XrdCl::Log::pTopicMap

private

Referenced by RegisterTopic().

uint32_t XrdCl::Log::pTopicMaxLength

private

---

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

• XrdClLog.hh