Cpl::System::Shutdown::Handler Class Reference

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

Detailed Description

This call defines the callback interface that is used when the application is shutdown.

#include <Shutdown.h>

Inheritance diagram for Cpl::System::Shutdown::Handler:

Collaboration diagram for Cpl::System::Shutdown::Handler:

Public Member Functions
virtual int	notify (int exit_code)=0
	This method is called when the application is shutting down.
virtual	~Handler ()
	Ensure the destructor is virtual.
Public Member Functions inherited from Cpl::Container::Item
bool	insert_ (void *newContainerPtr)
	Helper method to trap when inserting an item in multiple containers.
bool	isInContainer_ (const void *containerPtr) const noexcept
	Returns 'true' if the instance is in the specified container.

Additional Inherited Members
Static Public Member Functions inherited from Cpl::Container::Item
static void	remove_ (Item *itemPtr) noexcept
	Helper method to do the proper 'clean-up' for the multiple-containers-error-trap when removing an item from a container.
Public Attributes inherited from Cpl::Container::Item
void *	m_nextPtr_
	The link field.
void *	m_inListPtr_
	Debug field.
Protected Member Functions inherited from Cpl::Container::Item
	Item ()
	Constructor.
	Item (const char *)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Constructor & Destructor Documentation

~Handler()

virtual Cpl::System::Shutdown::Handler::~Handler ( )

inlinevirtual

Ensure the destructor is virtual.

Member Function Documentation

notify()

virtual int Cpl::System::Shutdown::Handler::notify ( int exit_code )

pure virtual

This method is called when the application is shutting down.

The method is passed 'exit_code' which is the exit code provided by the application when called the Shutdown interface. The return value from the handler will be used as the application shutdown exit code. To leave the exit code unaltered - return the passed in 'exit_code'.

Notes:

o The final exit code is the serialized 'sum' of the all of the
  shutdown handlers.
o The notify() method is called in the thread context that
  initiated the shutdown.

---

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

• Cpl/System/Shutdown.h