ROOT logo
ROOT » NET » NETX » TXNetFile

class TXNetFile: public TNetFile


TXNetFile

Authors: Alvise Dorigo, Fabrizio Furano
INFN Padova, 2003
Interfaced to the standalone client (XrdClient): G. Ganis, CERN

TXNetFile is an extension of TNetFile able to deal with new xrootd
server. Its new features are:
- Automatic server kind recognition (xrootd load balancer, xrootd
data server, old rootd)
- Backward compatibility with old rootd server (acts as an old
TNetFile)
- Fault tolerance for read/write operations (read/write timeouts
and retry)
- Internal connection timeout (tunable indipendently from the OS
one) handled by threads
- handling of redirections from server
- Single TCP physical channel for multiple TXNetFile's instances
inside the same application
So, each TXNetFile object client must send messages containing
its ID (streamid). The server, of course, will respond with
messages containing the client's ID, in order to make the client
able to recognize its message by matching its streamid with that
one contained in the server's response.
- Tunable log verbosity level (0 = nothing, 3 = dump read/write
buffers too!)
- Many parameters configurable via TEnv facility (see SetParm()
methods)


Function Members (Methods)

public:
TXNetFile()
TXNetFile(const char* url, Option_t* option = "", const char* fTitle = "", Int_t compress = 1, Int_t netopt = 0, Bool_t parallelopen = kFALSE, const char* logicalurl = 0)
virtual~TXNetFile()
voidTObject::AbstractMethod(const char* method) const
virtual voidTDirectoryFile::Add(TObject* obj, Bool_t replace = kFALSE)
static voidTDirectory::AddDirectory(Bool_t add = kTRUE)
static Bool_tTDirectory::AddDirectoryStatus()
virtual voidTDirectoryFile::Append(TObject* obj, Bool_t replace = kFALSE)
virtual Int_tTDirectoryFile::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 voidTDirectoryFile::Browse(TBrowser* b)
virtual voidTDirectoryFile::Build(TFile* motherFile = 0, TDirectory* motherDir = 0)
virtual Bool_tTDirectoryFile::cd(const char* path = 0)
static Bool_tTDirectory::Cd(const char* path)
static TClass*Class()
virtual const char*TObject::ClassName() const
virtual voidTDirectory::Clear(Option_t* option = "")
virtual TObject*TNamed::Clone(const char* newname = "") const
virtual TObject*TDirectoryFile::CloneObject(const TObject* obj, Bool_t autoadd = kTRUE)
virtual voidClose(Option_t* opt = "")
virtual Int_tTNamed::Compare(const TObject* obj) const
virtual voidTFile::Copy(TObject&) const
static Bool_tTFile::Cp(const char* src, const char* dst, Bool_t progressbar = kTRUE, UInt_t buffersize = 1000000)
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() constMENU
virtual TObject*TObject::DrawClone(Option_t* option = "") constMENU
virtual voidTFile::DrawMap(const char* keys = "*", Option_t* option = "")MENU
virtual voidTObject::Dump() constMENU
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*TDirectoryFile::FindKey(const char* keyname) const
virtual TKey*TDirectoryFile::FindKeyAny(const char* keyname) const
virtual TObject*TDirectory::FindObject(const char* name) const
virtual TObject*TDirectory::FindObject(const TObject* obj) const
virtual TObject*TDirectoryFile::FindObjectAny(const char* name) const
virtual TObject*TDirectoryFile::FindObjectAnyFile(const char* name) const
virtual voidFlush()
virtual TObject*TDirectoryFile::Get(const char* namecycle)
TArchiveFile*TFile::GetArchive() const
virtual TFile::EAsyncOpenStatusGetAsyncOpenStatus()
Int_tTFile::GetBestBuffer() const
virtual Int_tTDirectoryFile::GetBufferSize() const
virtual Long64_tTFile::GetBytesRead() const
virtual Long64_tTFile::GetBytesReadExtra() const
virtual Int_tGetBytesToPrefetch() const
virtual Long64_tTFile::GetBytesWritten() const
static const char*TFile::GetCacheFileDir()
TFileCacheRead*TFile::GetCacheRead() const
TFileCacheWrite*TFile::GetCacheWrite() const
TArrayC*TFile::GetClassIndex() const
Float_tTFile::GetCompressionFactor()
Int_tTFile::GetCompressionLevel() const
const TDatime&TDirectoryFile::GetCreationDate() const
virtual TDirectory*TDirectoryFile::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*TNetFile::GetEndpointUrl() const
virtual Int_tTFile::GetErrno() const
Int_tTNetFile::GetErrorCode() const
Int_tTFile::GetFd() const
virtual TFile*TDirectoryFile::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*TDirectoryFile::GetKey(const char* name, Short_t cycle = 9999) const
virtual TList*TDirectory::GetList() const
TList*TFile::GetListOfFree() const
virtual TList*TDirectoryFile::GetListOfKeys() const
TObjArray*TFile::GetListOfProcessIDs() const
const TDatime&TDirectoryFile::GetModificationDate() const
virtual TObject*TDirectory::GetMother() const
virtual TDirectory*TDirectory::GetMotherDir() const
virtual const char*TNamed::GetName() const
virtual Int_tTFile::GetNbytesFree() const
virtual Int_tTFile::GetNbytesInfo() const
virtual Int_tTDirectoryFile::GetNbytesKeys() const
virtual Int_tTFile::GetNfree() const
virtual Int_tTDirectoryFile::GetNkeys() const
virtual Int_tTFile::GetNProcessIDs() const
voidTDirectory::GetObject(const char* namecycle, void*& ptr)
virtual void*TDirectoryFile::GetObjectChecked(const char* namecycle, const char* classname)
virtual void*TDirectoryFile::GetObjectChecked(const char* namecycle, const TClass* cl)
virtual char*TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_tTObject::GetObjectStat()
virtual void*TDirectoryFile::GetObjectUnchecked(const char* namecycle)
static Bool_tTFile::GetOnlyStaged()
static UInt_tTFile::GetOpenTimeout()
virtual Option_t*TFile::GetOption() const
virtual const char*TDirectory::GetPath() const
virtual const char*TDirectory::GetPathStatic() const
static Int_tTFile::GetReadaheadSize()
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)
Long64_tTFile::GetRelOffset() const
virtual Long64_tTDirectoryFile::GetSeekDir() const
virtual Long64_tTFile::GetSeekFree() const
virtual Long64_tTFile::GetSeekInfo() const
virtual Long64_tTDirectoryFile::GetSeekKeys() const
virtual Long64_tTDirectoryFile::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 = "", TString* prefix = 0)
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() constMENU
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
virtual Bool_tTDirectoryFile::IsModified() const
Bool_tTObject::IsOnHeap() const
virtual Bool_tIsOpen() const
Bool_tTFile::IsRaw() const
virtual Bool_tTNamed::IsSortable() const
virtual Bool_tTDirectoryFile::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")MENU
virtual voidTFile::Map()MENU
virtual Bool_tTNetFile::Matches(const char* url)
voidTObject::MayNotUse(const char* method) const
virtual TDirectory*TDirectoryFile::mkdir(const char* name, const char* title = "")
virtual Bool_tTFile::MustFlush() const
virtual Bool_tTObject::Notify()
virtual TFile*TDirectoryFile::OpenFile(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)
virtual voidTFile::Paint(Option_t* option = "")
virtual voidTObject::Pop()
virtual voidPrint(Option_t* option = "") const
virtual voidTDirectoryFile::Purge(Short_t nkeep = 1)
virtual voidTDirectory::pwd() const
virtual Int_tTObject::Read(const char* name)
virtual voidTDirectoryFile::ReadAll(Option_t* option = "")
virtual Bool_tReadBuffer(char* buf, Int_t len)
virtual Bool_tReadBufferAsync(Long64_t offs, Int_t len)
virtual Bool_tReadBuffers(char* buf, Long64_t* pos, Int_t* len, Int_t nbuf)
virtual voidTFile::ReadFree()
virtual Int_tTDirectoryFile::ReadKeys(Bool_t forceRead = kTRUE)
virtual TProcessID*TFile::ReadProcessID(UShort_t pidf)
virtual voidTFile::ReadStreamerInfo()
virtual Int_tTDirectoryFile::ReadTObject(TObject* obj, const char* keyname)
virtual Int_tTFile::Recover()
virtual voidTDirectory::RecursiveRemove(TObject* obj)
virtual TObject*TDirectory::Remove(TObject*)
virtual Int_tReOpen(Option_t* mode)
voidTObject::ResetBit(UInt_t f)
virtual voidResetCache()
virtual voidTFile::ResetErrno() const
virtual voidTDirectoryFile::rmdir(const char* name)
virtual voidTDirectoryFile::Save()
virtual voidTObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual Int_tTDirectoryFile::SaveObjectAs(const TObject* obj, const char* filename = "", Option_t* option = "") const
virtual voidTObject::SavePrimitive(basic_ostream<char,char_traits<char> >& out, Option_t* option = "")
virtual voidTDirectoryFile::SaveSelf(Bool_t force = kFALSE)
virtual voidTNetFile::Seek(Long64_t offset, TFile::ERelativeTo pos = kBeg)
voidTObject::SetBit(UInt_t f)
voidTObject::SetBit(UInt_t f, Bool_t set)
virtual voidTDirectoryFile::SetBufferSize(Int_t bufsize)
static Bool_tTFile::SetCacheFileDir(const char* cacheDir, Bool_t operateDisconnected = kTRUE, Bool_t forceCacheread = kFALSE)
virtual voidTFile::SetCacheRead(TFileCacheRead* cache)
virtual voidTFile::SetCacheWrite(TFileCacheWrite* cache)
virtual voidTFile::SetCompressionLevel(Int_t level = 1)
virtual voidTObject::SetDrawOption(Option_t* option = "")MENU
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)
virtual voidTDirectoryFile::SetModified()
virtual voidTDirectory::SetMother(TObject* mother)
virtual voidTDirectory::SetName(const char* newname)
virtual voidTNamed::SetNameTitle(const char* name, const char* title)
static voidTObject::SetObjectStat(Bool_t stat)
static Bool_tTFile::SetOnlyStaged(Bool_t onlystaged)
static UInt_tTFile::SetOpenTimeout(UInt_t timeout)
virtual voidTFile::SetOption(Option_t* option = ">")
static voidTFile::SetReadaheadSize(Int_t bufsize = 256000)
virtual voidTFile::SetReadCalls(Int_t readcalls = 0)
static voidTFile::SetReadStreamerInfo(Bool_t readinfo = kTRUE)
virtual voidTDirectoryFile::SetSeekDir(Long64_t v)
virtual voidTNamed::SetTitle(const char* title = "")MENU
virtual voidTDirectoryFile::SetTRefAction(TObject* ref, TObject* parent)
virtual voidTObject::SetUniqueID(UInt_t uid)
virtual voidTDirectoryFile::SetWritable(Bool_t writable = kTRUE)
virtual voidShowMembers(TMemberInspector& insp, char* parent)
virtual voidTFile::ShowStreamerInfo()
static Bool_tTFile::ShrinkCacheFileDir(Long64_t shrinkSize, Long_t cleanupInteval = 0)
virtual Int_tTFile::Sizeof() const
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* buffer, Int_t BufferLength)
virtual voidTDirectoryFile::WriteDirHeader()
virtual voidTFile::WriteFree()
virtual voidTFile::WriteHeader()
virtual voidTDirectoryFile::WriteKeys()
Int_tTDirectory::WriteObject(const void* obj, const char* name, Option_t* option = "", Int_t bufsize = 0)
virtual Int_tTDirectoryFile::WriteObjectAny(const void* obj, const char* classname, const char* name, Option_t* option = "", Int_t bufsize = 0)
virtual Int_tTDirectoryFile::WriteObjectAny(const void* obj, const TClass* cl, const char* name, Option_t* option = "", Int_t bufsize = 0)
virtual UShort_tTFile::WriteProcessID(TProcessID* pid)
virtual voidTFile::WriteStreamerInfo()
virtual Int_tTDirectoryFile::WriteTObject(const TObject* obj, const char* name = 0, Option_t* option = "", Int_t bufsize = 0)
protected:
Bool_tTDirectory::cd1(const char* path)
static Bool_tTDirectory::Cd1(const char* path)
virtual voidTDirectoryFile::CleanTargets()
virtual voidTNetFile::ConnectServer(Int_t* stat, EMessageTypes* kind, Int_t netopt, Int_t tcpwindowsize, Bool_t forceOpen, Bool_t forceRead)
virtual voidTNetFile::Create(const char* url, Option_t* option, Int_t netopt)
virtual voidTNetFile::Create(TSocket* s, Option_t* option, Int_t netopt)
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
Bool_tTFile::FlushWriteCache()
voidTObject::MakeZombie()
voidTNetFile::PrintError(const char* where, Int_t err)
Int_tTFile::ReadBufferViaCache(char* buf, Int_t len)
Int_tTNetFile::Recv(Int_t& status, EMessageTypes& kind)
voidTDirectory::RegisterContext(TDirectory::TContext* ctxt)
virtual Int_tTFile::SysRead(Int_t fd, void* buf, Int_t len)
virtual Long64_tTFile::SysSeek(Int_t fd, Long64_t offset, Int_t whence)
virtual Int_tTFile::SysSync(Int_t fd)
virtual Int_tTFile::SysWrite(Int_t fd, const void* buf, Int_t len)
voidTDirectory::UnregisterContext(TDirectory::TContext* ctxt)
Int_tTFile::WriteBufferViaCache(const char* buf, Int_t len)
private:
TXNetFile(const TXNetFile&)
voidCreateXClient(const char* url, Option_t* option, Int_t netopt, Bool_t parallelopen)
static voidFormUrl(TUrl uut, TString& uu)
static Int_tGetRootdProtocol(TSocket* s)
virtual voidInit(Bool_t create)
Bool_tOpen(Option_t* option, Bool_t parallelopen)
TXNetFile&operator=(const TXNetFile&)
Int_tParseOptions(const char* opts, Int_t& cachesz, Int_t& readaheadsz, Int_t& rmpolicy, Int_t& mxredir, Int_t& rastrategy, Int_t& readtrimblksz)
static voidSetEnv()
voidSynchronizeCacheSize()
virtual Int_tSysClose(Int_t fd)
virtual Int_tSysOpen(const char* pathname, Int_t flags, UInt_t mode)
virtual Int_tSysStat(Int_t fd, Long_t* id, Long64_t* size, Long_t* flags, Long_t* modtime)

