ConsumerExport Class Reference

#include <ConsumerExport.h>

List of all members.

Public Member Functions
	ConsumerExport (const int firstPort, const bool restartEnable=false, const int reportToStateManager=2)
	~ConsumerExport ()
int	send (TConsumerInfo *consinfo, Bool_t modFlag=kFALSE)
int	send (const char *messString)
pid_t	getServerPid ()
Static Public Member Functions
int	getMaxString ()
void	setMaxString (int newLength)
Private Member Functions
	ConsumerExport (const ConsumerExport &ce)
ConsumerExport &	operator= (const ConsumerExport &ce)
int	send (TList *list)
int	send (const TObject *object)
void	errorReact (const Int_t sendRes)
void	createCanvasString (TList *canvasList)
int	lengthNeeded (TList *canvasList)
int	startServer ()
int	connectServer ()
int	reestablishServer ()
Private Attributes
bool	_debug
bool	_restartEnable
bool	_sendingEnable
int	_reportToStateManager
int	_port
pid_t	_serverPid
time_t	_serverStartTime
char *	_canvasString
TMonitor *	_consMonitor
TServerSocket *	_consSS
TSocket *	_consSock
Static Private Attributes
int	_maxStringLength = 1000

---

Constructor & Destructor Documentation

ConsumerExport::ConsumerExport (  const int  firstPort, const bool  restartEnable = false, const int  reportToStateManager = 2 )

