XrdSfsGPFile Class Reference

#include <XrdSfsGPFile.hh>

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

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

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

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.

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.

Constructor & Destructor Documentation

XrdSfsGPFile()

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

inline

Constructor and Destructor.

~XrdSfsGPFile()

virtual XrdSfsGPFile::~XrdSfsGPFile ( )

inlinevirtual

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.

csVal

const char* XrdSfsGPFile::csVal

Checksum value as a hex string.

delegate

const uint16_t XrdSfsGPFile::delegate = 0x0008

static

Use delegation.

dst

const char* XrdSfsGPFile::dst

get: local path, put: full URL

gpfID

uint32_t XrdSfsGPFile::gpfID

Can be used by the implementation.

gpfInfo

XrdSfsGPInfo* XrdSfsGPFile::gpfInfo

Can be used by the implementation.

keepErr

const uint16_t XrdSfsGPFile::keepErr = 0x0004

static

Keep file after request failure.

lclCGI

const char* XrdSfsGPFile::lclCGI

The CGI, if any, for the local path.

mkPath

const uint16_t XrdSfsGPFile::mkPath = 0x0002

static

Create destination path.

opts

uint16_t XrdSfsGPFile::opts

Options as defined below.

pingsec

uint8_t XrdSfsGPFile::pingsec

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

replace

const uint16_t XrdSfsGPFile::replace = 0x0001

static

Replace existing file.

rsvd1

uint16_t XrdSfsGPFile::rsvd1

rsvd2

uint8_t XrdSfsGPFile::rsvd2

rsvd3

void* XrdSfsGPFile::rsvd3

Reserved field.

sources

uint8_t XrdSfsGPFile::sources

Number of parallel sources (0 -> default)

src

const char* XrdSfsGPFile::src

get: full URL, put: local path

streams

uint8_t XrdSfsGPFile::streams

Number of parallel streams (0 -> default)

tident

const char* XrdSfsGPFile::tident

Trace identifier.

useTLS

const uint16_t XrdSfsGPFile::useTLS = 0x0080

static

Use TLS for the data path.

verCKS

const uint16_t XrdSfsGPFile::verCKS = 0x0040

static

Verify checksum after transfer.

---

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

• XrdSfsGPFile.hh