XRootD
XrdCl::CopyJob Class Referenceabstract

Copy job. More...

#include <XrdClCopyJob.hh>

+ Inheritance diagram for XrdCl::CopyJob:
+ Collaboration diagram for XrdCl::CopyJob:

Public Member Functions

 CopyJob (uint16_t jobId, PropertyList *jobProperties, PropertyList *jobResults)
 Constructor. More...
 
virtual ~CopyJob ()
 Virtual destructor. More...
 
PropertyListGetProperties ()
 Get the job properties. More...
 
PropertyListGetResults ()
 Get the job results. More...
 
const URLGetSource () const
 Get source. More...
 
const URLGetTarget () const
 Get target. More...
 
void Init ()
 
virtual XRootDStatus Run (CopyProgressHandler *progress=0)=0
 

Protected Attributes

uint16_t pJobId
 
PropertyListpProperties
 
PropertyListpResults
 
URL pSource
 
URL pTarget
 

Detailed Description

Copy job.

Definition at line 35 of file XrdClCopyJob.hh.

Constructor & Destructor Documentation

◆ CopyJob()

XrdCl::CopyJob::CopyJob ( uint16_t  jobId,
PropertyList jobProperties,
PropertyList jobResults 
)
inline

Constructor.

Definition at line 41 of file XrdClCopyJob.hh.

43  :
44  pProperties( jobProperties ),
45  pResults( jobResults ),
46  pJobId( jobId )
47  {
48  Init();
49  }
PropertyList * pResults
PropertyList * pProperties

References Init().

+ Here is the call graph for this function:

◆ ~CopyJob()

virtual XrdCl::CopyJob::~CopyJob ( )
inlinevirtual

Virtual destructor.

Definition at line 54 of file XrdClCopyJob.hh.

55  {
56  }

Member Function Documentation

◆ GetProperties()

PropertyList* XrdCl::CopyJob::GetProperties ( )
inline

Get the job properties.

Definition at line 78 of file XrdClCopyJob.hh.

79  {
80  return pProperties;
81  }

References pProperties.

◆ GetResults()

PropertyList* XrdCl::CopyJob::GetResults ( )
inline

Get the job results.

Definition at line 86 of file XrdClCopyJob.hh.

87  {
88  return pResults;
89  }

References pResults.

◆ GetSource()

const URL& XrdCl::CopyJob::GetSource ( ) const
inline

Get source.

Definition at line 94 of file XrdClCopyJob.hh.

95  {
96  return pSource;
97  }

References pSource.

Referenced by XrdCl::ClassicCopyJob::ClassicCopyJob(), XrdCl::ThirdPartyCopyJob::ThirdPartyCopyJob(), XrdCl::TPFallBackCopyJob::TPFallBackCopyJob(), XrdCl::ClassicCopyJob::Run(), and XrdCl::ThirdPartyCopyJob::Run().

+ Here is the caller graph for this function:

◆ GetTarget()

const URL& XrdCl::CopyJob::GetTarget ( ) const
inline

Get target.

Definition at line 102 of file XrdClCopyJob.hh.

103  {
104  return pTarget;
105  }

References pTarget.

Referenced by XrdCl::ClassicCopyJob::ClassicCopyJob(), XrdCl::ThirdPartyCopyJob::ThirdPartyCopyJob(), XrdCl::TPFallBackCopyJob::TPFallBackCopyJob(), XrdCl::ClassicCopyJob::Run(), and XrdCl::ThirdPartyCopyJob::Run().

+ Here is the caller graph for this function:

◆ Init()

void XrdCl::CopyJob::Init ( )
inline

Definition at line 61 of file XrdClCopyJob.hh.

62  {
63  pProperties->Get( "source", pSource );
64  pProperties->Get( "target", pTarget );
65  }
bool Get(const std::string &name, Item &item) const

References XrdCl::PropertyList::Get(), pProperties, pSource, and pTarget.

Referenced by CopyJob().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ Run()

virtual XRootDStatus XrdCl::CopyJob::Run ( CopyProgressHandler progress = 0)
pure virtual

Run the copy job

Parameters
progressthe handler to be notified about the copy progress
Returns
status of the copy operation

Implemented in XrdCl::TPFallBackCopyJob, XrdCl::ThirdPartyCopyJob, and XrdCl::ClassicCopyJob.

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

+ Here is the caller graph for this function:

Member Data Documentation

◆ pJobId

uint16_t XrdCl::CopyJob::pJobId
protected

Definition at line 112 of file XrdClCopyJob.hh.

Referenced by XrdCl::ClassicCopyJob::Run(), and XrdCl::TPFallBackCopyJob::Run().

◆ pProperties

PropertyList* XrdCl::CopyJob::pProperties
protected

◆ pResults

PropertyList* XrdCl::CopyJob::pResults
protected

◆ pSource

URL XrdCl::CopyJob::pSource
protected

Definition at line 110 of file XrdClCopyJob.hh.

Referenced by GetSource(), and Init().

◆ pTarget

URL XrdCl::CopyJob::pTarget
protected

Definition at line 111 of file XrdClCopyJob.hh.

Referenced by GetTarget(), and Init().


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