XrdCl::CopyProgressHandler Class Reference

Interface for copy progress notification. More...

#include <XrdClCopyProcess.hh>

Inheritance diagram for XrdCl::CopyProgressHandler:

Collaboration diagram for XrdCl::CopyProgressHandler:

Public Member Functions
virtual	~CopyProgressHandler ()
virtual void	BeginJob (uint32_t jobNum, uint32_t jobTotal, const URL *source, const URL *destination)
virtual void	EndJob (uint32_t jobNum, const PropertyList *result)
virtual void	JobProgress (uint32_t jobNum, uint64_t bytesProcessed, uint64_t bytesTotal)
virtual bool	ShouldCancel (uint32_t jobNum)
	Determine whether the job should be canceled.

Detailed Description

Interface for copy progress notification.

Definition at line 41 of file XrdClCopyProcess.hh.

Constructor & Destructor Documentation

~CopyProgressHandler()

virtual XrdCl::CopyProgressHandler::~CopyProgressHandler ( )

inlinevirtual

Definition at line 44 of file XrdClCopyProcess.hh.

{}

Member Function Documentation

BeginJob()

virtual void XrdCl::CopyProgressHandler::BeginJob ( uint32_t jobNum, uint32_t jobTotal, const URL * source, const URL * destination )

inlinevirtual

Notify when a new job is about to start

Parameters

jobNum	the job number of the copy job concerned
jobTotal	total number of jobs being processed
source	the source url of the current job
destination	the destination url of the current job

Reimplemented in ProgressDisplay.

Definition at line 54 of file XrdClCopyProcess.hh.

      {
        (void)jobNum; (void)jobTotal; (void)source; (void)destination;
      };

EndJob()

virtual void XrdCl::CopyProgressHandler::EndJob ( uint32_t jobNum, const PropertyList * result )

inlinevirtual

Notify when the previous job has finished

Parameters

jobNum	job number
result	result of the job

Reimplemented in ProgressDisplay, and ProgressDisplay.

Definition at line 68 of file XrdClCopyProcess.hh.

      {
        (void)jobNum; (void)result;
      };

JobProgress()

virtual void XrdCl::CopyProgressHandler::JobProgress ( uint32_t jobNum, uint64_t bytesProcessed, uint64_t bytesTotal )

inlinevirtual

Notify about the progress of the current job

Parameters

jobNum	job number
bytesProcessed	bytes processed by the current job
bytesTotal	total number of bytes to be processed by the current job

Reimplemented in ProgressDisplay, and ProgressDisplay.

Definition at line 82 of file XrdClCopyProcess.hh.

      {
        (void)jobNum; (void)bytesProcessed; (void)bytesTotal;
      };

Referenced by XrdCl::ClassicCopyJob::Run().

Here is the caller graph for this function:

ShouldCancel()

virtual bool XrdCl::CopyProgressHandler::ShouldCancel ( uint32_t jobNum )

inlinevirtual

Determine whether the job should be canceled.

Definition at line 92 of file XrdClCopyProcess.hh.

      {
        (void)jobNum;
        return false;
      }

Referenced by XrdCl::ClassicCopyJob::Run().

Here is the caller graph for this function:

---

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

• XrdClCopyProcess.hh