![]() |
ROOT 6.10/09 Reference Guide |
The PROOF manager interacts with the PROOF server coordinator to create or destroy a PROOF session, attach to or detach from existing one, and to monitor any client activity on the cluster.
At most one manager instance per server is allowed.
Definition at line 43 of file TProofMgr.h.
Public Types | |
enum | EServType { kProofd = 0, kXProofd = 1, kProofLite = 2 } |
![]() | |
enum | { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff } |
enum | { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) } |
enum | EStatusBits { kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13) } |
Public Member Functions | |
TProofMgr (const char *url, Int_t loglevel=-1, const char *alias="") | |
Create a PROOF manager for the standard (old) environment. More... | |
virtual | ~TProofMgr () |
Destroy a TProofMgr instance. More... | |
virtual TProof * | AttachSession (Int_t, Bool_t=kFALSE) |
Dummy version provided for completeness. More... | |
virtual TProof * | AttachSession (TProofDesc *, Bool_t=kFALSE) |
Dummy version provided for completeness. More... | |
void | Close () |
virtual Int_t | Cp (const char *, const char *=0, const char *=0) |
virtual TProof * | CreateSession (const char *=0, const char *=0, Int_t=-1) |
Create a new remote session (master and associated workers). More... | |
virtual void | DetachSession (Int_t, Option_t *="") |
Detach session with 'id' from its proofserv. More... | |
virtual void | DetachSession (TProof *, Option_t *="") |
Detach session 'p' from its proofserv. More... | |
virtual void | DiscardSession (TProof *p) |
Discard TProofDesc of session 'p' from the internal list. More... | |
virtual void | Find (const char *="~/", const char *=0, const char *=0) |
virtual Int_t | GetFile (const char *, const char *, const char *=0) |
virtual const char * | GetMssUrl (Bool_t=kFALSE) |
virtual TProofDesc * | GetProofDesc (Int_t id) |
Get TProofDesc instance corresponding to 'id'. More... | |
virtual TProofDesc * | GetProofDesc (TProof *p) |
Get TProofDesc instance corresponding to TProof object 'p'. More... | |
virtual Int_t | GetRemoteProtocol () const |
virtual TProofLog * | GetSessionLogs (Int_t=0, const char *=0, const char *="-v \ SvcMsg\, Bool_t=kFALSE) |
virtual const char * | GetUrl () |
virtual void | Grep (const char *, const char *=0, const char *=0) |
virtual Bool_t | IsLite () const |
virtual Bool_t | IsProofd () const |
virtual Bool_t | IsValid () const |
virtual void | Ls (const char *="~/", const char *=0, const char *=0) |
virtual Bool_t | MatchUrl (const char *url) |
Checks if 'url' refers to the same 'user:port' entity as the URL in memory. More... | |
virtual Int_t | Md5sum (const char *, TString &, const char *=0) |
virtual void | More (const char *, const char *=0, const char *=0) |
virtual Int_t | PutFile (const char *, const char *, const char *=0) |
virtual TList * | QuerySessions (Option_t *opt="S") |
Get list of sessions accessible to this manager. More... | |
virtual TObjString * | ReadBuffer (const char *, Long64_t, Int_t) |
virtual TObjString * | ReadBuffer (const char *, const char *) |
virtual Int_t | Reset (Bool_t hard=kFALSE, const char *usr=0) |
Send a cleanup request for the sessions associated with the current user. More... | |
virtual Int_t | Rm (const char *, const char *=0, const char *=0) |
Run 'rm' on 'what'. Locally it is just a call to TSystem::Unlink . More... | |
virtual Int_t | SendMsgToUsers (const char *, const char *=0) |
Send a message to connected users. More... | |
virtual void | SetAlias (const char *alias="") |
virtual void | SetInvalid () |
virtual void | SetMssUrl (const char *mss) |
virtual Int_t | SetROOTVersion (const char *) |
virtual void | ShowROOTVersions () |
virtual void | ShowWorkers () |
Show available workers. More... | |
virtual void | ShutdownSession (Int_t id) |
virtual void | ShutdownSession (TProof *p) |
virtual Int_t | Stat (const char *, FileStat_t &, const char *=0) |
virtual void | Tail (const char *, const char *=0, const char *=0) |
![]() | |
TNamed () | |
TNamed (const char *name, const char *title) | |
TNamed (const TString &name, const TString &title) | |
TNamed (const TNamed &named) | |
TNamed copy ctor. More... | |
virtual | ~TNamed () |
virtual void | Clear (Option_t *option="") |
Set name and title to empty strings (""). More... | |
virtual TObject * | Clone (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... | |
TNamed & | operator= (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... | |
![]() | |
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... | |
virtual const char * | ClassName () const |
Returns name of class to which the object belongs. 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 TObject * | DrawClone (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 TObject * | FindObject (const char *name) const |
Must be redefined in derived classes. More... | |
virtual TObject * | FindObject (const TObject *obj) const |
Must be redefined in derived classes. More... | |
virtual Option_t * | GetDrawOption () 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 char * | GetObjectInfo (Int_t px, Int_t py) const |
Returns string containing info about the object at position (px,py). More... | |
virtual Option_t * | GetOption () const |
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 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... | |
Bool_t | IsOnHeap () const |
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). 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... | |
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. 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 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, Bool_t set) |
Set or unset the user status bits as specified in f. More... | |
void | SetBit (UInt_t f) |
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... | |
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 Public Member Functions | |
static TProofMgr * | Create (const char *url, Int_t loglevel=-1, const char *alias=0, Bool_t xpd=kTRUE) |
Static method returning the appropriate TProofMgr object using the plugin manager. More... | |
static TList * | GetListOfManagers () |
Extract pointers to PROOF managers from TROOT::fProofs. More... | |
static Int_t | Ping (const char *url, Bool_t checkxrd=kFALSE) |
Non-blocking check for a PROOF (or Xrootd, if checkxrd) service at 'url' Return 0 if a XProofd (or Xrootd, if checkxrd) daemon is listening at 'url' -1 if nothing is listening on the port (connection cannot be open) 1 if something is listening but not XProofd (or not Xrootd, if checkxrd) More... | |
static void | SetTXProofMgrHook (TProofMgr_t pmh) |
Set hook to TXProofMgr ctor. More... | |
static TFileCollection * | UploadFiles (TList *src, const char *mss, const char *dest=0) |
Upload files provided via the list 'src' (as TFileInfo or TObjString) to 'mss'. More... | |
static TFileCollection * | UploadFiles (const char *txtfile, const char *mss, const char *dest=0) |
Upload to 'mss' the files listed in the text file 'srcfiles' or contained in the directory 'srcfiles'. More... | |
![]() | |
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 | |
TProofMgr () | |
![]() | |
virtual void | DoError (int level, const char *location, const char *fmt, va_list va) const |
Interface to ErrorHandler (protected). More... | |
void | MakeZombie () |
Protected Attributes | |
TSignalHandler * | fIntHandler |
TString | fMssUrl |
Int_t | fRemoteProtocol |
EServType | fServType |
TList * | fSessions |
TUrl | fUrl |
![]() | |
TString | fName |
TString | fTitle |
Static Protected Attributes | |
static TList | fgListOfManagers |
Private Member Functions | |
TProofMgr (const TProofMgr &) | |
TProofMgr & | operator= (const TProofMgr &) |
Static Private Member Functions | |
static TProofMgr_t | GetXProofMgrHook () |
Get the constructor hook fro TXProofMgr. More... | |
static void | ReplaceSubdirs (const char *fn, TString &fdst, TList &dirph) |
Parse file name extracting the directory subcomponents in dirs, stored as TObjStrings. More... | |
Static Private Attributes | |
static TProofMgr_t | fgTXProofMgrHook = 0 |
#include <TProofMgr.h>
enum TProofMgr::EServType |
Enumerator | |
---|---|
kProofd | |
kXProofd | |
kProofLite |
Definition at line 46 of file TProofMgr.h.
|
private |
|
inlineprotected |
Definition at line 68 of file TProofMgr.h.
TProofMgr::TProofMgr | ( | const char * | url, |
Int_t | loglevel = -1 , |
||
const char * | alias = "" |
||
) |
Create a PROOF manager for the standard (old) environment.
Definition at line 62 of file TProofMgr.cxx.
|
virtual |
Destroy a TProofMgr instance.
Definition at line 109 of file TProofMgr.cxx.
Dummy version provided for completeness.
Just returns a pointer to existing session 'id' (as shown by TProof::QuerySessions) or 0 if 'id' is not valid. The boolena 'gui' should be kTRUE when invoked from the GUI.
Reimplemented in TXProofMgr.
Definition at line 123 of file TProofMgr.cxx.
|
virtual |
Dummy version provided for completeness.
Just returns a pointer to existing session 'id' (as shown by TProof::QuerySessions) or 0 if 'id' is not valid.
Reimplemented in TXProofMgr.
Definition at line 138 of file TProofMgr.cxx.
|
inline |
Definition at line 79 of file TProofMgr.h.
|
inlinevirtual |
Reimplemented in TXProofMgr.
Definition at line 112 of file TProofMgr.h.
|
static |
Static method returning the appropriate TProofMgr object using the plugin manager.
Definition at line 498 of file TProofMgr.cxx.
|
virtual |
Create a new remote session (master and associated workers).
Reimplemented in TProofMgrLite.
Definition at line 386 of file TProofMgr.cxx.
Detach session with 'id' from its proofserv.
The 'id' is the number shown by QuerySessions. The correspondent TProof object is deleted. If id == 0 all the known sessions are detached. Option opt="S" or "s" forces session shutdown.
Reimplemented in TXProofMgr.
Definition at line 159 of file TProofMgr.cxx.
Detach session 'p' from its proofserv.
The instance 'p' is invalidated and should be deleted by the caller
Reimplemented in TXProofMgr.
Definition at line 203 of file TProofMgr.cxx.
Discard TProofDesc of session 'p' from the internal list.
Definition at line 366 of file TProofMgr.cxx.
|
inlinevirtual |
Reimplemented in TXProofMgr.
Definition at line 113 of file TProofMgr.h.
|
inlinevirtual |
Reimplemented in TXProofMgr.
Definition at line 122 of file TProofMgr.h.
|
static |
Extract pointers to PROOF managers from TROOT::fProofs.
Definition at line 459 of file TProofMgr.cxx.
Reimplemented in TXProofMgr.
Definition at line 87 of file TProofMgr.h.
|
virtual |
Get TProofDesc instance corresponding to 'id'.
Definition at line 324 of file TProofMgr.cxx.
|
virtual |
Get TProofDesc instance corresponding to TProof object 'p'.
Definition at line 345 of file TProofMgr.cxx.
|
inlinevirtual |
Definition at line 90 of file TProofMgr.h.
|
inlinevirtual |
Reimplemented in TXProofMgr, and TProofMgrLite.
Definition at line 91 of file TProofMgr.h.
|
inlinevirtual |
Definition at line 94 of file TProofMgr.h.
|
staticprivate |
Get the constructor hook fro TXProofMgr.
We do this without the plugin manager because it blocks the CINT mutex breaking the parallel startup.
Definition at line 595 of file TProofMgr.cxx.
|
inlinevirtual |
Reimplemented in TXProofMgr.
Definition at line 114 of file TProofMgr.h.
|
inlinevirtual |
Definition at line 75 of file TProofMgr.h.
|
inlinevirtual |
Definition at line 76 of file TProofMgr.h.
|
inlinevirtual |
Reimplemented in TXProofMgr.
Definition at line 77 of file TProofMgr.h.
|
inlinevirtual |
Reimplemented in TXProofMgr.
Definition at line 115 of file TProofMgr.h.
|
virtual |
Checks if 'url' refers to the same 'user:port' entity as the URL in memory.
Reimplemented in TXProofMgr.
Definition at line 430 of file TProofMgr.cxx.
Reimplemented in TXProofMgr.
Definition at line 119 of file TProofMgr.h.
|
inlinevirtual |
Reimplemented in TXProofMgr.
Definition at line 116 of file TProofMgr.h.
Non-blocking check for a PROOF (or Xrootd, if checkxrd) service at 'url' Return 0 if a XProofd (or Xrootd, if checkxrd) daemon is listening at 'url' -1 if nothing is listening on the port (connection cannot be open) 1 if something is listening but not XProofd (or not Xrootd, if checkxrd)
Definition at line 630 of file TProofMgr.cxx.
|
inlinevirtual |
Reimplemented in TXProofMgr.
Definition at line 123 of file TProofMgr.h.
Get list of sessions accessible to this manager.
Reimplemented in TXProofMgr.
Definition at line 228 of file TProofMgr.cxx.
|
inlinevirtual |
Reimplemented in TXProofMgr, and TProofMgrLite.
Definition at line 97 of file TProofMgr.h.
|
inlinevirtual |
Reimplemented in TXProofMgr, and TProofMgrLite.
Definition at line 99 of file TProofMgr.h.
Parse file name extracting the directory subcomponents in dirs, stored as TObjStrings.
Definition at line 744 of file TProofMgr.cxx.
Send a cleanup request for the sessions associated with the current user.
Not supported.
Reimplemented in TXProofMgr.
Definition at line 306 of file TProofMgr.cxx.
|
virtual |
Run 'rm' on 'what'. Locally it is just a call to TSystem::Unlink .
Reimplemented in TXProofMgr.
Definition at line 1065 of file TProofMgr.cxx.
|
virtual |
Send a message to connected users.
Only superusers can do this. The first argument specifies the message or the file from where to take the message. The second argument specifies the user to which to send the message: if empty or null the message is send to all the connected users. return 0 in case of success, -1 in case of error
Reimplemented in TXProofMgr.
Definition at line 294 of file TProofMgr.cxx.
|
inlinevirtual |
Definition at line 104 of file TProofMgr.h.
|
inlinevirtual |
Reimplemented in TXProofMgr.
Definition at line 78 of file TProofMgr.h.
|
inlinevirtual |
Definition at line 105 of file TProofMgr.h.
|
inlinevirtual |
Reimplemented in TXProofMgr.
Definition at line 106 of file TProofMgr.h.
|
static |
Set hook to TXProofMgr ctor.
Definition at line 618 of file TProofMgr.cxx.
|
inlinevirtual |
Reimplemented in TXProofMgr.
Definition at line 107 of file TProofMgr.h.
|
virtual |
Definition at line 108 of file TProofMgr.h.
Definition at line 109 of file TProofMgr.h.
|
inlinevirtual |
Reimplemented in TXProofMgr.
Definition at line 120 of file TProofMgr.h.
|
inlinevirtual |
Reimplemented in TXProofMgr.
Definition at line 118 of file TProofMgr.h.
|
static |
Upload files provided via the list 'src' (as TFileInfo or TObjString) to 'mss'.
The path under 'mss' is determined by 'dest'; the following place-holders can be used in 'dest': <d0>, <d1>, <d2>, ... referring to the n-th sub-component of the src path <bn> basename in the source path <bs> basename sans extension <ex> Extension <sn> serial number of file in the list <s0> as <sn> but zero padded <fn> the full file path <us>, <gr> the local user and group names. <pg> the users PROOF group <pa> immediate parent directory <gp> next-to immediate parent directory So, for example, if the source filename for the 99-th file is protosrc://host//d0/d1/d2/d3/d4/d5/myfile then with dest = '/pool/user/<d3>/<d4>/<d5>/<s>/<bn>' and mss = 'protodst://hostdst//nm/ the corresponding destination path is protodst://hostdst//nm/pool/user/d3/d4/d5/99/myfile
If 'dest' is empty, <fn> is used.
Returns a TFileCollection with the destination files created; this TFileCollection is, for example, ready to be registered as dataset.
Definition at line 801 of file TProofMgr.cxx.
|
static |
Upload to 'mss' the files listed in the text file 'srcfiles' or contained in the directory 'srcfiles'.
In the case 'srcfiles' is a text file, the files must be specified one per line, with line beginning by '#' ignored (i.e. considered comments). The path under 'mss' is defined by 'dest'; the following place-holders can be used in 'dest': <d0>, <d1>, <d2>, ... referring to the n-th sub-component of the src path <bn> basename in the source path <sn> serial number of file in the list <fn> the full file path <us>, <gr> the local user and group names. So, for example, if the source filename for the 99-th file is protosrc://host//d0/d1/d2/d3/d4/d5/myfile then with dest = '/pool/user/<d3>/<d4>/<d5>/<s>/<bn>' and mss = 'protodst://hostdst//nm/ the corresponding destination path is protodst://hostdst//nm/pool/user/d3/d4/d5/99/myfile
If 'dest' is empty, <fn> is used.
Returns a TFileCollection with the destination files created; this TFileCollection is, for example, ready to be registered as dataset.
Definition at line 986 of file TProofMgr.cxx.
|
staticprotected |
Definition at line 66 of file TProofMgr.h.
|
staticprivate |
Definition at line 52 of file TProofMgr.h.
|
protected |
Definition at line 64 of file TProofMgr.h.
|
protected |
Definition at line 58 of file TProofMgr.h.
|
protected |
Definition at line 59 of file TProofMgr.h.
|
protected |
Definition at line 60 of file TProofMgr.h.
|
protected |
Definition at line 61 of file TProofMgr.h.
|
protected |
Definition at line 62 of file TProofMgr.h.