Public Member Functions | Private Member Functions | Private Attributes | Friends

XrdSutPFile Class Reference

#include <XrdSutPFile.hh>

Collaboration diagram for XrdSutPFile:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 XrdSutPFile (const char *n, kXR_int32 openmode=kPFEcreate, kXR_int32 createmode=0600, bool hashtab=1)
 XrdSutPFile (const XrdSutPFile &f)
virtual ~XrdSutPFile ()
bool Init (const char *n, kXR_int32 openmode=kPFEcreate, kXR_int32 createmode=0600, bool hashtab=1)
kXR_int32 Open (kXR_int32 opt, bool *wasopen=0, const char *nam=0, kXR_int32 createmode=0600)
kXR_int32 Close (kXR_int32 d=-1)
const char * Name () const
bool IsValid () const
kXR_int32 LastError () const
const char * LastErrStr () const
kXR_int32 RemoveEntry (const char *name)
kXR_int32 RemoveEntry (kXR_int32 ofs)
kXR_int32 RemoveEntries (const char *name, char opt)
kXR_int32 Trim (const char *fbak=0)
kXR_int32 UpdateHeader (XrdSutPFHeader hd)
kXR_int32 WriteEntry (XrdSutPFEntry ent)
kXR_int32 UpdateCount (const char *nm, int *cnt=0, int step=1, bool reset=0)
kXR_int32 ResetCount (const char *nm)
kXR_int32 ReadCount (const char *nm, int &cnt)
kXR_int32 RetrieveHeader (XrdSutPFHeader &hd)
kXR_int32 ReadEntry (const char *name, XrdSutPFEntry &ent, int opt=0)
kXR_int32 ReadEntry (kXR_int32 ofs, XrdSutPFEntry &ent)
kXR_int32 SearchEntries (const char *name, char opt, kXR_int32 *ofs=0, kXR_int32 nofs=1)
kXR_int32 SearchSpecialEntries (kXR_int32 *ofs=0, kXR_int32 nofs=1)
kXR_int32 Browse (void *out=0)

Private Member Functions

kXR_int32 WriteHeader (XrdSutPFHeader hd)
kXR_int32 ReadHeader (XrdSutPFHeader &hd)
kXR_int32 WriteInd (kXR_int32 ofs, XrdSutPFEntInd ind)
kXR_int32 ReadInd (kXR_int32 ofs, XrdSutPFEntInd &ind)
kXR_int32 WriteEnt (kXR_int32 ofs, XrdSutPFEntry ent)
kXR_int32 ReadEnt (kXR_int32 ofs, XrdSutPFEntry &ent)
kXR_int32 Reset (kXR_int32 ofs, kXR_int32 size)
kXR_int32 UpdateHashTable (bool force=0)
kXR_int32 Err (kXR_int32 code, const char *loc, const char *em1=0, const char *em2=0)

Private Attributes

char * name
bool valid
kXR_int32 fFd
XrdOucHash< kXR_int32 > * fHashTable
kXR_int32 fHTutime
kXR_int32 fError
XrdOucString fErrStr

Friends

class XrdSutCache

Constructor & Destructor Documentation

XrdSutPFile::XrdSutPFile ( const char *  n,
kXR_int32  openmode = kPFEcreate,
kXR_int32  createmode = 0600,
bool  hashtab = 1 
)

References fFd, fHashTable, fHTutime, Init(), name, and valid.

XrdSutPFile::XrdSutPFile ( const XrdSutPFile &  f  ) 

References fFd, and name.

XrdSutPFile::~XrdSutPFile (  )  [virtual]

References Close(), fHashTable, and name.

Member Function Documentation

kXR_int32 XrdSutPFile::Browse ( void *  out = 0  ) 

References XrdSutPFBuf::buf, XrdSutPFEntry::buf1, XrdSutPFEntry::buf2, XrdSutPFEntry::buf3, XrdSutPFEntry::buf4, Close(), XrdSutPFEntry::cnt, XrdSutPFHeader::ctime, XrdSutPFEntInd::entofs, XrdSutPFHeader::entries, XrdSutPFHeader::fileID, XrdSutPFHeader::indofs, XrdSutPFHeader::itime, XrdSutPFHeader::jnksiz, kPFE_special, XrdSutPFBuf::len, localtime_r, XrdSutPFEntry::mtime, XrdSutPFEntInd::name, name, XrdSutPFEntInd::nxtofs, Open(), ReadEnt(), ReadHeader(), ReadInd(), SearchSpecialEntries(), XrdSutPFEntry::status, XrdSutPFHeader::version, and XrdSutTimeString().

