XrdCl::DefaultEnv Class Reference

#include <XrdClDefaultEnv.hh>

Inheritance diagram for XrdCl::DefaultEnv:

Collaboration diagram for XrdCl::DefaultEnv:

Static Public Member Functions
static std::string	GetVersion ()
	Get client version.
static Env *	GetEnv ()
	Get default client environment.
static PostMaster *	GetPostMaster ()
	Get default post master.
static Log *	GetLog ()
	Get default log.
static void	SetLogLevel (const std::string &level)
static bool	SetLogFile (const std::string &filepath)
static void	SetLogMask (const std::string &level, const std::string &mask)
static ForkHandler *	GetForkHandler ()
	Get the fork handler.
static FileTimer *	GetFileTimer ()
	Get file timer task.
static Monitor *	GetMonitor ()
	Get the monitor object.
static CheckSumManager *	GetCheckSumManager ()
	Get checksum manager.
static TransportManager *	GetTransportManager ()
	Get transport manager.
static PlugInManager *	GetPlugInManager ()
	Get plug-in manager.
static PlugInFactory *	GetPlugInFactory (const std::string url)
static void	ReInitializeLogging ()
	Re-initialize the logging.

Private Member Functions
	DefaultEnv ()
	Constructor.

Static Private Member Functions
static void	Initialize ()
	Initialize the environment.
static void	Finalize ()
	Finalize the environment.
static void	SetUpLog ()

Static Private Attributes
static XrdSysMutex	sInitMutex
static Env *	sEnv
static PostMaster *	sPostMaster
static Log *	sLog
static ForkHandler *	sForkHandler
static FileTimer *	sFileTimer
static Monitor *	sMonitor
static XrdOucPinLoader *	sMonitorLibHandle
static bool	sMonitorInitialized
static CheckSumManager *	sCheckSumManager
static TransportManager *	sTransportManager
static PlugInManager *	sPlugInManager

Friends
struct	::EnvInitializer

Additional Inherited Members
Public Member Functions inherited from XrdCl::Env
virtual	~Env ()
	Destructor.
bool	GetString (const std::string &key, std::string &value)
bool	PutString (const std::string &key, const std::string &value)
bool	GetInt (const std::string &key, int &value)
bool	PutInt (const std::string &key, int value)
bool	ImportInt (const std::string &key, const std::string &shellKey)
bool	ImportString (const std::string &key, const std::string &shellKey)
bool	GetDefaultIntValue (const std::string &key, int &value)
bool	GetDefaultStringValue (const std::string &key, std::string &value)
void	WriteLock ()
void	UnLock ()
void	ReInitializeLock ()
void	RecreateLock ()

Detailed Description

Default environment for the client. Responsible for setting/importing defaults for the variables used by the client. And holding other global stuff.

Constructor & Destructor Documentation

DefaultEnv()

XrdCl::DefaultEnv::DefaultEnv ( )

private

Constructor.

Member Function Documentation

Finalize()

static void XrdCl::DefaultEnv::Finalize ( )

staticprivate

Finalize the environment.

GetCheckSumManager()

static CheckSumManager * XrdCl::DefaultEnv::GetCheckSumManager ( )

static

Get checksum manager.

Referenced by XrdCl::CheckSumHelper::Initialize().

GetEnv()

static Env * XrdCl::DefaultEnv::GetEnv ( )

static

Get default client environment.

Referenced by XrdCl::ZipListHandler::ZipListHandler().

GetFileTimer()

static FileTimer * XrdCl::DefaultEnv::GetFileTimer ( )

static

Get file timer task.

GetForkHandler()

static ForkHandler * XrdCl::DefaultEnv::GetForkHandler ( )

static

Get the fork handler.

GetLog()

static Log * XrdCl::DefaultEnv::GetLog ( )

static

Get default log.

Referenced by XrdCl::RecorderFactory::CreateFileSystem(), XrdCl::CheckSumHelper::GetCheckSum(), XrdCl::CheckSumHelper::GetCheckSumImpl(), XrdCl::CheckSumHelper::Initialize(), XrdCl::Recorder::Output::Instance(), XrdCl::Recorder::Output::Open(), XrdCl::AsyncHSReader::Read(), XrdCl::AsyncMsgReader::Read(), XrdCl::AsyncDiscardReader::Read(), XrdCl::AsyncRawReader::Read(), XrdCl::AsyncVectorReader::Read(), XrdCl::AsyncHSWriter::Write(), XrdCl::AsyncMsgWriter::Write(), XrdCl::Recorder::Output::Write(), XrdCl::XRootDMsgHandler::XRootDMsgHandler(), XrdCl::Recorder::Output::~Output(), and XrdCl::XRootDMsgHandler::~XRootDMsgHandler().

