Definition at line 29 of file TXNetFileStager.h.

Public Member Functions
	TXNetFileStager (const char *stager="")
	Constructor. Init a TXNetSystem instance to the XRD system.

virtual	~TXNetFileStager ()
	Destructor.

Bool_t	IsStaged (const char *path)
	Check if the file defined by 'path' is ready to be used.

Bool_t	IsValid () const

Int_t	Locate (const char *path, TString &endpath)
	Get actual end-point url for a path Returns 0 in case of success and 1 if any error occured.

Int_t	LocateCollection (TFileCollection *fc, Bool_t addDummyUrl=kFALSE)
	Bulk locate request for a collection of files.

Bool_t	Matches (const char *s)
	Returns kTRUE if stager 's' is compatible with current stager.

void	Print (Option_t *option="") const
	Print basic info about this stager.

Bool_t	Stage (const char path, Option_t opt=0)
	Issue a stage request for file defined by 'path'.

Bool_t	Stage (TCollection pathlist, Option_t opt=0)
	Issue a stage request for file defined by 'path'.

Public Member Functions inherited from TFileStager
	TFileStager (const char *stager)

virtual	~TFileStager ()

virtual TList *	GetStaged (TCollection *pathlist)
	Retrieves the staging (online) status for a list of path names.

TClass *	IsA () const override

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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.

virtual void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer.

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.

TClass *	IsA () const override

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	SetName (const char *name)
	Set the name of the TNamed.

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.

virtual Int_t	Sizeof () const
	Return size of the TNamed part of the TObject.

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

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.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

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 void	Delete (Option_t *option="")
	Delete this object.

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

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.

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 TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

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 Option_t *	GetOption () const

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

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

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	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

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.

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.

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.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Static Private Member Functions
static void	GetPrefix (const char *url, TString &pfx)
	Isolate prefix in url.

Private Attributes
TString	fPrefix

TXNetSystem *	fSystem

Additional Inherited Members
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 )) }

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

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static TString	GetPathName (TObject *o)
	Return the path name contained in object 'o' allowing for TUrl, TObjString or TFileInfo.

static TFileStager *	Open (const char *stager)
	Open a stager, after having loaded the relevant plug-in.

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.

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

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

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

#include <TXNetFileStager.h>

Inheritance diagram for TXNetFileStager:

[legend]

Constructor & Destructor Documentation

◆ TXNetFileStager()

TXNetFileStager::TXNetFileStager ( const char * stager = "" )

Constructor. Init a TXNetSystem instance to the XRD system.

Definition at line 31 of file TXNetFileStager.cxx.

◆ ~TXNetFileStager()

TXNetFileStager::~TXNetFileStager ( )

virtual

Destructor.

Definition at line 44 of file TXNetFileStager.cxx.

Member Function Documentation

◆ GetPrefix()

void TXNetFileStager::GetPrefix	(	const char *	url,
		TString &	pfx
	)

staticprivate

Isolate prefix in url.

Definition at line 168 of file TXNetFileStager.cxx.

◆ IsStaged()

Bool_t TXNetFileStager::IsStaged ( const char * path )

virtual

Check if the file defined by 'path' is ready to be used.

Reimplemented from TFileStager.

Definition at line 55 of file TXNetFileStager.cxx.

◆ IsValid()

Bool_t TXNetFileStager::IsValid ( ) const

inlinevirtual

Reimplemented from TFileStager.

Definition at line 48 of file TXNetFileStager.h.

◆ Locate()

Int_t TXNetFileStager::Locate	(	const char *	path,
		TString &	endpath
	)

virtual

Get actual end-point url for a path Returns 0 in case of success and 1 if any error occured.

Reimplemented from TFileStager.

Definition at line 198 of file TXNetFileStager.cxx.

◆ LocateCollection()

Int_t TXNetFileStager::LocateCollection	(	TFileCollection *	fc,
		Bool_t	addDummyUrl = `kFALSE`
	)

virtual

Bulk locate request for a collection of files.

A noop prepare command is issued beforehand to fill redirector's cache, then Locate() is issued on each file. Results are saved back to the input collection: when a file is found, the staged bit is set to on, and its endpoint URL is added, if different from the redirector's URL. If a file is not found, the staged bit is set to off. If addDummyUrl is kTRUE, in case file is not staged or redirector is identical to endpoint URL, a dummy URL is prepended, respectively: "noop://redir" and "noop://none". If the collection contains URLs with "anchors" (i.e., #fileName.root), they are ignored by xrootd. The Locate() command preserves anchors, but needs single paths to be full URLs beginning with root://. Returns < 0 in case of errors, and the number of files processed in case of success.

Reimplemented from TFileStager.

Definition at line 229 of file TXNetFileStager.cxx.

◆ Matches()

Bool_t TXNetFileStager::Matches ( const char * s )

virtual

Returns kTRUE if stager 's' is compatible with current stager.

Avoids multiple instantiations of the potentially the same TXNetSystem.

Reimplemented from TFileStager.

Definition at line 318 of file TXNetFileStager.cxx.

◆ Print()

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

virtual

Print basic info about this stager.

Reimplemented from TNamed.

Definition at line 189 of file TXNetFileStager.cxx.

◆ Stage() [1/2]

Bool_t TXNetFileStager::Stage	(	const char *	path,
		Option_t *	opt = `0`
	)

virtual

Issue a stage request for file defined by 'path'.

The string 'opt' defines 'option' and 'priority' for 'Prepare': the format is opt = "option=o priority=p".

Reimplemented from TFileStager.

Definition at line 122 of file TXNetFileStager.cxx.

◆ Stage() [2/2]

Bool_t TXNetFileStager::Stage	(	TCollection *	paths,
		Option_t *	opt = `0`
	)

virtual

Issue a stage request for file defined by 'path'.

The string 'opt' defines 'option' and 'priority' for 'Prepare': the format is opt = "option=o priority=p".

Reimplemented from TFileStager.

Definition at line 79 of file TXNetFileStager.cxx.

Member Data Documentation

◆ fPrefix

TString TXNetFileStager::fPrefix

private

Definition at line 32 of file TXNetFileStager.h.

◆ fSystem

TXNetSystem* TXNetFileStager::fSystem

private

Definition at line 33 of file TXNetFileStager.h.

net/netx/inc/TXNetFileStager.h

net/netx/src/TXNetFileStager.cxx

Public Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TXNetFileStager()

◆ ~TXNetFileStager()

Member Function Documentation

◆ GetPrefix()

◆ IsStaged()

◆ IsValid()

◆ Locate()

◆ LocateCollection()

◆ Matches()

◆ Print()

◆ Stage() [1/2]

◆ Stage() [2/2]

Member Data Documentation

◆ fPrefix

◆ fSystem