kXR_int32 XrdSutPFile::Close ( kXR_int32  d = -1  ) 

References close, Err(), fcntl(), fFd, and kPFErrUnlocking.

Referenced by Browse(), XrdSutCache::Flush(), Init(), XrdSutCache::Load(), ReadEntry(), RemoveEntry(), RetrieveHeader(), SearchEntries(), SearchSpecialEntries(), Trim(), UpdateCount(), UpdateHeader(), WriteEntry(), and ~XrdSutPFile().

kXR_int32 XrdSutPFile::Err ( kXR_int32  code,
const char *  loc,
const char *  em1 = 0,
const char *  em2 = 0 
) [private]

References DEBUG, EPNAME, fError, fErrStr, kPFErrBadInputs, kPFErrBadOp, kPFErrFileAlreadyOpen, kPFErrFileLocked, kPFErrFileNotOpen, kPFErrFileOpen, kPFErrFileRename, kPFErrLenMismatch, kPFErrLocking, kPFErrNoFile, kPFErrOutOfMemory, kPFErrRead, kPFErrSeek, kPFErrStat, kPFErrUnlocking, snprintf, and XrdSutMAXBUF.

Referenced by Close(), Init(), Open(), ReadEnt(), ReadEntry(), ReadHeader(), ReadInd(), RemoveEntry(), Reset(), SearchEntries(), Trim(), UpdateCount(), UpdateHashTable(), WriteEnt(), WriteEntry(), WriteHeader(), and WriteInd().

bool XrdSutPFile::Init ( const char *  n,
kXR_int32  openmode = kPFEcreate,
kXR_int32  createmode = 0600,
bool  hashtab = 1 
)

References Close(), Err(), fFd, fHashTable, fHTutime, kDefFileID, kPFErrNoFile, kXrdIFVersion, name, Open(), stat(), UpdateHashTable(), valid, and WriteHeader().

Referenced by XrdSecProtocolpwd::Init(), and XrdSutPFile().

bool XrdSutPFile::IsValid (  )  const [inline]

References valid.

Referenced by XrdSutCache::Flush(), XrdSecProtocolpwd::Init(), XrdSutCache::Load(), XrdSecProtocolpwd::ParseClientInput(), XrdSecProtocolpwd::QueryCreds(), and XrdSecProtocolpwd::QueryUser().

kXR_int32 XrdSutPFile::LastError (  )  const [inline]

References fError.

const char* XrdSutPFile::LastErrStr (  )  const [inline]

References XrdOucString::c_str(), and fErrStr.

Referenced by XrdSutCache::Flush(), and XrdSutCache::Load().

const char* XrdSutPFile::Name (  )  const [inline]

References name.

Referenced by GetEntry(), RemoveEntries(), and XrdSecProtocolpwd::XrdSecProtocolpwd().

kXR_int32 XrdSutPFile::Open ( kXR_int32  opt,
bool *  wasopen = 0,
const char *  nam = 0,
kXR_int32  createmode = 0600 
)

References XrdOucString::c_str(), close, Err(), F_GETFL, fcntl(), fFd, kPFErrBadInputs, kPFErrBadOp, kPFErrFileAlreadyOpen, kPFErrFileLocked, kPFErrFileOpen, kPFErrLocking, kPFErrNoFile, kPFErrStat, name, open(), and stat().

Referenced by Browse(), Init(), ReadEntry(), RemoveEntry(), RetrieveHeader(), SearchEntries(), SearchSpecialEntries(), Trim(), UpdateCount(), UpdateHeader(), and WriteEntry().

kXR_int32 XrdSutPFile::ReadCount ( const char *  nm,
int &  cnt 
) [inline]

References UpdateCount().

kXR_int32 XrdSutPFile::ReadEnt ( kXR_int32  ofs,
XrdSutPFEntry &  ent 
) [private]

References XrdSutPFBuf::buf, XrdSutPFEntry::buf1, XrdSutPFEntry::buf2, XrdSutPFEntry::buf3, XrdSutPFEntry::buf4, XrdSutPFEntry::cnt, Err(), fFd, kPFErrFileNotOpen, kPFErrOutOfMemory, kPFErrRead, kPFErrSeek, XrdSutPFBuf::len, lseek(), XrdSutPFEntry::mtime, read(), and XrdSutPFEntry::status.

Referenced by Browse(), XrdSutCache::Load(), ReadEntry(), SearchSpecialEntries(), Trim(), and UpdateCount().

kXR_int32 XrdSutPFile::ReadEntry ( const char *  name,
XrdSutPFEntry &  ent,
int  opt = 0 
)

References Close(), XrdSutPFEntInd::entofs, Err(), fHashTable, fHTutime, XrdOucHash< T >::Find(), XrdSutPFHeader::indofs, XrdSutPFHeader::itime, kPFErrBadInputs, XrdOucString::matches(), XrdSutPFEntInd::name, XrdSutPFEntInd::nxtofs, Open(), ReadEnt(), ReadHeader(), ReadInd(), XrdSutPFEntry::Reset(), XrdSutPFEntry::SetName(), and UpdateHashTable().

Referenced by XrdSutCache::Flush(), GetEntry(), and XrdSecProtocolpwd::Init().

kXR_int32 XrdSutPFile::ReadEntry ( kXR_int32  ofs,
XrdSutPFEntry &  ent 
)

References Close(), XrdSutPFEntInd::entofs, Err(), kPFErrBadInputs, XrdSutPFEntInd::name, Open(), ReadEnt(), ReadInd(), and XrdSutPFEntry::SetName().

kXR_int32 XrdSutPFile::ReadHeader ( XrdSutPFHeader &  hd  )  [private]

References XrdSutPFHeader::ctime, XrdSutPFHeader::entries, Err(), fFd, XrdSutPFHeader::fileID, XrdSutPFHeader::indofs, XrdSutPFHeader::itime, XrdSutPFHeader::jnksiz, kFileIDSize, kPFErrFileNotOpen, kPFErrRead, kPFErrSeek, lseek(), read(), and XrdSutPFHeader::version.

Referenced by Browse(), XrdSutCache::Load(), ReadEntry(), RemoveEntry(), RetrieveHeader(), SearchEntries(), SearchSpecialEntries(), Trim(), UpdateCount(), UpdateHashTable(), and WriteEntry().

kXR_int32 XrdSutPFile::ReadInd ( kXR_int32  ofs,
XrdSutPFEntInd &  ind 
) [private]

References XrdSutPFEntInd::entofs, XrdSutPFEntInd::entsiz, Err(), fFd, kPFErrFileNotOpen, kPFErrOutOfMemory, kPFErrRead, kPFErrSeek, lseek(), XrdSutPFEntInd::name, XrdSutPFEntInd::nxtofs, and read().

Referenced by Browse(), XrdSutCache::Load(), ReadEntry(), RemoveEntry(), SearchEntries(), SearchSpecialEntries(), Trim(), UpdateCount(), UpdateHashTable(), and WriteEntry().

kXR_int32 XrdSutPFile::RemoveEntries ( const char *  name,
char  opt 
)

References DEBUG, EPNAME, Name(), RemoveEntry(), and SearchEntries().

kXR_int32 XrdSutPFile::RemoveEntry ( const char *  name  ) 

References Close(), XrdSutPFHeader::ctime, XrdSutPFEntInd::entofs, XrdSutPFHeader::entries, XrdSutPFEntInd::entsiz, Err(), fFd, fHashTable, fHTutime, XrdOucHash< T >::Find(), XrdSutPFHeader::indofs, XrdSutPFHeader::itime, XrdSutPFHeader::jnksiz, kPFErrBadInputs, kPFErrSeek, lseek(), XrdSutPFEntInd::name, XrdSutPFEntInd::nxtofs, Open(), ReadHeader(), ReadInd(), Reset(), UpdateHashTable(), write(), WriteHeader(), and WriteInd().

Referenced by RemoveEntries().

kXR_int32 XrdSutPFile::RemoveEntry ( kXR_int32  ofs  ) 

