XrdCl::CopyProgressHandler Class Reference

Interface for copy progress notification. More...

#include <XrdClCopyProcess.hh>

List of all members.

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

---

Detailed Description

Interface for copy progress notification.

---

Constructor & Destructor Documentation

virtual XrdCl::CopyProgressHandler::~CopyProgressHandler

(

)

[inline, virtual]

---

Member Function Documentation

virtual void XrdCl::CopyProgressHandler::BeginJob	(	uint16_t	jobNum,
		uint16_t	jobTotal,
		const URL *	source,
		const URL *	destination
	)			[inline, virtual]

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

virtual void XrdCl::CopyProgressHandler::EndJob	(	uint16_t	jobNum,
		const PropertyList *	result
	)			[inline, virtual]

Notify when the previous job has finished

Parameters:

	jobNum	job number
	result	result of the job

virtual void XrdCl::CopyProgressHandler::JobProgress	(	uint16_t	jobNum,
		uint64_t	bytesProcessed,
		uint64_t	bytesTotal
	)			[inline, virtual]

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

virtual bool XrdCl::CopyProgressHandler::ShouldCancel

(

uint16_t

jobNum

)

[inline, virtual]

Determine whether the job should be canceled.

---

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

• XrdClCopyProcess.hh

---