Legacy Code

TThread is a legacy interface: there will be no bug fixes nor new developments. Therefore it is not recommended to use it in new long-term production code. But, depending on the context, using TThread might still be a valid solution.

This class implements threads. A thread is an execution environment much lighter than a process. A single process can have multiple threads. The actual work is done via the TThreadImp class (either TPosixThread or TWin32Thread).

Definition at line 40 of file TThread.h.

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 = (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 Member Functions
	TThread (const char thname, VoidFunc_t fn, void arg=nullptr, EPriority pri=kNormalPriority)
	Create a detached thread with a name.

	TThread (const char thname, VoidRtnFunc_t fn, void arg=nullptr, EPriority pri=kNormalPriority)
	Create thread with a name.

	TThread (Long_t id=0)
	Create a TThread for a already running thread.

	TThread (VoidFunc_t fn, void *arg=nullptr, EPriority pri=kNormalPriority)
	Create a detached thread.

	TThread (VoidRtnFunc_t fn, void *arg=nullptr, EPriority pri=kNormalPriority)
	Create a thread.

virtual	~TThread ()
	Cleanup the thread.

void	Delete (Option_t *option="") override
	Delete this object.

Long_t	GetId () const

EPriority	GetPriority () const

EState	GetState () const

TClass *	IsA () const override

Long_t	Join (void **ret=nullptr)
	Join this thread.

Int_t	Kill ()
	Kill this thread.

Int_t	Run (void *arg=nullptr, const int affinity=-1)
	Start the thread.

void	SetPriority (EPriority pri)
	Set thread priority.

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.

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.

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

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	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 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 (the base implementation is no-op).

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, void vp)
	Only called by placement new when throwing an exception.

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

void	operator delete[] (void ptr, void vp)
	Only called by placement new[] when throwing an exception.

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 Public Member Functions
static Int_t	CancelPoint ()
	Static method to set a cancellation point.

static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static Int_t	CleanUp ()
	Static method to cleanup the calling thread.

static Int_t	CleanUpPop (Int_t exe=0)
	Static method which pops thread cleanup method off stack.

static Int_t	CleanUpPush (void free, void arg=nullptr)
	Static method which pushes thread cleanup method on stack.

static const char *	DeclFileName ()

static Int_t	Delete (TThread *&th)
	Static method to delete the specified thread.

static Int_t	Exists ()
	Static method to check if threads exist.

static Int_t	Exit (void *ret=nullptr)
	Static method which terminates the execution of the calling thread.

static TThread *	GetThread (const char *name)
	Static method to find a thread by name.

static TThread *	GetThread (Long_t id)
	Static method to find a thread by id.

static Int_t	GetTime (ULong_t absSec, ULong_t absNanoSec)
	Static method to get the current time.

static void	Initialize ()
	Initialize the Thread package.

static Bool_t	IsInitialized ()
	Return true, if the TThread objects have been initialize.

static Long_t	Join (Long_t id, void **ret=nullptr)
	Static method to join a thread by id.

static Int_t	Kill (const char *name)
	Static method to kill thread by name.

static Int_t	Kill (Long_t id)
	Static method to kill the thread by id.

static Int_t	Lock ()
	Static method to lock the main thread mutex.

static void	Printf (const char *fmt,...)
	Static method providing a thread safe printf. Appends a newline.

static void	Ps ()
	Static method listing the existing threads.

static void	ps ()

static TThread *	Self ()
	Static method returning pointer to current thread.

static Long_t	SelfId ()
	Static method returning the id for the current thread.

static Int_t	SetCancelAsynchronous ()
	Static method to set the cancellation response type of the calling thread to asynchronous, i.e.

static Int_t	SetCancelDeferred ()
	Static method to set the cancellation response type of the calling thread to deferred, i.e.

static Int_t	SetCancelOff ()
	Static method to turn off thread cancellation.

static Int_t	SetCancelOn ()
	Static method to turn on thread cancellation.

static Int_t	Sleep (ULong_t secs, ULong_t nanos=0)
	Static method to sleep the calling thread.

static Int_t	TryLock ()
	Static method to try to lock the main thread mutex.

static void **	Tsd (void *dflt, Int_t k)
	Static method returning a pointer to thread specific data container of the calling thread.

static Int_t	UnLock ()
	Static method to unlock the main thread mutex.

static void	XAction ()
	Static method called via the thread timer to execute in the main thread certain commands.

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
	TThread (const TThread &)=delete

void	Constructor ()
	Common thread constructor.

