Cpl::System::StartupHook_ Class Reference

This class defines a start-up handler/hook that allows a Colony.Core sub-system to register to be called when the Api::initialize() method is called. More...

Detailed Description

This class defines a start-up handler/hook that allows a Colony.Core sub-system to register to be called when the Api::initialize() method is called.

The intended usage of this interface is that a sub-system creates a sub-class of this class and then creates a static instance of its sub-class. During the init process, the instance's 'notifyInit' method will be called.

Note: This class/interface SHOULD ONLY be used by Colony.Core interfaces - the application should NEVER register a startup hook!

#include <PrivateStartup_.h>

Inheritance diagram for Cpl::System::StartupHook_:

Collaboration diagram for Cpl::System::StartupHook_:

Public Types
enum	InitLevel_T { eTEST_INFRA =0 , eSYSTEM , eMIDDLE_WARE , eAPPLICATION }
	This enum defines 'init_levels'. More...

Public Member Functions
virtual void	notify (InitLevel_T init_level)=0
	Initialized last.
virtual	~StartupHook_ ()
	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.

Static Public Member Functions
static void	registerHook (StartupHook_ &callbackInstance, InitLevel_T initOrder)
	This is used to register instance of this class.
static void	notifyStartupClients (void)
	This method is intended to be USED ONLY by the Cpl::System::Api::init() method to trigger all of the registered init callbacks.
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.

Protected Member Functions
	StartupHook_ (InitLevel_T myInitLevel)
	Base Class constructor -->performs the callback/init-level registration.
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.

Additional Inherited Members
Public Attributes inherited from Cpl::Container::Item
void *	m_nextPtr_
	The link field.
void *	m_inListPtr_
	Debug field.

Member Enumeration Documentation

InitLevel_T

enum Cpl::System::StartupHook_::InitLevel_T

This enum defines 'init_levels'.

The init levels are processed in order (lowest value to highest), i.e. callbacks for lowest numbered init level are called first and the callback for highest numbered init level are called last. Within a init level there is no guaranteed order to the callbacks.

Enumerator
eSYSTEM	Initialized first.

Constructor & Destructor Documentation

StartupHook_()

Cpl::System::StartupHook_::StartupHook_ ( InitLevel_T  myInitLevel )

protected

Base Class constructor -->performs the callback/init-level registration.

~StartupHook_()

virtual Cpl::System::StartupHook_::~StartupHook_ ( )

inlinevirtual

Ensure the destructor is virtual.

Member Function Documentation

notify()

virtual void Cpl::System::StartupHook_::notify ( InitLevel_T  init_level )

pure virtual

Initialized last.

This method is called as part of the Colony.Core initialize() process. The 'init_level' informs the client what initialize level context the notifyInit() method is being called.

notifyStartupClients()

static void Cpl::System::StartupHook_::notifyStartupClients ( void  )

static

This method is intended to be USED ONLY by the Cpl::System::Api::init() method to trigger all of the registered init callbacks.

registerHook()

static void Cpl::System::StartupHook_::registerHook ( StartupHook_ &  callbackInstance, InitLevel_T  initOrder  )

static

This is used to register instance of this class.

This method is NOT implemented by the 'client sub-system' - it is a singleton that is implemented Cpl::System::Startup classes.

NOTE: This is the ONE Colony.Core method that can be called BEFORE Cpl::System::Api::initialize() is called.

---

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

• Cpl/System/PrivateStartup_.h