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 independently 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)

Interfaced to the standalone client (XrdClient): G. Ganis, CERN

Definition at line 55 of file TXNetFile.h.

Public Member Functions
	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)
	Create a TXNetFile object.

virtual	~TXNetFile ()
	Destructor.

virtual void	Close (const Option_t *opt="")
	Close the file (see TNetFile::Close() or TFile::Close() for more details).

virtual void	Flush ()
	Flushes un-written data.

virtual TFile::EAsyncOpenStatus	GetAsyncOpenStatus ()
	Return status of asynchronous request.

virtual Int_t	GetBytesToPrefetch () const
	Max number of bytes to prefetch.

virtual TClass *	IsA () const

virtual Bool_t	IsOpen () const
	Return kTRUE if the file is open, kFALSE otherwise.

virtual void	Print (Option_t *option="") const
	Print the local statistics.

virtual Bool_t	ReadBuffer (char *buf, Int_t len)
	Override TNetFile::ReadBuffer to deal with the xrootd server.

virtual Bool_t	ReadBuffer (char *buf, Long64_t pos, Int_t len)
	Pass through to TNetFile implementation which will call back eventually to our ReadBuffer with 2 arguments to deal with xrootd errors.

virtual Bool_t	ReadBufferAsync (Long64_t offs, Int_t len)
	Implementation dealing with the xrootd server.

virtual 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].

virtual Int_t	ReOpen (const Option_t *mode)
	Re-open the file (see TNetFile::ReOpen() or TFile::ReOpen() for more details).

virtual void	ResetCache ()
	Reset the cache.

virtual void	Streamer (TBuffer &)
	Stream a TFile object.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual Bool_t	WriteBuffer (const char *buffer, Int_t BufferLength)
	Override TNetFile::WriteBuffer to deal with the xrootd server.

Public Member Functions inherited from TNetFile
	TNetFile ()

	TNetFile (const char url, Option_t option="", const char *ftitle="", Int_t compress=ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault, Int_t netopt=0)
	Create a TNetFile object.

virtual	~TNetFile ()
	TNetFile dtor. Send close message and close socket.

void	Close (Option_t *option="") override
	Close remote file.

const TUrl *	GetEndpointUrl () const override

Int_t	GetErrorCode () const

Bool_t	Matches (const char *url) override
	Return kTRUE if 'url' matches the coordinates of this file.

Int_t	ReOpen (Option_t *mode) override
	Reopen a file with a different access mode, like from READ to UPDATE or from NEW, CREATE, RECREATE, UPDATE to READ.

void	Seek (Long64_t offset, ERelativeTo pos=kBeg) override
	Set position from where to start reading.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TFile
	TFile ()
	File default Constructor.

	TFile (const char fname, Option_t option="", const char *ftitle="", Int_t compress=ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault)
	Opens or creates a local ROOT file.

virtual	~TFile ()
	File destructor.

void	Copy (TObject &) const override
	Copy this to obj.

virtual Bool_t	Cp (const char *dst, Bool_t progressbar=kTRUE, UInt_t buffersize=1000000)
	Allows to copy this file to the dst URL.

virtual TKey *	CreateKey (TDirectory mother, const TObject obj, const char *name, Int_t bufsize)
	Creates key for object and converts data to buffer.

virtual TKey *	CreateKey (TDirectory mother, const void obj, const TClass cl, const char name, Int_t bufsize)
	Creates key for object and converts data to buffer.

void	Delete (const char *namecycle="") override
	Delete object namecycle.

void	Draw (Option_t *option="") override
	Fill Graphics Structure and Paint.

virtual void	DrawMap (const char keys="", Option_t *option="")
	Draw map of objects in this file.

void	FillBuffer (char *&buffer) override
	Encode file output buffer.

TArchiveFile *	GetArchive () const

Long64_t	GetArchiveOffset () const

Int_t	GetBestBuffer () const
	Return the best buffer size of objects on this file.

virtual Long64_t	GetBytesRead () const

virtual Long64_t	GetBytesReadExtra () const

virtual Long64_t	GetBytesWritten () const
	Return the total number of bytes written so far to the file.

TFileCacheRead *	GetCacheRead (const TObject *tree=nullptr) const
	Return a pointer to the current read cache.

TFileCacheWrite *	GetCacheWrite () const
	Return a pointer to the current write cache.

TArrayC *	GetClassIndex () const

Int_t	GetCompressionAlgorithm () const

Float_t	GetCompressionFactor ()
	Return the file compression factor.

Int_t	GetCompressionLevel () const

Int_t	GetCompressionSettings () const

virtual Long64_t	GetEND () const

virtual Int_t	GetErrno () const
	Method returning errno.

Int_t	GetFd () const

TList *	GetListOfFree () const

TObjArray *	GetListOfProcessIDs () const

virtual Int_t	GetNbytesFree () const

virtual Int_t	GetNbytesInfo () const

virtual TString	GetNewUrl ()

virtual Int_t	GetNfree () const

virtual Int_t	GetNProcessIDs () const

Option_t *	GetOption () const override

virtual Int_t	GetReadCalls () const

Int_t	GetRecordHeader (char *buf, Long64_t first, Int_t maxbytes, Int_t &nbytes, Int_t &objlen, Int_t &keylen)
	Read the logical record header starting at a certain postion.

Long64_t	GetRelOffset () const

virtual Long64_t	GetSeekFree () const

virtual Long64_t	GetSeekInfo () const

virtual Long64_t	GetSize () const
	Returns the current file size.

const TList *	GetStreamerInfoCache ()
	Returns the cached list of StreamerInfos used in this file.

virtual TList *	GetStreamerInfoList () final
	Read the list of TStreamerInfo objects written to this file.

Int_t	GetVersion () const

virtual void	IncrementProcessIDs ()

