XrdOfsDirectory Class Reference

#include <XrdOfs.hh>

Inheritance diagram for XrdOfsDirectory:

Collaboration diagram for XrdOfsDirectory:

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

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

Additional Inherited Members
Public Attributes inherited from XrdSfsDirectory
XrdOucErrInfo &	error

Detailed Description

Definition at line 63 of file XrdOfs.hh.

Constructor & Destructor Documentation

XrdOfsDirectory()

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

inline

Definition at line 81 of file XrdOfs.hh.

                          : XrdSfsDirectory(eInfo), tident(user ? user : ""),
                            fname(0), dp(0), atEOF(0) {}

References XrdSfsDirectory::XrdSfsDirectory(), atEOF, dp, fname, and tident.

Referenced by XrdOfsDirFull::XrdOfsDirFull().

Here is the call graph for this function:

Here is the caller graph for this function:

~XrdOfsDirectory()

virtual XrdOfsDirectory::~XrdOfsDirectory ( )

inlinevirtual

Definition at line 85 of file XrdOfs.hh.

{if (dp) close();}

References close(), and dp.

Here is the call graph for this function:

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.

Definition at line 422 of file XrdOfs.cc.

{
   EPNAME("autoStat");
   int retc;
 
// Check if this directory is actually open
//
   if (!dp) {XrdOfsFS->Emsg(epname, error, EBADF, "autostat directory");
             return SFS_ERROR;
            }
 
// Set the stat buffer in the storage system directory but don't complain.
//
    if ((retc = dp->StatRet(buf))) return retc;
    return SFS_OK;
}

References dp, EPNAME, XrdSfsDirectory::error, SFS_ERROR, SFS_OK, stat, and XrdOfsFS.

close()

int XrdOfsDirectory::close ( )

virtual

Close the directory.

Returns

One of SFS_OK or SFS_ERROR

Implements XrdSfsDirectory.

Definition at line 376 of file XrdOfs.cc.

{
   EPNAME("closedir");
   int retc;
 
// Check if this directory is actually open
//
   if (!dp) {XrdOfsFS->Emsg(epname, error, EBADF, "close directory");
             return SFS_ERROR;
            }
   XTRACE(closedir, fname, "");
 
// Close this directory
//
    if ((retc = dp->Close()))
      {std::string eText;
       const char* etP = 0;
       if (XrdOfsFS->tryXERT && dp->getErrMsg(eText)) etP = eText.c_str();
       retc = XrdOfsFS->Emsg(epname, error, retc, "close", fname, etP);
      }  else retc = SFS_OK;
 
// All done
//
   delete dp;
   dp = 0;
   free(fname);
   fname = 0;
   return retc;
}

References closedir, dp, EPNAME, XrdSfsDirectory::error, fname, SFS_ERROR, SFS_OK, XrdOfsFS, and XTRACE.

Referenced by ~XrdOfsDirectory().

Here is the caller graph for this function:

copyError()

void XrdOfsDirectory::copyError ( XrdOucErrInfo & einfo )

inline

Definition at line 75 of file XrdOfs.hh.

{einfo = error;}

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.

Definition at line 77 of file XrdOfs.hh.

{return (const char *)fname;}

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.

Definition at line 313 of file XrdOfs.cc.

{
   EPNAME("readdir");
   int retc;
 
// Check if this directory is actually open
//
   if (!dp) {XrdOfsFS->Emsg(epname, error, EBADF, "read directory");
             return 0;
            }
 
// Check if we are at EOF (once there we stay there)
//
   if (atEOF) return 0;
 
// Read the next directory entry
//
   if ((retc = dp->Readdir(dname, sizeof(dname))) < 0)
      {std::string eText;
       const char* etP = 0;
       if (XrdOfsFS->tryXERT && dp->getErrMsg(eText)) etP = eText.c_str();
       XrdOfsFS->Emsg(epname, error, retc, "read directory", fname, etP);
       return 0;
      }
 
// Check if we have reached end of file
//
   if (!*dname)
      {atEOF = 1;
       error.clear();
       XTRACE(readdir, fname, "<eof>");
       return 0;
      }
 
// Return the actual entry
//
   XTRACE(readdir, fname, dname);
   return (const char *)(dname);
}

References atEOF, dname, dp, EPNAME, XrdSfsDirectory::error, fname, readdir, XrdOfsFS, and XTRACE.

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.

Definition at line 245 of file XrdOfs.cc.

{
   EPNAME("opendir");
   static const int od_mode = SFS_O_RDONLY|SFS_O_META;
   XrdOucEnv Open_Env(info,0,client);
   int retc;
 
// Trace entry
//
   XTRACE(opendir, dir_path, "");
 
// Verify that this object is not already associated with an open directory
//
   if (dp) return
      XrdOfsFS->Emsg(epname, error, EADDRINUSE, "open directory", dir_path);
 
// Apply security, as needed
//
   AUTHORIZE(client,&Open_Env,AOP_Readdir,"open directory",dir_path,error);
 
// Find out where we should open this directory
//
   if (XrdOfsFS->DirRdr && XrdOfsFS->Finder && XrdOfsFS->Finder->isRemote()
   &&  (retc = XrdOfsFS->Finder->Locate(error, dir_path, od_mode, &Open_Env)))
      return XrdOfsFS->fsError(error, retc);
 
// Open the directory and allocate a handle for it
//
   if (!(dp = XrdOfsOss->newDir(tident))) retc = -ENOMEM;
      else if (!(retc = dp->Opendir(dir_path, Open_Env)))
              {fname = strdup(dir_path);
               return SFS_OK;
              }
 
// Handle extended error information
//
   std::string eText;
   const char* etP = 0;
   if (dp && XrdOfsFS->tryXERT)
      {if (dp->getErrMsg(eText)) etP = eText.c_str();
       delete dp; dp = 0;
      }
 
// Encountered an error
//
   return XrdOfsFS->Emsg(epname, error, retc, "open directory", dir_path, etP);
}

References AOP_Readdir, AUTHORIZE, dp, EPNAME, XrdSfsDirectory::error, fname, opendir, SFS_O_META, SFS_O_RDONLY, SFS_OK, tident, XrdOfsFS, XrdOfsOss, and XTRACE.

Member Data Documentation

atEOF

int XrdOfsDirectory::atEOF

protected

Definition at line 91 of file XrdOfs.hh.

Referenced by XrdOfsDirectory(), and nextEntry().

dname

char XrdOfsDirectory::dname[MAXNAMLEN]

protected

Definition at line 92 of file XrdOfs.hh.

Referenced by nextEntry().

dp

XrdOssDF* XrdOfsDirectory::dp

protected

Definition at line 90 of file XrdOfs.hh.

Referenced by XrdOfsDirectory(), ~XrdOfsDirectory(), autoStat(), close(), nextEntry(), and open().

fname

char* XrdOfsDirectory::fname

protected

Definition at line 89 of file XrdOfs.hh.

Referenced by XrdOfsDirectory(), close(), FName(), nextEntry(), and open().

tident

const char* XrdOfsDirectory::tident

protected

Definition at line 88 of file XrdOfs.hh.

Referenced by XrdOfsDirectory(), and open().

---

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

• XrdOfs.hh
• XrdOfs.cc