This class controls a client application running in a task which is controlled by another server task via transport channels which are held by a task handler object. More...

#include <TGo4ClientTask.h>

Inheritance diagram for TGo4ClientTask:

Public Member Functions
	TGo4ClientTask (const char name, const char serverhost="localhost", UInt_t negotiationport=0, Bool_t blockingmode=kTRUE, Bool_t standalone=kFALSE, Bool_t autostart=kFALSE, Bool_t autocreate=kTRUE, Bool_t ismaster=kFALSE, Bool_t autoconnect=kTRUE)

virtual	~TGo4ClientTask ()

void	AddLocalCommand (TGo4Command *com)
	Put command into the command queue for local execution in main thread.

Bool_t	ConnectServer (const char node, UInt_t negport, Go4CommandMode_t role=kGo4ComModeRefused, const char passwd=nullptr)
	Connect this client to a waiting server task on node with negotiation channel negport.

TGo4TaskStatus *	CreateStatus () override
	create a status object with information on the current client state.

Bool_t	DisconnectServer (Bool_t isterminating=kFALSE)
	Disconnect the current server task, but do not terminate the client.

TGo4BufferQueue *	GetCommandQueue (const char *task=nullptr) override

TGo4BufferQueue *	GetDataQueue (const char *task=nullptr) override

const char *	GetServerHostName () const

TGo4BufferQueue *	GetStatusQueue (const char *task=nullptr) override

TGo4TaskHandler *	GetTaskHandler () override

Int_t	Initialization () override
	override the ThreadManager Initialization used by AppControlTimer to let this thing initialize the client transport connection

Bool_t	IsConnected () const

void	Quit () override
	Quit the client; method to be called from command object, may be overridden in user implementation.

Public Member Functions inherited from TGo4Task
	TGo4Task (const char *name, Bool_t blockingmode, Bool_t autostart=kFALSE, Bool_t autocreate=kTRUE, Bool_t ismaster=kFALSE)

virtual	~TGo4Task ()

void	AddUserCommand (TGo4Command *com)
	Add a user command object to the existing command list.

void	AddUserCommandList (TGo4CommandProtoList *comlist)
	Add a user command list to the existing command list.

virtual void	ExecuteString (const char *command)
	Execute string command.

TBuffer *	GetAbortBuffer ()
	Use preallocated abort buffer to stop remote socket wait from taskhandler itself.

const char *	GetCommanderName () const

TGo4Master *	GetMaster () const

TGo4Slave *	GetSlave () const

virtual void	GetStatus ()
	Send current status information of the task to the master; may be re-implemented by application subclass of TGo4Task.

TMutex *	GetStatusBufferMutex ()
	Access to the mutex of status buffer.

Int_t	Initialization () override
	Overrides the ThreadManager Initialization; is used to setup the client connections on demand; checks for fbConnectRequest flag.

Bool_t	IsMaster () const

Bool_t	IsWorkStopped () const

virtual void	KillMain ()
	Kill the main thread; method to be called from command, should be overridden in user implementation.

TGo4Command *	MakeCommand (const char *name)
	Method using internal command prototype list to produce a clone of the specified command.

virtual TGo4Command *	NextCommand ()
	Delivers next command from command queue.

TObject *	NextObject (Bool_t wait=kTRUE)
	Delivers next object from data queue.

TGo4Status *	NextStatus (Bool_t wait=kTRUE)
	Delivers next status object from status queue.

virtual void	RestartMain ()
	Restart the main thread; method to be called from command, should be overridden in user implementation.

void	SendObject (TObject obj, const char receiver=nullptr)
	Send object via data channel to the master.

virtual void	SendStatus (TGo4Status stat, const char receiver=nullptr)
	Send status object via status channel to the master.

virtual void	SendStatusBuffer ()
	Send internal status buffer to the master(s).

void	SendStatusMessage (Int_t level, Bool_t printout, const char *text,...)
	Send message string in a status object to the gui.

void	SendStopBuffers (const char *taskname=nullptr)
	Send message buffers with stop values into queues and via socket connections.

void	SetOwner (TGo4TaskOwner *owner)
	Set owner object and switch automatically in master or slave mode, depending on owner type.

virtual void	Start ()
	General start method of client application to be called from remote command; should be re-implemented by application.

virtual Int_t	StartWorkThreads ()
	start the working threads of the task implementation; this method is used after the current connection has changed, to continue reading/writing the queues.

virtual void	Stop ()
	General stop method of client application to be called from remote command; should be re-implemented by application.

virtual Int_t	StopWorkThreads ()
	stop the working threads of the task implementation; this method is used before the current connection is changed to prevent reading/writing and waiting for the wrong queues.

