XRootD
XrdMonRoll Class Reference

#include <XrdMonRoll.hh>

+ Collaboration diagram for XrdMonRoll:

Classes

struct  setMember
 

Public Types

enum  rollType {
  Misc ,
  Protocol
}
 

Public Member Functions

 XrdMonRoll (XrdMonitor &xMon)
 
 ~XrdMonRoll ()
 
bool Register (rollType setType, const char *setName, setMember setVec[])
 

Static Public Attributes

static RAtomic_uint EOV = {0}
 

Detailed Description

Definition at line 46 of file XrdMonRoll.hh.


Class Documentation

◆ XrdMonRoll::setMember

struct XrdMonRoll::setMember

The setMember structure is used to define a set of counters that will be registered with this class. These counters are report in the summary.

Parameters
varName- Is the name of the variable and becomes the xml tag or of JSON key for the reported value.
varValu- Is the reference to the associated counter variable holding the value.

Definition at line 60 of file XrdMonRoll.hh.

+ Collaboration diagram for XrdMonRoll::setMember:
Class Members
const char * varName
RAtomic_uint & varValu

Member Enumeration Documentation

◆ rollType

Enumerator
Misc 
Protocol 

Definition at line 82 of file XrdMonRoll.hh.

Constructor & Destructor Documentation

◆ XrdMonRoll()

XrdMonRoll::XrdMonRoll ( XrdMonitor xMon)

Definition at line 46 of file XrdMonRoll.cc.

46  : xrdMon(xMon)
47 { memset(rsvd, 0, sizeof(rsvd));}

◆ ~XrdMonRoll()

XrdMonRoll::~XrdMonRoll ( )
inline

Definition at line 87 of file XrdMonRoll.hh.

87 {}

Member Function Documentation

◆ Register()

bool XrdMonRoll::Register ( rollType  setType,
const char *  setName,
setMember  setVec[] 
)

Definition at line 53 of file XrdMonRoll.cc.

55 { return xrdMon.Register(setType, setName, setVec);}
bool Register(XrdMonRoll::rollType setType, const char *setName, XrdMonRoll::setMember setVec[])
Definition: XrdMonitor.hh:39

References XrdMonitor::Register().

+ Here is the call graph for this function:

Member Data Documentation

◆ EOV

RAtomic_uint XrdMonRoll::EOV = {0}
static

Register a set of counters to be reported.

Parameters
setType- Is the type of set being defined: Misc - counters for miscellaneous activities. Protocol - counters for a protocol.
setName- Is the name of the set of counter variables. The name must not already be registered. The name is reported in stats xml tag or JSON stats key value.
setVec- Is a vector of setMember items that define the set of variables for the summary report. The last element of the vector must be initialized to {0, EOV}. The vector must reside in allocated storage until execution ends.
Returns
true when the set has been registered and false if the set is already registered (i.e. setName is in use).

Definition at line 80 of file XrdMonRoll.hh.


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