XrdXrootdGPFileInfo Class Reference

#include <XrdXrootdGPFile.hh>

Public Types
enum	Status { isPending = 0, isCopying = 1, isProving = 2 }

Public Member Functions
bool	Completed (const char *eMsg=0, int eNum=0)
enum XrdXrootdGPFileInfo::Status	Update (uint64_t xfrsz, Status stat)
	XrdXrootdGPFileInfo (XrdXrootdGPFAgent &gpf)
	~XrdXrootdGPFileInfo ()

Public Attributes
const char *	cksType
	Checksum type or nil if none wanted. More...
const char *	cksValue
	Checksum value or nil if none wanted. More...
const char *	src
	Source specification (path or URL) More...
const char *	srcCgi
	Source cgi or nil if none. More...
const char *	dst
	Destination specification (path or URL) More...
uint16_t	pingsec
	Seconds between ping call to Update() More...
uint16_t	streams
	Number of parallel streams (0 -> default) More...

Private Attributes
XrdXrootdGPFAgent &	gpfAgent

Detailed Description

The XrdXrootdGFileInfo class contains the get/putFile() parameters and contains callback methods that indicate when the operation completes as well as for progress status updates.

Member Enumeration Documentation

Status

enum XrdXrootdGPFileInfo::Status

Supply status information to the client. This is normally done every Info::pingsec seconds.

Parameters

xfrsz	- The number of bytes transmitted.
stat	- One of Status indicating execution stage.

Returns

true - Status sent to client.

false - Client is no longer connected, status not sent.

Enumerator
isPending	Copy operation is pending.
isCopying	Copy operation in progress.
isProving	Copy operation verifiying checksum.

Constructor & Destructor Documentation

XrdXrootdGPFileInfo()

XrdXrootdGPFileInfo::XrdXrootdGPFileInfo ( XrdXrootdGPFAgent &  gpf )

inline

~XrdXrootdGPFileInfo()

XrdXrootdGPFileInfo::~XrdXrootdGPFileInfo ( )

inline

Member Function Documentation

Completed()

bool XrdXrootdGPFileInfo::Completed	(	const char *	eMsg = 0,
		int	eNum = 0
	)

Indicate that an accepted get/putFile requtest has completed. This must be called at completion afterwhich this object must be deleted.

Parameters

eMsg	- A text string describing the problem if in error. If no error was encounteredm a nil pointer should be passed.
eNum	- The errno value corresponding to the error type. A value zero indicates that the copy successfully completed.

Returns

true - Completion sent to client.

false - Client is no longer connected, completion not sent.

Update()

enum XrdXrootdGPFileInfo::Status XrdXrootdGPFileInfo::Update	(	uint64_t	xfrsz,
		Status	stat
	)

Member Data Documentation

cksType

const char* XrdXrootdGPFileInfo::cksType

Checksum type or nil if none wanted.

cksValue

const char* XrdXrootdGPFileInfo::cksValue

Checksum value or nil if none wanted.

dst

const char* XrdXrootdGPFileInfo::dst

Destination specification (path or URL)

gpfAgent

XrdXrootdGPFAgent& XrdXrootdGPFileInfo::gpfAgent

private

pingsec

uint16_t XrdXrootdGPFileInfo::pingsec

Seconds between ping call to Update()

src

const char* XrdXrootdGPFileInfo::src

Source specification (path or URL)

srcCgi

const char * XrdXrootdGPFileInfo::srcCgi

Source cgi or nil if none.

Destination cgi or nil if none.

streams

uint16_t XrdXrootdGPFileInfo::streams

Number of parallel streams (0 -> default)

---

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

• XrdXrootdGPFile.hh