XRootD
XrdCl::Monitor Class Referenceabstract

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

#include <XrdClMonitor.hh>

+ Collaboration diagram for XrdCl::Monitor:

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.

Definition at line 55 of file XrdClMonitor.hh.


Class Documentation

◆ XrdCl::Monitor::CopyBInfo

struct XrdCl::Monitor::CopyBInfo

Describe a start of copy event. Copy events are sequential by nature. a copybeg event is followed by a number of open and close events. When the copy finishes, all files are closed and a copyend event occurs.

Definition at line 173 of file XrdClMonitor.hh.

+ Collaboration diagram for XrdCl::Monitor::CopyBInfo:
Class Members
TransferInfo transfer The transfer in question.

Member Enumeration Documentation

◆ EventCode

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.

Definition at line 212 of file XrdClMonitor.hh.

213  {
214  EvCopyBeg,
215  EvCopyEnd,
216  EvCheckSum,
217  EvOpen,
218  EvClose,
219  EvErrIO,
220  EvConnect,
221  EvDisconnect
222 
223  };
@ EvCopyBeg
CopyBInfo: Copy operation started.
@ EvDisconnect
DisconnectInfo: Logout from a server.
@ EvClose
CloseInfo: File closed.
@ EvCopyEnd
CopyEInfo: Copy operation ended.
@ EvCheckSum
CheckSumInfo: File checksummed.
@ EvErrIO
ErrorInfo: An I/O error occurred.
@ EvOpen
OpenInfo: File opened.
@ EvConnect
ConnectInfo: Login into a server.

Constructor & Destructor Documentation

◆ Monitor()

XrdCl::Monitor::Monitor ( )
inline

Constructor.

Definition at line 61 of file XrdClMonitor.hh.

61 {}

◆ ~Monitor()

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

Destructor.

Definition at line 66 of file XrdClMonitor.hh.

66 {}

Member Function Documentation

◆ Event()

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

Inform the monitor of an event.

Parameters
evCodeis the event that occurred (see enum evNum)
evDatais 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

Referenced by XrdCl::Stream::OnConnect(), XrdCl::FileStateHandler::OnOpen(), XrdCl::FileStateHandler::OnStateError(), XrdCl::ClassicCopyJob::Run(), and XrdCl::ThirdPartyCopyJob::Run().

+ Here is the caller graph for this function:

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