#include <TGo4TaskManager.h>

Inheritance diagram for TGo4TaskManager:

Public Member Functions
	TGo4TaskManager (const char name, TGo4ServerTask server, UInt_t negotiationport=0, Bool_t createconnector=kTRUE)

virtual	~TGo4TaskManager ()

Int_t	ServeClient ()

Go4CommandMode_t	ClientLogin ()

Int_t	ConnectClient (const char client, const char host, Go4CommandMode_t role=kGo4ComModeController)

Int_t	DisConnectClient (const char *name, Bool_t clientwait=kTRUE)

Int_t	DisConnectClient (TGo4TaskHandler *taskhandler, Bool_t clientwait=kTRUE)

Bool_t	AddClient (const char client, const char host, Go4CommandMode_t role)

Bool_t	AddTaskHandler (TGo4TaskHandler *han)

TGo4TaskHandler *	NewTaskHandler (const char *name)

Bool_t	RemoveTaskHandler (const char *name)

TGo4TaskHandler *	GetTaskHandler (const char *name)

TGo4TaskHandler *	GetLastTaskHandler ()

TGo4TaskHandler *	NextTaskHandler (Bool_t reset=kFALSE)

TMutex *	GetMutex ()

UInt_t	GetTaskCount () const

UInt_t	GetNegotiationPort ()

Int_t	WaitForClientRemoved ()

Bool_t	HasControllerTask ()

Static Public Attributes
static const Int_t	fgiDISCONCYCLES =360

static const UInt_t	fguDISCONTIME =500

Private Member Functions
	TGo4TaskManager ()

	TGo4TaskManager (const TGo4TaskManager &right)

Private Attributes
TGo4ServerTask *	fxServer {nullptr}

TGo4Socket *	fxTransport {nullptr}

TObjArray *	fxTaskList {nullptr}

TMutex *	fxListMutex {nullptr}

TIterator *	fxTaskIter {nullptr}

UInt_t	fuTaskCount {0}

UInt_t	fuNegotiationPort {0}

Bool_t	fbClientIsRemoved {kFALSE}

Bool_t	fbHasControllerConnection {kFALSE}

Detailed Description

Definition at line 27 of file TGo4TaskManager.h.

Constructor & Destructor Documentation

◆ TGo4TaskManager() [1/3]

TGo4TaskManager::TGo4TaskManager	(	const char *	name,
		TGo4ServerTask *	server,
		UInt_t	negotiationport = `0`,
		Bool_t	createconnector = `kTRUE`
	)

Definition at line 33 of file TGo4TaskManager.cxx.

References TGo4Log::Debug(), TGo4TaskHandler::fguCONNECTORPORT, fuNegotiationPort, fxListMutex, fxServer, fxTaskIter, fxTaskList, fxTransport, and TGo4Socket::Open().

◆ ~TGo4TaskManager()

TGo4TaskManager::~TGo4TaskManager ( )

virtual

Definition at line 68 of file TGo4TaskManager.cxx.

References TGo4Socket::Close(), fxListMutex, fxTaskIter, fxTaskList, and fxTransport.

◆ TGo4TaskManager() [2/3]

TGo4TaskManager::TGo4TaskManager ( )

private

◆ TGo4TaskManager() [3/3]

TGo4TaskManager::TGo4TaskManager ( const TGo4TaskManager & right )

private

Member Function Documentation

◆ AddClient()

Bool_t TGo4TaskManager::AddClient	(	const char *	client,
		const char *	host,
		Go4CommandMode_t	role
	)

adds client task of name to manager: create server task handler and try to connect to client Command execution role depends on previous login passowrd

Definition at line 348 of file TGo4TaskManager.cxx.

References TGo4TaskHandler::Connect(), TGo4Log::Error(), fbHasControllerConnection, fuTaskCount, fxServer, fxTransport, TGo4TaskHandler::Get_fgcERROR(), TGo4TaskHandler::GetComPort(), TGo4TaskHandler::GetDatPort(), TGo4Command::GetModeDescription(), TGo4TaskHandler::GetRole(), TGo4TaskHandler::GetStatPort(), TGo4Log::Info(), kGo4ComModeObserver, NewTaskHandler(), RemoveTaskHandler(), TGo4Socket::Send(), TGo4Task::SendStatusMessage(), TGo4ServerTask::SetCurrentTask(), TGo4TaskHandler::SetRole(), and TGo4Log::Warn().

