XrdSfsGPFile Class Reference

#include <XrdSfsGPFile.hh>

Collaboration diagram for XrdSfsGPFile:

Public Types
enum	GPFState {   gpfPend = 0 ,   gpfXfr ,   gpfCSV }

Public Member Functions
	XrdSfsGPFile (const char *tid="")
	Constructor and Destructor.
virtual	~XrdSfsGPFile ()
virtual void	Finished (int rc, const char *emsg=0)=0
virtual void	Status (GPFState state, uint32_t cpct, uint64_t bytes)=0

Public Attributes
union {
uint32_t	gpfID
	Can be used by the implementation.
XrdSfsGPInfo *	gpfInfo
	Can be used by the implementation.
};
const char *	csType
	Checksum type.
const char *	csVal
	Checksum value as a hex string.
const char *	dst
	get: local path, put: full URL
const char *	lclCGI
	The CGI, if any, for the local path.
uint16_t	opts
	Options as defined below.
uint8_t	pingsec
	Seconds between calls to Update() (0 -> no calls)
uint16_t	rsvd1
uint8_t	rsvd2
void *	rsvd3
	Reserved field.
uint8_t	sources
	Number of parallel sources (0 -> default)
const char *	src
	get: full URL, put: local path
uint8_t	streams
	Number of parallel streams (0 -> default)
const char *	tident
	Trace identifier.

Static Public Attributes
static const uint16_t	delegate = 0x0008
	Use delegation.
static const uint16_t	keepErr = 0x0004
	Keep file after request failure.
static const uint16_t	mkPath = 0x0002
	Create destination path.
static const uint16_t	replace = 0x0001
	Replace existing file.
static const uint16_t	useTLS = 0x0080
	Use TLS for the data path.
static const uint16_t	verCKS = 0x0040
	Verify checksum after transfer.

Detailed Description

Definition at line 36 of file XrdSfsGPFile.hh.

Member Enumeration Documentation

GPFState

enum XrdSfsGPFile::GPFState

Provide request status. Only recursive locks should be held, if any.

Parameters

state	- One of the enums listed indicating the request state.
cpct	- Percentage (0 to 100) of completion.
bytes	- Number of bytes processed in the indicated state.

Enumerator
gpfPend	Request is pending.
gpfXfr	Request is transfering data.
gpfCSV	Request is doing checksum validation.

Definition at line 91 of file XrdSfsGPFile.hh.

              {gpfPend = 0,  
               gpfXfr,       
               gpfCSV        
              };

Constructor & Destructor Documentation

XrdSfsGPFile()

XrdSfsGPFile::XrdSfsGPFile ( const char *  tid = "" )

inline

Constructor and Destructor.

Definition at line 102 of file XrdSfsGPFile.hh.

                         : opts(0),    rsvd1(0),
                           pingsec(0), sources(0), streams(0),  rsvd2(0),
                           gpfInfo(0), src(0),     dst(0),      lclCGI(0),
                           csType(0),  csVal(0),   tident(tid), rsvd3(0) {}

~XrdSfsGPFile()

virtual XrdSfsGPFile::~XrdSfsGPFile ( )

inlinevirtual

Definition at line 107 of file XrdSfsGPFile.hh.

{}

Member Function Documentation

Finished()

virtual void XrdSfsGPFile::Finished ( int  rc, const char *  emsg = 0  )

pure virtual

Indicate the request has finished.

Parameters

rc	- the final return code. A value of zero indicates success. A non-zero value should be the errno value corresponding to the reason for the failure.
emsg	- An optional message further explaining the reason for the failure (highly recommended).

No value is returned but this object is deleted and no references to the object should exist after return is made.

Status()

virtual void XrdSfsGPFile::Status ( GPFState  state, uint32_t  cpct, uint64_t  bytes  )

pure virtual

Member Data Documentation

[union]

union { ... } XrdSfsGPFile

csType

const char* XrdSfsGPFile::csType

Checksum type.

Definition at line 62 of file XrdSfsGPFile.hh.

csVal

const char* XrdSfsGPFile::csVal

Checksum value as a hex string.

Definition at line 63 of file XrdSfsGPFile.hh.

delegate

const uint16_t XrdSfsGPFile::delegate = 0x0008

static

Use delegation.

Definition at line 41 of file XrdSfsGPFile.hh.

dst

const char* XrdSfsGPFile::dst

get: local path, put: full URL

Definition at line 60 of file XrdSfsGPFile.hh.

keepErr

const uint16_t XrdSfsGPFile::keepErr = 0x0004

static

Keep file after request failure.

Definition at line 42 of file XrdSfsGPFile.hh.

lclCGI

const char* XrdSfsGPFile::lclCGI

The CGI, if any, for the local path.

Definition at line 61 of file XrdSfsGPFile.hh.

mkPath

const uint16_t XrdSfsGPFile::mkPath = 0x0002

static

Create destination path.

Definition at line 43 of file XrdSfsGPFile.hh.

opts

uint16_t XrdSfsGPFile::opts

Options as defined below.

Definition at line 40 of file XrdSfsGPFile.hh.

pingsec

uint8_t XrdSfsGPFile::pingsec

Seconds between calls to Update() (0 -> no calls)

Definition at line 49 of file XrdSfsGPFile.hh.

replace

const uint16_t XrdSfsGPFile::replace = 0x0001

static

Replace existing file.

Definition at line 44 of file XrdSfsGPFile.hh.

rsvd1

uint16_t XrdSfsGPFile::rsvd1

Definition at line 48 of file XrdSfsGPFile.hh.

rsvd2

uint8_t XrdSfsGPFile::rsvd2

Definition at line 52 of file XrdSfsGPFile.hh.

rsvd3

void* XrdSfsGPFile::rsvd3

Reserved field.

Definition at line 66 of file XrdSfsGPFile.hh.

sources

uint8_t XrdSfsGPFile::sources

Number of parallel sources (0 -> default)

Definition at line 50 of file XrdSfsGPFile.hh.

src

const char* XrdSfsGPFile::src

get: full URL, put: local path

Definition at line 59 of file XrdSfsGPFile.hh.

streams

uint8_t XrdSfsGPFile::streams

Number of parallel streams (0 -> default)

Definition at line 51 of file XrdSfsGPFile.hh.

tident

const char* XrdSfsGPFile::tident

Trace identifier.

Definition at line 64 of file XrdSfsGPFile.hh.

useTLS

const uint16_t XrdSfsGPFile::useTLS = 0x0080

static

Use TLS for the data path.

Definition at line 45 of file XrdSfsGPFile.hh.

verCKS

const uint16_t XrdSfsGPFile::verCKS = 0x0040

static

Verify checksum after transfer.

Definition at line 46 of file XrdSfsGPFile.hh.

---

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

• XrdSfsGPFile.hh