library: libDCache
#include "TDCacheFile.h"


class description - header file - source file
viewCVS header - viewCVS source

class TDCacheFile: public TFile

Inheritance Inherited Members Includes Libraries
Class Charts

Function Members (Methods)

Display options:
Show inherited
Show non-public
TDCacheFile(const char* path, Option_t* option = "", const char* ftitle = "", Int_t compress = 1)
voidTObject::AbstractMethod(const char* method) const
voidTDirectory::Add(TObject* obj)
virtual voidTDirectory::Append(TObject* obj)
Int_tTDirectory::AppendKey(TKey* key)
virtual voidTObject::AppendPad(Option_t* option = "")
static TFileOpenHandle*TFile::AsyncOpen(const char* name, Option_t* option = "", const char* ftitle = "", Int_t compress = 1, Int_t netopt = 0)
virtual voidTDirectory::Browse(TBrowser* b)
voidTDirectory::Build(TFile* motherFile = 0, TDirectory* motherDir = 0)
virtual Bool_tTDirectory::cd(const char* path = "0")
static Bool_tTDirectory::Cd(const char* path)
static Bool_tCheckFile(const char* path, const char* location = "0")
static TClass*Class()
virtual const char*TObject::ClassName() const
virtual voidTDirectory::Clear(Option_t* option = "")
virtual TObject*TNamed::Clone(const char* newname = "") const
virtual voidTFile::Close(Option_t* option = "")
virtual Int_tTNamed::Compare(const TObject* obj) const
virtual voidTFile::Copy(TObject&) const
virtual TKey*TFile::CreateKey(TDirectory* mother, const TObject* obj, const char* name, Int_t bufsize)
virtual TKey*TFile::CreateKey(TDirectory* mother, const void* obj, const TClass* cl, const char* name, Int_t bufsize)
static voidTDirectory::DecodeNameCycle(const char* namecycle, char* name, Short_t& cycle)
virtual voidTFile::Delete(const char* namecycle = "")
virtual voidTDirectory::DeleteAll(Option_t* option = "")
virtual Int_tTObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual voidTFile::Draw(Option_t* option = "")
virtual voidTObject::DrawClass() const
virtual TObject*TObject::DrawClone(Option_t* option = "") const
virtual voidTFile::DrawMap(const char* keys = "*", Option_t* option = "")
virtual voidTObject::Dump() const
static voidTDirectory::EncodeNameCycle(char* buffer, const char* name, Short_t cycle)
virtual voidTObject::Error(const char* method, const char* msgfmt) const
virtual voidTObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual voidTObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual voidTObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual voidTObject::Fatal(const char* method, const char* msgfmt) const
virtual voidTFile::FillBuffer(char*& buffer)
virtual TKey*TDirectory::FindKey(const char* keyname) const
virtual TKey*TDirectory::FindKeyAny(const char* keyname) const
virtual TObject*TDirectory::FindObject(const char* name) const
virtual TObject*TDirectory::FindObject(const TObject* obj) const
virtual TObject*TDirectory::FindObjectAny(const char* name) const
virtual voidTFile::Flush()
virtual TObject*TDirectory::Get(const char* namecycle)
TArchiveFile*TFile::GetArchive() const
static TFile::EAsyncOpenStatusTFile::GetAsyncOpenStatus(const char* name)
static TFile::EAsyncOpenStatusTFile::GetAsyncOpenStatus(TFileOpenHandle* handle)
Int_tTFile::GetBestBuffer() const
virtual Int_tTDirectory::GetBufferSize() const
virtual Long64_tTFile::GetBytesRead() const
virtual Long64_tTFile::GetBytesWritten() const
TFileCacheRead*TFile::GetCacheRead() const
TFileCacheWrite*TFile::GetCacheWrite() const
TArrayC*TFile::GetClassIndex() const
Int_tTFile::GetCompressionLevel() const
const TDatime&TDirectory::GetCreationDate() const
static TStringGetDcapPath(const char* path)
static const char*GetDcapVersion()
virtual TDirectory*TDirectory::GetDirectory(const char* namecycle, Bool_t printError = false, const char* funcname = "GetDirectory")
virtual Option_t*TObject::GetDrawOption() const
static Long_tTObject::GetDtorOnly()
virtual Long64_tTFile::GetEND() const
virtual const TUrl*TFile::GetEndpointUrl() const
static const TUrl*TFile::GetEndpointUrl(const char* name)
virtual Int_tTFile::GetErrno() const
Int_tTFile::GetFd() const
virtual TFile*TDirectory::GetFile() const
static Long64_tTFile::GetFileBytesRead()
static Long64_tTFile::GetFileBytesWritten()
static Long64_tTFile::GetFileCounter()
static Int_tTFile::GetFileReadCalls()
virtual const char*TObject::GetIconName() const
virtual TKey*TDirectory::GetKey(const char* name, Short_t cycle = 9999) const
virtual TList*TDirectory::GetList() const
TList*TFile::GetListOfFree() const
virtual TList*TDirectory::GetListOfKeys() const
TObjArray*TFile::GetListOfProcessIDs() const
const TDatime&TDirectory::GetModificationDate() const
TObject*TDirectory::GetMother() const
TDirectory*TDirectory::GetMotherDir() const
virtual const char*TNamed::GetName() const
virtual Int_tTFile::GetNbytesFree() const
virtual Int_tTFile::GetNbytesInfo() const
virtual Int_tTDirectory::GetNbytesKeys() const
virtual Int_tTFile::GetNfree() const
virtual Int_tTDirectory::GetNkeys() const
virtual Int_tTFile::GetNProcessIDs() const
voidTDirectory::GetObject(const char* namecycle, void*& ptr)
virtual void*TDirectory::GetObjectChecked(const char* namecycle, const char* classname)
virtual void*TDirectory::GetObjectChecked(const char* namecycle, const TClass* cl)
virtual char*TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_tTObject::GetObjectStat()
virtual void*TDirectory::GetObjectUnchecked(const char* namecycle)
virtual Option_t*TFile::GetOption() const
virtual const char*TDirectory::GetPath() const
virtual const char*TDirectory::GetPathStatic() const
virtual Int_tTFile::GetReadCalls() const
Int_tTFile::GetRecordHeader(char* buf, Long64_t first, Int_t maxbytes, Int_t& nbytes, Int_t& objlen, Int_t& keylen)
virtual Long64_tTDirectory::GetSeekDir() const
virtual Long64_tTFile::GetSeekFree() const
virtual Long64_tTFile::GetSeekInfo() const
virtual Long64_tTDirectory::GetSeekKeys() const
virtual Long64_tTDirectory::GetSeekParent() const
virtual Long64_tTFile::GetSize() const
const TList*TFile::GetStreamerInfoCache()
virtual TList*TFile::GetStreamerInfoList()
virtual const char*TNamed::GetTitle() const
static TFile::EFileTypeTFile::GetType(const char* name, Option_t* option = "")
virtual UInt_tTObject::GetUniqueID() const
TUUIDTDirectory::GetUUID() const
Int_tTFile::GetVersion() const
virtual Bool_tTObject::HandleTimer(TTimer* timer)
virtual ULong_tTNamed::Hash() const
static voidTFile::IncrementFileCounter()
virtual voidTFile::IncrementProcessIDs()
virtual voidTObject::Info(const char* method, const char* msgfmt) const
virtual Bool_tTObject::InheritsFrom(const char* classname) const
virtual Bool_tTObject::InheritsFrom(const TClass* cl) const
virtual voidTObject::Inspect() const
voidTObject::InvertBit(UInt_t f)
virtual TClass*IsA() const
virtual Bool_tTFile::IsArchive() const
Bool_tTFile::IsBinary() const
virtual Bool_tTObject::IsEqual(const TObject* obj) const
virtual Bool_tTDirectory::IsFolder() const
Bool_tTDirectory::IsModified() const
Bool_tTObject::IsOnHeap() const
virtual Bool_tTFile::IsOpen() const
Bool_tTFile::IsRaw() const
virtual Bool_tTNamed::IsSortable() const
Bool_tTDirectory::IsWritable() const
Bool_tTObject::IsZombie() const
virtual voidTFile::ls(Option_t* option = "") const
virtual voidTFile::MakeFree(Long64_t first, Long64_t last)
virtual voidTFile::MakeProject(const char* dirname, const char* classes = "*", Option_t* option = "new")
virtual voidTFile::Map()
virtual Bool_tTFile::Matches(const char* name)
voidTObject::MayNotUse(const char* method) const
virtual TDirectory*TDirectory::mkdir(const char* name, const char* title = "")
virtual Bool_tTFile::MustFlush() const
virtual Bool_tTObject::Notify()
static TFile*TFile::Open(TFileOpenHandle* handle)
static TFile*TFile::Open(const char* name, Option_t* option = "", const char* ftitle = "", Int_t compress = 1, Int_t netopt = 0)
static voidTObject::operator delete(void* ptr)
static voidTObject::operator delete(void* ptr, void* vp)
static voidTObject::operator delete[](void* ptr)
static voidTObject::operator delete[](void* ptr, void* vp)
void*TObject::operator new(size_t sz)
void*TObject::operator new(size_t sz, void* vp)
void*TObject::operator new[](size_t sz)
void*TObject::operator new[](size_t sz, void* vp)
TNamed&TNamed::operator=(const TNamed& rhs)
virtual voidTFile::Paint(Option_t* option = "")
virtual voidTObject::Pop()
virtual voidTFile::Print(Option_t* option = "") const
virtual voidTDirectory::Purge(Short_t nkeep = 1)
virtual voidTDirectory::pwd() const
virtual Int_tTObject::Read(const char* name)
virtual voidTDirectory::ReadAll(Option_t* option = "")
virtual Bool_tReadBuffer(char* buf, Int_t len)
virtual Bool_tTFile::ReadBuffers(char* buf, Long64_t* pos, Int_t* len, Int_t nbuf)
virtual voidTFile::ReadFree()
virtual Int_tTDirectory::ReadKeys()
virtual voidTFile::ReadStreamerInfo()
virtual Int_tTFile::Recover()
virtual voidTDirectory::RecursiveRemove(TObject* obj)
virtual Int_tTFile::ReOpen(Option_t* mode)
voidTObject::ResetBit(UInt_t f)
virtual voidResetErrno() const
virtual voidTDirectory::rmdir(const char* name)
virtual voidTDirectory::Save()
virtual voidTObject::SaveAs(const char* filename = "", Option_t* option = "") const
virtual voidTObject::SavePrimitive(ostream& out, Option_t* option = "")
virtual voidTDirectory::SaveSelf(Bool_t force = kFALSE)
virtual voidTFile::Seek(Long64_t offset, TFile::ERelativeTo pos = kBeg)
voidTObject::SetBit(UInt_t f)
voidTObject::SetBit(UInt_t f, Bool_t set)
virtual voidTDirectory::SetBufferSize(Int_t bufsize)
virtual voidTFile::SetCacheRead(TFileCacheRead* cache)
virtual voidTFile::SetCacheWrite(TFileCacheWrite* cache)
virtual voidTFile::SetCompressionLevel(Int_t level = 1)
virtual voidTObject::SetDrawOption(Option_t* option = "")
static voidTObject::SetDtorOnly(void* obj)
virtual voidTFile::SetEND(Long64_t last)
static voidTFile::SetFileBytesRead(Long64_t bytes = 0)
static voidTFile::SetFileBytesWritten(Long64_t bytes = 0)
static voidTFile::SetFileReadCalls(Int_t readcalls = 0)
voidTDirectory::SetMother(const TObject* mother)
virtual voidTDirectory::SetName(const char* newname)
virtual voidTNamed::SetNameTitle(const char* name, const char* title)
static voidTObject::SetObjectStat(Bool_t stat)
static voidSetOnError(TDCacheFile::OnErrorAction = kOnErrorDefault)
static voidSetOpenTimeout(UInt_t secs)
virtual voidTFile::SetOption(Option_t* option = ">")
virtual voidTFile::SetReadCalls(Int_t readcalls = 0)
static voidTFile::SetReadStreamerInfo(Bool_t readinfo = kTRUE)
static voidSetReplyHostName(const char* host_name)
voidTDirectory::SetSeekDir(Long64_t v)
virtual voidTNamed::SetTitle(const char* title = "")
virtual voidTObject::SetUniqueID(UInt_t uid)
voidTDirectory::SetWritable(Bool_t writable = kTRUE)
virtual voidShowMembers(TMemberInspector& insp, char* parent)
virtual voidTFile::ShowStreamerInfo()
virtual Int_tTFile::Sizeof() const
static Bool_tStage(const char* path, UInt_t secs, const char* location = "0")
virtual voidStreamer(TBuffer& b)
voidStreamerNVirtual(TBuffer& b)
voidTFile::SumBuffer(Int_t bufsize)
virtual voidTObject::SysError(const char* method, const char* msgfmt) const
Bool_tTObject::TestBit(UInt_t f) const
Int_tTObject::TestBits(UInt_t f) const
virtual voidTFile::UseCache(Int_t maxCacheSize = 10, Int_t pageSize = 0)
virtual voidTObject::UseCurrentStyle()
virtual voidTObject::Warning(const char* method, const char* msgfmt) const
virtual Int_tTFile::Write(const char* name = "0", Int_t opt = 0, Int_t bufsiz = 0)
virtual Int_tTFile::Write(const char* name = "0", Int_t opt = 0, Int_t bufsiz = 0) const
virtual Bool_tWriteBuffer(const char* buf, Int_t len)
virtual voidTDirectory::WriteDirHeader()
virtual voidTFile::WriteFree()
virtual voidTFile::WriteHeader()
virtual voidTDirectory::WriteKeys()
Int_tTDirectory::WriteObject(const void* obj, const char* name, Option_t* option = "")
virtual Int_tTDirectory::WriteObjectAny(const void* obj, const char* classname, const char* name, Option_t* option = "")
virtual Int_tTDirectory::WriteObjectAny(const void* obj, const TClass* cl, const char* name, Option_t* option = "")
virtual voidTFile::WriteStreamerInfo()
virtual Int_tTDirectory::WriteTObject(const TObject* obj, const char* name = "0", Option_t* option = "")
Bool_tTDirectory::cd1(const char* path)
static Bool_tTDirectory::Cd1(const char* path)
virtual Long64_tTFile::DirCreateEntry(TDirectory*)
virtual Int_tTFile::DirReadKeys(TDirectory*)
virtual voidTFile::DirWriteHeader(TDirectory*)
virtual voidTFile::DirWriteKeys(TDirectory*)
virtual voidTObject::DoError(int level, const char* location, const char* fmt, va_list va) const
voidTDirectory::FillFullPath(TString& buf) const
virtual TFile::EAsyncOpenStatusTFile::GetAsyncOpenStatus()
Long64_tTFile::GetRelOffset() const
virtual voidTFile::Init(Bool_t create)
Int_tTFile::ReadBufferViaCache(char* buf, Int_t len)
Int_tTFile::WriteBufferViaCache(const char* buf, Int_t len)
virtual Int_tSysClose(Int_t fd)
virtual Int_tSysOpen(const char* pathname, Int_t flags, UInt_t mode)
virtual Int_tSysRead(Int_t fd, void* buf, Int_t len)
virtual Long64_tSysSeek(Int_t fd, Long64_t offset, Int_t whence)
virtual Int_tSysStat(Int_t fd, Long_t* id, Long64_t* size, Long_t* flags, Long_t* modtime)
virtual Int_tSysSync(Int_t fd)
virtual Int_tSysWrite(Int_t fd, const void* buf, Int_t len)