Referenced by ConnectClient().

◆ AddTaskHandler()

Bool_t TGo4TaskManager::AddTaskHandler ( TGo4TaskHandler * han )

adds external task handler to array

Definition at line 376 of file TGo4TaskManager.cxx.

References fxListMutex, and fxTaskList.

Referenced by NewTaskHandler().

◆ ClientLogin()

Go4CommandMode_t TGo4TaskManager::ClientLogin ( )

Check account and password of the client that requests a connection to this server. Return value specifies client access priorities as defined in TGo4Command.h Returns 0 in case of incorrect login.

Definition at line 204 of file TGo4TaskManager.cxx.

References TGo4Log::Debug(), fbHasControllerConnection, TGo4TaskHandler::fgcMASTER, TGo4TaskHandler::fgcSLAVE, TGo4TaskHandler::fgxADMINISTRATORACCOUNT, TGo4TaskHandler::fgxCONTROLLERACCOUNT, TGo4TaskHandler::fgxOBSERVERACCOUNT, fxServer, fxTransport, TGo4TaskHandler::Get_fgcOK(), TGo4Task::IsMaster(), kGo4ComModeAdministrator, kGo4ComModeController, kGo4ComModeObserver, kGo4ComModeRefused, TGo4Socket::RecvRaw(), and TGo4Log::Warn().

Referenced by ServeClient().

◆ ConnectClient()

Int_t TGo4TaskManager::ConnectClient	(	const char *	client,
		const char *	host,
		Go4CommandMode_t	role = `kGo4ComModeController`
	)

used by connector runnable to wait for a client request to connect to this server task. May specify mode of allowed commands in case of client is master.

Definition at line 284 of file TGo4TaskManager.cxx.

References AddClient().

Referenced by ServeClient().

◆ DisConnectClient() [1/2]

Int_t TGo4TaskManager::DisConnectClient	(	const char *	name,
		Bool_t	clientwait = `kTRUE`
	)

disonnect an existing client by name, wait for negotiation OK if clientwait is true

Definition at line 294 of file TGo4TaskManager.cxx.

References GetTaskHandler(), and TGo4Log::Info().

Referenced by TGo4ServerTask::RemoveClient(), and ServeClient().

◆ DisConnectClient() [2/2]

Int_t TGo4TaskManager::DisConnectClient	(	TGo4TaskHandler *	taskhandler,
		Bool_t	clientwait = `kTRUE`
	)

disonnect an existing client by name, wait for negotiation OK if clientwait is true

Definition at line 308 of file TGo4TaskManager.cxx.

References TGo4Log::Debug(), TGo4TaskHandler::DisConnect(), fbClientIsRemoved, fbHasControllerConnection, fuTaskCount, fxServer, fxTransport, TGo4TaskHandler::Get_fgcOK(), TGo4TaskHandler::GetRole(), kGo4ComModeObserver, TGo4Socket::RecvRaw(), RemoveTaskHandler(), and TGo4Task::SendStopBuffers().

◆ GetLastTaskHandler()

TGo4TaskHandler * TGo4TaskManager::GetLastTaskHandler ( )

returns last task handler in list

Definition at line 445 of file TGo4TaskManager.cxx.

References fxListMutex, and fxTaskList.

Referenced by TGo4ServerTask::SetCurrentTask().

◆ GetMutex()

TMutex* TGo4TaskManager::GetMutex ( )

inline

Definition at line 103 of file TGo4TaskManager.h.

References fxListMutex.

Referenced by TGo4TaskOwner::GetTaskManagerMutex(), TGo4ServerTask::NextCommand(), TGo4ServerTask::Quit(), TGo4ServerTask::SendStatus(), TGo4ServerTask::SendStatusBuffer(), and TGo4ServerTask::Shutdown().

◆ GetNegotiationPort()

UInt_t TGo4TaskManager::GetNegotiationPort ( )

returns the portnumber for client server negotiation port which is actually used by the running taskmanager

Definition at line 480 of file TGo4TaskManager.cxx.

References fuNegotiationPort, fxTransport, and TGo4Socket::GetPort().

Referenced by TGo4AnalysisProxy::ConnectorPort(), GetTaskCount(), TGo4AnalysisProxy::LaunchAsClient(), ServeClient(), and TGo4ServerTask::StopConnectorThread().

◆ GetTaskCount()