virtual Bool_t	IsArchive () const

Bool_t	IsBinary () const

Bool_t	IsRaw () const

void	ls (Option_t *option="") const override
	List file contents.

virtual void	MakeFree (Long64_t first, Long64_t last)
	Mark unused bytes on the file.

virtual void	MakeProject (const char dirname, const char classes="", Option_t option="new")
	Generate source code necessary to access the objects stored in the file.

virtual void	Map ()

virtual void	Map (Option_t *opt)
	List the contents of a file sequentially.

virtual Bool_t	MustFlush () const

void	Paint (Option_t *option="") override
	Paint all objects in the file.

virtual void	ReadFree ()
	Read the FREE linked list.

virtual TProcessID *	ReadProcessID (UShort_t pidf)
	The TProcessID with number pidf is read from this file.

virtual void	ReadStreamerInfo ()
	Read the list of StreamerInfo from this file.

virtual Int_t	Recover ()
	Attempt to recover file if not correctly closed.

virtual void	ResetErrno () const
	Method resetting the errno.

virtual void	SetCacheRead (TFileCacheRead cache, TObject tree=nullptr, ECacheAction action=kDisconnect)
	Set a pointer to the read cache.

virtual void	SetCacheWrite (TFileCacheWrite *cache)
	Set a pointer to the write cache.

virtual void	SetCompressionAlgorithm (Int_t algorithm=ROOT::RCompressionSetting::EAlgorithm::kUseGlobal)
	See comments for function SetCompressionSettings.

virtual void	SetCompressionLevel (Int_t level=ROOT::RCompressionSetting::ELevel::kUseMin)
	See comments for function SetCompressionSettings.

virtual void	SetCompressionSettings (Int_t settings=ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault)
	Used to specify the compression level and algorithm.

virtual void	SetEND (Long64_t last)

virtual void	SetOffset (Long64_t offset, ERelativeTo pos=kBeg)
	Set position from where to start reading.

virtual void	SetOption (Option_t *option=">")

virtual void	SetReadCalls (Int_t readcalls=0)

virtual void	ShowStreamerInfo ()
	Show the StreamerInfo of all classes written to this file.

Int_t	Sizeof () const override
	Return the size in bytes of the file header.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

void	SumBuffer (Int_t bufsize)
	Increment statistics for buffer sizes of objects in this file.

Int_t	Write (const char *name=nullptr, Int_t opt=0, Int_t bufsiz=0) const override
	One can not save a const TDirectory object.

Int_t	Write (const char *name=nullptr, Int_t opt=0, Int_t bufsiz=0) override
	Write memory objects to this file.

virtual void	WriteFree ()
	Write FREE linked list on the file.

virtual void	WriteHeader ()
	Write File Header.

virtual UShort_t	WriteProcessID (TProcessID *pid)
	Check if the ProcessID pidd is already in the file, if not, add it and return the index number in the local file list.

virtual void	WriteStreamerInfo ()
	Write the list of TStreamerInfo as a single object in this file The class Streamer description for all classes written to this file is saved.

Public Member Functions inherited from TDirectoryFile
	TDirectoryFile ()
	Default TDirectoryFile constructor.

	TDirectoryFile (const char name, const char title, Option_t option="", TDirectory motherDir=nullptr)
	Create a new TDirectoryFile.

virtual	~TDirectoryFile ()
	Destructor.

void	Add (TObject *obj, Bool_t replace=kFALSE) override

void	Append (TObject *obj, Bool_t replace=kFALSE) override
	Append object to this directory.

Int_t	AppendKey (TKey *key) override
	Insert key in the linked list of keys of this directory.

void	Browse (TBrowser *b) override
	Browse the content of the directory.

void	Build (TFile motherFile=nullptr, TDirectory motherDir=nullptr) override

Bool_t	cd () override
	Change current directory to "this" directory.

Bool_t	cd (const char *path) override
	Change current directory the directory described by the path if given one.

TObject *	CloneObject (const TObject *obj, Bool_t autoadd=kTRUE) override
	Make a clone of an object using the Streamer facility.

TKey *	FindKey (const char *keyname) const override
	Find key with name keyname in the current directory.

TKey *	FindKeyAny (const char *keyname) const override
	Find key with name keyname in the current directory or its subdirectories.

TObject *	FindObjectAny (const char *name) const override
	Find object by name in the list of memory objects of the current directory or its sub-directories.

TObject *	FindObjectAnyFile (const char *name) const override
	Scan the memory lists of all files for an object with name.

template<class T >
T *	Get (const char *namecycle)
	See documentation of TDirectoryFile::Get(const char *namecycle)

TObject *	Get (const char *namecycle) override
	Return pointer to object identified by namecycle.

Int_t	GetBufferSize () const override
	Return the buffer size to create new TKeys.

const TDatime &	GetCreationDate () const

TDirectory *	GetDirectory (const char apath, Bool_t printError=false, const char funcname="GetDirectory") override
	Find a directory named "apath".

TFile *	GetFile () const override

TKey *	GetKey (const char *name, Short_t cycle=9999) const override
	Return pointer to key with name,cycle.

TList *	GetListOfKeys () const override

const TDatime &	GetModificationDate () const

Int_t	GetNbytesKeys () const override

Int_t	GetNkeys () const override

void *	GetObjectChecked (const char namecycle, const char classname) override
	See documentation of TDirectoryFile::GetObjectCheck(const char namecycle, const TClass cl)

void *	GetObjectChecked (const char namecycle, const TClass cl) override
	Return pointer to object identified by namecycle if and only if the actual object is a type suitable to be stored as a pointer to a "expectedClass" If expectedClass is null, no check is performed.

void *	GetObjectUnchecked (const char *namecycle) override
	Return pointer to object identified by namecycle.