Data Members

public:
enum TFile::EAsyncOpenStatus { kAOSNotAsync
kAOSFailure
kAOSInProgress
kAOSSuccess
};
enum TFile::EOpenTimeOut { kInstantTimeout
kEternalTimeout
};
enum TFile::EStatusBits { kRecovered
kHasReferences
kDevNull
kWriteError
kBinaryFile
kRedirected
};
enum TFile::ERelativeTo { kBeg
kCur
kEnd
};
enum TFile::[unnamed] { kStartBigFile
};
enum TFile::EFileType { kDefault
kLocal
kNet
kWeb
kFile
};
enum TDirectoryFile::[unnamed] { kCloseDirectory
};
enum TObject::EStatusBits { kCanDelete
kMustCleanup
kObjInCanvas
kIsReferenced
kHasUUID
kCannotPick
kNoContextMenu
kInvalidObject
};
enum TObject::[unnamed] { kIsOnHeap
kNotDeleted
kZombie
kBitMask
kSingleKey
kOverwrite
kWriteDelete
};
protected:
TArchiveFile*TFile::fArchive!Archive file from which we read this file
Long64_tTFile::fArchiveOffset!Offset at which file starts in archive
TFileOpenHandle*TFile::fAsyncHandle!For proper automatic cleanup
TFile::EAsyncOpenStatusTFile::fAsyncOpenStatus!Status of an asynchronous open request
Long64_tTFile::fBEGINFirst used byte in file
Int_tTDirectoryFile::fBufferSizeDefault buffer size to create new TKeys
Long64_tTFile::fBytesReadNumber of bytes read from this file
Long64_tTFile::fBytesReadExtraNumber of extra bytes (overhead) read by the readahead buffer
Long64_tTFile::fBytesWriteNumber of bytes written to this file
TFileCacheRead*TFile::fCacheRead!Pointer to the read cache (if any)
TFileCacheWrite*TFile::fCacheWrite!Pointer to the write cache (if any)
TArrayC*TFile::fClassIndex!Index of TStreamerInfo classes written to this file
Int_tTFile::fCompressCompression level from 0(not compressed) to 9 (max compression)
TDirectory::TContext*TDirectory::fContext!Pointer to a list of TContext object pointing to this TDirectory
Int_tTFile::fDFile descriptor
TDatimeTDirectoryFile::fDatimeCDate and time when directory is created
TDatimeTDirectoryFile::fDatimeMDate and time of last modification
Long64_tTFile::fENDLast used byte in file
TUrlTNetFile::fEndpointUrlURL of realfile (after possible redirection)
Int_tTNetFile::fErrorCodeerror code returned by rootd (matching gRootdErrStr)
TFile*TDirectoryFile::fFilepointer to current file in memory
TList*TFile::fFreeFree segments linked list table
TList*TFile::fInfoCache!Cached list of the streamer infos in this file
Bool_tTFile::fInitDone!True if the file has been initialized
Bool_tTFile::fIsArchive!True if this is a pure archive file
Bool_tTFile::fIsRootFile!True is this is a ROOT file, raw file otherwise
TList*TDirectoryFile::fKeysPointer to keys list in memory
TList*TDirectory::fListList of objects in memory
Bool_tTDirectoryFile::fModifiedtrue if directory has been modified
TObject*TDirectory::fMotherpointer to mother of the directory
Bool_tTFile::fMustFlush!True if the file buffers must be flushed
Int_tTFile::fNProcessIDsNumber of TProcessID written to this file
TStringTNamed::fNameobject identifier
Int_tTFile::fNbytesFreeNumber of bytes for free segments structure
Int_tTFile::fNbytesInfoNumber of bytes for StreamerInfo record
Int_tTDirectoryFile::fNbytesKeysNumber of bytes for the keys
Int_tTDirectoryFile::fNbytesNameNumber of bytes in TNamed at creation time
Int_tTNetFile::fNetoptinitial network options (used for ReOpen())
Bool_tTFile::fNoAnchorInName!True if we don't want to force the anchor to be appended to the file name
Long64_tTFile::fOffset!Seek offset used by remote file classes
TList*TFile::fOpenPhases!Time info about open phases
TStringTFile::fOptionFile options
TStringTDirectory::fPathBuffer!Buffer for GetPath() function
TObjArray*TFile::fProcessIDs!Array of pointers to TProcessIDs
Int_tTNetFile::fProtocolrootd protocol level
Int_tTFile::fReadCallsNumber of read calls ( not counting the cache calls )
TStringTFile::fRealNameEffective real file name (not original url)
Long64_tTDirectoryFile::fSeekDirLocation of directory on file
Long64_tTFile::fSeekFreeLocation on disk of free segments structure
Long64_tTFile::fSeekInfoLocation on disk of StreamerInfo record
Long64_tTDirectoryFile::fSeekKeysLocation of Keys record on file
Long64_tTDirectoryFile::fSeekParentLocation of parent directory on file
TSocket*TNetFile::fSocketconnection to rootd server
Double_tTFile::fSum2BufferSum of squares of buffer sizes of objects written so far
Double_tTFile::fSumBufferSum of buffer sizes of objects written so far
TStringTNamed::fTitleobject title
TUUIDTDirectory::fUUIDUnique identifier
Char_tTFile::fUnitsNumber of bytes for file pointers
TUrlTFile::fUrl!URL of file
TStringTNetFile::fUserremote user name
Int_tTFile::fVersionFile format version
Bool_tTDirectoryFile::fWritabletrue if directory is writable
Int_tTFile::fWrittenNumber of objects written so far
static Bool_tTDirectory::fgAddDirectory!flag to add histograms, graphs,etc to the directory
static TList*TFile::fgAsyncOpenRequestsList of handles for pending open requests
static Long64_tTFile::fgBytesReadNumber of bytes read by all TFile objects
static Long64_tTFile::fgBytesWriteNumber of bytes written by all TFile objects
static TStringTFile::fgCacheFileDirDirectory where to locally stage files
static Bool_tTFile::fgCacheFileDisconnectedIndicates, we trust in the files in the cache dir without stat on the cached file
static Bool_tTFile::fgCacheFileForceIndicates, to force all READ to CACHEREAD
static Long64_tTFile::fgFileCounterCounter for all opened files
static Bool_tTFile::fgOnlyStagedBefore the file is opened, it is checked, that the file is staged, if not, the open fails
static UInt_tTFile::fgOpenTimeoutTimeout for open operations in ms - 0 corresponds to blocking i/o
static Int_tTFile::fgReadCallsNumber of bytes read from all TFile objects
static Bool_tTFile::fgReadInfoif true (default) ReadStreamerInfo is called when opening a file
static Int_tTFile::fgReadaheadSizeReadahead buffer size
private:
XrdClient*fClientHandle to the client object
XrdSysRecMutex*fInitMtxProtects fInitDone, serializes the
Bool_tfIsRootdNature of remote file server
static Bool_tfgInitDoneAvoid initializing more than once
static Bool_tfgRootdBCControl rootd backward compatibility

Class Charts

Inheritance Inherited Members Includes Libraries
Class Charts

Function documentation

TXNetFile(const char* url, Option_t* option = "", const char* fTitle = "", Int_t compress = 1, Int_t netopt = 0, Bool_t parallelopen = kFALSE, const char* logicalurl = 0)
 Create a TXNetFile object. A TXNetFile object is the same as a TNetFile
 (from which the former derives) except that the protocol is extended to
 support dealing with new xrootd data server or xrootd load balancer
 server.

 The "url" argument must be of the form

   root://server1:port1[,server2:port2,...,serverN:portN]/pathfile,

 Note that this means that multiple servers (>= 1) can be specified in
 the url. The connection will try to connect to the first server:port
 and if that does not succeed, it will try the second one, and so on
 until it finds a server that will respond.

 See the TNetFile documentation for the description of the other arguments.

 The creation consists of internal variable settings (most important is
 the client's domain), creation of a TXUrl array containing all specified
 urls (a single url is serverX:portX/pathfile), trying to connect to the
 servers calling Connect() method, getting a valid access to the remote
 server the client is connected to using GetAccessToSrv() method,
 recognizing the remote server (if an old rootd the TNetFile's Create
 method will be called).

 The options field of the URL can be used for the following purposes:
   a. open a non-ROOT generic file
      "root://server1:port1[,server2:port2,...]/pathfile?filetype=raw"
   b. re-check the environment variables
      "root://server1:port1[,server2:port2,...]/pathfile?checkenv"
   c. set the cache size (in bytes)
      "root://server1:port1[,server2:port2,...]/pathfile?cachesz=20000000"
   d. set the read-ahead size (in bytes)
      "root://server1:port1[,server2:port2,...]/pathfile?readaheadsz=100000"
   e. set the cache remove policy
      "root://server1:port1[,server2:port2,...]/pathfile?rmpolicy=1"
   f. set the max number of redirections
      "root://server1:port1[,server2:port2,...]/pathfile?mxredir=2"
 (multiple options can be set concurrently)
~TXNetFile()
 Destructor.
void FormUrl(TUrl uut, TString& uu)
 Form url for rootd socket.
Int_t ParseOptions(const char* opts, Int_t& cachesz, Int_t& readaheadsz, Int_t& rmpolicy, Int_t& mxredir, Int_t& rastrategy, Int_t& readtrimblksz)
 Parse input options for cache parameters
void CreateXClient(const char* url, Option_t* option, Int_t netopt, Bool_t parallelopen)
 The real creation work is done here.
Int_t GetRootdProtocol(TSocket* s)
 Find out the remote rootd protocol version.
 Returns -1 in case of error.
Bool_t Open(Option_t* option, Bool_t parallelopen)
 The real creation work is done here.
Bool_t ReadBuffer(char* buf, Int_t len)
 Override TNetFile::ReadBuffer to deal with the xrootd server.
 Returns kTRUE in case of errors.
Bool_t ReadBufferAsync(Long64_t offs, Int_t len)
 Implementation dealing with the xrootd server.
 Returns kTRUE in case of errors.
 This is the same as TXNetFile::ReadBuffer but using the async
 call from xrootd
Bool_t ReadBuffers(char* buf, Long64_t* pos, Int_t* len, Int_t nbuf)
 Read the nbuf blocks described in arrays pos and len,
 where pos[i] is the seek position of block i of length len[i].
 Note that for nbuf=1, this call is equivalent to TFile::ReafBuffer
 This function is overloaded by TNetFile, TWebFile, etc.
 Returns kTRUE in case of failure.
 Note: This is the overloading made in TXNetFile, If ReadBuffers
 is supported by xrootd it will try to gt the whole list from one single
 call avoiding the latency of multiple calls
Bool_t WriteBuffer(const char* buffer, Int_t BufferLength)
 Override TNetFile::WriteBuffer to deal with the xrootd server.
 Returns kTRUE in case of errors.
void Init(Bool_t create)
 Initialize the file. Makes sure that the file is really open before
 calling TFile::Init. It may block.
Bool_t IsOpen() const
 Return kTRUE if the file is open, kFALSE otherwise.
TFile::EAsyncOpenStatus GetAsyncOpenStatus()
 Return status of asynchronous request
Int_t ReOpen(Option_t* mode)
 Re-open the file (see TNetFile::ReOpen() or TFile::ReOpen()
 for more details).
void Close(Option_t* opt = "")
 Close the file (see TNetFile::Close() or TFile::Close()
 for more details).
void Flush()
 Flushes un-written data.
Int_t SysStat(Int_t fd, Long_t* id, Long64_t* size, Long_t* flags, Long_t* modtime)
 Override TNetFile::SysStat (see parent's method for more details).
Int_t SysClose(Int_t fd)
 Override TNetFile::SysClose (see parent's method for more details).
Int_t SysOpen(const char* pathname, Int_t flags, UInt_t mode)
 Override TNetFile::SysOpen (see parent's method for more details).
void SetEnv()
 Set the relevant environment variables
void SynchronizeCacheSize()
 Synchronize the cache size
 Alternative purging policy
void ResetCache()
 Reset the cache
Int_t GetBytesToPrefetch() const
 Max number of bytes to prefetch.
void Print(Option_t* option = "") const
 Print the local statistics.
TXNetFile(const TXNetFile& )
 attempts to Init() for this object only
 Methods
TXNetFile& operator=(const TXNetFile& )
TXNetFile()
{}