XrdOfsDirectory Class Reference

#include <XrdOfs.hh>

Inheritance diagram for XrdOfsDirectory:

Collaboration diagram for XrdOfsDirectory:

Public Member Functions
int	open (const char *dirName, const XrdSecEntity *client, const char *opaque=0)
const char *	nextEntry ()
int	close ()
void	copyError (XrdOucErrInfo &einfo)
const char *	FName ()
int	autoStat (struct stat *buf)
	XrdOfsDirectory (XrdOucErrInfo &eInfo, const char *user)
virtual	~XrdOfsDirectory ()
Public Member Functions inherited from XrdSfsDirectory
	XrdSfsDirectory (const char *user=0, int MonID=0)
	XrdSfsDirectory (XrdSfsDirectory &wrapD)
	XrdSfsDirectory (XrdOucErrInfo &eInfo)
virtual	~XrdSfsDirectory ()
	Destructor.

Protected Attributes
const char *	tident
char *	fname
XrdOssDF *	dp
int	atEOF
char	dname [MAXNAMLEN]

Additional Inherited Members
Public Attributes inherited from XrdSfsDirectory
XrdOucErrInfo &	error

Constructor & Destructor Documentation

XrdOfsDirectory()

XrdOfsDirectory::XrdOfsDirectory ( XrdOucErrInfo &  eInfo, const char *  user  )

inline

~XrdOfsDirectory()

virtual XrdOfsDirectory::~XrdOfsDirectory ( )

inlinevirtual

References close(), and dp.

Member Function Documentation

autoStat()

int XrdOfsDirectory::autoStat ( struct stat *  buf )

virtual

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

Returns

If supported, SFS_OK should be returned. If not supported, then SFS_ERROR should be returned with error.code set to ENOTSUP.

Note

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

Reimplemented from XrdSfsDirectory.

close()

int XrdOfsDirectory::close ( )

virtual

Close the directory.

Returns

One of SFS_OK or SFS_ERROR

Implements XrdSfsDirectory.

Referenced by ~XrdOfsDirectory().

copyError()

void XrdOfsDirectory::copyError ( XrdOucErrInfo &  einfo )

inline

References XrdSfsDirectory::error.

FName()

const char * XrdOfsDirectory::FName ( )

inlinevirtual

Get the directory path.

Returns

Null terminated string of the path used in open().

Implements XrdSfsDirectory.

References fname.

nextEntry()

const char * XrdOfsDirectory::nextEntry ( )

virtual

Get the next directory entry.

Returns

A null terminated string with the directory name. Normally, "." ".." are not returned. If a null pointer is returned then if this is due to an error, error.code should contain errno. Otherwise, error.code should contain zero to indicate that no more entries exist (i.e. end of list). See autoStat() for additional caveats.

Implements XrdSfsDirectory.

open()

int XrdOfsDirectory::open ( const char *  path, const XrdSecEntity *  client, const char *  opaque = 0  )

virtual

Open a directory.

Parameters

path	- Pointer to the path of the directory to be opened.
client	- Client's identify (see common description).
opaque	- path's CGI information (see common description).

Returns

One of SFS_OK, SFS_ERROR, SFS_REDIRECT, ir SFS_STALL

Implements XrdSfsDirectory.

Member Data Documentation

atEOF

int XrdOfsDirectory::atEOF

protected

dname

char XrdOfsDirectory::dname[MAXNAMLEN]

protected

dp

XrdOssDF* XrdOfsDirectory::dp

protected

Referenced by ~XrdOfsDirectory().

fname

char* XrdOfsDirectory::fname

protected

Referenced by FName().

tident

const char* XrdOfsDirectory::tident

protected

---

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

• XrdOfs.hh