XrdSfsDirectory Class Reference

#include <XrdSfsInterface.hh>

Inheritance diagram for XrdSfsDirectory:
Inheritance graph
[legend]
Collaboration diagram for XrdSfsDirectory:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual int open (const char *path, const XrdSecEntity *client=0, const char *opaque=0)=0
virtual const char * nextEntry ()=0
virtual int close ()=0
virtual const char * FName ()=0
virtual int autoStat (struct stat *buf)
 XrdSfsDirectory (const char *user=0, int MonID=0)
 XrdSfsDirectory (XrdSfsDirectory &wrapD)
 XrdSfsDirectory (XrdOucErrInfo &eInfo)
virtual ~XrdSfsDirectory ()
 Destructor.

Public Attributes

XrdOucErrInfoerror

Private Attributes

XrdOucErrInfolclEI

Detailed Description

The XrdSfsDirectory object is returned by XrdSfsFileSystem::newFile() when the caller wants to be able to perform directory oriented operations.


Constructor & Destructor Documentation

XrdSfsDirectory::XrdSfsDirectory ( const char *  user = 0,
int  MonID = 0 
) [inline]

Constructor (user and MonID are the ones passed to newDir()!). This constructor should only be used by base plugins. Plugins that wrap an SfsDirectory should use the second version of the constructor shown below.

Parameters:
user - Text identifying the client responsible for this call. The pointer may be null if identification is missing.
MonID - The monitoring identifier assigned to this and all future requests using the returned object.

References error, and lclEI.

XrdSfsDirectory::XrdSfsDirectory ( XrdSfsDirectory wrapD  )  [inline]

Constructor for plugins that wrap another SfsDirectory. This constructor inherits the error object from a wrapped SfsDirectory object so that only one identical error object exists for all directory objects in the chain.

Parameters:
wrapD - Reference to the directory object being wrapped.
XrdSfsDirectory::XrdSfsDirectory ( XrdOucErrInfo eInfo  )  [inline]

Constructor for base plugins that predefined an error object. This is a convenience constructor for base plugins only.

Parameters:
eInfo - Reference to the error object to use.
virtual XrdSfsDirectory::~XrdSfsDirectory (  )  [inline, virtual]

Destructor.

References lclEI.


Member Function Documentation

virtual int XrdSfsDirectory::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.

Reimplemented in XrdDigDirectory, XrdOfsDirectory, and XrdSsiDir.

virtual int XrdSfsDirectory::close (  )  [pure virtual]

Close the directory.

Returns:
One of SFS_OK or SFS_ERROR

Implemented in XrdBwmDirectory, XrdDigDirectory, XrdOfsDirectory, XrdSfsNativeDirectory, and XrdSsiDir.

virtual const char* XrdSfsDirectory::FName (  )  [pure virtual]

Get the directory path.

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

Implemented in XrdBwmDirectory, XrdDigDirectory, XrdOfsDirectory, XrdSfsNativeDirectory, and XrdSsiDir.

virtual const char* XrdSfsDirectory::nextEntry (  )  [pure 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).

Implemented in XrdBwmDirectory, XrdDigDirectory, XrdOfsDirectory, XrdSfsNativeDirectory, and XrdSsiDir.

virtual int XrdSfsDirectory::open ( const char *  path,
const XrdSecEntity client = 0,
const char *  opaque = 0 
) [pure 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

Implemented in XrdBwmDirectory, XrdOfsDirectory, and XrdSsiDir.


Member Data Documentation

The error object is used to return details whenever something other than SFS_OK is returned from the methods in this class, when noted.

Referenced by XrdSsiDir::copyError(), XrdOfsDirectory::copyError(), XrdBwmDirectory::copyError(), and XrdSfsDirectory().


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 7 Jul 2020 for xrootd by  doxygen 1.6.1