TGo4ComRemoveClient Class Reference

server command: current client is removed (disconnected) from server More...

#include <TGo4ComRemoveClient.h>

Inheritance diagram for TGo4ComRemoveClient:

Public Member Functions
	TGo4ComRemoveClient ()
Int_t	ExeCom () override
	Do the command action.
void	SetClient (const char *name)
	Specify the name of the client to be removed.
void	SetWaitForClient (Bool_t wait=kTRUE)
Public Member Functions inherited from TGo4TaskHandlerCommand
	TGo4TaskHandlerCommand ()
	TGo4TaskHandlerCommand (const char *name, const char *description)
Int_t	RefuseCom () override
	Optional action if command is not allowed (warning message e.g.)
Public Member Functions inherited from TGo4Command
	TGo4Command ()
	TGo4Command (const char *name, const char *description, Int_t id)
virtual	~TGo4Command ()
Int_t	GetCommandID () const
Go4CommandMode_t	GetMode () const
Go4CommandMode_t	GetProtection () const
const char *	GetReceiverName () const
const char *	GetTaskName () const
virtual void	Help ()
Bool_t	IsEnabled () const
Bool_t	IsExclusive () const
Bool_t	IsLocal () const
Bool_t	IsSynchron () const
virtual Bool_t	Log (Int_t mode=0)
virtual void	Set (TGo4RemoteCommand *remcon)
	Set internals of this command from specification of external remote command (command container).
void	SetDescription (const char *)
void	SetMode (Go4CommandMode_t m)
virtual void	SetReceiver (TGo4CommandReceiver *rec)
void	SetReceiverName (const char *)
void	SetTaskName (const char *)
const char *	What () const

Private Attributes
Bool_t	fbWaitForClient {kFALSE}
TString	fxClientName
	name of the client to be removed

Additional Inherited Members
Static Public Member Functions inherited from TGo4Command
static const char *	GetModeDescription (Go4CommandMode_t mode)
	text description of current execution mode
Protected Member Functions inherited from TGo4Command
void	SetProtection (Go4CommandMode_t m)
Protected Attributes inherited from TGo4Command
Bool_t	fbIsEnabled {kFALSE}
Bool_t	fbIsExclusive {kFALSE}
Bool_t	fbIsLocal {kFALSE}
Bool_t	fbIsSynchron {kFALSE}
Int_t	fiCommandID {0}
Go4CommandMode_t	fiMode {kGo4ComModeRefused}
	mode value for execution rights of sending task
Go4CommandMode_t	fiProtection {kGo4ComModeRefused}
	Execute protection of this command.
Int_t	fiVersion {0}
TGo4CommandReceiver *	fxReceiverBase {nullptr}
Static Protected Attributes inherited from TGo4Command
static const char *	fgcMODEDESCRIPTION []
	resolve description of command modes here

Detailed Description

server command: current client is removed (disconnected) from server

Definition at line 24 of file TGo4ComRemoveClient.h.

Constructor & Destructor Documentation

TGo4ComRemoveClient()

TGo4ComRemoveClient::TGo4ComRemoveClient

(

)

Definition at line 21 of file TGo4ComRemoveClient.cxx.

References TGo4TaskHandlerCommand::TGo4TaskHandlerCommand(), TGo4Command::fbIsLocal, fbWaitForClient, fxClientName, and TGo4Command::SetReceiverName().

Member Function Documentation

ExeCom()

Int_t TGo4ComRemoveClient::ExeCom ( )

overridevirtual

Do the command action.

Reimplemented from TGo4Command.

Definition at line 41 of file TGo4ComRemoveClient.cxx.

References TGo4Log::Debug(), fbWaitForClient, fxClientName, TGo4Command::fxReceiverBase, and TGo4ServerTask::RemoveClient().

SetClient()

void TGo4ComRemoveClient::SetClient

(

const char *

name

)

Specify the name of the client to be removed.

Definition at line 31 of file TGo4ComRemoveClient.cxx.

References fxClientName.

Referenced by TGo4TaskHandlerAbortException::Handle().

SetWaitForClient()

void TGo4ComRemoveClient::SetWaitForClient

(

Bool_t

wait = kTRUE

)

Definition at line 36 of file TGo4ComRemoveClient.cxx.

References fbWaitForClient.

Referenced by TGo4TaskHandlerAbortException::Handle().

Field Documentation

fbWaitForClient

Bool_t TGo4ComRemoveClient::fbWaitForClient {kFALSE}

private

Definition at line 41 of file TGo4ComRemoveClient.h.

Referenced by TGo4ComRemoveClient(), ExeCom(), and SetWaitForClient().

fxClientName

TString TGo4ComRemoveClient::fxClientName

private

name of the client to be removed

Definition at line 39 of file TGo4ComRemoveClient.h.

Referenced by TGo4ComRemoveClient(), ExeCom(), and SetClient().

---

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

• Go4CommandsTaskHandler/TGo4ComRemoveClient.h
• Go4CommandsTaskHandler/TGo4ComRemoveClient.cxx