Bool_t	SubmitCommand (const char *name)
	send command specified by name to the current client task

Bool_t	SubmitCommand (TGo4Command *com)
	send given command to the current client task.

Bool_t	SubmitEmergencyCommand (Go4EmergencyCommand_t val)
	send emergency quit command to the current client task

Bool_t	SubmitEmergencyData (Go4EmergencyCommand_t val, const char *receiver=nullptr)
	Send emergency command via data channel.

Bool_t	SubmitLocalCommand (TGo4Command *com)
	Send given command to the current client task.

void	Terminate (Bool_t termapp=kTRUE) override
	deletes the Manager instance via Control timer.

void	TerminateFast () override
	Overwrites the Threadmanager TerminateFast to shutdown the objectserver properly.

void	UpdateStatusBuffer ()
	Create status object and stream it into the status send buffer.

void	WakeCommandQueue (Int_t id=0)
	Put dummy object into command queue to wake up user threads which might wait for a command.

Public Member Functions inherited from TGo4ThreadManager
	TGo4ThreadManager (const char *name, Bool_t blockingmode=kTRUE, Bool_t autostart=kTRUE, Bool_t autocreate=kTRUE)
	Normal constructor.

	TGo4ThreadManager (const TGo4ThreadManager &right)

virtual	~TGo4ThreadManager ()

Bool_t	BlockApp ()
	Blocks gSystem by means of the blocking timer.

TGo4ThreadHandler *	GetWorkHandler () const
	Access to ThreadHandler for working threads.

Bool_t	IsAppBlocking () const
	Returns true if threadmanager works in root system blocking mode.

Bool_t	IsBeingQuit () const
	Returns true if threadmanager works in root system blocking mode.

Bool_t	IsInitDone () const

Bool_t	IsTerminateApp () const

Bool_t	IsTerminating () const
	returns termination status of Threadmanager

void	Launch ()
	This Method has to be called to create the startup threads and to turn on the application control timer.

void	SetBeingQuit (Bool_t on)

void	SetTimer (TGo4AppControlTimer *ctrltimer)
	user can exchange the standard control timer by an own derived one by this method

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.

Public Member Functions inherited from TGo4CommandReceiver
	TGo4CommandReceiver ()

virtual	~TGo4CommandReceiver ()

Protected Member Functions
void	UpdateStatus (TGo4TaskStatus *state) override
	method needed by method CreateStatus of any status subclasses to set the values of the clienttask specific part of the status object.

Protected Member Functions inherited from TGo4Task
virtual TGo4TaskHandlerCommandList *	CreateCommandList ()
	factory method for command list; overridden by implementation

TGo4ObjectQueue *	GetLocalCommandQueue ()

TGo4TaskHandlerCommandList *	GetPrototype ()
	get pointer to currently valid command list

void	SetMaster (Bool_t on=kTRUE)

void	SetWorkIsStopped (Bool_t on)

Private Attributes
Bool_t	fbAutoConnect {kFALSE}
	!True if client task shall try to connect automatically at Initialization.

Bool_t	fbServerConnected {kFALSE}
	true if connection to server is established, otherwise false

TGo4BufferQueue *	fxCommandQ {nullptr}

TGo4BufferQueue *	fxDataQ {nullptr}

TString	fxServerHostname
	hostname of server machine

TGo4BufferQueue *	fxStatusQ {nullptr}

TGo4TaskHandler *	fxTaskHandler {nullptr}
	aggregationByValue

Additional Inherited Members
Public Types inherited from TGo4ThreadManager
enum	{ fguTEXTLENGTH = 256 }
	Default textlength for char arrays. More...

Static Public Member Functions inherited from TGo4Task
static Int_t	Get_fgiTERMID ()

Static Public Attributes inherited from TGo4ThreadManager
static const Long_t	fglTIMERPERIOD = 200
	Period in ms for the application control timer.

Protected Attributes inherited from TGo4Task
TBuffer *	fxStatusBuffer {nullptr}
	Buffer containing the analysis status which is updated by the main thread.

TMutex *	fxStatusMutex {nullptr}
	Mutex protecting status buffer between main and watch thread.

Protected Attributes inherited from TGo4ThreadManager
Bool_t	fbAppBlocking {kFALSE}
	true if threadmanager shall block root gSystem using the AppControlTimer; false if gSystem shall never be blocked (necessary for gui)

Bool_t	fbAutoCreate {kFALSE}
	If true, TThreads of all go4threads in list shall be created automatically on calling Launch().

Bool_t	fbAutoStart {kFALSE}
	If true, workfunctions (runnable Run()) of all go4threads in list shall be started automatically on Initialization.

