#include <XrdPss.hh>

Inheritance diagram for XrdPssFile:

Collaboration diagram for XrdPssFile:

[legend]

Classes
struct	tprInfo

Public Member Functions
virtual int	Close (long long *retsz=0)

virtual int	Open (const char *, int, mode_t, XrdOucEnv &)

int	Fchmod (mode_t mode)

int	Fstat (struct stat *)

int	Fsync ()

int	Fsync (XrdSfsAio *aiop)

int	Ftruncate (unsigned long long)

ssize_t	pgRead (void buffer, off_t offset, size_t rdlen, uint32_t csvec, uint64_t opts)

int	pgRead (XrdSfsAio *aioparm, uint64_t opts)

ssize_t	pgWrite (void buffer, off_t offset, size_t wrlen, uint32_t csvec, uint64_t opts)

int	pgWrite (XrdSfsAio *aioparm, uint64_t opts)

ssize_t	Read (off_t, size_t)

ssize_t	Read (void *, off_t, size_t)

int	Read (XrdSfsAio *aiop)

ssize_t	ReadV (XrdOucIOVec *readV, int n)

ssize_t	ReadRaw (void *, off_t, size_t)

ssize_t	Write (const void *, off_t, size_t)

int	Write (XrdSfsAio *aiop)

	XrdPssFile (const char *tid)

virtual	~XrdPssFile ()

Public Member Functions inherited from XrdOssDF
virtual int	Opendir (const char *path, XrdOucEnv &env)

virtual int	Readdir (char *buff, int blen)

virtual int	StatRet (struct stat *buff)

virtual void	Flush ()
	Flush filesystem cached pages for this file (used for checksums).

virtual off_t	getMmap (void **addr)

virtual int	isCompressed (char *cxidp=0)

virtual ssize_t	WriteV (XrdOucIOVec *writeV, int wrvcnt)

uint16_t	DFType ()

virtual int	Fctl (int cmd, int alen, const char args, char *resp=0)

virtual int	getFD ()

virtual const char *	getTID ()

	XrdOssDF (const char *tid="", uint16_t dftype=0, int fdnum=-1)

virtual	~XrdOssDF ()

Private Attributes
struct XrdPssFile::tprInfo *	rpInfo

char *	tpcPath

const XrdSecEntity *	entity

Additional Inherited Members
Static Public Attributes inherited from XrdOssDF
static const uint64_t	Verify = 0x8000000000000000ULL
	all: Verify checksums

static const uint64_t	doCalc = 0x4000000000000000ULL
	pgw: Calculate checksums

static const uint16_t	DF_isDir = 0x0001
	Object is for a directory.

static const uint16_t	DF_isFile = 0x0002
	Object is for a file.

static const uint16_t	DF_isProxy = 0x0010
	Object is a proxy object.

static const int	Fctl_ckpObj = 0

static const int	Fctl_utimes = 1

Protected Attributes inherited from XrdOssDF
const char *	tident

off_t	pgwEOF

int	fd

uint16_t	dfType

short	rsvd

Constructor & Destructor Documentation

◆ XrdPssFile()

XrdPssFile::XrdPssFile ( const char * tid )

inline

◆ ~XrdPssFile()

virtual XrdPssFile::~XrdPssFile ( )

inlinevirtual

References Close(), XrdOssDF::fd, rpInfo, and tpcPath.

Member Function Documentation

◆ Close()

virtual int XrdPssFile::Close ( long long * retsz = 0 )

virtual

Close a directory or file.

Parameters

retsz If not nil, where the size of the file is to be returned.

Returns: 0 upon success or -errno or -osserr (see XrdOssError.hh).

Implements XrdOssDF.

Referenced by ~XrdPssFile().

◆ Fchmod()

int XrdPssFile::Fchmod ( mode_t mode )

inlinevirtual

Change file mode settings.

Parameters

mode	- The new file mode setting.

Returns: 0 upon success or -errno or -osserr (see XrdOssError.hh).

