CTBCAFServiceCmMgmtClient - Revision history

Allyntree at 13:54, 8 September 2022

2022-09-08T13:54:25Z

← Older revision		Revision as of 09:54, 8 September 2022
Line 1:		Line 1:
			{{DISPLAYTITLE:CTBCAFServiceCmMgmtClient}}
	The class ''CTBCAFServiceCmMgmtClient'' is used by applications that want to be informed of the current active configuration, and active database connection string.		The class ''CTBCAFServiceCmMgmtClient'' is used by applications that want to be informed of the current active configuration, and active database connection string.

Abrassard at 17:33, 30 May 2011

2011-05-30T17:33:52Z

← Older revision		Revision as of 13:33, 30 May 2011
Line 6:		Line 6:
	* ''OnDbMaintenance'': This function is called to indicate to the application that the database is in maintenance mode (or unavailable) and should not be accessed. A call to ''OnReloadConfig'' will indicate when the database is ready again.		* ''OnDbMaintenance'': This function is called to indicate to the application that the database is in maintenance mode (or unavailable) and should not be accessed. A call to ''OnReloadConfig'' will indicate when the database is ready again.


	~~For this function to be called, the application must be added to the list of applications managed by Toolpack OAM.~~

	~~To add an application to be launched by Toolpack OAM, follow this procedure: [[Toolpack_OAM_add_app\|Add custom application to Toolpack]]~~

	== Example usage ==		== Example usage ==

Abrassard at 17:28, 30 May 2011

2011-05-30T17:28:42Z

← Older revision		Revision as of 13:28, 30 May 2011
Line 6:		Line 6:
	* ''OnDbMaintenance'': This function is called to indicate to the application that the database is in maintenance mode (or unavailable) and should not be accessed. A call to ''OnReloadConfig'' will indicate when the database is ready again.		* ''OnDbMaintenance'': This function is called to indicate to the application that the database is in maintenance mode (or unavailable) and should not be accessed. A call to ''OnReloadConfig'' will indicate when the database is ready again.


			For this function to be called, the application must be added to the list of applications managed by Toolpack OAM.

			To add an application to be launched by Toolpack OAM, follow this procedure: [[Toolpack_OAM_add_app\|Add custom application to Toolpack]]

	== Example usage ==		== Example usage ==

Abrassard at 15:05, 30 May 2011

2011-05-30T15:05:07Z

Show changes

Abrassard: Starting this doc

2011-05-30T14:43:20Z

Starting this doc

New page

The class ''CTBCAFServiceCmMgmtClient'' is used by applications that want to be informed of the current active configuration, and active database connection string.

An application that initializes this class has to provide a callback to interface ''ITBCAFServiceCmMgmtClient''. This interface provides 3 functions that the application must implement:
* ''OnValidateConfig'': Tells the application to validate the given configuration. This is already handled by standard, Toolpack applications so it's not required to do anything here.
* ''OnReloadConfig'': Tells the application that the configuration has been modified (or active configuration changed), and the application must reload any information from the database that it previously loaded and kept locally
* ''OnDbMaintenance'': This function is called to indicate to the application that the database is in maintenance mode (or unavailable) and should not be accessed. A call to ''OnReloadConfig'' will indicate when the database is ready again.

== Example usage ==