Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

TGo4ThreadManager Class Reference

base class for classes that shall be accessed from a thread /runnable instance. More...

#include <TGo4ThreadManager.h>

Inheritance diagram for TGo4ThreadManager:

Public Methods
	TGo4ThreadManager (const TGo4ThreadManager &right)
	TGo4ThreadManager (const char *name, Bool_t blockingmode=kTRUE, Bool_t autostart=kTRUE, Bool_t autocreate=kTRUE)
	ctor parameters: blockingmode=true: gApplication is blocked by timer autostart=true: all thread runnables start their work on Initialization() autocreate=true: all threads added to handler in threadmanager ctor are created on Launch(). More...
virtual	~TGo4ThreadManager ()
TGo4ThreadManager &	operator= (const TGo4ThreadManager &right)
void	SetTimer (TGo4AppControlTimer *ctrltimer)
	user can exchange the standard control timer by an own derived one by this method. More...
TGo4ThreadHandler *	GetWorkHandler ()
	Access to ThreadHandler for working threads. More...
Bool_t	BlockApp ()
	Blocks gSystem by means of the blocking timer. More...
Bool_t	UnBlockApp (Int_t mode=0)
	Wakes up the control timer waiting for his condition; parameter mode specifies whether timer will block again at next turn (mode=0), timer will block when all threads are up (mode=1), or timer will not block again unless the next Block call, i.e. More...
virtual Int_t	Initialization ()
Bool_t	IsInitDone () const
Bool_t	IsTerminating () const
	returns termination status of Threadmanager. More...
Bool_t	IsTerminateApp () const
Bool_t	IsAppBlocking ()
	Returns true if threadmanager works in root system blocking mode. More...
void	Launch ()
	This Method has to be called to create the startup threads and to turn on the application control timer. More...
virtual void	Terminate (Bool_t termapp=kTRUE)
	deletes the Manager instance via Control timer. More...
virtual void	TerminateFast ()
	Alternative termination in case of error. More...
Static Public Attributes
const Long_t	fglTIMERPERIOD = 200
	Period in ms for the application control timer. More...
const UInt_t	fguTEXTLENGTH = 256
	Default textlength for char arrays. More...
Protected Attributes
Bool_t	fbInitDone
	is set kTRUE after first Initialize is done. More...
Bool_t	fbTerminating
	flag showing termination status. More...
Bool_t	fbTerminateApplication
	If true, terminate complete application. More...
Bool_t	fbAppBlocking
	true if threadmanager shall block root gSystem using the AppControlTimer; false if gSystem shall never be blocked (necessary for gui). More...
Bool_t	fbAutoCreate
	If true, TThreads of all go4threads in list shall be created automatically on calling Launch(). More...
Bool_t	fbAutoStart
	If true, workfunctions (runnable Run()) of all go4threads in list shall be started automatically on Initialization. More...
TGo4AppControlTimer *	fxBlocker
	Composition of Application control timer. More...
TGo4ThreadHandler *	fxWorkHandler
	Thread handler aggregate (threadsafe list of go4 threads) More...
Private Methods
	TGo4ThreadManager ()

Detailed Description

base class for classes that shall be accessed from a thread /runnable instance.

Author:: J. Adamczewski , Go4 project-DVEE-GSI Darmstadt , Germany , j.adamczewski@gsi.de

Version:: 0.9

Since:: jul 2000-oct 2001

Definition at line 34 of file TGo4ThreadManager.h.

Constructor & Destructor Documentation

TGo4ThreadManager::TGo4ThreadManager ( const TGo4ThreadManager & right )

Definition at line 27 of file TGo4ThreadManager.cxx.
References fxBlocker, fxWorkHandler, and TRACE.

TGo4ThreadManager::TGo4ThreadManager ( const char * name,

Bool_t blockingmode = kTRUE,

Bool_t autostart = kTRUE,

Bool_t autocreate = kTRUE

)

ctor parameters: blockingmode=true: gApplication is blocked by timer autostart=true: all thread runnables start their work on Initialization() autocreate=true: all threads added to handler in threadmanager ctor are created on Launch().

