Logo ROOT  
Reference Guide
TXNetFileStager Class Reference

Definition at line 29 of file TXNetFileStager.h.

Public Member Functions

 TXNetFileStager (const char *stager="")
 Constructor. Init a TXNetSystem instance to the XRD system. More...
 
virtual ~TXNetFileStager ()
 Destructor. More...
 
Bool_t IsStaged (const char *path)
 Check if the file defined by 'path' is ready to be used. More...
 
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. More...
 
Int_t LocateCollection (TFileCollection *fc, Bool_t addDummyUrl=kFALSE)
 Bulk locate request for a collection of files. More...
 
Bool_t Matches (const char *s)
 Returns kTRUE if stager 's' is compatible with current stager. More...
 
void Print (Option_t *option="") const
 Print basic info about this stager. More...
 
Bool_t Stage (const char *path, Option_t *opt=0)
 Issue a stage request for file defined by 'path'. More...
 
Bool_t Stage (TCollection *pathlist, Option_t *opt=0)
 Issue a stage request for file defined by 'path'. More...
 
- Public Member Functions inherited from TFileStager
 TFileStager (const char *stager)
 
virtual ~TFileStager ()
 
virtual TListGetStaged (TCollection *pathlist)
 Retrieves the staging (online) status for a list of path names. More...
 
virtual Bool_t IsStaged (const char *)
 Just check if the file exists locally. More...
 
virtual Bool_t IsValid () const
 
virtual Int_t Locate (const char *u, TString &f)
 Just check if the file exists locally. More...
 
virtual Int_t LocateCollection (TFileCollection *fc, Bool_t addDummyUrl=kFALSE)
 Massive location of files. More...
 
virtual Bool_t Matches (const char *s)
 
virtual Bool_t Stage (const char *, Option_t *=0)
 
virtual Bool_t Stage (TCollection *pathlist, Option_t *opt=0)
 Issue a stage request for a list of files. More...
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor. More...
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare two TNamed objects. More...
 
virtual void Copy (TObject &named) const
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual void Print (Option_t *option="") const
 Print TNamed name and title. More...
 
virtual void SetName (const char *name)
 Set the name of the TNamed. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
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. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
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. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
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). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
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. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Static Private Member Functions

static void GetPrefix (const char *url, TString &pfx)
 Isolate prefix in url. More...
 

Private Attributes

TString fPrefix
 
TXNetSystemfSystem
 

Additional Inherited Members

- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) ,
  kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13)
}
 
- Static Public Member Functions inherited from TFileStager
static TString GetPathName (TObject *o)
 Return the path name contained in object 'o' allowing for TUrl, TObjString or TFileInfo. More...
 
static TFileStagerOpen (const char *stager)
 Open a stager, after having loaded the relevant plug-in. More...
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- 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). More...
 
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 32 of file TXNetFileStager.cxx.

◆ ~TXNetFileStager()

TXNetFileStager::~TXNetFileStager ( )
virtual

Destructor.

Definition at line 45 of file TXNetFileStager.cxx.

Member Function Documentation

◆ GetPrefix()

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

Isolate prefix in url.

Definition at line 169 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 56 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 199 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 230 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 319 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 190 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 123 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 80 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.


The documentation for this class was generated from the following files: