GSI Object Oriented Online Offline (Go4)  GO4-6.3.0
Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
TGo4Socket Class Reference

#include <TGo4Socket.h>

Public Member Functions

 TGo4Socket (Bool_t IsClient)
 
virtual ~TGo4Socket ()
 
virtual Int_t Open (const char *host, Int_t port, Bool_t keepservsock=kFALSE)
 
virtual Int_t Close (Option_t *opt="")
 
virtual Int_t Send (TObject *obj)
 
virtual Int_t Send (const char *name)
 
virtual TObject * Recv (const char *name=nullptr)
 
virtual char * RecvRaw (const char *name=nullptr)
 
Bool_t IsOpen () const
 
Bool_t IsClientMode () const
 
Int_t GetPort () const
 
Int_t SendBuffer (TBuffer *buf)
 
Int_t ReceiveBuffer ()
 
const TBuffer * GetBuffer () const
 

Static Public Attributes

static const Int_t fguOPENWAIT =200
 
static const Int_t fgiOPENCYCLES =6
 
static const Int_t fgiBUFLENGTH =256
 
static const Int_t fgiBUFINITSIZE =65536
 
static const Int_t fgiBUFEXTRASPACE =8
 
static const char * fgcGOON = "-I- go on"
 

Protected Member Functions

 TGo4Socket ()=delete
 
void ReallocBuffer (TBuffer *buffer, Int_t oldsize, Int_t newsize)
 

Private Attributes

Bool_t fbClientMode {kFALSE}
 
Bool_t fbOpen {kFALSE}
 
TSocket * fxSocket {nullptr}
 
TServerSocket * fxServerSocket {nullptr}
 
Int_t fiPort {0}
 
char * fxLocalBuffer {nullptr}
 
TBuffer * fxBuffer {nullptr}
 

Detailed Description

Definition at line 24 of file TGo4Socket.h.

Constructor & Destructor Documentation

◆ TGo4Socket() [1/2]

TGo4Socket::TGo4Socket ( Bool_t  IsClient)

Definition at line 38 of file TGo4Socket.cxx.

References TGo4Log::Debug(), TGo4SocketSignalHandler::DisableSigPipe(), fbClientMode, fgiBUFINITSIZE, fgiBUFLENGTH, fxBuffer, fxLocalBuffer, GO4TRACE, and TGo4SocketSignalHandler::SetSigWINCH().

◆ ~TGo4Socket()

TGo4Socket::~TGo4Socket ( )
virtual

Definition at line 64 of file TGo4Socket.cxx.

References fxBuffer, fxLocalBuffer, fxServerSocket, fxSocket, and GO4TRACE.

◆ TGo4Socket() [2/2]

TGo4Socket::TGo4Socket ( )
protecteddelete

Member Function Documentation

◆ Close()

Int_t TGo4Socket::Close ( Option_t *  opt = "")
virtual

Definition at line 210 of file TGo4Socket.cxx.

References fbOpen, fxSocket, and GO4TRACE.

Referenced by TGo4TaskHandler::CloseChannels(), TGo4TaskHandler::Connect(), TGo4TaskHandler::DisConnect(), TGo4ObjClient::DisconnectServer(), TGo4TaskHandler::ServerRequest(), TGo4ServerTask::StopConnectorThread(), TGo4HistogramServer::TimerConnect(), TGo4ServerTask::TimerConnect(), TGo4HistogramServer::~TGo4HistogramServer(), and TGo4TaskManager::~TGo4TaskManager().

◆ GetBuffer()

const TBuffer* TGo4Socket::GetBuffer ( ) const
inline

Access the internal receiving buffer of this socket.

Definition at line 59 of file TGo4Socket.h.

References fxBuffer.

Referenced by TGo4ObjClient::ReceiveBuffer(), TGo4StatusRunnable::Run(), TGo4DataRunnable::Run(), and TGo4CommandRunnable::Run().

◆ GetPort()

Int_t TGo4Socket::GetPort ( ) const
inline

Definition at line 41 of file TGo4Socket.h.

References fiPort, ReceiveBuffer(), and SendBuffer().

Referenced by TGo4TaskManager::GetNegotiationPort(), TGo4HistogramServer::GetObjPort(), and TGo4TaskHandler::WaitGetPort().

◆ IsClientMode()

Bool_t TGo4Socket::IsClientMode ( ) const
inline

Definition at line 39 of file TGo4Socket.h.

References fbClientMode.