References Close(), XrdSutPFHeader::ctime, XrdSutPFEntInd::entofs, XrdSutPFHeader::entries, XrdSutPFEntInd::entsiz, Err(), fFd, fHTutime, XrdSutPFHeader::itime, XrdSutPFHeader::jnksiz, kPFErrBadInputs, kPFErrSeek, lseek(), Open(), ReadHeader(), ReadInd(), Reset(), UpdateHashTable(), write(), WriteHeader(), and WriteInd().

kXR_int32 XrdSutPFile::Reset ( kXR_int32  ofs,
kXR_int32  size 
) [private]

References Err(), fFd, kPFErrSeek, lseek(), and write().

Referenced by RemoveEntry(), and WriteEntry().

kXR_int32 XrdSutPFile::ResetCount ( const char *  nm  )  [inline]

References UpdateCount().

kXR_int32 XrdSutPFile::RetrieveHeader ( XrdSutPFHeader &  hd  ) 

References Close(), Open(), and ReadHeader().

Referenced by Trim().

kXR_int32 XrdSutPFile::SearchEntries ( const char *  name,
char  opt,
kXR_int32 *  ofs = 0,
kXR_int32  nofs = 1 
)

References XrdOucString::assign(), Close(), XrdSutPFEntInd::entofs, Err(), XrdSutPFHeader::indofs, kPFErrBadInputs, XrdOucString::matches(), XrdSutPFEntInd::name, XrdSutPFEntInd::nxtofs, Open(), ReadHeader(), and ReadInd().

Referenced by RemoveEntries().

kXR_int32 XrdSutPFile::SearchSpecialEntries ( kXR_int32 *  ofs = 0,
kXR_int32  nofs = 1 
)

References Close(), XrdSutPFEntInd::entofs, XrdSutPFHeader::indofs, kPFE_special, XrdSutPFEntInd::nxtofs, Open(), ReadEnt(), ReadHeader(), ReadInd(), and XrdSutPFEntry::status.

Referenced by Browse().

kXR_int32 XrdSutPFile::Trim ( const char *  fbak = 0  ) 

References Close(), XrdSutPFHeader::ctime, DEBUG, XrdSutPFEntInd::entofs, EPNAME, Err(), fFd, XrdSutPFHeader::indofs, XrdSutPFHeader::itime, XrdSutPFHeader::jnksiz, kPFErrFileRename, kPFErrOutOfMemory, kPFErrSeek, lseek(), name, XrdSutPFEntInd::nxtofs, Open(), ReadEnt(), ReadHeader(), ReadInd(), rename(), RetrieveHeader(), WriteEnt(), WriteHeader(), and WriteInd().

kXR_int32 XrdSutPFile::UpdateCount ( const char *  nm,
int *  cnt = 0,
int  step = 1,
bool  reset = 0 
)

References Close(), XrdSutPFEntry::cnt, XrdSutPFEntInd::entofs, Err(), fHashTable, fHTutime, XrdOucHash< T >::Find(), XrdSutPFHeader::indofs, XrdSutPFHeader::itime, kPFErrBadInputs, XrdSutPFEntry::mtime, XrdSutPFEntInd::name, XrdSutPFEntInd::nxtofs, Open(), ReadEnt(), ReadHeader(), ReadInd(), UpdateHashTable(), and WriteEnt().

Referenced by ReadCount(), and ResetCount().

kXR_int32 XrdSutPFile::UpdateHashTable ( bool  force = 0  )  [private]

References XrdOucHash< T >::Add(), XrdSutPFHeader::entries, Err(), fFd, fHashTable, fHTutime, XrdSutPFHeader::indofs, XrdSutPFHeader::itime, kPFErrFileNotOpen, kPFErrOutOfMemory, XrdSutPFEntInd::name, XrdSutPFEntInd::nxtofs, XrdOucHash< T >::Purge(), ReadHeader(), and ReadInd().

Referenced by Init(), ReadEntry(), RemoveEntry(), and UpdateCount().

kXR_int32 XrdSutPFile::UpdateHeader ( XrdSutPFHeader  hd  ) 

References Close(), Open(), and WriteHeader().

kXR_int32 XrdSutPFile::WriteEnt ( kXR_int32  ofs,
XrdSutPFEntry  ent 
) [private]