Data Members

enum OnErrorAction { kOnErrorRetry
enum TFile::EAsyncOpenStatus { kAOSNotAsync
enum TFile::EStatusBits { kRecovered
enum TFile::ERelativeTo { kBeg
enum TFile::[unnamed] { kStartBigFile
enum TFile::EFileType { kDefault
enum TDirectory::[unnamed] { kCloseDirectory
enum TObject::EStatusBits { kCanDelete
enum TObject::[unnamed] { kIsOnHeap
Double_tTFile::fSumBufferSum of buffer sizes of objects written so far
Double_tTFile::fSum2BufferSum of squares of buffer sizes of objects written so far
Long64_tTFile::fBytesWriteNumber of bytes written to this file
Long64_tTFile::fBytesReadNumber of bytes read from this file
Long64_tTFile::fBEGINFirst used byte in file
Long64_tTFile::fENDLast used byte in file
Long64_tTFile::fSeekFreeLocation on disk of free segments structure
Long64_tTFile::fSeekInfoLocation on disk of StreamerInfo record
Int_tTFile::fDFile descriptor
Int_tTFile::fVersionFile format version
Int_tTFile::fCompressCompression level from 0(not compressed) to 9 (max compression)
Int_tTFile::fNbytesFreeNumber of bytes for free segments structure
Int_tTFile::fNbytesInfoNumber of bytes for StreamerInfo record
Int_tTFile::fWrittenNumber of objects written so far
Int_tTFile::fNProcessIDsNumber of TProcessID written to this file
Int_tTFile::fReadCallsNumber of read calls ( not counting the cache calls )
TStringTFile::fRealNameEffective real file name (not original url)
TStringTFile::fOptionFile options
Char_tTFile::fUnitsNumber of bytes for file pointers
TList*TFile::fFreeFree segments linked list table
TArrayC*TFile::fClassIndex!Index of TStreamerInfo classes written to this file
TObjArray*TFile::fProcessIDs!Array of pointers to TProcessIDs
Long64_tTFile::fOffset!Seek offset used by remote file classes
TArchiveFile*TFile::fArchive!Archive file from which we read this file
TFileCacheRead*TFile::fCacheRead!Pointer to the read cache (if any)
TFileCacheWrite*TFile::fCacheWrite!Pointer to the write cache (if any)
Long64_tTFile::fArchiveOffset!Offset at which file starts in archive
Bool_tTFile::fIsArchive!True if this is a pure archive file
Bool_tTFile::fNoAnchorInName!True if we don't want to force the anchor to be appended to the file name
Bool_tTFile::fIsRootFile!True is this is a ROOT file, raw file otherwise
Bool_tTFile::fInitDone!True if the file has been initialized
Bool_tTFile::fMustFlush!True if the file buffers must be flushed
TFileOpenHandle*TFile::fAsyncHandle!For proper automatic cleanup
TFile::EAsyncOpenStatusTFile::fAsyncOpenStatus!Status of an asynchronous open request
TUrlTFile::fUrl!URL of file
TList*TFile::fInfoCache!Cached list of the streamer infos in this file
static TList*TFile::fgAsyncOpenRequests!List of handles for pending open requests
static Long64_tTFile::fgBytesWriteNumber of bytes written by all TFile objects
static Long64_tTFile::fgBytesReadNumber of bytes read by all TFile objects
static Long64_tTFile::fgFileCounterCounter for all opened files
static Int_tTFile::fgReadCallsNumber of bytes read from all TFile objects
static Bool_tTFile::fgReadInfoif true (default) ReadStreamerInfo is called when opening a file
Bool_tTDirectory::fModifiedtrue if directory has been modified
Bool_tTDirectory::fWritabletrue if directory is writable
TDatimeTDirectory::fDatimeCDate and time when directory is created
TDatimeTDirectory::fDatimeMDate and time of last modification
Int_tTDirectory::fNbytesKeysNumber of bytes for the keys
Int_tTDirectory::fNbytesNameNumber of bytes in TNamed at creation time
Int_tTDirectory::fBufferSizeDefault buffer size to create new TKeys
Long64_tTDirectory::fSeekDirLocation of directory on file
Long64_tTDirectory::fSeekParentLocation of parent directory on file
Long64_tTDirectory::fSeekKeysLocation of Keys record on file
TFile*TDirectory::fFilepointer to current file in memory
TObject*TDirectory::fMotherpointer to mother of the directory
TList*TDirectory::fListPointer to objects list in memory
TList*TDirectory::fKeysPointer to keys list in memory
TUUIDTDirectory::fUUIDUnique identifier
TStringTDirectory::fPathBuffer!Buffer for GetPath() function
TStringTNamed::fNameobject identifier
TStringTNamed::fTitleobject title
Bool_tfStatCached! (transient) is file status cached?
TDCacheFile::stat64fStatBuffer! (transient) Cached file status buffer (for performance)

Class Description

