Cpl::System::Shutdown Class Reference

This class defines methods for forcibly terminating the application. More...

Detailed Description

This class defines methods for forcibly terminating the application.

How gracefully (or not) the shutdown is dependent on the actual platform implementation. In addition, what 'shutdown' means is also platform dependent, e.g. on an embedded platform it may invoke a reboot and/or restart of the application.

Since this is a forcibly shutdown there are no guaranties with respect to releasing resources.

The interface does provide for callback method(s) to be called on shutdown. These methods are guaranteed to be called (or at least attempted to be called in the case of true code failure).

#include <Shutdown.h>

Classes
class	Handler
	This call defines the callback interface that is used when the application is shutdown. More...

Static Public Member Functions
static int	success (void)
	This function will force a shutdown of the application with a 'success' exit code.
static int	failure (int exit_code=OPTION_CPL_SYSTEM_SHUTDOWN_FAILURE_ERROR_CODE)
	This function will force a shutdown of the application with a 'failure' exit code.
static void	registerHandler (Shutdown::Handler &instanceToRegister)
	This method is used to register a callback method that will be called when success() or failure() is called and before the application exits.
static int	notifyShutdownHandlers_ (int exit_code)
	This COMPONENT Scoped method.

Member Function Documentation

failure()

static int Cpl::System::Shutdown::failure ( int  exit_code = OPTION_CPL_SYSTEM_SHUTDOWN_FAILURE_ERROR_CODE )

static

This function will force a shutdown of the application with a 'failure' exit code.

The caller can optional specify an exit code. What 'forced' means is dependent on the actual platform. All registered callback methods will be called before exiting the application. The returned value - assuming the method actually returns - will be the 'final' exit code (the passed in exit_code can be alter by registered Shutdown Handlers).

Note: The recommended approach for exiting the application due to an error is to use the Cpl::System::FatalError interface so that the 'why' of the failure has the potential for being captured.

notifyShutdownHandlers_()

static int Cpl::System::Shutdown::notifyShutdownHandlers_ ( int  exit_code )

static

This COMPONENT Scoped method.

The application SHOULD not directly access this method (unless you are REALLY REALLY REALLY sure you know what you are doing).

Helper method used to notify registered shutdown handlers

registerHandler()

static void Cpl::System::Shutdown::registerHandler ( Shutdown::Handler &  instanceToRegister )

static

This method is used to register a callback method that will be called when success() or failure() is called and before the application exits.

There is NO guaranteed order on when the register callback methods (when there is multiple register callbacks) will be called OR with respect to application code running. The only guarantee is that the callbacks will be called AFTER the above methods are called and BEFORE the application shutdown.

During shutdown, the 'notify()' method of 'instanceToRegister' is called.

success()

static int Cpl::System::Shutdown::success ( void  )

static

This function will force a shutdown of the application with a 'success' exit code.

What 'forced' means is dependent on the actual platform. All registered callback methods will be called before exiting the application.

---

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

• Cpl/System/Shutdown.h