Definition at line 38 of file TGo4ThreadManager.cxx.
References TGo4Log::Debug(), fbAppBlocking, fbAutoCreate, fbAutoStart, fglTIMERPERIOD, fguTEXTLENGTH, fxBlocker, fxWorkHandler, TGo4AppControlTimer::SetApplicationRun(), and TRACE.

TGo4ThreadManager::~TGo4ThreadManager ( ) [virtual]

Definition at line 74 of file TGo4ThreadManager.cxx.
References fxWorkHandler, and TRACE.

TGo4ThreadManager::TGo4ThreadManager ( ) [private]

Member Function Documentation

TGo4ThreadManager & TGo4ThreadManager::operator= ( const TGo4ThreadManager & right )

Definition at line 83 of file TGo4ThreadManager.cxx.
References fbAppBlocking, fbInitDone, fbTerminating, fxBlocker, fxWorkHandler, and TRACE.
Referenced by TGo4TestThreadManager::operator=().

void TGo4ThreadManager::SetTimer ( TGo4AppControlTimer * ctrltimer ) [inline]

user can exchange the standard control timer by an own derived one by this method.

Definition at line 55 of file TGo4ThreadManager.h.
References fxBlocker.

TGo4ThreadHandler* TGo4ThreadManager::GetWorkHandler ( ) [inline]

Access to ThreadHandler for working threads.

Definition at line 63 of file TGo4ThreadManager.h.
References fxWorkHandler.
Referenced by TGo4ServerTask::ConnectorThreadIsStopped(), TGo4Slave::GetThreadHandler(), TGo4AppControlTimer::Notify(), TGo4TestRunnable::Run(), TGo4ServerTask::StartConnectorThread(), TGo4ExampleServer::StartWorkThreads(), TGo4ServerTask::StopConnectorThread(), TGo4ExampleServer::StopWorkThreads(), TGo4Task::TGo4Task(), TGo4TaskHandler::TGo4TaskHandler(), TGo4ThreadException::TGo4ThreadException(), TGo4Display::~TGo4Display(), and TGo4ServerTask::~TGo4ServerTask().

Bool_t TGo4ThreadManager::BlockApp ( )

Blocks gSystem by means of the blocking timer.

Definition at line 103 of file TGo4ThreadManager.cxx.
References fbTerminating, fxBlocker, fxWorkHandler, TGo4ThreadHandler::IsOperating(), TGo4AppControlTimer::SetApplicationRun(), and TRACE.
Referenced by TGo4ThreadHandler::Cancel(), TGo4ThreadHandler::Create(), TGo4ThreadHandler::CreateAll(), Initialization(), TGo4ThreadHandler::ReCreate(), TGo4ThreadHandler::RemoveThread(), TGo4TestRunnable::Run(), TGo4ThreadHandler::Start(), and TGo4ThreadHandler::StartAll().

Bool_t TGo4ThreadManager::UnBlockApp ( Int_t mode = 0 )

Wakes up the control timer waiting for his condition; parameter mode specifies whether timer will block again at next turn (mode=0), timer will block when all threads are up (mode=1), or timer will not block again unless the next Block call, i.e.
applicationrun flag is reset (mode=2)
Definition at line 131 of file TGo4ThreadManager.cxx.
References fxBlocker, TGo4AppControlTimer::GetApplicationRun(), TGo4AppControlTimer::GetCondition(), TGo4AppControlTimer::SetApplicationRun(), and TRACE.
Referenced by TGo4ThreadHandler::Cancel(), TGo4ThreadHandler::Create(), TGo4ThreadHandler::CreateAll(), TGo4ThreadHandler::ReCreate(), TGo4ThreadHandler::RemoveThread(), TGo4TestRunnable::Run(), TGo4ThreadHandler::Start(), TGo4ThreadHandler::StartAll(), and Terminate().

Int_t TGo4ThreadManager::Initialization ( ) [virtual]

