GSI Object Oriented Online Offline (Go4)  GO4-6.1.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
TGo4ClientTask Class Reference

#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 ()
virtual Int_t Initialization ()
virtual void Quit ()
virtual TGo4TaskStatusCreateStatus ()
TGo4TaskHandlerGetTaskHandler ()
void AddLocalCommand (TGo4Command *com)
TGo4BufferQueueGetCommandQueue (const char *task=0)
TGo4BufferQueueGetStatusQueue (const char *task=0)
TGo4BufferQueueGetDataQueue (const char *task=0)
Bool_t ConnectServer (const char *node, UInt_t negport, Go4CommandMode_t role=kGo4ComModeRefused, const char *passwd=0)
Bool_t DisconnectServer (Bool_t isterminating=kFALSE)
const char * GetServerHostName ()
Bool_t IsConnected () const
- 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 ()
virtual void Start ()
virtual void Stop ()
virtual void KillMain ()
virtual void RestartMain ()
virtual void Terminate (Bool_t termapp=kTRUE)
virtual void TerminateFast ()
virtual void ExecuteString (const char *command)
Bool_t IsMaster ()
void SetOwner (TGo4TaskOwner *owner)
void AddUserCommand (TGo4Command *com)
void AddUserCommandList (TGo4CommandProtoList *comlist)
TGo4StatusNextStatus (Bool_t wait=kTRUE)
TObject * NextObject (Bool_t wait=kTRUE)
virtual TGo4CommandNextCommand ()
void SendObject (TObject *obj, const char *receiver=0)
virtual void SendStatus (TGo4Status *stat, const char *receiver=0)
virtual void SendStatusBuffer ()
TMutex * GetStatusBufferMutex ()
void SendStatusMessage (Int_t level, Bool_t printout, const char *text,...)
void UpdateStatusBuffer ()
Bool_t SubmitCommand (const char *name)
Bool_t SubmitEmergencyCommand (Go4EmergencyCommand_t val)
Bool_t SubmitEmergencyData (Go4EmergencyCommand_t val, const char *receiver=0)
Bool_t SubmitLocalCommand (TGo4Command *com)
Bool_t SubmitCommand (TGo4Command *com)
TGo4CommandMakeCommand (const char *name)
void WakeCommandQueue (Int_t id=0)
virtual Int_t StartWorkThreads ()
virtual Int_t StopWorkThreads ()
Bool_t IsWorkStopped ()
virtual void GetStatus ()
const char * GetCommanderName () const
TGo4MasterGetMaster ()
TGo4SlaveGetSlave ()
void SendStopBuffers (const char *taskname=0)
TBuffer * GetAbortBuffer ()
- Public Member Functions inherited from TGo4ThreadManager
 TGo4ThreadManager (const TGo4ThreadManager &right)
 TGo4ThreadManager (const char *name, Bool_t blockingmode=kTRUE, Bool_t autostart=kTRUE, Bool_t autocreate=kTRUE)
virtual ~TGo4ThreadManager ()
void SetTimer (TGo4AppControlTimer *ctrltimer)
TGo4ThreadHandlerGetWorkHandler () const
Bool_t BlockApp ()
Bool_t UnBlockApp (Int_t mode=0)
Bool_t IsInitDone () const
Bool_t IsTerminating () const
Bool_t IsTerminateApp () const
Bool_t IsAppBlocking () const
Bool_t IsBeingQuit () const
void SetBeingQuit (Bool_t on)
void Launch ()
- Public Member Functions inherited from TGo4CommandReceiver
 TGo4CommandReceiver ()
virtual ~TGo4CommandReceiver ()

Protected Member Functions

virtual void UpdateStatus (TGo4TaskStatus *state)
- Protected Member Functions inherited from TGo4Task
CreateCommandList ()
TGo4TaskHandlerCommandListGetPrototype ()
TGo4ObjectQueueGetLocalCommandQueue ()
void SetMaster (Bool_t on=kTRUE)
void SetWorkIsStopped (Bool_t on)

Private Attributes

TString fxServerHostname
Bool_t fbAutoConnect
Bool_t fbServerConnected

Additional Inherited Members

- Public Types inherited from TGo4ThreadManager
enum  { fguTEXTLENGTH = 256 }
- Static Public Member Functions inherited from TGo4Task
static Int_t Get_fgiTERMID ()
- Static Public Attributes inherited from TGo4ThreadManager
static const Long_t fglTIMERPERIOD = 200
- Protected Attributes inherited from TGo4Task
TMutex * fxStatusMutex
TBuffer * fxStatusBuffer
- Protected Attributes inherited from TGo4ThreadManager
Bool_t fbInitDone
Bool_t fbTerminating
Bool_t fbTerminateApplication
Bool_t fbAppBlocking
Bool_t fbAutoCreate
Bool_t fbAutoStart
Int_t fbBeingQuit

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 33 of file TGo4ClientTask.h.

Constructor & Destructor Documentation

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 
TGo4ClientTask::~TGo4ClientTask ( )

Definition at line 50 of file TGo4ClientTask.cxx.

References DisconnectServer(), and fxTaskHandler.

Member Function Documentation

void TGo4ClientTask::AddLocalCommand ( TGo4Command com)

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

Definition at line 195 of file TGo4ClientTask.cxx.

References TGo4BufferQueue::AddBufferFromObject(), TGo4Log::Debug(), and fxCommandQ.

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

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 179 of file TGo4ClientTask.cxx.

References UpdateStatus().

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 145 of file TGo4ClientTask.cxx.

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

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

TGo4BufferQueue * TGo4ClientTask::GetCommandQueue ( const char *  task = 0)

Reimplemented from TGo4Task.

Definition at line 208 of file TGo4ClientTask.cxx.

References fxCommandQ.

Referenced by DisconnectServer().

TGo4BufferQueue * TGo4ClientTask::GetDataQueue ( const char *  task = 0)

Reimplemented from TGo4Task.

Definition at line 217 of file TGo4ClientTask.cxx.

References fxDataQ.

Referenced by TGo4ExampleClient::TGo4ExampleClient().

const char* TGo4ClientTask::GetServerHostName ( )

Definition at line 100 of file TGo4ClientTask.h.

References fxServerHostname.

Referenced by Initialization(), and UpdateStatus().

TGo4BufferQueue * TGo4ClientTask::GetStatusQueue ( const char *  task = 0)

Reimplemented from TGo4Task.

Definition at line 213 of file TGo4ClientTask.cxx.

References fxStatusQ.

TGo4TaskHandler * TGo4ClientTask::GetTaskHandler ( )

Reimplemented from TGo4Task.

Definition at line 56 of file TGo4ClientTask.cxx.

References fxTaskHandler.

Referenced by TGo4ClientTask(), and TGo4ExampleClient::TGo4ExampleClient().

Int_t TGo4ClientTask::Initialization ( )

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

Reimplemented from TGo4Task.

Definition at line 61 of file TGo4ClientTask.cxx.

References ConnectServer(), fbAutoConnect, TGo4ThreadManager::fbInitDone, GetServerHostName(), TGo4Task::Initialization(), and TGo4Task::Terminate().

Bool_t TGo4ClientTask::IsConnected ( ) const

Definition at line 102 of file TGo4ClientTask.h.

References fbServerConnected.

Referenced by TGo4TaskOwner::IsConnected().

void TGo4ClientTask::Quit ( )

Quit the client; method to be called from command object, may be overridden in user implementation

Reimplemented from TGo4Task.

Definition at line 169 of file TGo4ClientTask.cxx.

References TGo4Log::Debug(), DisconnectServer(), TGo4Task::IsMaster(), TGo4Task::Quit(), TGo4Task::SendStatusMessage(), and TGo4Task::Terminate().

void TGo4ClientTask::UpdateStatus ( TGo4TaskStatus state)

method needed by method CreateStatus of any status subclasses to set the values of the clienttask specific part of the status object.

Reimplemented from TGo4Task.

Reimplemented in TGo4ExampleClient.

Definition at line 187 of file TGo4ClientTask.cxx.

References GetServerHostName(), TGo4ClientStatus::SetNames(), and TGo4Task::UpdateStatus().

Referenced by CreateStatus(), and TGo4ExampleClient::UpdateStatus().

Member Data Documentation

Bool_t TGo4ClientTask::fbAutoConnect

!True if client task shall try to connect automatically at Initialization. This is the previous behaviour with standalone client. If false, connection will be done on ConnectServer method.

Definition at line 132 of file TGo4ClientTask.h.

Referenced by Initialization().

Bool_t TGo4ClientTask::fbServerConnected

true if connection to server is established, otherwise false

Definition at line 137 of file TGo4ClientTask.h.

Referenced by ConnectServer(), DisconnectServer(), and IsConnected().

TGo4BufferQueue* TGo4ClientTask::fxCommandQ

Definition at line 117 of file TGo4ClientTask.h.

Referenced by AddLocalCommand(), GetCommandQueue(), and TGo4ClientTask().

TGo4BufferQueue* TGo4ClientTask::fxDataQ

Definition at line 116 of file TGo4ClientTask.h.

Referenced by GetDataQueue(), and TGo4ClientTask().

TString TGo4ClientTask::fxServerHostname

hostname of server machine

Definition at line 126 of file TGo4ClientTask.h.

Referenced by GetServerHostName(), and TGo4ClientTask().

TGo4BufferQueue* TGo4ClientTask::fxStatusQ

Definition at line 115 of file TGo4ClientTask.h.

Referenced by GetStatusQueue(), and TGo4ClientTask().

TGo4TaskHandler* TGo4ClientTask::fxTaskHandler

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