XrdXrootdGPFileInfo Class Reference

#include <XrdXrootdGPFile.hh>

List of all members.

Public Types

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

Public Member Functions

bool Completed (const char *eMsg=0, int eNum=0)
 XrdXrootdGPFileInfo (XrdXrootdGPFAgent &gpf)
 ~XrdXrootdGPFileInfo ()

Public Attributes

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

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

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 ( XrdXrootdGPFAgent &  gpf  )  [inline]
XrdXrootdGPFileInfo::~XrdXrootdGPFileInfo (  )  [inline]

Member Function Documentation

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.

Member Data Documentation

Checksum type or nil if none wanted.

Checksum value or nil if none wanted.

Destination specification (path or URL).

XrdXrootdGPFAgent& XrdXrootdGPFileInfo::gpfAgent [private]

Seconds between ping call to Update().

Source specification (path or URL).

Source cgi or nil if none.

Destination cgi or nil if none.

Number of parallel streams (0 -> default).

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.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 7 Jul 2020 for xrootd by  doxygen 1.6.1