void	DoError (Int_t level, const char location, const char fmt, va_list va) const override
	Interface to ErrorHandler.

void	ErrorHandler (int level, const char location, const char fmt, va_list ap) const
	Thread specific error handler function.

TThread &	operator= (const TThread &)=delete

void	SetComment (const char *txt=nullptr)

Static Private Member Functions
static void	AfterCancel (TThread *th)
	Static method which is called after the thread has been canceled.

static void *	Function (void *ptr)
	Static method which is called by the system thread function and which in turn calls the actual user function.

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.

static void	Init ()
	Initialize global state and variables once.

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.

Private Attributes
void *	fClean

char	fComment [100]

Bool_t	fDetached

VoidRtnFunc_t	fFcnRetn

VoidFunc_t	fFcnVoid

Longptr_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 = nullptr

static Long_t	fgMainId = 0

static TMutex *	fgMainMutex

static TThreadImp *	fgThreadImp = nullptr

static std::atomic< char * > volatile	fgXAct {nullptr}

static TCondition *	fgXActCondi = 0

static TMutex *	fgXActMutex = nullptr

static volatile Int_t	fgXAnb = 0

static void **volatile	fgXArr = nullptr

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 Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

Protected Member Functions inherited from TObject
void	MakeZombie ()

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

#include <TThread.h>

Inheritance diagram for TThread:

[legend]

Member Typedef Documentation

◆ VoidFunc_t

typedef void(* TThread::VoidFunc_t) (void *)

Definition at line 53 of file TThread.h.

◆ VoidRtnFunc_t

typedef void *(* TThread::VoidRtnFunc_t) (void *)

Definition at line 52 of file TThread.h.

Member Enumeration Documentation

◆ EPriority

enum TThread::EPriority

Enumerator
kLowPriority
kNormalPriority
kHighPriority

Definition at line 55 of file TThread.h.

◆ EState

enum TThread::EState

Enumerator
kInvalidState
kNewState
kRunningState
kTerminatedState
kFinishedState
kCancelingState
kCanceledState
kDeletingState

Definition at line 61 of file TThread.h.

Constructor & Destructor Documentation

◆ TThread() [1/6]

TThread::TThread ( const TThread & )

privatedelete

◆ TThread() [2/6]