Long64_t	GetSeekDir () const override

Long64_t	GetSeekKeys () const override

Long64_t	GetSeekParent () const override

Bool_t	IsModified () const override

Bool_t	IsWritable () const override

TDirectory *	mkdir (const char name, const char title="", Bool_t returnExistingDirectory=kFALSE) override
	Create a sub-directory "a" or a hierarchy of sub-directories "a/b/c/...".

TFile *	OpenFile (const char name, Option_t option="", const char *ftitle="", Int_t compress=ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault, Int_t netopt=0) override
	Interface to TFile::Open.

void	Purge (Short_t nkeep=1) override
	Purge lowest key cycles in a directory.

void	ReadAll (Option_t *option="") override
	Read objects from a ROOT file directory into memory.

Int_t	ReadKeys (Bool_t forceRead=kTRUE) override
	Read the linked list of keys.

Int_t	ReadTObject (TObject obj, const char keyname) override
	Read object with keyname from the current directory.

virtual void	ResetAfterMerge (TFileMergeInfo *)
	Reset the TDirectory after its content has been merged into another Directory.

void	rmdir (const char *name) override
	Removes subdirectory from the directory.

void	Save () override
	Save recursively all directory keys and headers.

Int_t	SaveObjectAs (const TObject obj, const char filename="", Option_t *option="") const override
	Save object in filename.

void	SaveSelf (Bool_t force=kFALSE) override
	Save Directory keys and header.

void	SetBufferSize (Int_t bufsize) override
	Set the default buffer size when creating new TKeys.

void	SetModified () override

void	SetSeekDir (Long64_t v) override

void	SetTRefAction (TObject ref, TObject parent) override
	Find the action to be executed in the dictionary of the parent class and store the corresponding exec number into fBits.

void	SetWritable (Bool_t writable=kTRUE) override
	Set the new value of fWritable recursively.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

void	WriteDirHeader () override
	Overwrite the Directory header record.

void	WriteKeys () override
	Write Keys linked list on the file.

Int_t	WriteObjectAny (const void obj, const char classname, const char name, Option_t option="", Int_t bufsize=0) override
	Write object from pointer of class classname in this directory.

Int_t	WriteObjectAny (const void obj, const TClass cl, const char name, Option_t option="", Int_t bufsize=0) override
	Write object of class with dictionary cl in this directory.

Int_t	WriteTObject (const TObject obj, const char name=nullptr, Option_t *option="", Int_t bufsize=0) override
	Write object obj to this directory.

Public Member Functions inherited from TDirectory
	TDirectory ()
	Directory default constructor.

	TDirectory (const char name, const char title, Option_t option="", TDirectory motherDir=nullptr)
	Create a new Directory.

virtual	~TDirectory ()
	Destructor.

void	Clear (Option_t *option="") override
	Delete all objects from a Directory list.

virtual void	DeleteAll (Option_t *option="")
	Delete all objects from memory.

TObject *	FindObject (const char *name) const override
	Find object by name in the list of memory objects.

TObject *	FindObject (const TObject *obj) const override
	Find object in the list of memory objects.

template<class T >
T *	Get (const char *namecycle)
	See documentation of TDirectoryFile::Get(const char *namecycle)

virtual TList *	GetList () const

TObject *	GetMother () const

TDirectory *	GetMotherDir () const

template<class T >
void	GetObject (const char namecycle, T &ptr)
	Get an object with proper type checking.

virtual const char *	GetPath () const
	Returns the full path of the directory.

virtual const char *	GetPathStatic () const
	Returns the full path of the directory.

TUUID	GetUUID () const

Bool_t	IsBuilt () const

Bool_t	IsFolder () const override
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

virtual void	pwd () const
	Print the path of the directory.

	R__DEPRECATED (6, 30, "Cannot be used safely, use `name + ';' + std::to_string(cycle)`") static void EncodeNameCycle(char *buffer

void	RecursiveRemove (TObject *obj) override
	Recursively remove object from a Directory.

virtual TObject *	Remove (TObject *)
	Remove an object from the in-memory list.

virtual void	SetMother (TObject *mother)

void	SetName (const char *newname) override
	Set the name for directory If the directory name is changed after the directory was written once, ROOT currently would NOT change the name of correspondent key in the mother directory.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

template<typename T >
std::enable_if_t<!std::is_base_of< TObject, T >::value, Int_t >	WriteObject (const T obj, const char name, Option_t *option="", Int_t bufsize=0)
	Write an object with proper type checking.

template<typename T >
std::enable_if_t< std::is_base_of< TObject, T >::value, Int_t >	WriteObject (const T obj, const char name, Option_t *option="", Int_t bufsize=0)
	Write an object with proper type checking.

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TNamed &named)
	TNamed copy ctor.

	TNamed (const TString &name, const TString &title)

virtual	~TNamed ()
	TNamed destructor.

void	Clear (Option_t *option="") override
	Set name and title to empty strings ("").

TObject *	Clone (const char *newname="") const override
	Make a clone of an object using the Streamer facility.

Int_t	Compare (const TObject *obj) const override
	Compare two TNamed objects.

void	Copy (TObject &named) const override
	Copy this to obj.

const char *	GetName () const override
	Returns name of object.

const char *	GetTitle () const override
	Returns title of object.

ULong_t	Hash () const override
	Return hash value for this object.

Bool_t	IsSortable () const override

void	ls (Option_t *option="") const override
	List TNamed name and title.

TNamed &	operator= (const TNamed &rhs)
	TNamed assignment operator.

virtual void	SetNameTitle (const char name, const char title)
	Set all the TNamed parameters (name and title).

virtual void	SetTitle (const char *title="")
	Set the title of the TNamed.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

ULong_t	CheckedHash ()
	Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad with: `gROOT->SetSelectedPad(c1)`.