Reimplemented in TGo4ClientTask, and TGo4Task.
Definition at line 179 of file TGo4ThreadManager.cxx.
References TGo4ThreadHandler::AllCreated(), BlockApp(), TGo4Log::Debug(), TGo4ThreadHandler::DumpThreads(), fbInitDone, fxWorkHandler, TGo4ThreadHandler::StartAll(), and TRACE.
Referenced by TGo4Task::Initialization(), and TGo4AppControlTimer::Notify().

Bool_t TGo4ThreadManager::IsInitDone ( ) const [inline]

Definition at line 85 of file TGo4ThreadManager.h.
References fbInitDone.

Bool_t TGo4ThreadManager::IsTerminating ( ) const [inline]

returns termination status of Threadmanager.

Definition at line 93 of file TGo4ThreadManager.h.
References fbTerminating.
Referenced by TGo4HistogramServer::ConnectObjectClient(), TGo4AppControlTimer::Notify(), TGo4StatusRunnable::Run(), TGo4DataRunnable::Run(), TGo4CommandRunnable::Run(), TGo4TaskManager::ServeClient(), TGo4TaskManager::WaitForClientRemoved(), TGo4ServerTask::WaitForConnection(), TGo4HistogramServer::WaitForConnection(), TGo4HistogramServer::WaitForOpen(), and TGo4TaskHandler::WaitGetPort().

Bool_t TGo4ThreadManager::IsTerminateApp ( ) const [inline]

Definition at line 98 of file TGo4ThreadManager.h.
References fbTerminateApplication.
Referenced by TGo4AppControlTimer::Notify().

Bool_t TGo4ThreadManager::IsAppBlocking ( ) [inline]

Returns true if threadmanager works in root system blocking mode.

Definition at line 106 of file TGo4ThreadManager.h.
References fbAppBlocking.

void TGo4ThreadManager::Launch ( )

This Method has to be called to create the startup threads and to turn on the application control timer.
Usually this is done at the end of the user's threadmanager constructor. The idea is that no thread should be started unless the user initializations are done; therefore, its up to the user to define when to Launch.
Definition at line 237 of file TGo4ThreadManager.cxx.
References TGo4ThreadHandler::CreateAll(), fxBlocker, fxWorkHandler, and TRACE.
Referenced by TGo4AnalysisClient::Constructor(), TGo4ClientTask::TGo4ClientTask(), TGo4Display::TGo4Display(), TGo4ExampleClient::TGo4ExampleClient(), TGo4ExampleServer::TGo4ExampleServer(), TGo4ServerTask::TGo4ServerTask(), and TGo4TestThreadManager::TGo4TestThreadManager().

void TGo4ThreadManager::Terminate ( Bool_t termapp = kTRUE ) [virtual]

deletes the Manager instance via Control timer.
If termap is true, also terminates the root Application
Reimplemented in TGo4Task.
Definition at line 254 of file TGo4ThreadManager.cxx.
References TGo4Log::Debug(), fbTerminateApplication, fbTerminating, fxWorkHandler, TGo4ThreadHandler::StopAll(), TRACE, and UnBlockApp().
Referenced by TGo4TerminateException::Handle(), TGo4Task::Terminate(), TerminateFast(), and TGo4Runnable::UnexpectedCatch().

void TGo4ThreadManager::TerminateFast ( ) [virtual]

Alternative termination in case of error.

Reimplemented in TGo4Task.
Definition at line 268 of file TGo4ThreadManager.cxx.
References Terminate().
Referenced by TGo4Task::TerminateFast().

Member Data Documentation

const Long_t TGo4ThreadManager::fglTIMERPERIOD = 200 [static]

Period in ms for the application control timer.

Definition at line 23 of file TGo4ThreadManager.cxx.
Referenced by TGo4ThreadManager().

const UInt_t TGo4ThreadManager::fguTEXTLENGTH = 256 [static]

Default textlength for char arrays.

