ROOT 6.16/01 Reference Guide |
Public Types | |
enum | EPriority { kLowPriority , kNormalPriority , kHighPriority } |
enum | EState { kInvalidState , kNewState , kRunningState , kTerminatedState , kFinishedState , kCancelingState , kCanceledState , kDeletingState } |
typedef void(* | VoidFunc_t) (void *) |
typedef void *(* | VoidRtnFunc_t) (void *) |
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) } |
Public Member Functions | |
TThread (const char *thname, VoidFunc_t fn, void *arg=0, EPriority pri=kNormalPriority) | |
Create a detached thread with a name. More... | |
TThread (const char *thname, VoidRtnFunc_t fn, void *arg=0, EPriority pri=kNormalPriority) | |
Create thread with a name. More... | |
TThread (Long_t id=0) | |
Create a TThread for a already running thread. More... | |
TThread (VoidFunc_t fn, void *arg=0, EPriority pri=kNormalPriority) | |
Create a detached thread. More... | |
TThread (VoidRtnFunc_t fn, void *arg=0, EPriority pri=kNormalPriority) | |
Create a thread. More... | |
virtual | ~TThread () |
Cleanup the thread. More... | |
void | Delete (Option_t *option="") |
Delete this object. More... | |
Long_t | GetId () const |
EPriority | GetPriority () const |
EState | GetState () const |
Long_t | Join (void **ret=0) |
Join this thread. More... | |
Int_t | Kill () |
Kill this thread. More... | |
Int_t | Run (void *arg=0) |
Start the thread. More... | |
void | SetPriority (EPriority pri) |
Set thread priority. 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 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... | |
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 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 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 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 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_t * | GetOption () 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... | |
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 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 Public Member Functions | |
static Int_t | CancelPoint () |
Static method to set a cancellation point. More... | |
static Int_t | CleanUp () |
Static method to cleanup the calling thread. More... | |
static Int_t | CleanUpPop (Int_t exe=0) |
Static method which pops thread cleanup method off stack. More... | |
static Int_t | CleanUpPush (void *free, void *arg=0) |
Static method which pushes thread cleanup method on stack. More... | |
static Int_t | Delete (TThread *&th) |
Static method to delete the specified thread. More... | |
static Int_t | Exists () |
Static method to check if threads exist. More... | |
static Int_t | Exit (void *ret=0) |
Static method which terminates the execution of the calling thread. More... | |
static TThread * | GetThread (const char *name) |
Static method to find a thread by name. More... | |
static TThread * | GetThread (Long_t id) |
Static method to find a thread by id. More... | |
static Int_t | GetTime (ULong_t *absSec, ULong_t *absNanoSec) |
Static method to get the current time. More... | |
static void | Initialize () |
Initialize the Thread package. More... | |
static Bool_t | IsInitialized () |
Return true, if the TThread objects have been initialize. More... | |
static Long_t | Join (Long_t id, void **ret=0) |
Static method to join a thread by id. More... | |
static Int_t | Kill (const char *name) |
Static method to kill thread by name. More... | |
static Int_t | Kill (Long_t id) |
Static method to kill the thread by id. More... | |
static Int_t | Lock () |
Static method to lock the main thread mutex. More... | |
static void | Printf (const char *fmt,...) |
Static method providing a thread safe printf. Appends a newline. More... | |
static void | Ps () |
Static method listing the existing threads. More... | |
static void | ps () |
static TThread * | Self () |
Static method returning pointer to current thread. More... | |
static Long_t | SelfId () |
Static method returning the id for the current thread. More... | |
static Int_t | SetCancelAsynchronous () |
Static method to set the cancellation response type of the calling thread to asynchronous, i.e. More... | |
static Int_t | SetCancelDeferred () |
Static method to set the cancellation response type of the calling thread to deferred, i.e. More... | |
static Int_t | SetCancelOff () |
Static method to turn off thread cancellation. More... | |
static Int_t | SetCancelOn () |
Static method to turn on thread cancellation. More... | |
static Int_t | Sleep (ULong_t secs, ULong_t nanos=0) |
Static method to sleep the calling thread. More... | |
static Int_t | TryLock () |
Static method to try to lock the main thread mutex. More... | |
static void ** | Tsd (void *dflt, Int_t k) |
Static method returning a pointer to thread specific data container of the calling thread. More... | |
static Int_t | UnLock () |
Static method to unlock the main thread mutex. More... | |
static void | XAction () |
Static method called via the thread timer to execute in the main thread certain commands. 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... | |
Private Member Functions | |
TThread (const TThread &) | |
void | Constructor () |
Common thread constructor. More... | |
void | DoError (Int_t level, const char *location, const char *fmt, va_list va) const |
Interface to ErrorHandler. More... | |
void | ErrorHandler (int level, const char *location, const char *fmt, va_list ap) const |
Thread specific error handler function. More... | |
TThread & | operator= (const TThread &) |
void | SetComment (const char *txt=0) |
Static Private Member Functions | |
static void | AfterCancel (TThread *th) |
Static method which is called after the thread has been canceled. More... | |
static void * | Function (void *ptr) |
Static method which is called by the system thread function and which in turn calls the actual user function. More... | |
static void ** | GetTls (Int_t k) |
Static method that initializes the TLS array of a thread and returns the reference to a given position in that array. More... | |
static void | Init () |
Initialize global state and variables once. More... | |
static Int_t | XARequest (const char *xact, Int_t nb, void **ar, Int_t *iret) |
Static method used to allow commands to be executed by the main thread. More... | |
Private Attributes | |
void * | fClean |
char | fComment [100] |
Bool_t | fDetached |
VoidRtnFunc_t | fFcnRetn |
VoidFunc_t | fFcnVoid |
Long_t | fHandle |
TThread ** | fHolder |
Long_t | fId |
Bool_t | fNamed |
TThread * | fNext |
TThread * | fPrev |
EPriority | fPriority |
EState | fState |
EState | fStateComing |
void * | fThreadArg |
Static Private Attributes | |
static TThread * | fgMain = 0 |
static Long_t | fgMainId = 0 |
static TMutex * | fgMainMutex |
static TThreadImp * | fgThreadImp = 0 |
static char *volatile | fgXAct = 0 |
static TCondition * | fgXActCondi = 0 |
static TMutex * | fgXActMutex = 0 |
static volatile Int_t | fgXAnb = 0 |
static void **volatile | fgXArr = 0 |
static volatile Int_t | fgXArt = 0 |
Friends | |
class | TJoinHelper |
class | TPosixThread |
class | TThreadCleaner |
class | TThreadImp |
class | TThreadTearDownGuard |
class | TThreadTimer |
class | TWin32Thread |
Additional Inherited Members | |
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 <TThread.h>
enum TThread::EPriority |
enum TThread::EState |
|
private |
TThread::TThread | ( | VoidRtnFunc_t | fn, |
void * | arg = 0 , |
||
EPriority | pri = kNormalPriority |
||
) |
Create a thread.
Specify the function or static class method to be executed by the thread and a pointer to the argument structure. The user function should return a void*. To start the thread call Run().
Definition at line 205 of file TThread.cxx.
TThread::TThread | ( | VoidFunc_t | fn, |
void * | arg = 0 , |
||
EPriority | pri = kNormalPriority |
||
) |
Create a detached thread.
Specify the function or static class method to be executed by the thread and a pointer to the argument structure. To start the thread call Run().
Definition at line 222 of file TThread.cxx.
TThread::TThread | ( | const char * | thname, |
VoidRtnFunc_t | fn, | ||
void * | arg = 0 , |
||
EPriority | pri = kNormalPriority |
||
) |
Create thread with a name.
Specify the function or static class method to be executed by the thread and a pointer to the argument structure. The user function should return a void*. To start the thread call Run().
Definition at line 239 of file TThread.cxx.
TThread::TThread | ( | const char * | thname, |
VoidFunc_t | fn, | ||
void * | arg = 0 , |
||
EPriority | pri = kNormalPriority |
||
) |
Create a detached thread with a name.
Specify the function or static class method to be executed by the thread and a pointer to the argument structure. To start the thread call Run().
Definition at line 256 of file TThread.cxx.
TThread::TThread | ( | Long_t | id = 0 | ) |
Create a TThread for a already running thread.
Definition at line 271 of file TThread.cxx.
|
virtual |
Cleanup the thread.
Definition at line 388 of file TThread.cxx.
Static method which is called after the thread has been canceled.
Definition at line 724 of file TThread.cxx.
|
static |
Static method to set a cancellation point.
Returns 0 on success, otherwise an error number will be returned.
Definition at line 671 of file TThread.cxx.
|
static |
Static method to cleanup the calling thread.
Definition at line 703 of file TThread.cxx.
Static method which pops thread cleanup method off stack.
Returns 0 in case of success and -1 in case of error.
Definition at line 692 of file TThread.cxx.
Static method which pushes thread cleanup method on stack.
Returns 0 in case of success and -1 in case of error.
Definition at line 680 of file TThread.cxx.
|
private |
Common thread constructor.
Definition at line 362 of file TThread.cxx.
Static method to delete the specified thread.
Returns -1 in case the thread was running and has been killed. Returns 0 in case the thread has been Delete and Cleaned up. The th pointer is not valid anymore in that case.
Definition at line 414 of file TThread.cxx.
|
private |
Thread specific error handler function.
It calls the user set error handler in the main thread.
Definition at line 955 of file TThread.cxx.
|
static |
Static method to check if threads exist.
Returns the number of running threads.
Definition at line 437 of file TThread.cxx.
Static method which terminates the execution of the calling thread.
Definition at line 737 of file TThread.cxx.
Static method which is called by the system thread function and which in turn calls the actual user function.
Definition at line 792 of file TThread.cxx.
|
static |
Static method to find a thread by name.
Definition at line 477 of file TThread.cxx.
Static method to find a thread by id.
Definition at line 461 of file TThread.cxx.
Static method to get the current time.
Returns the number of seconds.
Definition at line 756 of file TThread.cxx.
Static method that initializes the TLS array of a thread and returns the reference to a given position in that array.
Definition at line 902 of file TThread.cxx.
|
staticprivate |
Initialize global state and variables once.
Definition at line 316 of file TThread.cxx.
|
static |
|
static |
Return true, if the TThread objects have been initialize.
If false, the process is (from ROOT's point of view) single threaded.
Definition at line 306 of file TThread.cxx.
Static method to join a thread by id.
Definition at line 532 of file TThread.cxx.
Join this thread.
Definition at line 508 of file TThread.cxx.
Int_t TThread::Kill | ( | ) |
Kill this thread.
Returns 0 on success, otherwise an error number will be returned.
Definition at line 585 of file TThread.cxx.
|
static |
Static method to kill thread by name.
Returns 0 on success, otherwise an error number will be returned.
Definition at line 617 of file TThread.cxx.
Static method to kill the thread by id.
Returns 0 on success, otherwise an error number will be returned.
Definition at line 601 of file TThread.cxx.
|
static |
Static method to lock the main thread mutex.
Definition at line 767 of file TThread.cxx.
|
static |
Static method providing a thread safe printf. Appends a newline.
Definition at line 919 of file TThread.cxx.
|
static |
Static method listing the existing threads.
Definition at line 838 of file TThread.cxx.
Start the thread.
This starts the static method TThread::Function() which calls the user function specified in the TThread ctor with the arg argument. Returns 0 on success, otherwise an error number will be returned.
Definition at line 561 of file TThread.cxx.
|
static |
Static method returning pointer to current thread.
Definition at line 493 of file TThread.cxx.
|
static |
Static method returning the id for the current thread.
Definition at line 547 of file TThread.cxx.
|
static |
Static method to set the cancellation response type of the calling thread to asynchronous, i.e.
cancel as soon as the cancellation request is received.
Definition at line 652 of file TThread.cxx.
|
static |
Static method to set the cancellation response type of the calling thread to deferred, i.e.
cancel only at next cancellation point. Returns 0 on success, otherwise an error number will be returned.
Definition at line 662 of file TThread.cxx.
|
static |
Static method to turn off thread cancellation.
Returns 0 on success, otherwise an error number will be returned.
Definition at line 633 of file TThread.cxx.
|
static |
Static method to turn on thread cancellation.
Returns 0 on success, otherwise an error number will be returned.
Definition at line 642 of file TThread.cxx.
|
inlineprivate |
Set thread priority.
Definition at line 453 of file TThread.cxx.
Static method to sleep the calling thread.
Definition at line 745 of file TThread.cxx.
|
static |
Static method to try to lock the main thread mutex.
Definition at line 775 of file TThread.cxx.
Static method returning a pointer to thread specific data container of the calling thread.
k should be between 0 and kMaxUserThreadSlot for user application. (and between kMaxUserThreadSlot and kMaxThreadSlot for ROOT libraries). See ROOT::EThreadSlotReservation
Definition at line 889 of file TThread.cxx.
Static method to unlock the main thread mutex.
Definition at line 783 of file TThread.cxx.
|
static |
Static method called via the thread timer to execute in the main thread certain commands.
This to avoid sophisticated locking and possible deadlocking.
Definition at line 1070 of file TThread.cxx.
Static method used to allow commands to be executed by the main thread.
Definition at line 1020 of file TThread.cxx.
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
private |
|
private |
|
staticprivate |
|
staticprivate |