Reimplemented from XrdOssDF.

References XrdOssOK.

◆ Fstat()

int XrdPssFile::Fstat ( struct stat * buf )

virtual

Return state information for this file.

Parameters

buf	- Pointer to the structure where info it to be returned.

Returns: 0 upon success or -errno or -osserr (see XrdOssError.hh).

Reimplemented from XrdOssDF.

◆ Fsync() [1/2]

int XrdPssFile::Fsync ( void )

virtual

Synchronize associated file with media (synchronous).

Returns: 0 upon success or -errno or -osserr (see XrdOssError.hh).

Reimplemented from XrdOssDF.

◆ Fsync() [2/2]

int XrdPssFile::Fsync ( XrdSfsAio * aiop )

virtual

Synchronize associated file with media (asynchronous).

Parameters

aiop	- Pointer to async I/O request object.

Returns: 0 upon success or -errno or -osserr (see XrdOssError.hh).

Reimplemented from XrdOssDF.

◆ Ftruncate()

int XrdPssFile::Ftruncate ( unsigned long long flen )

virtual

Set the size of the associated file.

Parameters

flen	- The new size of the file.

Returns: 0 upon success or -errno or -osserr (see XrdOssError.hh).

Reimplemented from XrdOssDF.

◆ Open()

virtual int XrdPssFile::Open	(	const char *	path,
		int	Oflag,
		mode_t	Mode,
		XrdOucEnv &	env
	)

virtual

Open a file.

Parameters

path	- Pointer to the path of the file to be opened.
Oflag	- Standard open flags.
Mode	- File open mode (ignored unless creating a file).
env	- Reference to environmental information.

Returns: 0 upon success or -errno or -osserr (see XrdOssError.hh).

Reimplemented from XrdOssDF.

◆ pgRead() [1/2]

ssize_t XrdPssFile::pgRead	(	void *	buffer,
		off_t	offset,
		size_t	rdlen,
		uint32_t *	csvec,
		uint64_t	opts
	)

virtual

Reimplemented from XrdOssDF.

◆ pgRead() [2/2]

int XrdPssFile::pgRead	(	XrdSfsAio *	aioparm,
		uint64_t	opts
	)

virtual

Read file pages and checksums using asynchronous I/O.

Parameters

aioparm	- Pointer to async I/O object controlling the I/O.
opts	- Processing options (see above).

Returns: 0 upon if request started success or -errno or -osserr (see XrdOssError.hh).

Reimplemented from XrdOssDF.

◆ pgWrite() [1/2]

ssize_t XrdPssFile::pgWrite	(	void *	buffer,
		off_t	offset,
		size_t	wrlen,
		uint32_t *	csvec,
		uint64_t	opts
	)

virtual

Write file pages into a file with corresponding checksums.

Parameters

buffer	- pointer to buffer containing the bytes to write.
offset	- The offset where the write is to start.
wrlen	- The number of bytes to write.
csvec	- A vector which contains the corresponding CRC32 checksum for each page. See XrdOucPgrwUtils::csNum() for sizing.
opts	- Processing options (see above).

Returns: >= 0 The number of bytes written upon success. or -errno or -osserr upon failure. (see XrdOssError.hh).; < 0 -errno or -osserr upon failure. (see XrdOssError.hh).

Reimplemented from XrdOssDF.

◆ pgWrite() [2/2]

int XrdPssFile::pgWrite	(	XrdSfsAio *	aioparm,
		uint64_t	opts
	)

virtual

Write file pages and checksums using asynchronous I/O.

Parameters

aioparm	- Pointer to async I/O object controlling the I/O.
opts	- Processing options (see above).

Returns: 0 upon if request started success or -errno or -osserr (see XrdOssError.hh).

Reimplemented from XrdOssDF.

◆ Read() [1/3]

ssize_t XrdPssFile::Read	(	off_t	offset,
		size_t	size
	)

virtual

Preread file blocks into the file system cache.

Parameters