 A TDCacheFile is like a normal TFile except that it may read and     
 write its data via a dCache server (for more on the dCache daemon    
 see Given a path which doesn't belong    
 to the dCache managed filesystem, it falls back to the ordinary      
 TFile behaviour.                                                     

TDCacheFile(const char *path, Option_t *option, const char *ftitle, Int_t compress)
 Create a dCache file object. A dCache file is the same as a TFile
 except that it is being accessed via a dCache server. The url
 argument must be of the form: dcache:/pnfs/<path>/<file>.root or
 dcap://<>/<path>/<file>.root. If the file specified in the
 URL does not exist, is not accessable or can not be created the kZombie
 bit will be set in the TDCacheFile object. Use IsZombie() to see if the
 file is accessable. For a description of the option and other arguments
 see the TFile ctor. The preferred interface to this constructor is
 via TFile::Open().
 Close and cleanup dCache file.
Bool_t ReadBuffer(char *buf, Int_t len)
 Read specified byte range from remote file via dCache daemon.
 Returns kTRUE in case of error.
Bool_t WriteBuffer(const char *buf, Int_t len)
 Write specified byte range to remote file via dCache daemon.
 Returns kTRUE in case of error.
Bool_t Stage(const char *path, UInt_t after, const char *location)
 Stage() returns kTRUE on success and kFALSE on failure.
Bool_t CheckFile(const char *path, const char *location)
 CheckFile() returns kTRUE on success and kFALSE on failure.  In
 case the file exists but is not cached, CheckFile() returns
 kFALSE and errno is set to EAGAIN.
void SetOpenTimeout(UInt_t n)
 Set file open timeout.
void SetOnError(OnErrorAction a)
 Set on error handler.
void SetReplyHostName(const char *host_name)
 Set reply host name.
const char * GetDcapVersion()
 Return dCache version string.
Int_t SysOpen(const char *pathname, Int_t flags, UInt_t mode)
 Interface to system open. All arguments like in POSIX open.
Int_t SysClose(Int_t fd)
 Interface to system close. All arguments like in POSIX close.
Int_t SysRead(Int_t fd, void *buf, Int_t len)
 Interface to system read. All arguments like in POSIX read.
Int_t SysWrite(Int_t fd, const void *buf, Int_t len)
 Interface to system write. All arguments like in POSIX write.
Long64_t SysSeek(Int_t fd, Long64_t offset, Int_t whence)
 Interface to system seek. All arguments like in POSIX lseek.
Int_t SysSync(Int_t fd)
 Interface to system sync. All arguments like in POSIX fsync.
 dCache always keep it's files sync'ed, so there's no need to
 sync() them manually.
Int_t SysStat(Int_t, Long_t *id, Long64_t *size, Long_t *flags, Long_t *modtime)
 Get info about a file: id, size, flags, modification time.
 Id      is (statbuf.st_dev << 24) + statbuf.st_ino
 Size    is the file size
 Flags   is file type: 0 is regular file, bit 0 set executable,
                       bit 1 set directory, bit 2 set special file
                       (socket, fifo, pipe, etc.)
 Modtime is modification time.
 The function returns 0 in case of success and 1 if the file could
 not be stat'ed.
void ResetErrno()
 Method resetting the dc_errno and errno.
TString GetDcapPath(const char *path)
 Transform the input path into a path usuable by the dcap C library,
 i.e either dcap:// or
{ }

Author: Grzegorz Mazur 20/01/2002
Last update: root/dcache:$Name: $:$Id: TDCacheFile.cxx,v 1.30 2006/06/27 14:36:27 brun Exp $
Copyright (C) 1995-2000, Rene Brun and Fons Rademakers. *

ROOT page - Class index - Class Hierarchy - Top of the page

This page has been automatically generated. If you have any comments or suggestions about the page layout send a mail to ROOT support, or contact the developers with any questions or problems regarding ROOT.