xrootd
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 name, valid, fFd, fHTutime, fHashTable, and Init().

XrdSutPFile::XrdSutPFile ( const XrdSutPFile &  f)

References name, and fFd.

XrdSutPFile::~XrdSutPFile ( ) [virtual]

References name, fHashTable, and Close().

Member Function Documentation

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

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

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

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

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

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

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

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

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

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

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

bool XrdSutPFile::IsValid ( ) const [inline]

References valid.

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

kXR_int32 XrdSutPFile::LastError ( ) const [inline]

References fError.

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

References fErrStr, and XrdOucString::c_str().

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

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

References name.

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

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

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

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

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

References UpdateCount().

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

kXR_int32 XrdSutPFile::RemoveEntry ( const char *  name)

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

Referenced by RemoveEntries().

kXR_int32 XrdSutPFile::RemoveEntry ( kXR_int32  ofs)

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

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

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

Referenced by WriteEntry(), and RemoveEntry().

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

References UpdateCount().

kXR_int32 XrdSutPFile::RetrieveHeader ( XrdSutPFHeader &  hd)

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

Referenced by Trim().

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

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

Referenced by RemoveEntries().

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

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

Referenced by Browse().

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

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

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

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

Referenced by ResetCount(), and ReadCount().

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

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

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

kXR_int32 XrdSutPFile::UpdateHeader ( XrdSutPFHeader  hd)

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

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

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

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

kXR_int32 XrdSutPFile::WriteEntry ( XrdSutPFEntry  ent)

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

Referenced by XrdSutCache::Flush().

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

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

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

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

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

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

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 XrdSutPFile(), Init(), Open(), Close(), WriteHeader(), WriteEntry(), RemoveEntry(), Reset(), WriteInd(), WriteEnt(), ReadHeader(), ReadInd(), ReadEnt(), Trim(), and UpdateHashTable().

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

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

kXR_int32 XrdSutPFile::fHTutime [private]

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

char* XrdSutPFile::name [private]

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

bool XrdSutPFile::valid [private]

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

The documentation for this class was generated from the following files:
Generated on Sat Mar 17 2012 17:26:53 for xrootd by   doxygen 1.7.5