XrdCmsPerfMon Class Reference

#include <XrdCmsPerfMon.hh>

Inheritance diagram for XrdCmsPerfMon:

Collaboration diagram for XrdCmsPerfMon:

Classes
struct	PerfInfo
	Structure used for reporting performance metrics. More...

Public Member Functions
	XrdCmsPerfMon ()
	Constructor & Destructor.
virtual	~XrdCmsPerfMon ()
virtual bool	Configure (const char *cfn, char *Parms, XrdSysLogger &Logger, XrdCmsPerfMon &cmsMon, XrdOucEnv *EnvInfo, bool isCMS)
virtual void	GetInfo (PerfInfo &info)
virtual void	PutInfo (PerfInfo &info, bool alert=false)

Detailed Description

Definition at line 45 of file XrdCmsPerfMon.hh.

Constructor & Destructor Documentation

XrdCmsPerfMon()

XrdCmsPerfMon::XrdCmsPerfMon ( )

inline

Constructor & Destructor.

Definition at line 127 of file XrdCmsPerfMon.hh.

{}

Referenced by Configure(), and XrdCmsMeter::Monitor().

Here is the caller graph for this function:

~XrdCmsPerfMon()

virtual XrdCmsPerfMon::~XrdCmsPerfMon ( )

inlinevirtual

Definition at line 129 of file XrdCmsPerfMon.hh.

{}

Member Function Documentation

Configure()

virtual bool XrdCmsPerfMon::Configure ( const char * cfn, char * Parms, XrdSysLogger & Logger, XrdCmsPerfMon & cmsMon, XrdOucEnv * EnvInfo, bool isCMS )

inlinevirtual

Configure the PerfMon plugin object. This is called after the plugin is loaded via the shared library.

Parameters

cfn	The configuration file name.
Parms	Any parameters specified in the perf directive. If none, the pointer may be null.
Logger	The logging object.
cmsMon	The object to be used for async reporting.
EnvInfo	Environmental information of the caller, may be nil.
isCMS	True if loaded by the cmsd and false if loaded by xrootd.

Returns

True upon success. False upon failure.

Reimplemented in XrdCmsFinderTRG.

Definition at line 65 of file XrdCmsPerfMon.hh.

                        {(void)cfn; (void)Parms; (void)Logger; (void)cmsMon;
                         (void)EnvInfo; (void)isCMS;
                         return false;
                        }

References XrdCmsPerfMon(), and Logger.

Here is the call graph for this function:

GetInfo()

virtual void XrdCmsPerfMon::GetInfo ( PerfInfo & info )

inlinevirtual

Obtain performance statistics as load values from 0 to 100. The system calls this method at periodic intervals.

Parameters

info	Reference to the structure that should be filled out with load values, as desired. See the PerfInfo structure.

Definition at line 106 of file XrdCmsPerfMon.hh.

{(void)info;}

PutInfo()

virtual void XrdCmsPerfMon::PutInfo ( PerfInfo & info, bool alert = false )

inlinevirtual

Report performance statistics as load values from 0 to 100. The performance monitor plugin may call this method to asynchronously report performance via the passed XrdCmsPerfMon object during configuration.

Parameters

info	Reference to the structure that should be filled out with load values. See the PerfInfo structure.
alert	When true, load information is forcibly sent to the cluster's manager. Otherwise, it is only sent if it significantly changes. See the cms.sched directive fuzz parameter.

Reimplemented in XrdCmsFinderTRG, and XrdCmsMeter.

Definition at line 120 of file XrdCmsPerfMon.hh.

                      {(void)info; (void)alert;}

---

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

• XrdCmsPerfMon.hh