offset	- The offset where the read is to start.
size	- The number of bytes to pre-read.

Returns: 0 upon success or -errno or -osserr (see XrdOssError.hh).

Reimplemented from XrdOssDF.

◆ Read() [2/3]

ssize_t XrdPssFile::Read	(	void *	buffer,
		off_t	offset,
		size_t	size
	)

virtual

Read file bytes into a buffer.

Parameters

buffer	- pointer to buffer where the bytes are to be placed.
offset	- The offset where the read is to start.
size	- The number of bytes to read.

Returns: >= 0 The number of bytes that placed in buffer.; < 0 -errno or -osserr upon failure (see XrdOssError.hh).

Reimplemented from XrdOssDF.

◆ Read() [3/3]

int XrdPssFile::Read ( XrdSfsAio * aiop )

virtual

Read file bytes using asynchronous I/O.

Parameters

aiop	- Pointer to async I/O object controlling the I/O.

Returns: 0 upon if request started success or -errno or -osserr (see XrdOssError.hh).

Reimplemented from XrdOssDF.

◆ ReadRaw()

ssize_t XrdPssFile::ReadRaw	(	void *	buffer,
		off_t	offset,
		size_t	size
	)

virtual

Read uncompressed file bytes into a buffer.

Parameters

buffer	- pointer to buffer where the bytes are to be placed.
offset	- The offset where the read is to start.
size	- The number of bytes to read.

Returns: >= 0 The number of bytes that placed in buffer.; < 0 -errno or -osserr upon failure (see XrdOssError.hh).

Reimplemented from XrdOssDF.

◆ ReadV()

ssize_t XrdPssFile::ReadV	(	XrdOucIOVec *	readV,
		int	rdvcnt
	)

virtual

Read file bytes as directed by the read vector.

Parameters

readV	pointer to the array of read requests.
rdvcnt	the number of elements in readV.

Returns: >=0 The numbe of bytes read.; < 0 -errno or -osserr upon failure (see XrdOssError.hh).

Reimplemented from XrdOssDF.

◆ Write() [1/2]

ssize_t XrdPssFile::Write	(	const void *	buffer,
		off_t	offset,
		size_t	size
	)

virtual

Write file bytes from a buffer.

Parameters

buffer	- pointer to buffer where the bytes reside.
offset	- The offset where the write is to start.
size	- The number of bytes to write.

Returns: >= 0 The number of bytes that were written.; < 0 -errno or -osserr upon failure (see XrdOssError.hh).

Reimplemented from XrdOssDF.

◆ Write() [2/2]

int XrdPssFile::Write ( XrdSfsAio * aiop )

virtual

Write file bytes using asynchronous I/O.

Parameters

aiop	- Pointer to async I/O object controlling the I/O.

Returns: 0 upon if request started success or -errno or -osserr (see XrdOssError.hh).

Reimplemented from XrdOssDF.

Member Data Documentation

◆ entity

const XrdSecEntity* XrdPssFile::entity

private

◆ rpInfo

struct XrdPssFile::tprInfo * XrdPssFile::rpInfo

private

Referenced by ~XrdPssFile().

◆ tpcPath

char* XrdPssFile::tpcPath

private

Referenced by ~XrdPssFile().

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

XrdPss.hh

Classes

Public Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ XrdPssFile()

◆ ~XrdPssFile()

Member Function Documentation

◆ Close()

◆ Fchmod()

◆ Fstat()

◆ Fsync() [1/2]

◆ Fsync() [2/2]

◆ Ftruncate()

◆ Open()

◆ pgRead() [1/2]

◆ pgRead() [2/2]

◆ pgWrite() [1/2]

◆ pgWrite() [2/2]

◆ Read() [1/3]

◆ Read() [2/3]

◆ Read() [3/3]

◆ ReadRaw()

◆ ReadV()

◆ Write() [1/2]

◆ Write() [2/2]

Member Data Documentation

◆ entity

◆ rpInfo

◆ tpcPath