◆ IsOpen()

Bool_t TGo4Socket::IsOpen ( ) const
inline

Definition at line 37 of file TGo4Socket.h.

References fbOpen.

Referenced by TGo4TaskHandlerRunnable::CheckTransportOpen(), TGo4TaskHandler::ConnectClientChannel(), TGo4TaskHandler::ConnectServerChannel(), ReceiveBuffer(), Recv(), RecvRaw(), Send(), SendBuffer(), TGo4HistogramServer::TimerConnect(), and TGo4ServerTask::TimerConnect().

◆ Open()

Int_t TGo4Socket::Open ( const char *  host,
Int_t  port,
Bool_t  keepservsock = kFALSE 
)
virtual

Definition at line 92 of file TGo4Socket.cxx.

References TGo4Log::Debug(), fbClientMode, fbOpen, fgcGOON, fgiOPENCYCLES, fguOPENWAIT, fiPort, fxServerSocket, fxSocket, and GO4TRACE.

Referenced by TGo4TaskHandler::ConnectClientChannel(), TGo4ObjClient::ConnectServer(), TGo4TaskHandler::ServerRequest(), TGo4ServerTask::StopConnectorThread(), TGo4TaskManager::TGo4TaskManager(), TGo4HistogramServer::TimerConnect(), and TGo4ServerTask::TimerConnect().

◆ ReallocBuffer()

void TGo4Socket::ReallocBuffer ( TBuffer *  buffer,
Int_t  oldsize,
Int_t  newsize 
)
protected

Reallocate the fixed input buffer if necessary

Definition at line 461 of file TGo4Socket.cxx.

References fgiBUFEXTRASPACE.

Referenced by ReceiveBuffer().

◆ ReceiveBuffer()

Int_t TGo4Socket::ReceiveBuffer ( )

Receive raw buffer and fill the internal TBuffer of this socket instance with it.

Definition at line 273 of file TGo4Socket.cxx.

References TGo4Log::Debug(), fgiBUFINITSIZE, fxBuffer, fxSocket, GO4TRACE, IsOpen(), and ReallocBuffer().

Referenced by GetPort(), TGo4ObjClient::ReceiveBuffer(), TGo4StatusRunnable::Run(), TGo4DataRunnable::Run(), and TGo4CommandRunnable::Run().

◆ Recv()

TObject * TGo4Socket::Recv ( const char *  name = nullptr)
virtual

Definition at line 431 of file TGo4Socket.cxx.

References TGo4Log::Debug(), fxSocket, GO4TRACE, and IsOpen().

◆ RecvRaw()

char * TGo4Socket::RecvRaw ( const char *  name = nullptr)
virtual

Definition at line 401 of file TGo4Socket.cxx.

References TGo4Log::Debug(), fgiBUFLENGTH, fxLocalBuffer, fxSocket, GO4TRACE, and IsOpen().

Referenced by TGo4HistogramServer::CheckLogin(), TGo4TaskManager::ClientLogin(), TGo4TaskHandler::Connect(), TGo4TaskHandler::ConnectClientChannel(), TGo4ObjClient::ConnectServer(), TGo4TaskHandler::ConnectServerChannel(), TGo4TaskManager::DisConnectClient(), TGo4HistogramServer::HandleObjectRequest(), TGo4ObjClient::ReceiveObject(), TGo4CommandRunnable::Run(), TGo4HistogramServer::SendObject(), TGo4TaskManager::ServeClient(), and TGo4TaskHandler::ServerLogin().

◆ Send() [1/2]

Int_t TGo4Socket::Send ( TObject *  obj)
virtual

Definition at line 332 of file TGo4Socket.cxx.

References TGo4Log::Debug(), fxSocket, GO4TRACE, and IsOpen().

Referenced by TGo4TaskManager::AddClient(), TGo4HistogramServer::CheckLogin(), TGo4TaskHandler::Connect(), TGo4TaskHandler::ConnectClientChannel(), TGo4ObjClient::ConnectServer(), TGo4TaskHandler::ConnectServerChannel(), TGo4TaskHandler::DisConnect(), TGo4ObjClient::ReceiveObject(), TGo4CommandRunnable::Run(), TGo4ObjClient::SendCommand(), TGo4HistogramServer::SendObject(), TGo4TaskManager::ServeClient(), TGo4TaskHandler::ServerLogin(), TGo4TaskHandler::ServerRequest(), and TGo4ServerTask::StopConnectorThread().