TThread::TThread	(	VoidRtnFunc_t	fn,
		void *	arg = `nullptr`,
		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 208 of file TThread.cxx.

◆ TThread() [3/6]

TThread::TThread	(	VoidFunc_t	fn,
		void *	arg = `nullptr`,
		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 225 of file TThread.cxx.

◆ TThread() [4/6]

TThread::TThread	(	const char *	thname,
		VoidRtnFunc_t	fn,
		void *	arg = `nullptr`,
		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 242 of file TThread.cxx.

◆ TThread() [5/6]

TThread::TThread	(	const char *	thname,
		VoidFunc_t	fn,
		void *	arg = `nullptr`,
		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 259 of file TThread.cxx.

◆ TThread() [6/6]

TThread::TThread ( Long_t id = 0 )

Create a TThread for a already running thread.

Definition at line 274 of file TThread.cxx.

◆ ~TThread()

TThread::~TThread ( )

virtual

Cleanup the thread.

Definition at line 390 of file TThread.cxx.

Member Function Documentation

◆ AfterCancel()

void TThread::AfterCancel ( TThread * th )

staticprivate

Static method which is called after the thread has been canceled.

Definition at line 729 of file TThread.cxx.

◆ CancelPoint()

Int_t TThread::CancelPoint ( )

static

Static method to set a cancellation point.

Returns 0 on success, otherwise an error number will be returned.

Definition at line 676 of file TThread.cxx.

◆ Class()

static TClass * TThread::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TThread::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TThread::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 180 of file TThread.h.

◆ CleanUp()

Int_t TThread::CleanUp ( )

static

Static method to cleanup the calling thread.

Definition at line 708 of file TThread.cxx.

◆ CleanUpPop()

Int_t TThread::CleanUpPop ( Int_t exe = 0 )

static

Static method which pops thread cleanup method off stack.

Returns 0 in case of success and -1 in case of error.

Definition at line 697 of file TThread.cxx.

◆ CleanUpPush()

Int_t TThread::CleanUpPush	(	void *	free,
		void *	arg = `nullptr`
	)

static

Static method which pushes thread cleanup method on stack.

Returns 0 in case of success and -1 in case of error.

Definition at line 685 of file TThread.cxx.

◆ Constructor()

void TThread::Constructor ( )

private

Common thread constructor.

Definition at line 364 of file TThread.cxx.

◆ DeclFileName()

static const char * TThread::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 180 of file TThread.h.

◆ Delete() [1/2]

void TThread::Delete ( Option_t * option = "" )

inlineoverridevirtual

Delete this object.

Typically called as a command via the interpreter. Normally use "delete" operator when object has been allocated on the heap.

Reimplemented from TObject.

Definition at line 127 of file TThread.h.

◆ Delete() [2/2]

Int_t TThread::Delete ( TThread *& th )

static

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 416 of file TThread.cxx.

◆ DoError()

void TThread::DoError	(	Int_t	level,
		const char *	location,
		const char *	fmt,
		va_list	va
	)		const

overrideprivatevirtual

Interface to ErrorHandler.

User has to specify the class name as part of the location, just like for the global Info(), Warning() and Error() functions.

Reimplemented from TObject.

Definition at line 1000 of file TThread.cxx.

◆ ErrorHandler()

void TThread::ErrorHandler	(	int	level,
		const char *	location,
		const char *	fmt,
		va_list	ap
	)		const

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.

◆ Exists()

Int_t TThread::Exists ( )

static

Static method to check if threads exist.

Returns the number of running threads.

Definition at line 439 of file TThread.cxx.

◆ Exit()

Int_t TThread::Exit ( void * ret = nullptr )

static

Static method which terminates the execution of the calling thread.

Definition at line 742 of file TThread.cxx.

◆ Function()

void * TThread::Function ( void * ptr )

staticprivate

Static method which is called by the system thread function and which in turn calls the actual user function.

Definition at line 797 of file TThread.cxx.

◆ GetId()

Long_t TThread::GetId ( ) const

inline

Definition at line 130 of file TThread.h.

◆ GetPriority()

EPriority TThread::GetPriority ( ) const

inline

Definition at line 128 of file TThread.h.

◆ GetState()

EState TThread::GetState ( ) const

inline

Definition at line 129 of file TThread.h.

◆ GetThread() [1/2]

TThread * TThread::GetThread ( const char * name )

static

Static method to find a thread by name.

Definition at line 479 of file TThread.cxx.

◆ GetThread() [2/2]

TThread * TThread::GetThread ( Long_t id )

static

Static method to find a thread by id.

Definition at line 463 of file TThread.cxx.

◆ GetTime()

Int_t TThread::GetTime	(	ULong_t *	absSec,
		ULong_t *	absNanoSec
	)

static

Static method to get the current time.

Returns the number of seconds.

Definition at line 761 of file TThread.cxx.

◆ GetTls()

void ** TThread::GetTls ( Int_t k )

staticprivate

Static method that initializes the TLS array of a thread and returns the reference to a given position in that array.

Definition at line 907 of file TThread.cxx.

◆ Init()

void TThread::Init ( )

staticprivate

Initialize global state and variables once.

Definition at line 319 of file TThread.cxx.

◆ Initialize()

void TThread::Initialize ( )

static

Initialize the Thread package.

This initializes the TThread and ROOT global mutexes to make parts of ROOT thread safe/aware. This call is implicit in case a TThread is created.

Definition at line 300 of file TThread.cxx.

◆ IsA()

TClass * TThread::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TNamed.

Definition at line 180 of file TThread.h.

◆ IsInitialized()

Bool_t TThread::IsInitialized ( )

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 309 of file TThread.cxx.

◆ Join() [1/2]

Long_t TThread::Join	(	Long_t	id,
		void **	ret = `nullptr`
	)

static

Static method to join a thread by id.

Definition at line 534 of file TThread.cxx.

◆ Join() [2/2]

Long_t TThread::Join ( void ** ret = nullptr )

Join this thread.

Definition at line 510 of file TThread.cxx.

◆ Kill() [1/3]

Int_t TThread::Kill ( )

Kill this thread.

Returns 0 on success, otherwise an error number will be returned.

Definition at line 590 of file TThread.cxx.

◆ Kill() [2/3]

Int_t TThread::Kill ( const char * name )

static

Static method to kill thread by name.

Returns 0 on success, otherwise an error number will be returned.

Definition at line 622 of file TThread.cxx.

◆ Kill() [3/3]

Int_t TThread::Kill ( Long_t id )

static

Static method to kill the thread by id.

Returns 0 on success, otherwise an error number will be returned.

Definition at line 606 of file TThread.cxx.

◆ Lock()

Int_t TThread::Lock ( )

static

Static method to lock the main thread mutex.

Definition at line 772 of file TThread.cxx.

◆ operator=()

TThread & TThread::operator= ( const TThread & )

privatedelete

◆ Printf()

void TThread::Printf	(	const char *	fmt,
			...
	)

static

Static method providing a thread safe printf. Appends a newline.

Definition at line 916 of file TThread.cxx.

◆ Ps()

void TThread::Ps ( )

static

Static method listing the existing threads.

Definition at line 843 of file TThread.cxx.

◆ ps()

static void TThread::ps ( )

inlinestatic

Definition at line 132 of file TThread.h.

◆ Run()

Int_t TThread::Run	(	void *	arg = `nullptr`,
		const int	affinity = `-1`
	)

Start the thread.

This starts the static method TThread::Function() which calls the user function specified in the TThread ctor with the arg argument. If affinity is specified (>=0), a CPU affinity will be associated with the current thread. Returns 0 on success, otherwise an error number will be returned.

Definition at line 566 of file TThread.cxx.

◆ Self()

TThread * TThread::Self ( )

static

Static method returning pointer to current thread.

Definition at line 495 of file TThread.cxx.

◆ SelfId()

Long_t TThread::SelfId ( )

static

Static method returning the id for the current thread.

Definition at line 549 of file TThread.cxx.

◆ SetCancelAsynchronous()

Int_t TThread::SetCancelAsynchronous ( )

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 657 of file TThread.cxx.

◆ SetCancelDeferred()

Int_t TThread::SetCancelDeferred ( )

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 667 of file TThread.cxx.

◆ SetCancelOff()

Int_t TThread::SetCancelOff ( )

static

Static method to turn off thread cancellation.

Returns 0 on success, otherwise an error number will be returned.

Definition at line 638 of file TThread.cxx.

◆ SetCancelOn()

Int_t TThread::SetCancelOn ( )

static

Static method to turn on thread cancellation.

Returns 0 on success, otherwise an error number will be returned.

Definition at line 647 of file TThread.cxx.

◆ SetComment()

void TThread::SetComment ( const char * txt = nullptr )

inlineprivate

Definition at line 103 of file TThread.h.

◆ SetPriority()

void TThread::SetPriority ( EPriority pri )

Set thread priority.

Definition at line 455 of file TThread.cxx.

◆ Sleep()

Int_t TThread::Sleep	(	ULong_t	secs,
		ULong_t	nanos = `0`
	)

static

Static method to sleep the calling thread.

Definition at line 750 of file TThread.cxx.

◆ Streamer()

void TThread::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TNamed.

◆ StreamerNVirtual()

void TThread::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 180 of file TThread.h.

◆ TryLock()

Int_t TThread::TryLock ( )

static

Static method to try to lock the main thread mutex.

Definition at line 780 of file TThread.cxx.

◆ Tsd()

void ** TThread::Tsd	(	void *	dflt,
		Int_t	k
	)

static

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 894 of file TThread.cxx.

◆ UnLock()

Int_t TThread::UnLock ( )

static

Static method to unlock the main thread mutex.

Definition at line 788 of file TThread.cxx.

◆ XAction()

void TThread::XAction ( )

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 1073 of file TThread.cxx.

◆ XARequest()

Int_t TThread::XARequest	(	const char *	xact,
		Int_t	nb,
		void **	ar,
		Int_t *	iret
	)

staticprivate

Static method used to allow commands to be executed by the main thread.

Definition at line 1023 of file TThread.cxx.

Friends And Related Symbol Documentation

◆ TJoinHelper

friend class TJoinHelper

friend

Definition at line 48 of file TThread.h.

◆ TPosixThread

friend class TPosixThread

friend

Definition at line 43 of file TThread.h.

◆ TThreadCleaner

friend class TThreadCleaner

friend

Definition at line 45 of file TThread.h.

◆ TThreadImp

friend class TThreadImp

friend

Definition at line 42 of file TThread.h.

◆ TThreadTearDownGuard

friend class TThreadTearDownGuard

friend

Definition at line 47 of file TThread.h.

◆ TThreadTimer

friend class TThreadTimer

friend

Definition at line 44 of file TThread.h.

◆ TWin32Thread

friend class TWin32Thread

friend

Definition at line 46 of file TThread.h.

Member Data Documentation

◆ fClean

void* TThread::fClean

private

Definition at line 87 of file TThread.h.

◆ fComment

char TThread::fComment[100]

private

Definition at line 88 of file TThread.h.

◆ fDetached

Bool_t TThread::fDetached

private

Definition at line 82 of file TThread.h.

◆ fFcnRetn

VoidRtnFunc_t TThread::fFcnRetn

private

Definition at line 84 of file TThread.h.

◆ fFcnVoid

VoidFunc_t TThread::fFcnVoid

private

Definition at line 85 of file TThread.h.

◆ fgMain

TThread * TThread::fgMain = nullptr

staticprivate

Definition at line 96 of file TThread.h.

◆ fgMainId

Long_t TThread::fgMainId = 0

staticprivate

Definition at line 95 of file TThread.h.

◆ fgMainMutex

TMutex * TThread::fgMainMutex

staticprivate

Definition at line 97 of file TThread.h.

◆ fgThreadImp

TThreadImp * TThread::fgThreadImp = nullptr

staticprivate

Definition at line 90 of file TThread.h.

◆ fgXAct

std::atomic< char * > volatile TThread::fgXAct {nullptr}

staticprivate

Definition at line 91 of file TThread.h.

◆ fgXActCondi

TCondition * TThread::fgXActCondi = 0

staticprivate

Definition at line 99 of file TThread.h.

◆ fgXActMutex

TMutex * TThread::fgXActMutex = nullptr

staticprivate

Definition at line 98 of file TThread.h.

◆ fgXAnb

volatile Int_t TThread::fgXAnb = 0

staticprivate

Definition at line 93 of file TThread.h.

◆ fgXArr

void **volatile TThread::fgXArr = nullptr

staticprivate

Definition at line 92 of file TThread.h.

◆ fgXArt

volatile Int_t TThread::fgXArt = 0

staticprivate

Definition at line 94 of file TThread.h.

◆ fHandle

Longptr_t TThread::fHandle

private

Definition at line 81 of file TThread.h.

◆ fHolder

TThread** TThread::fHolder

private

Definition at line 76 of file TThread.h.

◆ fId

Long_t TThread::fId

private

Definition at line 80 of file TThread.h.

◆ fNamed

Bool_t TThread::fNamed

private

Definition at line 83 of file TThread.h.

◆ fNext

TThread* TThread::fNext

private

Definition at line 74 of file TThread.h.

◆ fPrev

TThread* TThread::fPrev

private

Definition at line 75 of file TThread.h.

◆ fPriority

EPriority TThread::fPriority

private

Definition at line 77 of file TThread.h.

◆ fState

EState TThread::fState

private

Definition at line 78 of file TThread.h.

◆ fStateComing

EState TThread::fStateComing

private

Definition at line 79 of file TThread.h.

◆ fThreadArg

void* TThread::fThreadArg

private

Definition at line 86 of file TThread.h.

Libraries for TThread:

[legend]

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

core/thread/inc/TThread.h
core/thread/src/TThread.cxx

Legacy Code

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Member Typedef Documentation

◆ VoidFunc_t

◆ VoidRtnFunc_t

Member Enumeration Documentation

◆ EPriority

◆ EState

Constructor & Destructor Documentation

◆ TThread() [1/6]

◆ TThread() [2/6]

◆ TThread() [3/6]

◆ TThread() [4/6]

◆ TThread() [5/6]

◆ TThread() [6/6]

◆ ~TThread()

Member Function Documentation

◆ AfterCancel()

◆ CancelPoint()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ CleanUp()

◆ CleanUpPop()

◆ CleanUpPush()

◆ Constructor()

◆ DeclFileName()

◆ Delete() [1/2]

◆ Delete() [2/2]

◆ DoError()

◆ ErrorHandler()

◆ Exists()

◆ Exit()

◆ Function()

◆ GetId()

◆ GetPriority()

◆ GetState()

◆ GetThread() [1/2]

◆ GetThread() [2/2]

◆ GetTime()

◆ GetTls()

◆ Init()

◆ Initialize()

◆ IsA()

◆ IsInitialized()

◆ Join() [1/2]

◆ Join() [2/2]

◆ Kill() [1/3]

◆ Kill() [2/3]

◆ Kill() [3/3]

◆ Lock()

◆ operator=()

◆ Printf()

◆ Ps()

◆ ps()

◆ Run()

◆ Self()

◆ SelfId()

◆ SetCancelAsynchronous()

◆ SetCancelDeferred()

◆ SetCancelOff()

◆ SetCancelOn()

◆ SetComment()

◆ SetPriority()

◆ Sleep()

◆ Streamer()

◆ StreamerNVirtual()

◆ TryLock()

◆ Tsd()

◆ UnLock()

◆ XAction()

◆ XARequest()