Int_t	fbBeingQuit {0}

Bool_t	fbInitDone {kFALSE}
	is set kTRUE after first Initialize is done

Bool_t	fbTerminateApplication {kFALSE}
	If true, terminate complete application.

Bool_t	fbTerminating {kFALSE}
	flag showing termination status

TGo4AppControlTimer *	fxBlocker {nullptr}
	Composition of Application control timer.

TGo4ThreadHandler *	fxWorkHandler {nullptr}
	Thread handler aggregate (threadsafe list of go4 threads) aggregationByValue 1 1.

Detailed Description

This class controls a client application running in a task which is controlled by another server task via transport channels which are held by a task handler object.

Apart from the transport threads, the application class which inherits from client task may provide working threads to serve the data queues and do the actual work

Definition at line 34 of file TGo4ClientTask.h.

Constructor & Destructor Documentation

◆ TGo4ClientTask()

TGo4ClientTask::TGo4ClientTask	(	const char *	name,
		const char *	serverhost = "localhost",
		UInt_t	negotiationport = 0,
		Bool_t	blockingmode = kTRUE,
		Bool_t	standalone = kFALSE,
		Bool_t	autostart = kFALSE,
		Bool_t	autocreate = kTRUE,
		Bool_t	ismaster = kFALSE,
		Bool_t	autoconnect = kTRUE )

Definition at line 23 of file TGo4ClientTask.cxx.

References TGo4Task::TGo4Task(), fbAutoConnect, fbServerConnected, fxCommandQ, fxDataQ, fxServerHostname, fxStatusQ, fxTaskHandler, TGo4TaskHandler::GetCommandQueue(), TGo4TaskHandler::GetDataQueue(), TGo4TaskHandler::GetStatusQueue(), GetTaskHandler(), TGo4Task::IsMaster(), and TGo4ThreadManager::Launch().

Referenced by TGo4ExampleClient::TGo4ExampleClient().

◆ ~TGo4ClientTask()

TGo4ClientTask::~TGo4ClientTask ( )

virtual

Definition at line 51 of file TGo4ClientTask.cxx.

References DisconnectServer(), and fxTaskHandler.

Member Function Documentation

◆ AddLocalCommand()

void TGo4ClientTask::AddLocalCommand ( TGo4Command * com )

Put command into the command queue for local execution in main thread.

Definition at line 169 of file TGo4ClientTask.cxx.

References TGo4Log::Debug(), and fxCommandQ.

◆ ConnectServer()

Bool_t TGo4ClientTask::ConnectServer	(	const char *	node,
		UInt_t	negport,
		Go4CommandMode_t	role = kGo4ComModeRefused,
		const char *	passwd = nullptr )

Connect this client to a waiting server task on node with negotiation channel negport.

Returns connection state, true if connection is established, otherwise false.

Definition at line 79 of file TGo4ClientTask.cxx.

References TGo4Log::Error(), fbServerConnected, fxTaskHandler, TGo4ThreadManager::fxWorkHandler, TGo4Log::Info(), TGo4Task::IsMaster(), kGo4ComModeAdministrator, kGo4ComModeController, kGo4ComModeObserver, TGo4Task::SendStatusMessage(), TGo4TaskHandler::SetAdminAccount(), TGo4TaskHandler::SetCtrlAccount(), TGo4TaskHandler::SetObservAccount(), and TGo4Log::Warn().

Referenced by TGo4AnalysisProxy::ConnectToServer(), and Initialization().

◆ CreateStatus()

TGo4TaskStatus * TGo4ClientTask::CreateStatus ( )

overridevirtual

create a status object with information on the current client state.

this object may be sent to the server or may be used to restore current status by memento mechanism

Reimplemented from TGo4Task.

Reimplemented in TGo4ExampleClient.

Definition at line 154 of file TGo4ClientTask.cxx.

References UpdateStatus().

◆ DisconnectServer()

Bool_t TGo4ClientTask::DisconnectServer ( Bool_t isterminating = kFALSE )

Disconnect the current server task, but do not terminate the client.

Return value indicates success state: true if disconnected, false if connection is still existing. If isterminating=true, work threads are not restarted again.

Definition at line 119 of file TGo4ClientTask.cxx.

References TGo4Queue::Clear(), fbServerConnected, fxTaskHandler, TGo4Task::Get_fgiTERMID(), GetCommandQueue(), TGo4Task::IsMaster(), TGo4Task::SendStopBuffers(), TGo4Task::StartWorkThreads(), TGo4Task::StopWorkThreads(), and TGo4Task::WakeCommandQueue().

Referenced by ~TGo4ClientTask(), TGo4Master::DisconnectSlave(), and Quit().