virtual void	Dump () const
	Dump contents of object on stdout.

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.

virtual void	Execute (const char method, const char params, Int_t *error=nullptr)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)
	Execute method on this object with parameters stored in the TObjArray.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.

Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message.

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const
	IsDestructed.

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification.

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.

void	operator delete (void *ptr)
	Operator delete.

void	operator delete[] (void *ptr)
	Operator delete [].

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename.

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out".

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message.

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TNetFile
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TFile
static TFileOpenHandle *	AsyncOpen (const char name, Option_t option="", const char *ftitle="", Int_t compress=ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault, Int_t netopt=0)
	Submit an asynchronous open request.

static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static Bool_t	Cp (const char src, const char dst, Bool_t progressbar=kTRUE, UInt_t buffersize=1000000)
	Allows to copy file from src to dst URL.

static TFile *&	CurrentFile ()
	Return the current ROOT file if any.

static const char *	DeclFileName ()

static EAsyncOpenStatus	GetAsyncOpenStatus (const char *name)
	Get status of the async open request related to 'name'.

static EAsyncOpenStatus	GetAsyncOpenStatus (TFileOpenHandle *handle)
	Get status of the async open request related to 'handle'.

static const char *	GetCacheFileDir ()
	Get the directory where to locally stage/cache remote files.

static const TUrl *	GetEndpointUrl (const char *name)
	Get final URL for file being opened asynchronously.

static Long64_t	GetFileBytesRead ()
	Static function returning the total number of bytes read from all files.

static Long64_t	GetFileBytesWritten ()
	Static function returning the total number of bytes written to all files.

static Long64_t	GetFileCounter ()

static Int_t	GetFileReadCalls ()
	Static function returning the total number of read calls from all files.

static Bool_t	GetOnlyStaged ()
	Returns staged only flag.

static UInt_t	GetOpenTimeout ()
	Returns open timeout (in ms).

static Int_t	GetReadaheadSize ()
	Static function returning the readahead buffer size.

static Bool_t	GetReadStreamerInfo ()
	If the streamerinfos are to be read at file opening.

static EFileType	GetType (const char name, Option_t option="", TString *prefix=nullptr)
	Resolve the file type as a function of the protocol field in 'name'.

static void	IncrementFileCounter ()

static TFile *	Open (const char name, Option_t option="", const char *ftitle="", Int_t compress=ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault, Int_t netopt=0)
	Create / open a file.

static TFile *	Open (TFileOpenHandle *handle)
	Waits for the completion of an asynchronous open request.

static Bool_t	SetCacheFileDir (ROOT::Internal::TStringView cacheDir, Bool_t operateDisconnected=kTRUE, Bool_t forceCacheread=kFALSE)

static Bool_t	SetCacheFileDir (std::string_view cacheDir, Bool_t operateDisconnected=kTRUE, Bool_t forceCacheread=kFALSE)
	Sets the directory where to locally stage/cache remote files.

static void	SetFileBytesRead (Long64_t bytes=0)

static void	SetFileBytesWritten (Long64_t bytes=0)

static void	SetFileReadCalls (Int_t readcalls=0)

static Bool_t	SetOnlyStaged (Bool_t onlystaged)
	Sets only staged flag.

static UInt_t	SetOpenTimeout (UInt_t timeout)
	Sets open timeout time (in ms). Returns previous timeout value.

static void	SetReadaheadSize (Int_t bufsize=256000)

static void	SetReadStreamerInfo (Bool_t readinfo=kTRUE)
	Specify if the streamerinfos must be read at file opening.

static Bool_t	ShrinkCacheFileDir (Long64_t shrinkSize, Long_t cleanupInteval=0)
	Try to shrink the cache to the desired size.

Static Public Member Functions inherited from TDirectoryFile
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TDirectory
static void	AddDirectory (Bool_t add=kTRUE)
	Sets the flag controlling the automatic add objects like histograms, TGraph2D, etc in memory.

static Bool_t	AddDirectoryStatus ()
	Static function: see TDirectory::AddDirectory for more comments.

static Bool_t	Cd (const char *path)
	Change current directory to "path".

static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static std::atomic< TDirectory * > &	CurrentDirectory ()
	Return the current directory for the current thread.

static const char *	DeclFileName ()

static void	DecodeNameCycle (const char namecycle, char name, Short_t &cycle, const size_t namesize=0)
	Decode a namecycle "aap;2" into name "aap" and cycle "2".

Static Public Member Functions inherited from TNamed
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Longptr_t	GetDtorOnly ()
	Return destructor only flag.

static Bool_t	GetObjectStat ()
	Get status of object stat flag.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Private Member Functions
	TXNetFile (const TXNetFile &)

void	CreateXClient (const char url, Option_t option, Int_t netopt, Bool_t parallelopen)
	The real creation work is done here.

void	Init (Bool_t create)
	Initialize the file.

Bool_t	Open (Option_t *option, Bool_t parallelopen)
	The real creation work is done here.

TXNetFile &	operator= (const TXNetFile &)

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	SynchronizeCacheSize ()
	Synchronize the cache size Alternative purging policy.

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).

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).

Static Private Member Functions
static void	FormUrl (TUrl uut, TString &uu)
	Form url for rootd socket.

static Int_t	GetRootdProtocol (TSocket *s)
	Find out the remote rootd protocol version.

static void	SetEnv ()
	Set the relevant environment variables.

Private Attributes
XrdClient *	fClient

void *	fInitMtx

Bool_t	fIsRootd

Static Private Attributes
static TFileStager *	fgFileStager = 0

static Bool_t	fgInitDone = kFALSE

static Bool_t	fgRootdBC = kTRUE

Friends
class	TXNetSystem

Additional Inherited Members
Public Types inherited from TFile
enum	{ kStartBigFile = 2000000000 }

enum	EAsyncOpenStatus { kAOSNotAsync = -1 , kAOSFailure = 0 , kAOSInProgress = 1 , kAOSSuccess = 2 }
	Asynchronous open request status. More...

enum	ECacheAction { kDisconnect = 0 , kDoNotDisconnect = 1 }
	TTreeCache flushing semantics. More...

enum	EFileType { kDefault = 0 , kLocal = 1 , kNet = 2 , kWeb = 3 , kFile = 4 , kMerge = 5 }
	File type. More...

enum	EOpenTimeOut { kInstantTimeout = 0 , kEternalTimeout = 999999999 }
	Open timeout constants. More...

enum	ERelativeTo { kBeg = 0 , kCur = 1 , kEnd = 2 }

enum	EStatusBits { kRecovered = (1ULL << ( 10 )) , kHasReferences = (1ULL << ( 11 )) , kDevNull = (1ULL << ( 12 )) , kWriteError = (1ULL << ( 14 )) , kBinaryFile = (1ULL << ( 15 )) , kRedirected = (1ULL << ( 16 )) , kReproducible = (1ULL << ( 17 )) }
	TFile status bits. BIT(13) is taken up by TObject. More...

Public Types inherited from TDirectoryFile
enum	EStatusBits { kCloseDirectory = (1ULL << ( 7 )) }

Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }

enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }

enum	EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) }

Public Attributes inherited from TDirectory
const char Short_t	cycle

const char *	name

Protected Types inherited from TDirectory
using	SharedGDirectory_t = std::shared_ptr< std::atomic< TDirectory * > >
	Pointer to a list of TContext object pointing to this TDirectory.

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

Protected Member Functions inherited from TNetFile
	TNetFile (const char url, const char ftitle, Int_t comp, Bool_t)
	Create a TNetFile object.

	TNetFile (const TNetFile &)

virtual void	ConnectServer (Int_t stat, EMessageTypes kind, Int_t netopt, Int_t tcpwindowsize, Bool_t forceOpen, Bool_t forceRead)
	Connect to remote rootd server.

virtual void	Create (const char url, Option_t option, Int_t netopt)
	Create a NetFile object.

virtual void	Create (TSocket s, Option_t option, Int_t netopt)
	Create a NetFile object using an existing connection (socket s).

TNetFile &	operator= (const TNetFile &)

void	PrintError (const char *where, Int_t err)
	Print error string depending on error code.

Int_t	Recv (Int_t &status, EMessageTypes &kind)
	Return status from rootd server and message kind.

Protected Member Functions inherited from TFile
virtual Long64_t	DirCreateEntry (TDirectory *)

virtual Int_t	DirReadKeys (TDirectory *)

virtual void	DirWriteHeader (TDirectory *)

virtual void	DirWriteKeys (TDirectory *)

Bool_t	FlushWriteCache ()
	Flush the write cache if active.

virtual InfoListRet	GetStreamerInfoListImpl (bool lookupSICache)
	See documentation of GetStreamerInfoList for more details.

Int_t	MakeProjectParMake (const char packname, const char filename)
	Create makefile at 'filemake' for PAR package 'pack'.

Int_t	MakeProjectParProofInf (const char packname, const char proofinfdir)
	Create BUILD.sh and SETUP.C under 'proofinf' for PAR package 'pack'.

Int_t	ReadBufferViaCache (char *buf, Int_t len)
	Read buffer via cache.

virtual Int_t	SysRead (Int_t fd, void *buf, Int_t len)
	Interface to system read. All arguments like in POSIX read().

virtual Long64_t	SysSeek (Int_t fd, Long64_t offset, Int_t whence)
	Interface to system lseek.

virtual Int_t	SysSync (Int_t fd)
	Interface to system fsync. All arguments like in POSIX fsync().

virtual Int_t	SysWrite (Int_t fd, const void *buf, Int_t len)
	Interface to system write. All arguments like in POSIX write().

Int_t	WriteBufferViaCache (const char *buf, Int_t len)
	Write buffer via cache.

Protected Member Functions inherited from TDirectoryFile
void	BuildDirectoryFile (TFile motherFile, TDirectory motherDir)
	Initialise directory to defaults.

void	CleanTargets ()
	Clean the pointers to this object (gDirectory, TContext, etc.)

void	InitDirectoryFile (TClass *cl=nullptr)
	Initialize the key associated with this directory (and the related data members.

Protected Member Functions inherited from TDirectory
	TDirectory (const TDirectory &directory)=delete

void	BuildDirectory (TFile motherFile, TDirectory motherDir)
	Initialise directory to defaults.

Bool_t	cd1 (const char *path)
	flag to add histograms, graphs,etc to the directory

void	CleanTargets ()
	Clean the pointers to this object (gDirectory, TContext, etc.).

void	FillFullPath (TString &buf) const
	Recursive method to fill full path for directory.

void	operator= (const TDirectory &)=delete

void	RegisterContext (TContext *ctxt)
	Register a TContext pointing to this TDirectory object.

void	RegisterGDirectory (SharedGDirectory_t &ptr)
	Register a std::atomic<TDirectory*> that will soon be pointing to this TDirectory object.

void	UnregisterContext (TContext *ctxt)
	UnRegister a TContext pointing to this TDirectory object.

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected).

void	MakeZombie ()

Static Protected Member Functions inherited from TDirectory
static Bool_t	Cd1 (const char *path)
	Change current directory to "path".

static SharedGDirectory_t &	GetSharedLocalCurrentDirectory ()
	Return the (address of) a shared pointer to the struct holding the actual thread local gDirectory pointer and the atomic_flag for its lock.

Protected Attributes inherited from TNetFile
TUrl	fEndpointUrl

Int_t	fErrorCode

Int_t	fNetopt

Int_t	fProtocol

TSocket *	fSocket

TString	fUser

Protected Attributes inherited from TFile
TArchiveFile *	fArchive {nullptr}
	!Archive file from which we read this file

Long64_t	fArchiveOffset {0}
	!Offset at which file starts in archive

TFileOpenHandle *	fAsyncHandle {nullptr}
	!For proper automatic cleanup

EAsyncOpenStatus	fAsyncOpenStatus {kAOSNotAsync}
	!Status of an asynchronous open request

Long64_t	fBEGIN {0}
	First used byte in file.

Long64_t	fBytesRead {0}
	Number of bytes read from this file.

Long64_t	fBytesReadExtra {0}
	Number of extra bytes (overhead) read by the readahead buffer.

Long64_t	fBytesWrite {0}
	Number of bytes written to this file.

TFileCacheRead *	fCacheRead {nullptr}
	!Pointer to the read cache (if any)

TMap *	fCacheReadMap {nullptr}
	!Pointer to the read cache (if any)

TFileCacheWrite *	fCacheWrite {nullptr}
	!Pointer to the write cache (if any)

TArrayC *	fClassIndex {nullptr}
	!Index of TStreamerInfo classes written to this file

Int_t	fCompress {0}
	Compression level and algorithm.

Int_t	fD {-1}
	File descriptor.

Long64_t	fEND {0}
	Last used byte in file.

TList *	fFree {nullptr}
	Free segments linked list table.

bool	fGlobalRegistration = true
	! if true, bypass use of global lists

TList *	fInfoCache {nullptr}
	!Cached list of the streamer infos in this file

Bool_t	fInitDone {kFALSE}
	!True if the file has been initialized

Bool_t	fIsArchive {kFALSE}
	!True if this is a pure archive file

Bool_t	fIsPcmFile {kFALSE}
	!True if the file is a ROOT pcm file.

Bool_t	fIsRootFile {kTRUE}
	!True is this is a ROOT file, raw file otherwise

Bool_t	fMustFlush {kTRUE}
	!True if the file buffers must be flushed

Int_t	fNbytesFree {0}
	Number of bytes for free segments structure.

Int_t	fNbytesInfo {0}
	Number of bytes for StreamerInfo record.

Bool_t	fNoAnchorInName {kFALSE}
	!True if we don't want to force the anchor to be appended to the file name

Int_t	fNProcessIDs {0}
	Number of TProcessID written to this file.

Long64_t	fOffset {0}
	!Seek offset cache

TList *	fOpenPhases {nullptr}
	!Time info about open phases

TString	fOption
	File options.

TObjArray *	fProcessIDs {nullptr}
	!Array of pointers to TProcessIDs

Int_t	fReadCalls {0}
	Number of read calls ( not counting the cache calls )

TString	fRealName
	Effective real file name (not original url)

Long64_t	fSeekFree {0}
	Location on disk of free segments structure.

Long64_t	fSeekInfo {0}
	Location on disk of StreamerInfo record.

Double_t	fSum2Buffer {0}
	Sum of squares of buffer sizes of objects written so far.

Double_t	fSumBuffer {0}
	Sum of buffer sizes of objects written so far.

Char_t	fUnits {0}
	Number of bytes for file pointers.

TUrl	fUrl
	!URL of file

Int_t	fVersion {0}
	File format version.

std::mutex	fWriteMutex
	!Lock for writing baskets / keys into the file.

Int_t	fWritten {0}
	Number of objects written so far.

Protected Attributes inherited from TDirectoryFile
Int_t	fBufferSize {0}
	Default buffer size to create new TKeys.

TDatime	fDatimeC
	Date and time when directory is created.

TDatime	fDatimeM
	Date and time of last modification.

TFile *	fFile {nullptr}
	Pointer to current file in memory.

TList *	fKeys {nullptr}
	Pointer to keys list in memory.

Bool_t	fModified {kFALSE}
	True if directory has been modified.

Int_t	fNbytesKeys {0}
	Number of bytes for the keys.

Int_t	fNbytesName {0}
	Number of bytes in TNamed at creation time.

Long64_t	fSeekDir {0}
	Location of directory on file.

Long64_t	fSeekKeys {0}
	Location of Keys record on file.

Long64_t	fSeekParent {0}
	Location of parent directory on file.

Bool_t	fWritable {kFALSE}
	True if directory is writable.

Protected Attributes inherited from TDirectory
TContext *	fContext {nullptr}
	Buffer for GetPath() function.

std::atomic< size_t >	fContextPeg {0}
	thread local gDirectory pointing to this object.

std::vector< SharedGDirectory_t >	fGDirectories

TList *	fList {nullptr}

TObject *	fMother {nullptr}

TString	fPathBuffer

std::atomic_flag	fSpinLock
	Counter delaying the TDirectory destructor from finishing.

TUUID	fUUID

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Static Protected Attributes inherited from TFile
static TList *	fgAsyncOpenRequests = nullptr

static std::atomic< Long64_t >	fgBytesRead {0}
	Number of bytes read by all TFile objects.

static std::atomic< Long64_t >	fgBytesWrite {0}
	Number of bytes written by all TFile objects.

static TString	fgCacheFileDir
	Directory where to locally stage files.

static Bool_t	fgCacheFileDisconnected = kTRUE
	Indicates, we trust in the files in the cache dir without stat on the cached file.

static Bool_t	fgCacheFileForce = kFALSE
	Indicates, to force all READ to CACHEREAD.

static std::atomic< Long64_t >	fgFileCounter {0}
	Counter for all opened files.

static Bool_t	fgOnlyStaged = kFALSE
	Before the file is opened, it is checked, that the file is staged, if not, the open fails.