References XrdSutPFBuf::buf, XrdSutPFEntry::buf1, XrdSutPFEntry::buf2, XrdSutPFEntry::buf3, XrdSutPFEntry::buf4, XrdSutPFEntry::cnt, Err(), fFd, kPFErrFileNotOpen, kPFErrLenMismatch, kPFErrOutOfMemory, kPFErrSeek, XrdSutPFBuf::len, XrdSutPFEntry::Length(), lseek(), XrdSutPFEntry::mtime, XrdSutPFEntry::status, and write().

Referenced by Trim(), UpdateCount(), and WriteEntry().

kXR_int32 XrdSutPFile::WriteEntry ( XrdSutPFEntry  ent  ) 

References Close(), XrdSutPFHeader::ctime, XrdSutPFEntInd::entofs, XrdSutPFHeader::entries, XrdSutPFEntInd::entsiz, Err(), fFd, XrdSutPFHeader::indofs, XrdSutPFHeader::itime, XrdSutPFHeader::jnksiz, kOfsCtime, kOfsItime, kOfsJnkSiz, kPFErrBadInputs, kPFErrSeek, XrdSutPFEntry::Length(), lseek(), XrdSutPFEntInd::name, XrdSutPFEntry::name, XrdSutPFEntInd::nxtofs, Open(), ReadHeader(), ReadInd(), Reset(), XrdSutPFEntInd::SetName(), write(), WriteEnt(), WriteHeader(), and WriteInd().

Referenced by XrdSutCache::Flush().

kXR_int32 XrdSutPFile::WriteHeader ( XrdSutPFHeader  hd  )  [private]

References XrdSutPFHeader::ctime, XrdSutPFHeader::entries, Err(), fFd, XrdSutPFHeader::fileID, XrdSutPFHeader::indofs, XrdSutPFHeader::itime, XrdSutPFHeader::jnksiz, kFileIDSize, kPFErrFileNotOpen, kPFErrLenMismatch, kPFErrOutOfMemory, kPFErrSeek, XrdSutPFHeader::Length(), lseek(), XrdSutPFHeader::version, and write().

Referenced by Init(), RemoveEntry(), Trim(), UpdateHeader(), and WriteEntry().

kXR_int32 XrdSutPFile::WriteInd ( kXR_int32  ofs,
XrdSutPFEntInd  ind 
) [private]

References XrdSutPFEntInd::entofs, XrdSutPFEntInd::entsiz, Err(), fFd, kPFErrFileNotOpen, kPFErrLenMismatch, kPFErrOutOfMemory, kPFErrSeek, XrdSutPFEntInd::Length(), lseek(), XrdSutPFEntInd::name, XrdSutPFEntInd::nxtofs, and write().

Referenced by RemoveEntry(), Trim(), and WriteEntry().

Friends And Related Function Documentation

friend class XrdSutCache [friend]

Member Data Documentation

kXR_int32 XrdSutPFile::fError [private]

Referenced by Err(), and LastError().

XrdOucString XrdSutPFile::fErrStr [private]

Referenced by Err(), and LastErrStr().

kXR_int32 XrdSutPFile::fFd [private]

Referenced by Close(), Init(), Open(), ReadEnt(), ReadHeader(), ReadInd(), RemoveEntry(), Reset(), Trim(), UpdateHashTable(), WriteEnt(), WriteEntry(), WriteHeader(), WriteInd(), and XrdSutPFile().

XrdOucHash<kXR_int32>* XrdSutPFile::fHashTable [private]

Referenced by Init(), ReadEntry(), RemoveEntry(), UpdateCount(), UpdateHashTable(), XrdSutPFile(), and ~XrdSutPFile().

kXR_int32 XrdSutPFile::fHTutime [private]

Referenced by Init(), ReadEntry(), RemoveEntry(), UpdateCount(), UpdateHashTable(), and XrdSutPFile().

char* XrdSutPFile::name [private]

Referenced by Browse(), Init(), Name(), Open(), Trim(), XrdSutPFile(), and ~XrdSutPFile().

bool XrdSutPFile::valid [private]

Referenced by Init(), IsValid(), and XrdSutPFile().

The documentation for this class was generated from the following files:
Generated on Wed Sep 1 2010 for xrootd by  doxygen 1.7.1