GetMonitor()

static Monitor * XrdCl::DefaultEnv::GetMonitor ( )

static

Get the monitor object.

GetPlugInFactory()

static PlugInFactory * XrdCl::DefaultEnv::GetPlugInFactory ( const std::string  url )

static

Retrieve the plug-in factory for the given URL

Returns

you do not own the returned memory

GetPlugInManager()

static PlugInManager * XrdCl::DefaultEnv::GetPlugInManager ( )

static

Get plug-in manager.

GetPostMaster()

static PostMaster * XrdCl::DefaultEnv::GetPostMaster ( )

static

Get default post master.

Referenced by XrdCl::Utils::GetProtocolVersion(), XrdCl::Operation< HasHndl >::Run(), XrdCl::EcHandler::Schedule(), XrdCl::ZipArchive::Schedule(), XrdCl::ParallelOperation< HasHndl >::Schedule(), and XrdCl::XRootDMsgHandler::XRootDMsgHandler().

GetTransportManager()

static TransportManager * XrdCl::DefaultEnv::GetTransportManager ( )

static

Get transport manager.

GetVersion()

static std::string XrdCl::DefaultEnv::GetVersion ( )

inlinestatic

Get client version.

Initialize()

static void XrdCl::DefaultEnv::Initialize ( )

staticprivate

Initialize the environment.

ReInitializeLogging()

static void XrdCl::DefaultEnv::ReInitializeLogging ( )

static

Re-initialize the logging.

SetLogFile()

static bool XrdCl::DefaultEnv::SetLogFile ( const std::string &  filepath )

static

Set log file

Parameters

filepath

path to the log file

SetLogLevel()

static void XrdCl::DefaultEnv::SetLogLevel ( const std::string &  level )

static

Set log level

Parameters

level

Dump, Debug, Info, Warning or Error

SetLogMask()

static void XrdCl::DefaultEnv::SetLogMask ( const std::string &  level, const std::string &  mask  )

static

Set log mask. Determines which diagnostics topics should be printed. It's a "|" separated list of topics. The first element may be "All" in which case all the topics are enabled and the subsequent elements may turn them off, or "None" in which case all the topics are disabled and the subsequent flags may turn them on. If the topic name is prefixed with "^", then it means that the topic should be disabled. If the topic name is not prefixed, then it means that the topic should be enabled.

The default for each level is "All", except for the "Dump" level, where the default is "All|^PollerMsg". This means that, at the "Dump" level, all the topics but "PollerMsg" are enabled.

Available topics: AppMsg, UtilityMsg, FileMsg, PollerMsg, PostMasterMsg, XRootDTransportMsg, TaskMgrMsg, XRootDMsg, FileSystemMsg, AsyncSockMsg

Parameters

level	log level or "All" for all levels
mask	log mask

SetUpLog()

static void XrdCl::DefaultEnv::SetUpLog ( )

staticprivate

Friends And Related Symbol Documentation

::EnvInitializer

friend struct ::EnvInitializer

friend

Member Data Documentation

sCheckSumManager

CheckSumManager* XrdCl::DefaultEnv::sCheckSumManager

staticprivate

sEnv

Env* XrdCl::DefaultEnv::sEnv

staticprivate

sFileTimer

FileTimer* XrdCl::DefaultEnv::sFileTimer

staticprivate

sForkHandler

ForkHandler* XrdCl::DefaultEnv::sForkHandler

staticprivate

sInitMutex

XrdSysMutex XrdCl::DefaultEnv::sInitMutex

staticprivate

sLog

Log* XrdCl::DefaultEnv::sLog

staticprivate

sMonitor

Monitor* XrdCl::DefaultEnv::sMonitor

staticprivate

sMonitorInitialized

bool XrdCl::DefaultEnv::sMonitorInitialized

staticprivate

sMonitorLibHandle

XrdOucPinLoader* XrdCl::DefaultEnv::sMonitorLibHandle

staticprivate

sPlugInManager

PlugInManager* XrdCl::DefaultEnv::sPlugInManager

staticprivate

sPostMaster

PostMaster* XrdCl::DefaultEnv::sPostMaster

staticprivate

sTransportManager

TransportManager* XrdCl::DefaultEnv::sTransportManager

staticprivate

---

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

• XrdClDefaultEnv.hh