static UInt_t	fgOpenTimeout = TFile::kEternalTimeout
	Timeout for open operations in ms - 0 corresponds to blocking i/o.

static Int_t	fgReadaheadSize = 256000
	Readahead buffer size.

static std::atomic< Int_t >	fgReadCalls {0}
	Number of bytes read from all TFile objects.

static Bool_t	fgReadInfo = kTRUE
	if true (default) ReadStreamerInfo is called when opening a file

static ROOT::Internal::RConcurrentHashColl	fgTsSIHashes
	!TS Set of hashes built from read streamer infos

Static Protected Attributes inherited from TDirectory
static Bool_t	fgAddDirectory = kTRUE
	MSVC doesn't support = ATOMIC_FLAG_INIT;.

#include <TXNetFile.h>

Inheritance diagram for TXNetFile:

[legend]

Constructor & Destructor Documentation

◆ TXNetFile() [1/3]

TXNetFile::TXNetFile ( const TXNetFile & )

private

◆ TXNetFile() [2/3]

TXNetFile::TXNetFile ( )

inline

Definition at line 97 of file TXNetFile.h.

◆ TXNetFile() [3/3]

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`
	)

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 (multiple options can be set):

open a non-ROOT generic file root://server1:port1[,server2:port2,...]/pathfile?filetype=raw
re-check the environment variables root://server1:port1[,server2:port2,...]/pathfile?checkenv
set the cache size (in bytes) root://server1:port1[,server2:port2,...]/pathfile?cachesz=20000000
set the read-ahead size (in bytes) root://server1:port1[,server2:port2,...]/pathfile?readaheadsz=100000
set the cache remove policy root://server1:port1[,server2:port2,...]/pathfile?rmpolicy=1
set the max number of redirections root://server1:port1[,server2:port2,...]/pathfile?mxredir=2

Definition at line 104 of file TXNetFile.cxx.

◆ ~TXNetFile()

TXNetFile::~TXNetFile ( )

virtual

Destructor.

Definition at line 147 of file TXNetFile.cxx.

Member Function Documentation

◆ Class()

static TClass * TXNetFile::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TXNetFile::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TXNetFile::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 119 of file TXNetFile.h.

◆ Close()

void TXNetFile::Close ( const Option_t * opt = "" )

virtual

Close the file (see TNetFile::Close() or TFile::Close() for more details).

Reimplemented in TAlienFile.

Definition at line 1028 of file TXNetFile.cxx.

◆ CreateXClient()

void TXNetFile::CreateXClient	(	const char *	url,
		Option_t *	option,
		Int_t	netopt,
		Bool_t	parallelopen
	)

private

The real creation work is done here.

Definition at line 242 of file TXNetFile.cxx.

◆ DeclFileName()

static const char * TXNetFile::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 119 of file TXNetFile.h.

◆ Flush()

void TXNetFile::Flush ( )

virtual

Flushes un-written data.

Reimplemented from TNetFile.

Definition at line 1052 of file TXNetFile.cxx.

◆ FormUrl()

void TXNetFile::FormUrl	(	TUrl	uut,
		TString &	uu
	)

staticprivate

Form url for rootd socket.

Definition at line 161 of file TXNetFile.cxx.

◆ GetAsyncOpenStatus()

TFile::EAsyncOpenStatus TXNetFile::GetAsyncOpenStatus ( )

virtual

Return status of asynchronous request.

Reimplemented from TFile.

Definition at line 992 of file TXNetFile.cxx.

◆ GetBytesToPrefetch()

Int_t TXNetFile::GetBytesToPrefetch ( ) const

virtual

Max number of bytes to prefetch.

Reimplemented from TFile.

Definition at line 1416 of file TXNetFile.cxx.

◆ GetRootdProtocol()

Int_t TXNetFile::GetRootdProtocol ( TSocket * s )

staticprivate

Find out the remote rootd protocol version.

Returns -1 in case of error.

Definition at line 412 of file TXNetFile.cxx.

◆ Init()

void TXNetFile::Init ( Bool_t create )

privatevirtual

Initialize the file.

Makes sure that the file is really open before calling TFile::Init. It may block.

Reimplemented from TNetFile.

Definition at line 911 of file TXNetFile.cxx.

◆ IsA()

virtual TClass * TXNetFile::IsA ( ) const

inlinevirtual

Returns: TClass describing current object

Reimplemented from TNetFile.

Definition at line 119 of file TXNetFile.h.

◆ IsOpen()

Bool_t TXNetFile::IsOpen ( ) const

virtual

Return kTRUE if the file is open, kFALSE otherwise.

Reimplemented from TNetFile.

Definition at line 974 of file TXNetFile.cxx.

◆ Open()

Bool_t TXNetFile::Open	(	Option_t *	option,
		Bool_t	parallelopen
	)

private

The real creation work is done here.

Definition at line 467 of file TXNetFile.cxx.

◆ operator=()

TXNetFile & TXNetFile::operator= ( const TXNetFile & )

private

◆ ParseOptions()

Int_t TXNetFile::ParseOptions	(	const char *	opts,
		Int_t &	cachesz,
		Int_t &	readaheadsz,
		Int_t &	rmpolicy,
		Int_t &	mxredir,
		Int_t &	rastrategy,
		Int_t &	readtrimblksz
	)

private

Parse input options for cache parameters.

Definition at line 190 of file TXNetFile.cxx.

◆ Print()

void TXNetFile::Print ( Option_t * option = "" ) const

virtual

Print the local statistics.

Reimplemented from TNetFile.

Definition at line 1433 of file TXNetFile.cxx.

◆ ReadBuffer() [1/2]

Bool_t TXNetFile::ReadBuffer	(	char *	buffer,
		Int_t	bufferLength
	)

virtual

Override TNetFile::ReadBuffer to deal with the xrootd server.

Returns kTRUE in case of errors.

Reimplemented from TNetFile.

Definition at line 582 of file TXNetFile.cxx.

◆ ReadBuffer() [2/2]

Bool_t TXNetFile::ReadBuffer	(	char *	buf,
		Long64_t	pos,
		Int_t	len
	)

virtual

Pass through to TNetFile implementation which will call back eventually to our ReadBuffer with 2 arguments to deal with xrootd errors.

Reimplemented from TNetFile.

Definition at line 676 of file TXNetFile.cxx.

◆ ReadBufferAsync()

Bool_t TXNetFile::ReadBufferAsync	(	Long64_t	offs,
		Int_t	bufferLength
	)

virtual

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

Reimplemented from TFile.

Definition at line 687 of file TXNetFile.cxx.

◆ ReadBuffers()

Bool_t TXNetFile::ReadBuffers	(	char *	buf,
		Long64_t *	pos,
		Int_t *	len,
		Int_t	nbuf
	)

virtual

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::ReadBuffer 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 get the whole list from one single call avoiding the latency of multiple calls

Reimplemented from TNetFile.

Definition at line 754 of file TXNetFile.cxx.

◆ ReOpen()

Int_t TXNetFile::ReOpen ( const Option_t * mode )

virtual

Re-open the file (see TNetFile::ReOpen() or TFile::ReOpen() for more details).

Definition at line 1013 of file TXNetFile.cxx.

◆ ResetCache()

void TXNetFile::ResetCache ( )

virtual

Reset the cache.

Definition at line 1407 of file TXNetFile.cxx.

◆ SetEnv()

void TXNetFile::SetEnv ( )

staticprivate

Set the relevant environment variables.

Definition at line 1192 of file TXNetFile.cxx.

◆ Streamer()

virtual void TXNetFile::Streamer ( TBuffer & b )

virtual

Stream a TFile object.

Reimplemented from TNetFile.

◆ StreamerNVirtual()

void TXNetFile::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 119 of file TXNetFile.h.

◆ SynchronizeCacheSize()

void TXNetFile::SynchronizeCacheSize ( )

private

Synchronize the cache size Alternative purging policy.

Definition at line 1375 of file TXNetFile.cxx.

◆ SysClose()

Int_t TXNetFile::SysClose ( Int_t fd )

privatevirtual

Override TNetFile::SysClose (see parent's method for more details).

Reimplemented from TNetFile.

Definition at line 1137 of file TXNetFile.cxx.

◆ SysOpen()

Int_t TXNetFile::SysOpen	(	const char *	pathname,
		Int_t	flags,
		UInt_t	mode
	)

privatevirtual

Override TNetFile::SysOpen (see parent's method for more details).

Reimplemented from TNetFile.

Definition at line 1161 of file TXNetFile.cxx.

◆ SysStat()

Int_t TXNetFile::SysStat	(	Int_t	fd,
		Long_t *	id,
		Long64_t *	size,
		Long_t *	flags,
		Long_t *	modtime
	)

privatevirtual

Override TNetFile::SysStat (see parent's method for more details).

Reimplemented from TNetFile.

Definition at line 1090 of file TXNetFile.cxx.

◆ WriteBuffer()

Bool_t TXNetFile::WriteBuffer	(	const char *	buffer,
		Int_t	bufferLength
	)

virtual

Override TNetFile::WriteBuffer to deal with the xrootd server.

Returns kTRUE in case of errors.

Reimplemented from TNetFile.

Definition at line 851 of file TXNetFile.cxx.

Friends And Related Symbol Documentation

◆ TXNetSystem

friend class TXNetSystem

friend

Definition at line 57 of file TXNetFile.h.

Member Data Documentation

◆ fClient

XrdClient* TXNetFile::fClient

private

Definition at line 66 of file TXNetFile.h.

◆ fgFileStager

TFileStager * TXNetFile::fgFileStager = 0

staticprivate

Definition at line 63 of file TXNetFile.h.

◆ fgInitDone

Bool_t TXNetFile::fgInitDone = kFALSE

staticprivate

Definition at line 61 of file TXNetFile.h.

◆ fgRootdBC

Bool_t TXNetFile::fgRootdBC = kTRUE

staticprivate

Definition at line 62 of file TXNetFile.h.

◆ fInitMtx

void* TXNetFile::fInitMtx

private

Definition at line 68 of file TXNetFile.h.

◆ fIsRootd

Bool_t TXNetFile::fIsRootd

private

Definition at line 67 of file TXNetFile.h.

net/netx/inc/TXNetFile.h

net/netx/src/TXNetFile.cxx

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ TXNetFile() [1/3]

◆ TXNetFile() [2/3]

◆ TXNetFile() [3/3]

◆ ~TXNetFile()

Member Function Documentation

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ Close()

◆ CreateXClient()

◆ DeclFileName()

◆ Flush()

◆ FormUrl()

◆ GetAsyncOpenStatus()

◆ GetBytesToPrefetch()

◆ GetRootdProtocol()

◆ Init()

◆ IsA()

◆ IsOpen()

◆ Open()

◆ operator=()

◆ ParseOptions()

◆ Print()

◆ ReadBuffer() [1/2]

◆ ReadBuffer() [2/2]

◆ ReadBufferAsync()

◆ ReadBuffers()

◆ ReOpen()

◆ ResetCache()

◆ SetEnv()

◆ Streamer()

◆ StreamerNVirtual()

◆ SynchronizeCacheSize()

◆ SysClose()

◆ SysOpen()

◆ SysStat()

◆ WriteBuffer()

Friends And Related Symbol Documentation

◆ TXNetSystem

Member Data Documentation

◆ fClient

◆ fgFileStager

◆ fgInitDone

◆ fgRootdBC

◆ fInitMtx

◆ fIsRootd