Definition at line 109 of file ConsumerExport.cc. References _consSS, _debug, _port, _sendingEnable, connectServer(), pipeBroken(), sigChildHandler(), and startServer(). : _debug(false), _restartEnable(restartEnable), _sendingEnable(true), _reportToStateManager(reportToStateManager), _port(firstPort), _serverPid(1), _canvasString(0), _consMonitor(new TMonitor), _consSS(0), _consSock(0) { const int maxPort=9999; const string myName = string("ConsumerExport::Constructor"); #ifdef CONSUMEREXPORT_DEBUG _debug = true; #endif if ((int)signal(SIGCHLD, sigChildHandler) == -1) cerr << myName << ": ERROR setting signal handler for SIGCHLD." << endl; if ((int)signal(SIGPIPE,pipeBroken) == -1) cerr << myName << ": ERROR setting signal handler for SIGPIPE." << endl; _consSS = new TServerSocket(_port,kTRUE); // Open server socket, Testing different ports while( (!_consSS->IsValid()) && (_port < maxPort) ) { delete _consSS; _port++; _consSS = new TServerSocket(_port,kTRUE); } if(_port == maxPort) { cerr << myName << ": Maximum port number reached. No free port " << "was found." << " ==>> RETURN NOW ! " << endl; _sendingEnable = false; } if (_consSS) { if (!_consSS->IsValid()) { cerr << myName << ": Server socket is not valid." << endl; _sendingEnable = false; delete _consSS; _consSS = 0; } else { if ( (startServer() > 0) && (!serverStartFailed) ) connectServer(); else { cerr << myName << ": ERROR: Failed to start the server program." << endl; cerr << myName << ": The Consumer will continue without sending " << "monitoring information to the server." << endl; _sendingEnable = false; delete _consSS; _consSS = 0; } } } else { _sendingEnable = false; } if (_debug) cout << myName << ": End of Constructor." << endl; }

ConsumerExport::~ConsumerExport (   )

Definition at line 172 of file ConsumerExport.cc. References _consSock, and DspEndConnection. { if (_consSock) { _consSock->Send(DspEndConnection.c_str()); _consSock->Close(); } delete [] _canvasString; }

ConsumerExport::ConsumerExport (  const ConsumerExport &  ce  )  [private]

---

Member Function Documentation

int ConsumerExport::connectServer (   )  [private]

Definition at line 569 of file ConsumerExport.cc. References _consMonitor, _consSock, _consSS, and brokenPipe. Referenced by ConsumerExport(), and reestablishServer(). { const string myName = string("ConsumerExport::connectServer()"); int res = 1; if (_debug) cout << myName << ": Waiting for display server to connect." << endl; if (_consSS) { _consSock = _consSS->Accept(); if (_debug) cout << myName << ": Accept returned." << endl; if (_consSock && _consSock->IsValid()) { if (_debug) { cout << myName << ": Connection to display server okay." << endl; } _consSock->SetOption(kNoDelay,1); _consMonitor->Add(_consSock); res = 0; brokenPipe = false; } else { cerr << myName << ": ERROR: the socket connection between display " << "server and \nconsumer failed." << endl; res = -1; } } else { res = -2; cerr << myName << ": ERROR: consumer server socket not valid." << endl; cerr << myName << ": Further reconnect trials don't make sense." << endl; } return res; }

void ConsumerExport::createCanvasString (  TList *  canvasList  )  [private]

Definition at line 447 of file ConsumerExport.cc. References _canvasString. Referenced by send(). { delete [] _canvasString; _canvasString = new char[_maxStringLength]; strcpy(_canvasString, "Modified"); TListIter iter(canList); while (TObject *obj = iter()) { strcat(_canvasString, "$"); strcat(_canvasString, obj->GetName()); } }

void ConsumerExport::errorReact (  const Int_t  sendRes  )  [private]

Definition at line 432 of file ConsumerExport.cc. References _consSock. Referenced by send(). { // This method implements the error reaction if the sending of a message // fails. cerr << "ConsumerExport: ERROR: Socket-Send returned with " << sendRes << ".\n" << " ==> Socket connection to the Display Server is \n" << " going to be closed IMMEDIATELY." << endl; _consSock->Close(); _consSock = 0; }

int ConsumerExport::getMaxString (   )  [inline, static]

Definition at line 51 of file ConsumerExport.h. {return _maxStringLength;}

pid_t ConsumerExport::getServerPid (   )

Definition at line 302 of file ConsumerExport.cc. { return _serverPid; }

int ConsumerExport::lengthNeeded (  TList *  canvasList  )  [private]

Definition at line 461 of file ConsumerExport.cc. Referenced by send(). { int length=0; TListIter iter(canList); while (TObject *obj = iter()) { length += strlen(obj->GetName()); length++; // Take also the $ signs into account } length += strlen("Unmodified"); length += 10; // Add some extra margin return length; }

ConsumerExport& ConsumerExport::operator= (  const ConsumerExport &  ce  )  [private]

int ConsumerExport::reestablishServer (   )  [private]

Definition at line 605 of file ConsumerExport.cc. References _serverPid, _serverStartTime, connectServer(), and startServer(). Referenced by send(). { const string myName = string("ConsumerExport::reestablishServer()"); const int minReconnectTime = 30; int rtValue = 1; bool locDebug = false; #ifdef CONSUMEREXPORT_DEBUG locDebug = true; #endif // Try to restart and reconnect to the display server, // but only if at least a minimum difference passed since the last // restart. time_t nowTime; time(&nowTime); if ( (difftime(nowTime, _serverStartTime) > minReconnectTime) && _restartEnable) { // Check whether the previous server existed. pid_t waitRes; int status; waitRes = waitpid(_serverPid, &status, WNOHANG); if (locDebug) cout << myName << ": waitRes = " << waitRes << endl; if ( ((!WIFEXITED(status)) && (!WIFSIGNALED(status))) #ifdef WIFSTOPPED || WIFSTOPPED(status) #endif #ifdef WIFCONTINUED || WIFCONTINUED(status) #endif ) { // The server did not terminat neither normally nor abnormally. // In this case we try to kill the process to make sure // it terminated before starting a new process. cerr << myName << ": Server was still alive. Need to kill it." << endl; kill(_serverPid, SIGKILL); } sleep(2); // Check /proc char procFileName[200]; sprintf(procFileName, "/proc/%d/stat", ((int)_serverPid)); FILE* fp; if ((fp = fopen(procFileName, "r"))) { cerr << myName << ": Server was still alive (/proc entry). " << "Need to kill it." << endl; kill(_serverPid, SIGKILL); fclose(fp); } cout << myName << ": Going to restart the server." << endl; _serverStartTime = time(&nowTime); if (startServer() != -1) rtValue = connectServer(); sleep(1); } else { rtValue = -2; } return rtValue; }

int ConsumerExport::send (  const TObject *  object  )  [private]

Definition at line 385 of file ConsumerExport.cc. References _consSock, DspConsumerFinish, DspConsumerSend, and errorReact(). { // This method sends a single objects via the socket to the display server. // The protocol with a leading "CONSUMER SEND" and a trailing // "CONSUMER FINISHED" is implemented. // // Return value: 1 if no error occured // 0 if the send failed // -1 if the socket is no longer valid int rtvalue=0; Int_t sendRes=0; if (_sendingEnable) { if (_consSock && _consSock->IsValid()) { TMessage mess(kMESS_OBJECT); mess.Reset(); sendRes=_consSock->Send(DspConsumerSend.c_str()); if (sendRes == -1) errorReact(sendRes); //----------------------------------------------------- if (_consSock->IsValid()) { mess.Reset(); mess.WriteObject(object); sendRes=_consSock->Send(mess); if (sendRes == -1) errorReact(sendRes); else { rtvalue=1; } } //----------------------------------------------------- mess.Reset(); sendRes=_consSock->Send(DspConsumerFinish.c_str()); if (sendRes == -1) errorReact(sendRes); } else { cout << "ConsumerExport: ERROR: Socket to display server is no " << "longer valid." << endl; rtvalue = -1; } } else { // Sending is disabled. rtvalue = -2; } return rtvalue; }

int ConsumerExport::send (  TList *  list  )  [private]

Definition at line 308 of file ConsumerExport.cc. References _consSock, and errorReact(). { // This method sends out a whole list of objects via the socket // to the display server. // // Return value: number of objects in the list which were sent // If the socket is no longer valid: -1 // // If the number of consequtively failed messages exceeds a limit // (_failedLimit) the socket is closed. As a consequence IsValid // returns false and the send-method returns -1. // int rtvalue=0; Int_t sendRes=0; if (_sendingEnable) { if (_consSock && _consSock->IsValid() && !brokenPipe) { TMessage mess(kMESS_OBJECT); //----------------------------------------------------- TListIter iter(objlist); while (TObject *obj = iter()) { if (_consSock && _consSock->IsValid() && !brokenPipe) { mess.Reset(); mess.WriteObject(obj); sendRes=_consSock->Send(mess); if (sendRes == -1) errorReact(sendRes); else { rtvalue++; } } } } else { cerr << "ConsumerExport: ERROR: Socket to display server is no " << "longer valid." << endl; rtvalue = -1; } } else { // Sending is disabled. rtvalue = -2; } return rtvalue; }

int ConsumerExport::send (  const char *  messString  )

Definition at line 353 of file ConsumerExport.cc. References _consSock, and errorReact(). { // This method simply sends out a string to the consumer. // // Return value: 1 if no error occured // 0 if the send of the string failed // -1 if the socket is no longer valid // int rtvalue=0; Int_t sendRes=0; if (_sendingEnable) { if( _consSock && _consSock->IsValid()) { sendRes=_consSock->Send(messString); if (sendRes == -1) errorReact(sendRes); else { rtvalue++; } } else { cout << "ConsumerExport: ERROR: Socket to display server is no " << "longer valid." << endl; rtvalue = -1; } } else { // Sending is disabled. rtvalue = -2; } return rtvalue; }

int ConsumerExport::send (  TConsumerInfo *  consinfo, Bool_t  modFlag = kFALSE )

Definition at line 187 of file ConsumerExport.cc. References _consSock, _consSS, _maxStringLength, _sendingEnable, createCanvasString(), DspConsumerFinish, DspConsumerSend, errorReact(), TConsumerInfo::isModified(), lengthNeeded(), TConsumerInfo::list(), reestablishServer(), and TConsumerInfo::setModified(). Referenced by main(), and CDFMonitoringModuleImp::Update(). { // This method sends out the consumer info and the whole list of objects // stored in consumer info via the socket to the display server. // The protocol with a leading "CONSUMER SEND" // and a trailing "CONSUMER FINISHED" is implemented. // // Return value: number of messages which were successfully sent // If the socket is no longer valid: -1 // // If the number of consequetively failed messages exceeds a limit // (_failedLimit) the socket is closed. As a consequence IsValid // returns false and the send-method returns -1. // const string myName = string("ConsumerExport::send()"); static Bool_t firstCall=kTRUE; int rtvalue=0; Int_t sendRes=0; // cout << myName << ": begin of function." << endl; if (_sendingEnable && !brokenPipe) { if (_consSock && _consSock->IsValid() && !brokenPipe) { TMessage mess(kMESS_OBJECT); mess.Reset(); //----------------------------------------------------- // 1.) Send start key word "CONSUMER SEND" sendRes=_consSock->Send(DspConsumerSend.c_str()); if (sendRes == -1) { errorReact(sendRes); return -4; } //----------------------------------------------------- // 2.) send the consumer info if (_consSock && _consSock->IsValid() && !brokenPipe) { if (consinfo) { mess.Reset(); mess.WriteObject(consinfo); sendRes = _consSock->Send(mess); if (sendRes == -1) { errorReact(sendRes); return -5; } else { rtvalue++; } } else { cerr << myName << ": Pointer to TConsumerInfo is NULL." << endl; return -3; } } //----------------------------------------------------- // 3.) send all objects in the TConsumerInfo list of objects if ((consinfo->list())->GetSize() > 0) { const char* ctrlString; if (firstCall || modFlag || consinfo->isModified()) { // Create a list of all objects to be sent. // Find out whether the default string length for the canvases // is large enough. int actualLength=lengthNeeded(consinfo->list()); if (_maxStringLength < actualLength) { _maxStringLength = actualLength; } createCanvasString(consinfo->list()); firstCall = kFALSE; ctrlString = _canvasString; consinfo->setModified(false); } else { ctrlString = "Unmodified"; } if (_consSock && _consSock->IsValid() && !brokenPipe) { mess.Reset(); // 4.) Send the string with the objects' name sendRes=_consSock->Send(ctrlString); if (sendRes == -1) errorReact(sendRes); else { rtvalue++; } } send(consinfo->list()); } //----------------------------------------------------- // 5.) Send the finish string mess.Reset(); if (_consSock->IsValid()) { sendRes=_consSock->Send(DspConsumerFinish.c_str()); if (sendRes == -1) errorReact(sendRes); } } else { cerr << myName << ": ERROR: Socket to display server is no " << "longer valid." << endl; if (_consSS && _restartEnable) { // It makes only sense to try to reconnect if the consumer server // socket is still there. reestablishServer(); firstCall = kTRUE; } else { // Disable the sending. _sendingEnable = false; } rtvalue = -1; } } else { // Sending is disabled. rtvalue = -2; } return rtvalue; }

void ConsumerExport::setMaxString (  int  newLength  )  [inline, static]

Definition at line 52 of file ConsumerExport.h. {_maxStringLength = newLength;}

int ConsumerExport::startServer (   )  [private]

Definition at line 479 of file ConsumerExport.cc. References _port, _reportToStateManager, _serverPid, _serverStartTime, serverPid, and serverStartFailCode. Referenced by ConsumerExport(), and reestablishServer(). { // Starts the display server using fork and exclp. const string myName = string("ConsumerExport::startServer()"); int rtValue = 0; char portChar[128]; char reportToSmChar[128]; char fullPath[128]; char fullPath2[128]; sprintf(fullPath, "Server"); sprintf(portChar, "%d", _port); sprintf(reportToSmChar, "%d", _reportToStateManager); if ( (_serverPid = fork()) < 0) { cerr << myName << ": ERROR: fork failed." << endl; rtValue = _serverPid; } else { // Fork successful. rtValue = _serverPid; if (_serverPid == 0) { // Child process int execRes = 0; if (_debug) cout << myName << ": fullPath = " << fullPath << endl; if ( (execRes = execlp(fullPath, "Server", portChar, reportToSmChar, (char *) 0)) < 0) { if (getenv("CONSUMERBINDIR")) { if (_debug) cout << "consumerbindir:" << getenv("CONSUMERBINDIR") << endl; sprintf(fullPath, "%s/Server", getenv("CONSUMERBINDIR")); if ( (execRes = execlp(fullPath, "Server", portChar, reportToSmChar, (char *) 0)) < 0) { if (getenv("CDFSOFT2_DIR")) { // cout << "CDFSOFT2_DIR = " << getenv("CDFSOFT2_DIR") << endl; sprintf(fullPath2, "%s/bin/%s/Server", getenv("CDFSOFT2_DIR"), getenv("BFARCH")); if ( (execRes = execlp(fullPath2, "Server", portChar, reportToSmChar, (char *) 0)) < 0) { cerr << myName << ": ERROR: execlp failed. rt = " << execRes << endl; cerr << myName << ": ERROR: Could not find the Server " << "Executable.\n Three different possibilities were " << "checked, all of them failed." << endl; cerr << myName << "1.) Default PATH. " << endl; cerr << myName << "2.) using $CONSUMERBINDIR: " << fullPath << "." << endl; cerr << myName << "3.) using the release directory " << "$CDFSOFT2_DIR: " << fullPath2 << endl; } } } } else { if (getenv("CDFSOFT2_DIR")) { // cout << "CDFSOFT2_DIR = " << getenv("CDFSOFT2_DIR") << endl; sprintf(fullPath2, "%s/bin/%s/Server", getenv("CDFSOFT2_DIR"), getenv("BFARCH")); if ( (execRes = execlp(fullPath2, "Server", portChar, (char *) 0)) < 0) { cerr << myName << ": ERROR: execlp failed. rt = " << execRes << endl; cerr << myName << ": ERROR: Could not find the Server " << "Executable. Three different possibilities\n were " << "checked. All of them FAILED !!!" << endl; cerr << myName << ": 1.) Server not in PATH." << endl; cerr << myName << ": 2.) $CONSUMERBINDIR is not set." << endl; cerr << myName << ": 3.) Using the release directory " << "$CDFSOFT2_DIR: " << fullPath2 << endl; cerr << myName << ": Therefore, the child process EXISTS NOW!" << endl; // Since the Server program could not be found anywhere, // the child has to exit. exit(serverStartFailCode); } } } } } else { // Mother process serverPid = _serverPid; sleep(1); if (serverStartFailed) rtValue = -10; } } time_t locTime; _serverStartTime = time(&locTime); return rtValue; }

---

Member Data Documentation

char* ConsumerExport::_canvasString [private]

Definition at line 63 of file ConsumerExport.h. Referenced by createCanvasString().

TMonitor* ConsumerExport::_consMonitor [private]

Definition at line 64 of file ConsumerExport.h. Referenced by connectServer().

TSocket* ConsumerExport::_consSock [private]

Definition at line 66 of file ConsumerExport.h. Referenced by connectServer(), errorReact(), send(), and ~ConsumerExport().

TServerSocket* ConsumerExport::_consSS [private]

Definition at line 65 of file ConsumerExport.h. Referenced by connectServer(), ConsumerExport(), and send().

bool ConsumerExport::_debug [private]

Definition at line 55 of file ConsumerExport.h. Referenced by ConsumerExport().

int ConsumerExport::_maxStringLength = 1000 [static, private]

Definition at line 184 of file ConsumerExport.cc. Referenced by send().

int ConsumerExport::_port [private]

Definition at line 59 of file ConsumerExport.h. Referenced by ConsumerExport(), and startServer().

int ConsumerExport::_reportToStateManager [private]

Definition at line 58 of file ConsumerExport.h. Referenced by startServer().

bool ConsumerExport::_restartEnable [private]

Definition at line 56 of file ConsumerExport.h.

bool ConsumerExport::_sendingEnable [private]

Definition at line 57 of file ConsumerExport.h. Referenced by ConsumerExport(), and send().

pid_t ConsumerExport::_serverPid [private]

Definition at line 60 of file ConsumerExport.h. Referenced by reestablishServer(), and startServer().

time_t ConsumerExport::_serverStartTime [private]

Definition at line 61 of file ConsumerExport.h. Referenced by reestablishServer(), and startServer().

---

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

• ConsumerExport.h
• ConsumerExport.cc

---