UInt_t TGo4TaskManager::GetTaskCount ( ) const

inline

Number of entries in taskhandler list, i.e. number of connected clients

Definition at line 106 of file TGo4TaskManager.h.

References fuTaskCount, GetNegotiationPort(), and WaitForClientRemoved().

◆ GetTaskHandler()

TGo4TaskHandler * TGo4TaskManager::GetTaskHandler ( const char * name )

returns certain task handler by name

Definition at line 435 of file TGo4TaskManager.cxx.

References fxListMutex, and fxTaskList.

Referenced by DisConnectClient(), TGo4ServerTask::GetTaskHandler(), and TGo4ServerTask::SetCurrentTask().

◆ HasControllerTask()

Bool_t TGo4TaskManager::HasControllerTask ( )

inline

Definition at line 118 of file TGo4TaskManager.h.

References fbHasControllerConnection.

◆ NewTaskHandler()

TGo4TaskHandler * TGo4TaskManager::NewTaskHandler ( const char * name )

creates new task handler with given name and adds it into array

Definition at line 395 of file TGo4TaskManager.cxx.

References AddTaskHandler(), fxServer, TGo4Task::IsMaster(), and TGo4TaskHandler::TGo4TaskHandler().

Referenced by AddClient().

◆ NextTaskHandler()

TGo4TaskHandler * TGo4TaskManager::NextTaskHandler ( Bool_t reset = kFALSE )

For iteration over all connected task handlers. If reset is true, internal iterator will be reset. Otherwies, continue iterating list until last entry. Returns 0 when iteration finishes.

Definition at line 455 of file TGo4TaskManager.cxx.

References fxListMutex, and fxTaskIter.

Referenced by TGo4ServerTask::NextCommand(), TGo4ServerTask::RemoveAllClients(), TGo4ServerTask::SendStatus(), and TGo4ServerTask::SendStatusBuffer().

◆ RemoveTaskHandler()

Bool_t TGo4TaskManager::RemoveTaskHandler ( const char * name )

removes task handler from array by name

Definition at line 406 of file TGo4TaskManager.cxx.

References fxListMutex, fxServer, fxTaskList, TGo4ServerTask::GetCurrentTaskHandler(), TGo4ServerTask::SetCurrentTask(), and TGo4Task::StartWorkThreads().

Referenced by AddClient(), and DisConnectClient().

◆ ServeClient()

Int_t TGo4TaskManager::ServeClient ( )

used by connector runnable to wait for a client connect/disonnect request

Definition at line 80 of file TGo4TaskManager.cxx.

References ClientLogin(), ConnectClient(), TGo4Log::Debug(), DisConnectClient(), TGo4TaskHandler::fgcCONNECT, TGo4TaskHandler::fgcDISCONNECT, fuNegotiationPort, fxServer, fxTransport, TGo4TaskHandler::Get_fgcERROR(), TGo4TaskHandler::Get_fgcOK(), TGo4TaskHandler::Get_fgiPORTWAITCYCLES(), TGo4TaskHandler::Get_fguPORTWAITTIME(), GetNegotiationPort(), TGo4ThreadManager::IsTerminating(), kGo4ComModeRefused, TGo4Socket::RecvRaw(), TGo4Socket::Send(), TGo4ServerTask::SetConnect(), TGo4ServerTask::SetDisConnect(), TGo4Thread::Sleep(), TGo4ServerTask::WaitForClose(), TGo4ServerTask::WaitForConnection(), and TGo4ServerTask::WaitForOpen().

Referenced by TGo4ConnectorRunnable::Run().

◆ WaitForClientRemoved()

Int_t TGo4TaskManager::WaitForClientRemoved ( )

Definition at line 462 of file TGo4TaskManager.cxx.

References fbClientIsRemoved, fgiDISCONCYCLES, fguDISCONTIME, fxServer, TGo4ThreadManager::IsTerminating(), and TGo4Thread::Sleep().

Referenced by GetTaskCount(), and TGo4ServerTask::RemoveClient().

Member Data Documentation

◆ fbClientIsRemoved

Bool_t TGo4TaskManager::fbClientIsRemoved {kFALSE}

private

True if the last specified client is removed from server. flag is set by connector thread who performs the DisconnectClient of TaskManager; is reset by WaitForClientRemoved method.

Definition at line 157 of file TGo4TaskManager.h.

Referenced by DisConnectClient(), and WaitForClientRemoved().

◆ fbHasControllerConnection

Bool_t TGo4TaskManager::fbHasControllerConnection {kFALSE}

private

True if this server already has one connection to a master client that has the controller role. Only one controller or administrator taskhandler is allowed per server.

Definition at line 162 of file TGo4TaskManager.h.

Referenced by AddClient(), ClientLogin(), DisConnectClient(), and HasControllerTask().

◆ fgiDISCONCYCLES

const Int_t TGo4TaskManager::fgiDISCONCYCLES =360

static

cycles to wait for client disconnection

Definition at line 123 of file TGo4TaskManager.h.

Referenced by WaitForClientRemoved().

◆ fguDISCONTIME

const UInt_t TGo4TaskManager::fguDISCONTIME =500

static

time for each disonnection wait cycle

Definition at line 128 of file TGo4TaskManager.h.

Referenced by WaitForClientRemoved().

◆ fuNegotiationPort

UInt_t TGo4TaskManager::fuNegotiationPort {0}

private

port number for the server client negotiation connections

Definition at line 152 of file TGo4TaskManager.h.

Referenced by GetNegotiationPort(), ServeClient(), and TGo4TaskManager().

◆ fuTaskCount

UInt_t TGo4TaskManager::fuTaskCount {0}

private

Definition at line 149 of file TGo4TaskManager.h.

Referenced by AddClient(), DisConnectClient(), and GetTaskCount().

◆ fxListMutex

TMutex* TGo4TaskManager::fxListMutex {nullptr}

private

Definition at line 144 of file TGo4TaskManager.h.

Referenced by AddTaskHandler(), GetLastTaskHandler(), GetMutex(), GetTaskHandler(), NextTaskHandler(), RemoveTaskHandler(), TGo4TaskManager(), and ~TGo4TaskManager().

◆ fxServer

TGo4ServerTask* TGo4TaskManager::fxServer {nullptr}

private

Definition at line 138 of file TGo4TaskManager.h.

Referenced by AddClient(), ClientLogin(), DisConnectClient(), NewTaskHandler(), RemoveTaskHandler(), ServeClient(), TGo4TaskManager(), and WaitForClientRemoved().

◆ fxTaskIter

TIterator* TGo4TaskManager::fxTaskIter {nullptr}

private

Iterator over list of tasks.

Definition at line 147 of file TGo4TaskManager.h.

Referenced by NextTaskHandler(), TGo4TaskManager(), and ~TGo4TaskManager().

◆ fxTaskList

TObjArray* TGo4TaskManager::fxTaskList {nullptr}

private

Definition at line 142 of file TGo4TaskManager.h.

Referenced by AddTaskHandler(), GetLastTaskHandler(), GetTaskHandler(), RemoveTaskHandler(), TGo4TaskManager(), and ~TGo4TaskManager().

◆ fxTransport

TGo4Socket* TGo4TaskManager::fxTransport {nullptr}

private

Definition at line 140 of file TGo4TaskManager.h.

Referenced by AddClient(), ClientLogin(), DisConnectClient(), GetNegotiationPort(), ServeClient(), TGo4TaskManager(), and ~TGo4TaskManager().

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

Go4TaskHandler/TGo4TaskManager.h
Go4TaskHandler/TGo4TaskManager.cxx

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TGo4TaskManager() [1/3]

◆ ~TGo4TaskManager()

◆ TGo4TaskManager() [2/3]

◆ TGo4TaskManager() [3/3]

Member Function Documentation

◆ AddClient()

◆ AddTaskHandler()

◆ ClientLogin()

◆ ConnectClient()

◆ DisConnectClient() [1/2]

◆ DisConnectClient() [2/2]

◆ GetLastTaskHandler()

◆ GetMutex()

◆ GetNegotiationPort()

◆ GetTaskCount()

◆ GetTaskHandler()

◆ HasControllerTask()

◆ NewTaskHandler()

◆ NextTaskHandler()

◆ RemoveTaskHandler()

◆ ServeClient()

◆ WaitForClientRemoved()

Member Data Documentation

◆ fbClientIsRemoved

◆ fbHasControllerConnection

◆ fgiDISCONCYCLES

◆ fguDISCONTIME

◆ fuNegotiationPort

◆ fuTaskCount

◆ fxListMutex

◆ fxServer

◆ fxTaskIter

◆ fxTaskList

◆ fxTransport