XrdOssDir Class Reference

#include <XrdOssApi.hh>

Inheritance diagram for XrdOssDir:

Collaboration diagram for XrdOssDir:

Public Member Functions
int	Close (long long *retsz=0)
int	Opendir (const char *, XrdOucEnv &)
int	Readdir (char *buff, int blen)
int	StatRet (struct stat *buff)
int	getFD ()
	XrdOssDir (const char *tid, DIR *dP=0)
	~XrdOssDir ()
Public Member Functions inherited from XrdOssDF
virtual int	Fchmod (mode_t mode)
virtual void	Flush ()
	Flush filesystem cached pages for this file (used for checksums).
virtual int	Fstat (struct stat *buf)
virtual int	Fsync ()
virtual int	Fsync (XrdSfsAio *aiop)
virtual int	Ftruncate (unsigned long long flen)
virtual off_t	getMmap (void **addr)
virtual int	isCompressed (char *cxidp=0)
virtual int	Open (const char *path, int Oflag, mode_t Mode, XrdOucEnv &env)
virtual ssize_t	pgRead (void *buffer, off_t offset, size_t rdlen, uint32_t *csvec, uint64_t opts)
virtual int	pgRead (XrdSfsAio *aioparm, uint64_t opts)
virtual ssize_t	pgWrite (void *buffer, off_t offset, size_t wrlen, uint32_t *csvec, uint64_t opts)
virtual int	pgWrite (XrdSfsAio *aioparm, uint64_t opts)
virtual ssize_t	Read (off_t offset, size_t size)
virtual ssize_t	Read (void *buffer, off_t offset, size_t size)
virtual int	Read (XrdSfsAio *aiop)
virtual ssize_t	ReadRaw (void *buffer, off_t offset, size_t size)
virtual ssize_t	ReadV (XrdOucIOVec *readV, int rdvcnt)
virtual ssize_t	Write (const void *buffer, off_t offset, size_t size)
virtual int	Write (XrdSfsAio *aiop)
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 const char *	getTID ()
	XrdOssDF (const char *tid="", uint16_t dftype=0, int fdnum=-1)
virtual	~XrdOssDF ()

Private Attributes
DIR *	lclfd
void *	mssfd
struct stat *	Stat
bool	ateof
bool	isopen
unsigned char	dOpts

Static Private Attributes
static const int	isStage = 0x01
static const int	noCheck = 0x02
static const int	noDread = 0x04

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

XrdOssDir()

XrdOssDir::XrdOssDir ( const char *  tid, DIR *  dP = 0  )

inline

References XrdOssDF::fd.

~XrdOssDir()

XrdOssDir::~XrdOssDir ( )

inline

References Close(), and isopen.

Member Function Documentation

Close()

int XrdOssDir::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 ~XrdOssDir().

getFD()

int XrdOssDir::getFD ( )

inlinevirtual

Return the underlying file descriptor.

Returns

-1 if there is no file descriptor or a non-negative FD number.

Reimplemented from XrdOssDF.

References XrdOssDF::fd.

Opendir()

int XrdOssDir::Opendir ( const char *  path, XrdOucEnv &  env  )

virtual

Open a directory.

Parameters

path	- Pointer to the path of the directory to be opened.
env	- Reference to environmental information.

Returns

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

Reimplemented from XrdOssDF.

Readdir()

int XrdOssDir::Readdir ( char *  buff, int  blen  )

virtual

Get the next directory entry.

Parameters

buff	- Pointer to buffer where a null terminated string of the entry name is to be returned. If no more entries exist, a null string is returned.
blen	- Length of the buffer.

Returns

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

Reimplemented from XrdOssDF.

StatRet()

int XrdOssDir::StatRet ( struct stat *  buff )

virtual

Set the stat() buffer where stat information is to be placed corresponding to the directory entry returned by Readdir().

Parameters

buff	- Pointer to stat structure to be used.

Returns

0 upon success or -ENOTSUP if not supported.

Note

This is a one-time call as stat structure is reused for each Readdir.

When StatRet() is in effect, directory entries that have been deleted from the target directory are quietly skipped.

Reimplemented from XrdOssDF.

Member Data Documentation

ateof

bool XrdOssDir::ateof

private

dOpts

unsigned char XrdOssDir::dOpts

private

isopen

bool XrdOssDir::isopen

private

Referenced by ~XrdOssDir().

isStage

const int XrdOssDir::isStage = 0x01

staticprivate

lclfd

DIR* XrdOssDir::lclfd

private

mssfd

void* XrdOssDir::mssfd

private

noCheck

const int XrdOssDir::noCheck = 0x02

staticprivate

noDread

const int XrdOssDir::noDread = 0x04

staticprivate

Stat

struct stat* XrdOssDir::Stat

private

---

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

• XrdOssApi.hh