Definition at line 25 of file TGo4ThreadManager.cxx.
Referenced by TGo4TaskHandler::ConnectClientChannel(), TGo4TaskHandler::ConnectServerChannel(), TGo4AnalysisClient::Constructor(), TGo4ComStartHistoServ::ExeCom(), TGo4AnalysisClient::ExecuteString(), TGo4ReplaceException::Handle(), TGo4RemoveException::Handle(), TGo4HistogramServer::HandleObjectRequest(), TGo4ServerTask::LaunchClient(), TGo4Master::LaunchSlaveServer(), TGo4MbsHist::ScanGo4Folder(), TGo4TaskManager::ServeClient(), TGo4ClientTask::TGo4ClientTask(), TGo4ExampleClient::TGo4ExampleClient(), TGo4ExampleServer::TGo4ExampleServer(), TGo4ServerTask::TGo4ServerTask(), TGo4Task::TGo4Task(), TGo4TaskHandler::TGo4TaskHandler(), TGo4TestThreadManager::TGo4TestThreadManager(), and TGo4ThreadManager().

Bool_t TGo4ThreadManager::fbInitDone [protected]

is set kTRUE after first Initialize is done.

Definition at line 148 of file TGo4ThreadManager.h.
Referenced by Initialization(), IsInitDone(), operator=(), and TGo4Task::UpdateStatus().

Bool_t TGo4ThreadManager::fbTerminating [protected]

flag showing termination status.

Definition at line 153 of file TGo4ThreadManager.h.
Referenced by BlockApp(), IsTerminating(), operator=(), Terminate(), and TGo4Task::UpdateStatus().

Bool_t TGo4ThreadManager::fbTerminateApplication [protected]

If true, terminate complete application.
If false, only terminate threadmanager instance.
Definition at line 159 of file TGo4ThreadManager.h.
Referenced by IsTerminateApp(), and Terminate().

Bool_t TGo4ThreadManager::fbAppBlocking [protected]

true if threadmanager shall block root gSystem using the AppControlTimer; false if gSystem shall never be blocked (necessary for gui).

Definition at line 166 of file TGo4ThreadManager.h.
Referenced by IsAppBlocking(), operator=(), TGo4ThreadManager(), and TGo4Task::UpdateStatus().

Bool_t TGo4ThreadManager::fbAutoCreate [protected]

If true, TThreads of all go4threads in list shall be created automatically on calling Launch().

Definition at line 172 of file TGo4ThreadManager.h.
Referenced by TGo4ThreadManager(), and TGo4Task::UpdateStatus().

Bool_t TGo4ThreadManager::fbAutoStart [protected]

If true, workfunctions (runnable Run()) of all go4threads in list shall be started automatically on Initialization.
If false, TThreads may be running, but workfunctions suspend in condition wait.
Definition at line 179 of file TGo4ThreadManager.h.
Referenced by TGo4ThreadManager(), and TGo4Task::UpdateStatus().

TGo4AppControlTimer* TGo4ThreadManager::fxBlocker [protected]

Composition of Application control timer.

Definition at line 187 of file TGo4ThreadManager.h.
Referenced by BlockApp(), Launch(), operator=(), SetTimer(), TGo4ThreadManager(), and UnBlockApp().

TGo4ThreadHandler* TGo4ThreadManager::fxWorkHandler [protected]

Thread handler aggregate (threadsafe list of go4 threads)

Definition at line 195 of file TGo4ThreadManager.h.
Referenced by BlockApp(), TGo4ClientTask::ConnectServer(), GetWorkHandler(), Initialization(), TGo4Task::Initialization(), Launch(), operator=(), TGo4ExampleClient::Start(), TGo4ExampleClient::Stop(), TGo4Task::SubmitLocalCommand(), Terminate(), TGo4ExampleClient::TGo4ExampleClient(), TGo4ExampleServer::TGo4ExampleServer(), TGo4ServerTask::TGo4ServerTask(), TGo4TestThreadManager::TGo4TestThreadManager(), TGo4ThreadManager(), TGo4ExampleClient::~TGo4ExampleClient(), TGo4ExampleServer::~TGo4ExampleServer(), and ~TGo4ThreadManager().

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

/Go4ThreadManager/TGo4ThreadManager.h
/Go4ThreadManager/TGo4ThreadManager.cxx

Generated on Tue Nov 8 10:56:57 2005 for Go4-v2.10-5 by

1.2.15

TGo4ThreadManager Class Reference

Public Methods

Static Public Attributes

Protected Attributes

Private Methods

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation