ServerApp Class Reference

#include <ServerApp.h>

Inheritance diagram for ServerApp:

Collaboration diagram for ServerApp:

Public Member Functions
string	appName (void) const
	Returns the name of the application.
virtual void	dump (ostream &strm) const
	dumps information about this object
virtual int	initialize (int argC, char **argV)
	Load and initialize any BES modules.
virtual int	main (int argC, char **argV)
	main method of the BES application
virtual int	run ()
	the applications functionality is implemented in the run method
	ServerApp ()
virtual int	terminate (int sig=0)
	clean up after the application
virtual	~ServerApp ()
Static Public Member Functions
static void	signalInterrupt (int sig)
static void	signalRestart (int sig)
static void	signalTerminate (int sig)
static BESApp *	TheApplication (void)
	Returns the BESApp application object for this application.
Protected Attributes
string	_appName
bool	_debug
bool	_isInitialized
Static Protected Attributes
static BESApp *	_theApplication = 0

Detailed Description

Definition at line 43 of file ServerApp.h.

Constructor & Destructor Documentation

ServerApp::ServerApp ( )

Definition at line 69 of file ServerApp.cc.

ServerApp::~ServerApp ( ) [virtual]

Definition at line 83 of file ServerApp.cc.

Member Function Documentation

string BESApp::appName ( void ) const [inline, inherited]

Returns the name of the application.

The name of the application is typically argv[0] passed into the main function. But could be passed into the application or derived in a different way.

Returns:: name of the application

Definition at line 132 of file BESApp.h.

References BESApp::_appName.

Referenced by BESBaseApp::dump(), initialize(), CmdApp::signalBrokenPipe(), CmdApp::signalCannotConnect(), CmdApp::signalInterrupt(), and CmdApp::signalTerminate().

void ServerApp::dump ( ostream & strm ) const [virtual]

dumps information about this object

Displays the pointer value of this instance

Parameters:

strm

C++ i/o stream to dump the information to

Reimplemented from BESModuleApp.

Definition at line 629 of file ServerApp.cc.

References PPTServer::dump(), UnixSocket::dump(), TcpSocket::dump(), BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().

Here is the call graph for this function:

int ServerApp::initialize	(	int	argC,
		char **	argV
	)			`[virtual]`

Load and initialize any BES modules.

Returns:: 0 if successful and not 0 otherwise

Parameters:

	argC	argc value passed to the main function
	argV	argv value passed to the main function

Reimplemented from BESModuleApp.

Definition at line 285 of file ServerApp.cc.

References BESApp::appName(), BESDEBUG, TheBESKeys::ConfigFile, BESError::get_message(), BESKeys::get_value(), BESDebug::Register(), SERVER_EXIT_FATAL_CAN_NOT_START, BESDebug::SetUp(), BESServerUtils::show_usage(), BESServerUtils::show_version(), signalInterrupt(), signalRestart(), signalTerminate(), BESApp::TheApplication(), TheBESKeys::TheKeys(), and BESLog::TheLog().

Here is the call graph for this function:

int BESBaseApp::main	(	int	argC,
		char **	argV
	)			`[virtual, inherited]`

main method of the BES application

sets the appName to argv[0], then calls initialize, run, and terminate in that order. Exceptions should be caught in the individual methods initialize, run and terminate and handled there.