---

TGo4TaskHandler Class Reference

This class is responsible for the interconnection of two tasks: provided are three communication channels (data, command, status), one thread runnable is acting on each transport channel (e.g. More...

#include <TGo4TaskHandler.h>

List of all members.

Public Methods
	TGo4TaskHandler (const char *name, TGo4ThreadManager *threadmanager, Bool_t clientmode=kFALSE, Bool_t mastermode=kTRUE, UInt_t negotiationport=0)
virtual	~TGo4TaskHandler ()
Bool_t	ConnectServerChannel (const char *name, TGo4Socket *negotiator, TGo4Socket *channel, const char *host)
	Method defining the connection protocol of one data transport channel (data, status, or command). More...
Bool_t	ConnectClientChannel (const char *name, TGo4Socket *negotiator, TGo4Socket *channel, const char *host)
	method defining the connection protocol of one data transport channel (data, status, or command). More...
TGo4Socket *	ServerRequest (const char *host="localhost")
	request to server at host to connect or disconnect us, returns negotiation channel. More...
Bool_t	ServerLogin (TGo4Socket *connector, Go4CommandMode_t account)
	Negotiate login to requested server channel with account type. More...
Bool_t	Connect (const char *host="localhost", TGo4Socket *negotiator=0)
	establishes the connections of all three transport channels and starts the service threads. More...
Bool_t	DisConnect (Bool_t waitforclient=kTRUE)
	Closes the connections of all three transport channels. More...
TGo4ThreadManager *	GetThreadManager () const
Int_t	WaitGetPort (TGo4Socket *sock)
	Get actual local port number of specified Go4 socket. More...
void	SetNegotiationPort (UInt_t port)
	Set port for the negotiation channel (client mode). More...
TGo4Socket *	GetCommandTransport () const
TGo4Socket *	GetStatusTransport () const
TGo4Socket *	GetDataTransport () const
TGo4Queue *	GetCommandQueue () const
TGo4Queue *	GetStatusQueue () const
TGo4Queue *	GetDataQueue () const
const char *	GetHostName () const
const char *	GetComName () const
const char *	GetDatName () const
const char *	GetStatName () const
Int_t	GetComPort () const
Int_t	GetDatPort () const
Int_t	GetStatPort () const
Go4CommandMode_t	GetRole ()
void	SetRole (Go4CommandMode_t role)
TGo4CommandInvoker *	GetInvoker () const
	returns pointer to copy of client invoker which may be used by server to check the valid command clients. More...
Bool_t	IsClientMode () const
	Check whether this instance is client or server taskhandler. More...
Bool_t	IsMasterMode () const
	Check whether this instance is client or server taskhandler. More...
void	SetAborting (Bool_t isaborting=kTRUE)
	sets the internal aborting state of this taskhandler instance; will be checked before an exception tries to cancel this taskhandler. More...
Bool_t	IsAborting () const
	Check whether this instance is currently being aborted. More...
void	SetInvoker (TGo4CommandInvoker *inv)
	sets pointer to client invoker which may be used by server to check the valid command clients. More...
virtual TGo4TaskHandlerStatus *	CreateStatus ()
	create a status object with information on the current taskhandler state. More...
Bool_t	StopTransportThreads (Bool_t wait=kTRUE)
	Stop all transport threads of this taskhandler (command, data, status). More...
void	StartTransportThreads ()
	Start all transport threads of this taskhandler (command, data, status). More...
Bool_t	WaitThreadStop (const char *name)
	Wait for the thread of name to be stopped. More...
void	CloseChannels ()
	Close transport channels and clear queues. More...
void	ClearQueues ()
	Clear all entries of queues. More...
Static Public Methods
void	SetAdminAccount (const char *name, const char *passwd)
	Specify login name and password for administrator account. More...
void	SetCtrlAccount (const char *name, const char *passwd)
	Specify login name and password for controller account. More...
void	SetObservAccount (const char *name, const char *passwd)
	Specify login name and password for observer account. More...
Static Public Attributes
const UInt_t	fguCONNECTORPORT = 5000
	Default port number of negotiation connection (raw transport). More...
const Int_t	fgiPORTWAITCYCLES = 150
	Cycles to wait for a nonzero portnumber. More...
const UInt_t	fguPORTWAITTIME = 200
	Time for each waitgetport cycle. More...
const Int_t	fgiTHREADSTOPCYCLES = 6
	cycles to wait for taskhandler thread stop on disconnection. More...
const UInt_t	fguTHREADSTOPTIME = 500
	time for each threadstop wait cycle. More...
const UInt_t	fguTRANSPORTCHECKDELAY = 5000
	Delay time (ms) to wait between two checks of transport connection. More...
const UInt_t	fguSTATUSQUEUESIZE = 1000
	Maximum entries allowed for status queue. More...
const UInt_t	fguDATAQUEUESIZE = 1000
	Maximum entries allowed for data queue. More...
const UInt_t	fguCOMMANDQUEUESIZE = 1000
	Maximum entries allowed for command queue. More...
const Text_t	fgcCONNECT [] = "CONNECT-VERSION-210"
	Initial string for connect request (raw transport). More...
const Text_t	fgcDISCONNECT [] = "DISCONNECT-VERSION-210"
	Initial string for disconnect request (raw transport). More...
const Text_t	fgcOK [] = "OK-VERSION-210"
	Ok string for client connect negotiations (raw transport). More...
const Text_t	fgcERROR [] = "ERROR-VERSION-210"
	Error string for client connect negotiations (raw transport). More...
const Text_t	fgcMASTER [] = "Master-VERSION-210"
	Task identifier for client connect negotiations (raw transport). More...
const Text_t	fgcSLAVE [] = "Slave-VERSION-210"
	Task identifier for client connect negotiations (raw transport). More...
const Text_t	fgcCOMMANDTHREAD [] = "COMMAND-"
	Suffix for command thread name. More...
const Text_t	fgcSTATUSTHREAD [] = "STATUS-"
	Suffix for status thread name. More...
const Text_t	fgcDATATHREAD [] = "DATA-"
	Suffix for data thread name. More...
Private Methods
	TGo4TaskHandler ()
Private Attributes
Bool_t	fbClientMode
	True if taskhandler runs in client mode. More...
Bool_t	fbMasterMode
	True if taskhandler runs in master mode (sends commands, receives data and status). More...
Bool_t	fbIsAborting
	True if taskhandler is being aborted e.g. More...
TGo4ThreadManager *	fxThreadManager
	Link to threadmanager that owns the task handler, used for runnable ctors. More...
TGo4ThreadHandler *	fxThreadHandler
	link to external threadhandler which is used for the transport service threads (runnables); these runnables are instantiated from the task handler ctor and passed to the thread handler who takes over the responsibility for the runnables (threadhandler internal mode threads) @associates <{TGo4ThreadHandler}>. More...
TGo4CommandInvoker *	fxInvoker
	Link to external command invoker instance used for direct command in client mode:. More...
TGo4Queue *	fxCommandQueue
	Buffers (queues) for the three transport channels:. More...
TGo4Queue *	fxStatusQueue
TGo4Queue *	fxDataQueue
TGo4Socket *	fxCommandTransport
	Transport channels (e.g. More...
TGo4Socket *	fxStatusTransport
TGo4Socket *	fxDataTransport
TString	fxComName
	Remember name of command thread. More...
TString	fxStatName
	Remember name of status thread. More...
TString	fxDatName
	Remember name of data thread. More...
TString	fxHostName
	Remember name of remote task handler. More...
UInt_t	fuNegPort
	Actual port number of negotiation connection (raw transport). More...
Int_t	fiComPort
	Command connection port number. More...
Int_t	fiStatPort
	Status connection port number. More...
Int_t	fiDatPort
	Data connection port number. More...
Go4CommandMode_t	fiRole
	For server connection to client: This indicates role of connected client, if client is master. More...
TGo4StatusRunnable *	fxStatusRun
	link to status runnable which is managed by thread handler @supplierCardinality 1 @clientCardinality 1. More...
TGo4DataRunnable *	fxDataRun
	link to data runnable which is managed by thread handler @supplierCardinality 1 @clientCardinality 1. More...
TGo4CommandRunnable *	fxCommandRun
	link to command runnable which is managed by thread handler @supplierCardinality 1 @clientCardinality 1. More...
Static Private Attributes
TNamed	fgxADMINISTRATORACCOUNT
	This keeps account for admin connection. More...
TNamed	fgxOBSERVERACCOUNT
	This keeps account for observer connection. More...
TNamed	fgxCONTROLLERACCOUNT
	This keeps account for controller connection. More...
Friends
class	TGo4TaskManager

---

Detailed Description

This class is responsible for the interconnection of two tasks: provided are three communication channels (data, command, status), one thread runnable is acting on each transport channel (e.g.

socket); one queue (buffer) is assigned to each channel depending on client or server mode of the task handler, the threads get objects from transporl and put them into the queue, or vice versa. (servertask sends commands, but receives data and status objects) taskhander is named such that it can be found in a list (i.e. task manager) by the server task which may serve more than one client tasks

Definition at line 50 of file TGo4TaskHandler.h.

---

Constructor & Destructor Documentation

TGo4TaskHandler::TGo4TaskHandler (  const char *    name, TGo4ThreadManager *    threadmanager, Bool_t    clientmode = kFALSE, Bool_t    mastermode = kTRUE, UInt_t    negotiationport = 0 )

Definition at line 73 of file TGo4TaskHandler.cxx. References TGo4Log::Debug(), fbClientMode, fbMasterMode, fgcCOMMANDTHREAD, fgcDATATHREAD, fgcSTATUSTHREAD, fguCOMMANDQUEUESIZE, fguCONNECTORPORT, fguDATAQUEUESIZE, fguSTATUSQUEUESIZE, TGo4ThreadManager::fguTEXTLENGTH, fuNegPort, fxCommandQueue, fxCommandRun, fxCommandTransport, fxComName, fxDataQueue, fxDataRun, fxDataTransport, fxDatName, fxInvoker, fxStatName, fxStatusQueue, fxStatusRun, fxStatusTransport, fxThreadHandler, fxThreadManager, GetComName(), GetDatName(), GetStatName(), TGo4ThreadManager::GetWorkHandler(), IsClientMode(), IsMasterMode(), kGo4ComModeController, TGo4ThreadHandler::NewThread(), and TGo4Queue::SetMaxEntries().

TGo4TaskHandler::~TGo4TaskHandler (    )  [virtual]

Definition at line 146 of file TGo4TaskHandler.cxx. References fxCommandQueue, fxCommandTransport, fxDataQueue, fxDataTransport, fxStatusQueue, fxStatusTransport, fxThreadHandler, GetComName(), GetDatName(), GetStatName(), and TGo4ThreadHandler::RemoveThread().

TGo4TaskHandler::TGo4TaskHandler (    )  [private]

---

Member Function Documentation

Bool_t TGo4TaskHandler::ConnectServerChannel (  const char *    name, TGo4Socket *    negotiator, TGo4Socket *    channel, const char *    host )

Method defining the connection protocol of one data transport channel (data, status, or command). For server socket mode (used by taskmanager) Definition at line 413 of file TGo4TaskHandler.cxx. References TGo4Log::Debug(), fgcOK, TGo4ThreadManager::fguTEXTLENGTH, TGo4Socket::IsOpen(), TGo4Socket::RecvRaw(), TGo4Socket::Send(), TGo4ServerTask::SetConnect(), TGo4ServerTask::WaitForConnection(), TGo4ServerTask::WaitForOpen(), and WaitGetPort().

Bool_t TGo4TaskHandler::ConnectClientChannel (  const char *    name, TGo4Socket *    negotiator, TGo4Socket *    channel, const char *    host )

method defining the connection protocol of one data transport channel (data, status, or command). For client socket mode (used by taskhandler) Definition at line 491 of file TGo4TaskHandler.cxx. References TGo4Log::Debug(), fgcOK, TGo4ThreadManager::fguTEXTLENGTH, TGo4Socket::IsOpen(), TGo4Socket::Open(), TGo4Socket::RecvRaw(), and TGo4Socket::Send().

TGo4Socket * TGo4TaskHandler::ServerRequest (  const char *    host = "localhost" )

request to server at host to connect or disconnect us, returns negotiation channel. Definition at line 159 of file TGo4TaskHandler.cxx. References TGo4Socket::Close(), TGo4Log::Debug(), fgcERROR, fuNegPort, fxThreadManager, GetRole(), TGo4Socket::Open(), TGo4Socket::Send(), and ServerLogin(). Referenced by DisConnect().

Bool_t TGo4TaskHandler::ServerLogin (  TGo4Socket *    connector, Go4CommandMode_t    account )

Negotiate login to requested server channel with account type. Definition at line 291 of file TGo4TaskHandler.cxx. References fgcERROR, fgcMASTER, fgcOK, fgcSLAVE, fgxADMINISTRATORACCOUNT, fgxCONTROLLERACCOUNT, fgxOBSERVERACCOUNT, Go4CommandMode_t, kGo4ComModeAdministrator, kGo4ComModeController, kGo4ComModeObserver, TGo4Socket::RecvRaw(), and TGo4Socket::Send(). Referenced by ServerRequest().

Bool_t TGo4TaskHandler::Connect (  const char *    host = "localhost", TGo4Socket *    negotiator = 0 )

establishes the connections of all three transport channels and starts the service threads. Definition at line 198 of file TGo4TaskHandler.cxx. References TGo4Log::Debug(), and fgcOK. Referenced by TGo4TaskManager::AddClient(), and TGo4ClientTask::ConnectServer().

Bool_t TGo4TaskHandler::DisConnect (  Bool_t    waitforclient = kTRUE )

Closes the connections of all three transport channels. Argument waitforclient specifies if server shall wait for client handshake over negotiation channel before shutting down the sockets. Definition at line 336 of file TGo4TaskHandler.cxx. References TGo4Socket::Close(), CloseChannels(), TGo4Log::Debug(), fgcDISCONNECT, fgcOK, GetHostName(), IsAborting(), TGo4Socket::Send(), ServerRequest(), and StopTransportThreads(). Referenced by TGo4TaskManager::DisConnectClient(), TGo4ClientTask::DisconnectServer(), and TGo4AnalysisClient::~TGo4AnalysisClient().

TGo4ThreadManager* TGo4TaskHandler::GetThreadManager (    )  const [inline]

Definition at line 96 of file TGo4TaskHandler.h. References fxThreadManager. Referenced by TGo4TaskHandlerException::TGo4TaskHandlerException().

Int_t TGo4TaskHandler::WaitGetPort (  TGo4Socket *    sock )

Get actual local port number of specified Go4 socket. Method polls until the port number is not zero, i.e. the created server socket has been bound to that number. Used by the Connect protocol to find out server port before sending it to the client. Definition at line 529 of file TGo4TaskHandler.cxx. References fgiPORTWAITCYCLES, fguPORTWAITTIME, fxThreadManager, TGo4Socket::GetPort(), TGo4ThreadManager::IsTerminating(), and TGo4Thread::Sleep(). Referenced by ConnectServerChannel().

void TGo4TaskHandler::SetNegotiationPort (  UInt_t    port )  [inline]

Set port for the negotiation channel (client mode). Required if connection should be done on different port after taskhandler was created. Definition at line 110 of file TGo4TaskHandler.h. References fuNegPort. Referenced by TGo4ClientTask::ConnectServer().

TGo4Socket* TGo4TaskHandler::GetCommandTransport (    )  const [inline]

Definition at line 112 of file TGo4TaskHandler.h. References fxCommandTransport. Referenced by TGo4CommandRunnable::TGo4CommandRunnable().

TGo4Socket* TGo4TaskHandler::GetStatusTransport (    )  const [inline]

Definition at line 114 of file TGo4TaskHandler.h. References fxStatusTransport. Referenced by TGo4StatusRunnable::TGo4StatusRunnable().

TGo4Socket* TGo4TaskHandler::GetDataTransport (    )  const [inline]

Definition at line 116 of file TGo4TaskHandler.h. References fxDataTransport. Referenced by TGo4DataRunnable::TGo4DataRunnable().

TGo4Queue* TGo4TaskHandler::GetCommandQueue (    )  const [inline]

Definition at line 118 of file TGo4TaskHandler.h. References fxCommandQueue. Referenced by TGo4ServerTask::GetCommandQueue(), TGo4ServerTask::NextCommand(), StopTransportThreads(), TGo4ClientTask::TGo4ClientTask(), and TGo4CommandRunnable::TGo4CommandRunnable().

TGo4Queue* TGo4TaskHandler::GetStatusQueue (    )  const [inline]

Definition at line 120 of file TGo4TaskHandler.h. References fxStatusQueue. Referenced by TGo4ServerTask::GetStatusQueue(), TGo4ServerTask::SendStatus(), TGo4ServerTask::SendStatusBuffer(), TGo4ClientTask::TGo4ClientTask(), and TGo4StatusRunnable::TGo4StatusRunnable().

TGo4Queue* TGo4TaskHandler::GetDataQueue (    )  const [inline]

Definition at line 122 of file TGo4TaskHandler.h. References fxDataQueue. Referenced by TGo4ServerTask::GetDataQueue(), TGo4ClientTask::TGo4ClientTask(), and TGo4DataRunnable::TGo4DataRunnable().

const char* TGo4TaskHandler::GetHostName (    )  const [inline]

Definition at line 124 of file TGo4TaskHandler.h. References fxHostName. Referenced by CreateStatus(), and DisConnect().

const char* TGo4TaskHandler::GetComName (    )  const [inline]

Definition at line 126 of file TGo4TaskHandler.h. References fxComName. Referenced by CreateStatus(), StartTransportThreads(), StopTransportThreads(), TGo4TaskHandler(), and ~TGo4TaskHandler().

const char* TGo4TaskHandler::GetDatName (    )  const [inline]

Definition at line 128 of file TGo4TaskHandler.h. References fxDatName. Referenced by CreateStatus(), StartTransportThreads(), StopTransportThreads(), TGo4TaskHandler(), and ~TGo4TaskHandler().

const char* TGo4TaskHandler::GetStatName (    )  const [inline]

Definition at line 130 of file TGo4TaskHandler.h. References fxStatName. Referenced by CreateStatus(), StartTransportThreads(), StopTransportThreads(), TGo4TaskHandler(), and ~TGo4TaskHandler().

Int_t TGo4TaskHandler::GetComPort (    )  const [inline]

Definition at line 132 of file TGo4TaskHandler.h. References fiComPort. Referenced by TGo4TaskManager::AddClient().

Int_t TGo4TaskHandler::GetDatPort (    )  const [inline]

Definition at line 134 of file TGo4TaskHandler.h. References fiDatPort. Referenced by TGo4TaskManager::AddClient().

Int_t TGo4TaskHandler::GetStatPort (    )  const [inline]

Definition at line 136 of file TGo4TaskHandler.h. References fiStatPort. Referenced by TGo4TaskManager::AddClient().

Go4CommandMode_t TGo4TaskHandler::GetRole (    )  [inline]

Definition at line 138 of file TGo4TaskHandler.h. References fiRole, and Go4CommandMode_t. Referenced by TGo4TaskManager::AddClient(), TGo4TaskManager::DisConnectClient(), TGo4ServerTask::NextCommand(), TGo4CommandRunnable::Run(), and ServerRequest().

void TGo4TaskHandler::SetRole (  Go4CommandMode_t    role )  [inline]

Definition at line 139 of file TGo4TaskHandler.h. References fiRole, and Go4CommandMode_t. Referenced by TGo4TaskManager::AddClient(), and TGo4ClientTask::ConnectServer().

TGo4CommandInvoker* TGo4TaskHandler::GetInvoker (    )  const [inline]

returns pointer to copy of client invoker which may be used by server to check the valid command clients. Definition at line 145 of file TGo4TaskHandler.h. References fxInvoker.

Bool_t TGo4TaskHandler::IsClientMode (    )  const [inline]

Check whether this instance is client or server taskhandler. Definition at line 148 of file TGo4TaskHandler.h. References fbClientMode. Referenced by TGo4TaskHandlerAbortException::Handle(), TGo4CommandRunnable::Run(), and TGo4TaskHandler().

Bool_t TGo4TaskHandler::IsMasterMode (    )  const [inline]

Check whether this instance is client or server taskhandler. Definition at line 151 of file TGo4TaskHandler.h. References fbMasterMode. Referenced by StopTransportThreads(), and TGo4TaskHandler().

void TGo4TaskHandler::SetAborting (  Bool_t    isaborting = kTRUE )  [inline]

sets the internal aborting state of this taskhandler instance; will be checked before an exception tries to cancel this taskhandler. Definition at line 157 of file TGo4TaskHandler.h. References fbIsAborting. Referenced by TGo4TaskHandlerAbortException::Handle(), and TGo4AnalysisClient::~TGo4AnalysisClient().

Bool_t TGo4TaskHandler::IsAborting (    )  const [inline]

Check whether this instance is currently being aborted. Definition at line 160 of file TGo4TaskHandler.h. References fbIsAborting. Referenced by DisConnect(), TGo4TaskHandlerAbortException::Handle(), TGo4Task::SendStopBuffers(), and TGo4Task::WakeCommandQueue().

void TGo4TaskHandler::SetInvoker (  TGo4CommandInvoker *    inv )  [inline]

sets pointer to client invoker which may be used by server to check the valid command clients. Definition at line 166 of file TGo4TaskHandler.h. References fxInvoker.

TGo4TaskHandlerStatus * TGo4TaskHandler::CreateStatus (    )  [virtual]

create a status object with information on the current taskhandler state. this object may be sent to the server or may be used to restore current status by memento mechanism Definition at line 401 of file TGo4TaskHandler.cxx. References fbIsAborting, fiComPort, fiDatPort, fiStatPort, fuNegPort, GetComName(), GetDatName(), GetHostName(), GetStatName(), TGo4TaskHandlerStatus::SetFlags(), TGo4TaskHandlerStatus::SetNames(), and TGo4TaskHandlerStatus::SetPorts(). Referenced by TGo4Task::UpdateStatus().

Bool_t TGo4TaskHandler::StopTransportThreads (  Bool_t    wait = kTRUE )

Stop all transport threads of this taskhandler (command, data, status). If wait is true, wait until threads are really stopped before return. If not all threads were stopped within defined stoptime and waitcycles, return value is false. Definition at line 563 of file TGo4TaskHandler.cxx. References fxThreadHandler, GetCommandQueue(), GetComName(), GetDatName(), GetStatName(), IsMasterMode(), TGo4ThreadHandler::Stop(), WaitThreadStop(), and TGo4Queue::Wake(). Referenced by DisConnect().

void TGo4TaskHandler::StartTransportThreads (    )

Start all transport threads of this taskhandler (command, data, status). Definition at line 556 of file TGo4TaskHandler.cxx. References fxThreadHandler, GetComName(), GetDatName(), GetStatName(), and TGo4ThreadHandler::Start().

Bool_t TGo4TaskHandler::WaitThreadStop (  const char *    name )

Wait for the thread of name to be stopped. Returns false if thread has not reached stopped state within the defined stoptime and cycles. Definition at line 587 of file TGo4TaskHandler.cxx. References TGo4Log::Debug(), fgiTHREADSTOPCYCLES, fguTHREADSTOPTIME, fxThreadHandler, TGo4ThreadHandler::GetThread(), TGo4Thread::IsWaiting(), and TGo4Thread::Sleep(). Referenced by StopTransportThreads().

void TGo4TaskHandler::CloseChannels (    )

Close transport channels and clear queues. Definition at line 385 of file TGo4TaskHandler.cxx. References ClearQueues(), TGo4Socket::Close(), fxCommandTransport, fxDataTransport, and fxStatusTransport. Referenced by DisConnect().

void TGo4TaskHandler::ClearQueues (    )

Clear all entries of queues. Definition at line 393 of file TGo4TaskHandler.cxx. References TGo4Queue::Clear(), fxCommandQueue, fxDataQueue, and fxStatusQueue. Referenced by CloseChannels(), and TGo4ClientTask::ConnectServer().

void TGo4TaskHandler::SetAdminAccount (  const char *    name, const char *    passwd )  [static]

Specify login name and password for administrator account. This is used when client requests for a server connection. For multiple master clients at a slave server, there can be only one controller, but many observers with restricted command rights. Definition at line 607 of file TGo4TaskHandler.cxx. References fgxADMINISTRATORACCOUNT. Referenced by TGo4ClientTask::ConnectServer(), and TGo4Analysis::SetAdministratorPassword().

void TGo4TaskHandler::SetCtrlAccount (  const char *    name, const char *    passwd )  [static]

Specify login name and password for controller account. This is used when client requests for a server connection. For multiple master clients at a slave server, there can be only one controller. Master server at slave client has always controller role. Definition at line 613 of file TGo4TaskHandler.cxx. References fgxCONTROLLERACCOUNT. Referenced by TGo4ClientTask::ConnectServer(), and TGo4Analysis::SetControllerPassword().

void TGo4TaskHandler::SetObservAccount (  const char *    name, const char *    passwd )  [static]

Specify login name and password for observer account. This is used when client requests for a server connection. For multiple master clients at a slave server, there can be only one controller, but many observers with restricted command rights. Definition at line 619 of file TGo4TaskHandler.cxx. References fgxOBSERVERACCOUNT. Referenced by TGo4ClientTask::ConnectServer(), and TGo4Analysis::SetObserverPassword().

---

Friends And Related Function Documentation

friend class TGo4TaskManager [friend]

Definition at line 54 of file TGo4TaskHandler.h.

---

Member Data Documentation

const UInt_t TGo4TaskHandler::fguCONNECTORPORT = 5000 [static]

Default port number of negotiation connection (raw transport). Definition at line 39 of file TGo4TaskHandler.cxx. Referenced by TGo4TaskHandler(), and TGo4TaskManager::TGo4TaskManager().

const Int_t TGo4TaskHandler::fgiPORTWAITCYCLES = 150 [static]

Cycles to wait for a nonzero portnumber. Definition at line 48 of file TGo4TaskHandler.cxx. Referenced by TGo4HistogramServer::ConnectObjectClient(), TGo4TaskManager::ServeClient(), and WaitGetPort().

const UInt_t TGo4TaskHandler::fguPORTWAITTIME = 200 [static]

Time for each waitgetport cycle. Definition at line 50 of file TGo4TaskHandler.cxx. Referenced by TGo4TaskHandlerRunnable::CheckTransportOpen(), TGo4HistogramServer::ConnectObjectClient(), TGo4TaskManager::ServeClient(), and WaitGetPort().

const Int_t TGo4TaskHandler::fgiTHREADSTOPCYCLES = 6 [static]

cycles to wait for taskhandler thread stop on disconnection. Definition at line 52 of file TGo4TaskHandler.cxx. Referenced by WaitThreadStop().

const UInt_t TGo4TaskHandler::fguTHREADSTOPTIME = 500 [static]

time for each threadstop wait cycle. Definition at line 54 of file TGo4TaskHandler.cxx. Referenced by WaitThreadStop().

const UInt_t TGo4TaskHandler::fguTRANSPORTCHECKDELAY = 5000 [static]

Delay time (ms) to wait between two checks of transport connection. Definition at line 41 of file TGo4TaskHandler.cxx.

const UInt_t TGo4TaskHandler::fguSTATUSQUEUESIZE = 1000 [static]

Maximum entries allowed for status queue. Definition at line 43 of file TGo4TaskHandler.cxx. Referenced by TGo4TaskHandler().

const UInt_t TGo4TaskHandler::fguDATAQUEUESIZE = 1000 [static]

Maximum entries allowed for data queue. Definition at line 44 of file TGo4TaskHandler.cxx. Referenced by TGo4TaskHandler().

const UInt_t TGo4TaskHandler::fguCOMMANDQUEUESIZE = 1000 [static]

Maximum entries allowed for command queue. Definition at line 45 of file TGo4TaskHandler.cxx. Referenced by TGo4TaskHandler().

const Text_t TGo4TaskHandler::fgcCONNECT = "CONNECT-VERSION-210" [static]

Initial string for connect request (raw transport). Definition at line 56 of file TGo4TaskHandler.cxx. Referenced by TGo4TaskManager::ServeClient().

const Text_t TGo4TaskHandler::fgcDISCONNECT = "DISCONNECT-VERSION-210" [static]

Initial string for disconnect request (raw transport). Definition at line 57 of file TGo4TaskHandler.cxx. Referenced by DisConnect(), and TGo4TaskManager::ServeClient().

const Text_t TGo4TaskHandler::fgcOK = "OK-VERSION-210" [static]

Ok string for client connect negotiations (raw transport). Definition at line 59 of file TGo4TaskHandler.cxx. Referenced by TGo4HistogramServer::CheckLogin(), TGo4TaskManager::ClientLogin(), Connect(), ConnectClientChannel(), TGo4ObjClient::ConnectServer(), ConnectServerChannel(), DisConnect(), TGo4TaskManager::DisConnectClient(), TGo4ObjClient::ReceiveObject(), TGo4CommandRunnable::Run(), TGo4HistogramServer::SendObject(), TGo4TaskManager::ServeClient(), and ServerLogin().

const Text_t TGo4TaskHandler::fgcERROR = "ERROR-VERSION-210" [static]

Error string for client connect negotiations (raw transport). Definition at line 60 of file TGo4TaskHandler.cxx. Referenced by TGo4TaskManager::AddClient(), TGo4HistogramServer::CheckLogin(), TGo4CommandRunnable::Run(), TGo4HistogramServer::SendObject(), TGo4TaskManager::ServeClient(), ServerLogin(), ServerRequest(), and TGo4ServerTask::StopConnectorThread().

const Text_t TGo4TaskHandler::fgcMASTER = "Master-VERSION-210" [static]

Task identifier for client connect negotiations (raw transport). Definition at line 62 of file TGo4TaskHandler.cxx. Referenced by TGo4TaskManager::ClientLogin(), and ServerLogin().

const Text_t TGo4TaskHandler::fgcSLAVE = "Slave-VERSION-210" [static]

Task identifier for client connect negotiations (raw transport). Definition at line 63 of file TGo4TaskHandler.cxx. Referenced by TGo4TaskManager::ClientLogin(), and ServerLogin().

const Text_t TGo4TaskHandler::fgcCOMMANDTHREAD = "COMMAND-" [static]

Suffix for command thread name. Definition at line 65 of file TGo4TaskHandler.cxx. Referenced by TGo4TaskHandler().

const Text_t TGo4TaskHandler::fgcSTATUSTHREAD = "STATUS-" [static]

Suffix for status thread name. Definition at line 66 of file TGo4TaskHandler.cxx. Referenced by TGo4TaskHandler().

const Text_t TGo4TaskHandler::fgcDATATHREAD = "DATA-" [static]

Suffix for data thread name. Definition at line 67 of file TGo4TaskHandler.cxx. Referenced by TGo4TaskHandler().

TNamed TGo4TaskHandler::fgxADMINISTRATORACCOUNT [static, private]

This keeps account for admin connection. Name is accountname, title is password. May be set from outside by public methods SetObservAccount and SetObservPasswd. Later we might keep this with encryption... Referenced by TGo4TaskManager::ClientLogin(), ServerLogin(), and SetAdminAccount().

TNamed TGo4TaskHandler::fgxOBSERVERACCOUNT [static, private]

This keeps account for observer connection. Name is accountname, title is password. May be set from outside by public methods SetObservAccount and SetObservPasswd. Later we might keep this with encryption... Referenced by TGo4TaskManager::ClientLogin(), ServerLogin(), and SetObservAccount().

TNamed TGo4TaskHandler::fgxCONTROLLERACCOUNT [static, private]

This keeps account for controller connection. Name is accountname, title is password. May be set from outside by public methods SetCtrlAccount and SetCtrlPasswd. Later we might keep this with encryption... Referenced by TGo4TaskManager::ClientLogin(), ServerLogin(), and SetCtrlAccount().

Bool_t TGo4TaskHandler::fbClientMode [private]

True if taskhandler runs in client mode. Definition at line 320 of file TGo4TaskHandler.h. Referenced by IsClientMode(), and TGo4TaskHandler().

Bool_t TGo4TaskHandler::fbMasterMode [private]

True if taskhandler runs in master mode (sends commands, receives data and status). Otherwise false. Definition at line 323 of file TGo4TaskHandler.h. Referenced by IsMasterMode(), and TGo4TaskHandler().

Bool_t TGo4TaskHandler::fbIsAborting [private]

True if taskhandler is being aborted e.g. by remove exception Definition at line 326 of file TGo4TaskHandler.h. Referenced by CreateStatus(), IsAborting(), and SetAborting().

TGo4ThreadManager* TGo4TaskHandler::fxThreadManager [private]

Link to threadmanager that owns the task handler, used for runnable ctors. Definition at line 329 of file TGo4TaskHandler.h. Referenced by GetThreadManager(), ServerRequest(), TGo4TaskHandler(), and WaitGetPort().

TGo4ThreadHandler* TGo4TaskHandler::fxThreadHandler [private]

link to external threadhandler which is used for the transport service threads (runnables); these runnables are instantiated from the task handler ctor and passed to the thread handler who takes over the responsibility for the runnables (threadhandler internal mode threads) @associates <{TGo4ThreadHandler}>. Definition at line 337 of file TGo4TaskHandler.h. Referenced by StartTransportThreads(), StopTransportThreads(), TGo4TaskHandler(), WaitThreadStop(), and ~TGo4TaskHandler().

TGo4CommandInvoker* TGo4TaskHandler::fxInvoker [private]

Link to external command invoker instance used for direct command in client mode:. Definition at line 340 of file TGo4TaskHandler.h. Referenced by GetInvoker(), SetInvoker(), and TGo4TaskHandler().

TGo4Queue* TGo4TaskHandler::fxCommandQueue [private]

Buffers (queues) for the three transport channels:. Definition at line 343 of file TGo4TaskHandler.h. Referenced by ClearQueues(), GetCommandQueue(), TGo4TaskHandler(), and ~TGo4TaskHandler().

TGo4Queue* TGo4TaskHandler::fxStatusQueue [private]

Definition at line 344 of file TGo4TaskHandler.h. Referenced by ClearQueues(), GetStatusQueue(), TGo4TaskHandler(), and ~TGo4TaskHandler().

TGo4Queue* TGo4TaskHandler::fxDataQueue [private]

Definition at line 345 of file TGo4TaskHandler.h. Referenced by ClearQueues(), GetDataQueue(), TGo4TaskHandler(), and ~TGo4TaskHandler().

TGo4Socket* TGo4TaskHandler::fxCommandTransport [private]

Transport channels (e.g. sockets) for command, status, data Definition at line 348 of file TGo4TaskHandler.h. Referenced by CloseChannels(), GetCommandTransport(), TGo4TaskHandler(), and ~TGo4TaskHandler().

TGo4Socket* TGo4TaskHandler::fxStatusTransport [private]

Definition at line 349 of file TGo4TaskHandler.h. Referenced by CloseChannels(), GetStatusTransport(), TGo4TaskHandler(), and ~TGo4TaskHandler().

TGo4Socket* TGo4TaskHandler::fxDataTransport [private]

Definition at line 350 of file TGo4TaskHandler.h. Referenced by CloseChannels(), GetDataTransport(), TGo4TaskHandler(), and ~TGo4TaskHandler().

TString TGo4TaskHandler::fxComName [private]

Remember name of command thread. Definition at line 353 of file TGo4TaskHandler.h. Referenced by GetComName(), and TGo4TaskHandler().

TString TGo4TaskHandler::fxStatName [private]

Remember name of status thread. Definition at line 356 of file TGo4TaskHandler.h. Referenced by GetStatName(), and TGo4TaskHandler().

TString TGo4TaskHandler::fxDatName [private]

Remember name of data thread. Definition at line 359 of file TGo4TaskHandler.h. Referenced by GetDatName(), and TGo4TaskHandler().

TString TGo4TaskHandler::fxHostName [private]

Remember name of remote task handler. Definition at line 362 of file TGo4TaskHandler.h. Referenced by GetHostName().

UInt_t TGo4TaskHandler::fuNegPort [private]

Actual port number of negotiation connection (raw transport). Definition at line 365 of file TGo4TaskHandler.h. Referenced by CreateStatus(), ServerRequest(), SetNegotiationPort(), and TGo4TaskHandler().

Int_t TGo4TaskHandler::fiComPort [private]

Command connection port number. Definition at line 368 of file TGo4TaskHandler.h. Referenced by CreateStatus(), and GetComPort().

Int_t TGo4TaskHandler::fiStatPort [private]

Status connection port number. Definition at line 371 of file TGo4TaskHandler.h. Referenced by CreateStatus(), and GetStatPort().

Int_t TGo4TaskHandler::fiDatPort [private]

Data connection port number. Definition at line 374 of file TGo4TaskHandler.h. Referenced by CreateStatus(), and GetDatPort().

Go4CommandMode_t TGo4TaskHandler::fiRole [private]

For server connection to client: This indicates role of connected client, if client is master. Depending on role, some actions may be forbidden. Role is equivalent to allowed command execution mode. Definition at line 381 of file TGo4TaskHandler.h. Referenced by GetRole(), and SetRole().

TGo4StatusRunnable* TGo4TaskHandler::fxStatusRun [private]

link to status runnable which is managed by thread handler @supplierCardinality 1 @clientCardinality 1. Definition at line 386 of file TGo4TaskHandler.h. Referenced by TGo4TaskHandler().

TGo4DataRunnable* TGo4TaskHandler::fxDataRun [private]

link to data runnable which is managed by thread handler @supplierCardinality 1 @clientCardinality 1. Definition at line 391 of file TGo4TaskHandler.h. Referenced by TGo4TaskHandler().

TGo4CommandRunnable* TGo4TaskHandler::fxCommandRun [private]

link to command runnable which is managed by thread handler @supplierCardinality 1 @clientCardinality 1. Definition at line 396 of file TGo4TaskHandler.h. Referenced by TGo4TaskHandler().

---

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

• /Go4TaskHandler/TGo4TaskHandler.h
• /Go4TaskHandler/TGo4TaskHandler.cxx

---