CmdApp Class Reference

Inheritance diagram for CmdApp:

Collaboration diagram for CmdApp:

Public Member Functions
std::string	appName () const
	Returns the name of the application.
CmdClient *	client ()
virtual void	dump (std::ostream &strm) const
	dumps information about this object
virtual int	initialize (int argC, char **argV)
	Initialize the application using the passed argc and argv values.
virtual int	main (int argC, char **argV)
	main routine, the main entry point for any BES applications.
virtual int	run ()
	The body of the application, implementing the primary functionality of the BES application.
virtual int	terminate (int sig=0)
	Clean up after the application.

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 ()
	Returns the BESApp application object for this application.

Protected Attributes
std::string	_appName
bool	_debug {false}
bool	_isInitialized {false}

Static Protected Attributes
static BESApp *	_theApplication = nullptr

Detailed Description

Definition at line 39 of file CmdApp.h.

Constructor & Destructor Documentation

CmdApp()

CmdApp::CmdApp

(

)

Definition at line 67 of file CmdApp.cc.

~CmdApp()

CmdApp::~CmdApp ( )

virtual

Definition at line 73 of file CmdApp.cc.

Member Function Documentation

appName()

std::string BESApp::appName ( ) const

inlineinherited

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 130 of file BESApp.h.

client()

CmdClient * CmdApp::client ( )

inline

Definition at line 64 of file CmdApp.h.

dump()

void CmdApp::dump ( std::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

Implements BESApp.

Definition at line 417 of file CmdApp.cc.

initialize()

int CmdApp::initialize ( int argC, char ** argV )

virtual

Initialize the application using the passed argc and argv values.

initialize the BES application

It is up to the derived classes of BESApp to implement the initialize method.

Parameters

argC	number of arguments passed to the application, which is argc passed to the main function.
argV	arguments passed to the application, which is argv passed to the main function.

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

Reimplemented from BESApp.

Definition at line 199 of file CmdApp.cc.

main()

int BESApp::main ( int argC, char ** argV )

virtualinherited

main routine, the main entry point for any BES applications.

main method of the BES application

It is up to the derived classes of BESApp to implement the main routine. However, the main method should call initialize, run and terminate in that order and should pass to the initialize routine the arguments argc and argv passed to the main function.

Parameters

argC	number of arguments passed to the application, which is argc passed to the main function.
argV	arguments passed to the application, which is argv passed to the main function.

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.

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

Definition at line 52 of file BESApp.cc.

run()

int CmdApp::run ( )

virtual

The body of the application, implementing the primary functionality of the BES application.

the applications functionality is implemented in the run method

It is up to the derived classes of BESApp to implement the run method.

It is up to the derived class to implement this method.

Returns

0 if successful and not 0 otherwise

Exceptions

BESError

if the derived class does not implement this method

Reimplemented from BESApp.

Definition at line 330 of file CmdApp.cc.

signalBrokenPipe()

void CmdApp::signalBrokenPipe ( int sig )

static

Definition at line 139 of file CmdApp.cc.

signalCannotConnect()

void CmdApp::signalCannotConnect ( int sig )

static

Definition at line 104 of file CmdApp.cc.

signalInterrupt()

void CmdApp::signalInterrupt ( int sig )

static

Definition at line 119 of file CmdApp.cc.

signalTerminate()

void CmdApp::signalTerminate ( int sig )

static

Definition at line 129 of file CmdApp.cc.

terminate()

int BESApp::terminate ( int sig = 0 )

virtualinherited

Clean up after the application.

clean up after the application

It is up to the derived classes of BESApp to implement the terminate method. Memory cleanup, file descriptor cleanup, etc... might go in this method.

Parameters

sig	if the application is terminating due to a signal, pass the signal to terminate routine.

Cleans up any global variables registered with BESGlobalIQ

Returns

0 if successful and not 0 otherwise

Parameters

sig	if the application is terminating due to a signal, otherwise 0 is passed.

See also

BESGlobalIQ

Reimplemented in BESModuleApp, ServerApp, and StandAloneApp.

Definition at line 100 of file BESApp.cc.

TheApplication()

static BESApp * BESApp::TheApplication ( )

inlinestaticinherited

Returns the BESApp application object for this application.

Returns

The application object

Definition at line 139 of file BESApp.h.

Member Data Documentation

_appName

std::string BESApp::_appName

protectedinherited

Definition at line 58 of file BESApp.h.

_debug

bool BESApp::_debug {false}

protectedinherited

Definition at line 59 of file BESApp.h.

_isInitialized

bool BESApp::_isInitialized {false}

protectedinherited

Definition at line 60 of file BESApp.h.

_theApplication

BESApp * BESApp::_theApplication = nullptr

staticprotectedinherited

Definition at line 61 of file BESApp.h.

---

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

• CmdApp.h
• CmdApp.cc