Motorola 6806800C47B API Description, Service Extensions, NcsCkptRegisterCkptArrivalCallback

API Description

2

2.1Service Extensions

The current release of NCS Checkpoint Service provides one API and a callback function in addition to the APIs defined in the SAF-AIS Checkpoint Service document SAF-AIS-CKPT- B.01.01. These APIs are defined as 'stand-alone' APIs so that other SAF-defined APIs are not disturbed, and compliance to SAF is not compromised. These extensions are defined to provide the hot-standby support to the Checkpoint Service user applications.

2.1.1ncsCkptRegisterCkptArrivalCallback()

Prototype

SaAisErrorTncsCkptRegisterCkptArrivalCallback(

SaCkptHandleT ckptHandle,

ncsCkptCkptArrivalCallbackT ckptArrivalCallback

);

Parameters

The following table describes the possible parameters.

Table 2-1 ncsCkptRegisterCkptArrivalCallback() Parameters

Parameter	Description
ckptHandle - [in]	The handle obtained through the
	saCkptInitialize() function,
	designating this particular initialization of
	the Checkpoint Service.
ckptArrivalCallback - [in]	The function pointer that the CKPT
	service shall invoke whenever an opened
	checkpoint scoped to ckptHandle is
	updated.

Description

This call registers the function callback that will be invoked whenever a opened checkpoint scoped to ckptHandle is updated. Though it can be invoked any time, the most likely time to invoke is just after saCkptInitialize() has been invoked. A client will not invoke this call at all if it does not wish to be notified in real-time about checkpoint updates.

Return Values

Checkpoint Service Programmer’s Reference (6806800C47B) 17