xrootd
Classes | Public Types | Public Member Functions | List of all members
XrdCl::Monitor Class Referenceabstract

An abstract class to describe the client-side monitoring plugin interface. More...

#include <XrdClMonitor.hh>

Classes

struct  CheckSumInfo
 Describe a checksum event. More...
 
struct  CloseInfo
 Describe a file close event. More...
 
struct  ConnectInfo
 Describe a server login event. More...
 
struct  CopyBInfo
 
struct  CopyEInfo
 Describe an end of copy event. More...
 
struct  DisconnectInfo
 Describe a server logout event. More...
 
struct  ErrorInfo
 Describe an encountered file-based error. More...
 
struct  OpenInfo
 Describe a file open event to the monitor. More...
 
struct  TransferInfo
 Describe the transfer. More...
 

Public Types

enum  EventCode {
  EvCopyBeg, EvCopyEnd, EvCheckSum, EvOpen,
  EvClose, EvErrIO, EvConnect, EvDisconnect
}
 

Public Member Functions

 Monitor ()
 Constructor. More...
 
virtual ~Monitor ()
 Destructor. More...
 
virtual void Event (EventCode evCode, void *evData)=0
 

Detailed Description

An abstract class to describe the client-side monitoring plugin interface.

Member Enumeration Documentation

Event codes passed to the Event() method. Event code values not listed here, if encountered, should be ignored.

Enumerator
EvCopyBeg 

CopyBInfo: Copy operation started.

EvCopyEnd 

CopyEInfo: Copy operation ended.

EvCheckSum 

CheckSumInfo: File checksummed.

EvOpen 

OpenInfo: File opened.

EvClose 

CloseInfo: File closed.

EvErrIO 

ErrorInfo: An I/O error occurred.

EvConnect 

ConnectInfo: Login into a server.

EvDisconnect 

DisconnectInfo: Logout from a server.

Constructor & Destructor Documentation

XrdCl::Monitor::Monitor ( )
inline

Constructor.

virtual XrdCl::Monitor::~Monitor ( )
inlinevirtual

Destructor.

Member Function Documentation

virtual void XrdCl::Monitor::Event ( EventCode  evCode,
void *  evData 
)
pure virtual

Inform the monitor of an event.

evCode is the event that occurred (see enum evNum) evInfo is the event information structure describing the event it is cast to (void *) so that one method can be used and should be recast to the correct corresponding struct


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