xrootd
Public Member Functions | List of all members
XrdCl::CopyProgressHandler Class Referenceabstract

Interface for copy progress notification. More...

#include <XrdClCopyProcess.hh>

Public Member Functions

virtual ~CopyProgressHandler ()
 
virtual void BeginJob (uint16_t jobNum, uint16_t jobTotal, const URL *source, const URL *destination)=0
 
virtual void EndJob (const XRootDStatus &status)=0
 
virtual void JobProgress (uint64_t bytesProcessed, uint64_t bytesTotal)=0
 

Detailed Description

Interface for copy progress notification.

Constructor & Destructor Documentation

virtual XrdCl::CopyProgressHandler::~CopyProgressHandler ( )
inlinevirtual

Member Function Documentation

virtual void XrdCl::CopyProgressHandler::BeginJob ( uint16_t  jobNum,
uint16_t  jobTotal,
const URL source,
const URL destination 
)
pure virtual

Notify when a new job is about to start

Parameters
jobNumthe job number of the copy job concerned
jobTotaltotal number of jobs being processed
sourcethe source url of the current job
destinationthe destination url of the current job
virtual void XrdCl::CopyProgressHandler::EndJob ( const XRootDStatus status)
pure virtual

Notify when the previous job has finished

Parameters
statusstatus of the job
virtual void XrdCl::CopyProgressHandler::JobProgress ( uint64_t  bytesProcessed,
uint64_t  bytesTotal 
)
pure virtual

Notify about the progress of the current job

Parameters
bytesProcessedbytes processed by the current job
bytesTotaltotal number of bytes to be processed by the current job

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