◆ Send() [2/2]

Int_t TGo4Socket::Send ( const char *  name)
virtual

Definition at line 366 of file TGo4Socket.cxx.

References TGo4Log::Debug(), fgiBUFLENGTH, fxLocalBuffer, fxSocket, GO4TRACE, and IsOpen().

◆ SendBuffer()

Int_t TGo4Socket::SendBuffer ( TBuffer *  buf)

Send raw buffer of external TBuffer object. Method will prepare raw buffer as a TMessage, i.e. the receiving side should be able to receive it by root TSocket message protocol.

Definition at line 220 of file TGo4Socket.cxx.

References TGo4Log::Debug(), fxSocket, GO4TRACE, and IsOpen().

Referenced by GetPort(), TGo4StatusRunnable::Run(), TGo4DataRunnable::Run(), TGo4CommandRunnable::Run(), and TGo4HistogramServer::SendObject().

Member Data Documentation

◆ fbClientMode

Bool_t TGo4Socket::fbClientMode {kFALSE}
private

True if instance runs in as client

Definition at line 88 of file TGo4Socket.h.

Referenced by IsClientMode(), Open(), and TGo4Socket().

◆ fbOpen

Bool_t TGo4Socket::fbOpen {kFALSE}
private

True if connection is open

Definition at line 91 of file TGo4Socket.h.

Referenced by Close(), IsOpen(), and Open().

◆ fgcGOON

const char * TGo4Socket::fgcGOON = "-I- go on"
static

First connection string, we are told to go on...

Definition at line 77 of file TGo4Socket.h.

Referenced by Open().

◆ fgiBUFEXTRASPACE

const Int_t TGo4Socket::fgiBUFEXTRASPACE =8
static

ROOT internal constant: extra space for reallocating object receive buffer (TBuffer)

Definition at line 74 of file TGo4Socket.h.

Referenced by ReallocBuffer().

◆ fgiBUFINITSIZE

const Int_t TGo4Socket::fgiBUFINITSIZE =65536
static

Initial size for object receive buffer (TBuffer)

Definition at line 71 of file TGo4Socket.h.

Referenced by TGo4BufferQueue::FreeBuffer(), TGo4BufferQueue::NewEntry(), ReceiveBuffer(), and TGo4Socket().

◆ fgiBUFLENGTH

const Int_t TGo4Socket::fgiBUFLENGTH =256
static

Raw transport buffer size

Definition at line 68 of file TGo4Socket.h.

Referenced by RecvRaw(), Send(), and TGo4Socket().

◆ fgiOPENCYCLES

const Int_t TGo4Socket::fgiOPENCYCLES =6
static

Number of retries for client open

Definition at line 65 of file TGo4Socket.h.

Referenced by Open().

◆ fguOPENWAIT

const Int_t TGo4Socket::fguOPENWAIT =200
static

Time to sleep between client open retries

Definition at line 62 of file TGo4Socket.h.

Referenced by Open().

◆ fiPort

Int_t TGo4Socket::fiPort {0}
private

Connected port number (of server socket which opened with portnumberscan)

Definition at line 100 of file TGo4Socket.h.

Referenced by GetPort(), and Open().

◆ fxBuffer

TBuffer* TGo4Socket::fxBuffer {nullptr}
private

1

Definition at line 106 of file TGo4Socket.h.

Referenced by GetBuffer(), ReceiveBuffer(), TGo4Socket(), and ~TGo4Socket().

◆ fxLocalBuffer

char* TGo4Socket::fxLocalBuffer {nullptr}
private

Definition at line 102 of file TGo4Socket.h.

Referenced by RecvRaw(), Send(), TGo4Socket(), and ~TGo4Socket().

◆ fxServerSocket

TServerSocket* TGo4Socket::fxServerSocket {nullptr}
private

Server Socket (server mode only)

Definition at line 97 of file TGo4Socket.h.

Referenced by Open(), and ~TGo4Socket().

◆ fxSocket

TSocket* TGo4Socket::fxSocket {nullptr}
private

root TSocket class doing the work

Definition at line 94 of file TGo4Socket.h.

Referenced by Close(), Open(), ReceiveBuffer(), Recv(), RecvRaw(), Send(), SendBuffer(), and ~TGo4Socket().

The documentation for this class was generated from the following files:
Generated on Wed Jan 10 2024 15:05:48 for GSI Object Oriented Online Offline (Go4) by   doxygen 1.8.13