#include <CmdApp.h>

Inheritance diagram for CmdApp:

Collaboration diagram for CmdApp:

Public Member Functions
string	appName (void) const
	Returns the name of the application.
CmdClient *	client ()
	CmdApp ()
virtual void	dump (ostream &strm) const
	dumps information about this object
virtual void	dump (ostream &strm) const
virtual int	initialize (int argC, char **argV)
	initialize the BES application
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
virtual int	terminate (int sig=0)
	clean up after the application
virtual	~CmdApp ()
Static Public Member Functions
static void	signalBrokenPipe (int sig)
static void	signalCannotConnect (int sig)
static void	signalInterrupt (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 42 of file CmdApp.h.

Constructor & Destructor Documentation

CmdApp::CmdApp ( )

Definition at line 61 of file CmdApp.cc.

CmdApp::~CmdApp ( ) [virtual]

Definition at line 75 of file CmdApp.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(), ServerApp::initialize(), signalBrokenPipe(), signalCannotConnect(), signalInterrupt(), and signalTerminate().

CmdClient* CmdApp::client ( ) [inline]

Definition at line 67 of file CmdApp.h.

Referenced by signalBrokenPipe(), and signalCannotConnect().

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

void BESBaseApp::dump ( ostream & strm ) const [virtual, inherited]

dumps information about this object

Displays the pointer value of this instance along with the name of the application, whether the application is initialized or not

Parameters:

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

Implements BESApp.

Reimplemented in BESModuleApp.

Definition at line 169 of file BESBaseApp.cc.

References BESApp::_isInitialized, BESApp::appName(), BESIndent::Indent(), BESIndent::LMarg(), and BESIndent::UnIndent().

Here is the call graph for this function:

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

initialize the BES application

uses the BESGlobalIQ static method BESGlobalInit to initialize any global variables needed by this application

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

Exceptions:

BESError if any exceptions or errors are encountered

See also:: BESGlobalIQ

Reimplemented from BESBaseApp.

Definition at line 231 of file CmdApp.cc.

References BES_CMDLN_DEFAULT_TIMEOUT, BESDEBUG, and BESDebug::SetUp().

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.