File/Library Based Ckeckpointing

Defines, Structures, Typedefs, Functions. More...

Files
file	clCkptExtApi.h
	Header file of Library based Checkpoint Service Related APIs.

Typedefs
typedef ClRcT(*	ClCkptDeserializeT )(ClUint32T, ClAddrT, ClUint32T, ClPtrT)
	De-serialize Signature.
typedef ClRcT(*	ClCkptSerializeT )(ClUint32T, ClAddrT *, ClUint32T *, ClPtrT)
	Serialize Signature.

Functions
ClRcT	clCkptLibraryCkptCreate (CL_IN ClCkptSvcHdlT ckptHdl, CL_IN ClNameT *pCkptName)
	Creates the checkpoint.
ClRcT	clCkptLibraryCkptDataSetCreate (CL_IN ClCkptSvcHdlT ckptHdl, CL_IN ClNameT *pCkptName, CL_IN ClUint32T dsId, CL_IN ClUint32T grpId, CL_IN ClUint32T order, CL_IN ClCkptSerializeT dsSerialiser, CL_IN ClCkptDeserializeT dsDeserialiser)
	Creates a data set.
ClRcT	clCkptLibraryCkptDataSetDelete (CL_IN ClCkptSvcHdlT ckptHdl, CL_IN ClNameT *pCkptName, CL_IN ClUint32T dsId)
	Deletes the dataset from the checkpoint.
ClRcT	clCkptLibraryCkptDataSetRead (CL_IN ClCkptSvcHdlT ckptHdl, CL_IN ClNameT *pCkptName, CL_IN ClUint32T dsId, CL_IN ClPtrT cookie)
	Reads the dataset information into the database.
ClRcT	clCkptLibraryCkptDataSetWrite (CL_IN ClCkptSvcHdlT ckptHdl, CL_IN ClNameT *pCkptName, CL_IN ClUint32T dsId, CL_IN ClPtrT cookie)
	Writes the dataset information into the database.
ClRcT	clCkptLibraryCkptDelete (CL_IN ClCkptSvcHdlT ckptHdl, CL_IN ClNameT *pCkptName)
	Deletes the checkpoint.
ClRcT	clCkptLibraryCkptElementCreate (ClCkptSvcHdlT ckptHdl, ClNameT *pCkptName, ClUint32T dsId, ClCkptSerializeT elemSerialiser, ClCkptDeserializeT elemDeserialiser)
	Creates the element of the Dataset.
ClRcT	clCkptLibraryCkptElementDelete (ClCkptSvcHdlT ckptHdl, ClNameT *pCkptName, ClUint32T dsId, ClPtrT elemId, ClUint32T elemLen)
	Writes the Element information into the database.
ClRcT	clCkptLibraryCkptElementWrite (ClCkptSvcHdlT ckptHdl, ClNameT *pCkptName, ClUint32T dsId, ClPtrT elemId, ClUint32T elemLen, ClPtrT cookie)
	Writes the Element information into the database.
ClRcT	clCkptLibraryDoesCkptExist (CL_IN ClCkptSvcHdlT ckptHdl, CL_IN ClNameT *pCkptName, CL_OUT ClBoolT *pRetVal)
	Checks the existence of a checkpoint.
ClRcT	clCkptLibraryDoesDatasetExist (CL_IN ClCkptSvcHdlT ckptHdl, CL_IN ClNameT *pCkptName, CL_IN ClUint32T dsId, CL_OUT ClBoolT *pRetVal)
	Checks the existence of a Dataset in a given checkpoint.
ClRcT	clCkptLibraryFinalize (CL_IN ClCkptSvcHdlT ckptHdl)
	Destroys the client.
ClRcT	clCkptLibraryInitialize (CL_INOUT ClCkptSvcHdlT *pCkptHdl)
	Initializes the client.

Detailed Description

Defines, Structures, Typedefs, Functions.

Function Documentation

ClRcT clCkptLibraryCkptCreate	(	CL_IN ClCkptSvcHdlT	ckptHdl,
		CL_IN ClNameT *	pCkptName
	)

Creates the checkpoint.

Header File:

clCkptExtApi.h

Parameters

ckptHdl	Handle to the client obtained from the clCkptLibraryInitialize() function, designating this particular initialization of the Checkpoint library.
pCkptName	Name of the Checkpoint.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	On passing an invalid handle.
CL_ERR_NULL_POINTER	On passing a NULL pointer.
CL_ERR_NO_MEMORY	On memory allocation failure.

Description:

This function is used to create the checkpoint. This function must be invoked before any further operations can be done with the checkpoint.

Library File:

clCkpt

See Also

clCkptLibraryCkptDelete

ClRcT clCkptLibraryCkptDataSetCreate	(	CL_IN ClCkptSvcHdlT	ckptHdl,
		CL_IN ClNameT *	pCkptName,
		CL_IN ClUint32T	dsId,
		CL_IN ClUint32T	grpId,
		CL_IN ClUint32T	order,
		CL_IN ClCkptSerializeT	dsSerialiser,
		CL_IN ClCkptDeserializeT	dsDeserialiser
	)

Creates a data set.

Header File:

clCkptExtApi.h

Parameters

ckptHdl	Handle to the client obtained from the clCkptLibraryInitialize() function, designating this particular initialization of the Checkpoint library.
pCkptName	Name of the Checkpoint.
dsId	A unique identifier for identifying the data set.
grpId	An optional group Id to group different data sets together. [Currently not used]
order	When all the members of group are checkpointed the order in which this particular data set is checkpointed. [Currently not used]
dsSerialiser	Serialiser or encoder for the data.
dsDeserialiser	Deserialiser/decoder for the data.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	On passing an invalid handle.
CL_ERR_NULL_POINTER	On passing a NULL pointer.
CL_ERR_INVALID_PARAMETER	On passing an invalid parameter.
CL_ERR_NO_MEMORY	On memory allocation failure.

Description:

This function is used to create a data set and allocate resources to it. This function should be invoked before performing any further operations on the dataset. The dataset information can then be read, or written into the database.

Library File:

clCkpt

See Also

clCkptLibraryCkptDataSetDelete(), clCkptLibraryCkptDataSetWrite(), clCkptLibraryCkptDataSetRead()

ClRcT clCkptLibraryCkptDataSetDelete	(	CL_IN ClCkptSvcHdlT	ckptHdl,
		CL_IN ClNameT *	pCkptName,
		CL_IN ClUint32T	dsId
	)

Deletes the dataset from the checkpoint.

Header File:

clCkptExtApi.h

Parameters

ckptHdl	Handle to the client obtained from the clCkptLibraryInitialize() function, designating this particular initialization of the Checkpoint library.
pCkptName	Name of the Checkpoint.
dsId	Identifier of the dataset to be deleted.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	On passing an invalid handle.
CL_ERR_NULL_POINTER	On passing a NULL pointer.
CL_ERR_INVALID_PARAMETER	On passing an invalid parameter.
CL_ERR_NOT_EXIST	The specified argument is not exist.

Description:

This function is used to delete the dataset from the checkpoint. Before this function is invoked, the dataset must have been created using the clCkptLibraryCkptDataSetCreate() function.

Library File:

clCkpt

See Also

clCkptLibraryCkptDataSetCreate(), clCkptLibraryCkptDataSetWrite(), clCkptLibraryCkptDataSetRead()

ClRcT clCkptLibraryCkptDataSetRead	(	CL_IN ClCkptSvcHdlT	ckptHdl,
		CL_IN ClNameT *	pCkptName,
		CL_IN ClUint32T	dsId,
		CL_IN ClPtrT	cookie
	)

Reads the dataset information into the database.

Header File:

clCkptExtApi.h

Parameters

ckptHdl	Handle to the client obtained from the clCkptLibraryInitialize() function, designating this particular initialization of the Checkpoint library.
pCkptName	Name of the Checkpoint.
dsId	Identifier of the dataset to be written.
cookie	User-data which will be opaquely passed to the serializer.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	On passing an invalid handle.
CL_ERR_NULL_POINTER	On passing a NULL pointer.
CL_ERR_NOT_EXIST	The specified argument does not exist.

Description:

This function is used to read the Dataset information from database.

Library File:

clCkpt

See Also

clCkptLibraryCkptDataSetCreate(), clCkptLibraryCkptDataSetDelete(), clCkptLibraryCkptDataSetRead()

ClRcT clCkptLibraryCkptDataSetWrite	(	CL_IN ClCkptSvcHdlT	ckptHdl,
		CL_IN ClNameT *	pCkptName,
		CL_IN ClUint32T	dsId,
		CL_IN ClPtrT	cookie
	)

Writes the dataset information into the database.

Header File:

clCkptExtApi.h

Parameters

ckptHdl	Handle to the client obtained from the clCkptLibraryInitialize() function, designating this particular initialization of the Checkpoint library.
pCkptName	Name of the Checkpoint.
dsId	Identifier of the dataset to be written.
cookie	User-data which will be opaquely passed to the serializer.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	On passing an invalid handle.
CL_ERR_NULL_POINTER	On passing a NULL pointer.
CL_ERR_NOT_EXIST	The specified argument is not exist.

Description:

This function is used to write the dataset information into the database.

Library File:

clCkpt

See Also

clCkptLibraryCkptDataSetCreate(), clCkptLibraryCkptDataSetDelete(), clCkptLibraryCkptDataSetRead()

ClRcT clCkptLibraryCkptDelete	(	CL_IN ClCkptSvcHdlT	ckptHdl,
		CL_IN ClNameT *	pCkptName
	)

Deletes the checkpoint.

Header File:

clCkptExtApi.h

Parameters

ckptHdl	Handle to the client obtained from the clCkptLibraryInitialize() function, designating this particular initialization of the Checkpoint library.
pCkptName	Name of the Checkpoint to be deleted.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	On passing an invalid handle.
CL_ERR_NULL_POINTER	On passing a NULL pointer.

Description:

This function is used to delete the checkpoint. This must be invoked when the checkpoint services are no longer required. This invocation frees all resources associated with the checkpoint.

Library File:

clCkpt

See Also

clCkptLibraryCkptCreate()

ClRcT clCkptLibraryCkptElementCreate	(	ClCkptSvcHdlT	ckptHdl,
		ClNameT *	pCkptName,
		ClUint32T	dsId,
		ClCkptSerializeT	elemSerialiser,
		ClCkptDeserializeT	elemDeserialiser
	)

Creates the element of the Dataset.

Header File:

clCkptExtApi.h

Parameters

ckptHdl	Handle to the client obtained from the clCkptLibraryInitialize() function, designating this particular initialization of the Checkpoint library.
pCkptName	Name of the Checkpoint.
dsId	Identifier of the dataset to be written.
elemSerialiser	Encoder of the element Data
elemDeserialiser	Decoder of the element Data.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	On passing an invalid handle.
CL_ERR_NULL_POINTER	On passing a NULL pointer.
CL_ERR_NOT_EXIST	The specified argument is not exist.

Description:

This function is used to create an element of the dataset. It must be invoked before any element of the dataset can be written.

Library File:

clCkpt

See Also

clCkptLibraryCkptElementWrite()

ClRcT clCkptLibraryCkptElementDelete	(	ClCkptSvcHdlT	ckptHdl,
		ClNameT *	pCkptName,
		ClUint32T	dsId,
		ClPtrT	elemId,
		ClUint32T	elemLen
	)

Writes the Element information into the database.

Header File:

clCkptExtApi.h

Parameters

ckptHdl	Handle to the client obtained from the clCkptLibraryInitialize() function, designating this particular initialization of the Checkpoint library.
pCkptName	Name of the Checkpoint.
dsId	Identifier of the dataset to be written.
elemId	Identifier of the element.
elemLen	Length of the elemId.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	On passing an invalid handle.
CL_ERR_NULL_POINTER	On passing pCkptName as a NULL pointer.
CL_ERR_INVALID_PARAMETER	On passing an invalid parameter.
CL_ERR_NOT_EXIST	The specified argument does not exist.

Description:

This function is used to delete element data which was written already by API clCkptLibraryCkptElementDelete. Before this function is invoked, the element must be created and key should exist.

Library File:

clCkpt

See Also

clCkptLibraryCkptElementCreate()

ClRcT clCkptLibraryCkptElementWrite	(	ClCkptSvcHdlT	ckptHdl,
		ClNameT *	pCkptName,
		ClUint32T	dsId,
		ClPtrT	elemId,
		ClUint32T	elemLen,
		ClPtrT	cookie
	)

Writes the Element information into the database.

Header File:

clCkptExtApi.h

Parameters

ckptHdl	Handle to the client obtained from the clCkptLibraryInitialize() function, designating this particular initialization of the Checkpoint library.
pCkptName	Name of the Checkpoint.
dsId	Identifier of the dataset to be written.
elemName	Identifier of the element.
elemLen	Length of the elemId.
cookie	User data. This is opaquely passed to the serializer.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	On passing an invalid handle.
CL_ERR_NULL_POINTER	On passing pCkptName as a NULL pointer.
CL_ERR_INVALID_PARAMETER	On passing an invalid parameter.
CL_ERR_NOT_EXIST	The specified argument does not exist.

Description:

This function is used to write the Element information into the database. Before this function is invoked, the element must be created using the clCkptLibraryCkptElementCreate() function.

Library File:

clCkpt

See Also

clCkptLibraryCkptElementCreate()

ClRcT clCkptLibraryDoesCkptExist	(	CL_IN ClCkptSvcHdlT	ckptHdl,
		CL_IN ClNameT *	pCkptName,
		CL_OUT ClBoolT *	pRetVal
	)

Checks the existence of a checkpoint.

Header File:

clCkptExtApi.h

Parameters

ckptHdl	Handle to the client obtained from the clCkptLibraryInitialize() function, designating this particular initialization of the Checkpoint library.
pCkptName	Name of the Checkpoint.
pRetVal	Return value to the user, returns CL_TRUE if it exists.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	On passing an invalid handle.
CL_ERR_NULL_POINTER	On passing a NULL pointer.

Description:

This function is used to check if the given checkpoint exists or not.

Library File:

clCkpt

See Also

clCkptLibraryDoesDatasetExist()

ClRcT clCkptLibraryDoesDatasetExist	(	CL_IN ClCkptSvcHdlT	ckptHdl,
		CL_IN ClNameT *	pCkptName,
		CL_IN ClUint32T	dsId,
		CL_OUT ClBoolT *	pRetVal
	)

Checks the existence of a Dataset in a given checkpoint.

Header File:

clCkptExtApi.h

Parameters

ckptHdl	Handle to the client obtained from the clCkptLibraryInitialize() function, designating this particular initialization of the Checkpoint library.
pCkptName	Name of the Checkpoint.
dsId	Identifier of the dataset.
pRetVal	Return value to the user, returns CL_TRUE, if it exists.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	On passing an invalid handle.
CL_ERR_NULL_POINTER	On passing a NULL pointer.

Description:

This function is used to check whether the given Dataset exists.

Library File:

clCkpt

See Also

clCkptLibraryDoesCkptExist()

ClRcT clCkptLibraryFinalize

(

CL_IN ClCkptSvcHdlT

ckptHdl

)

Destroys the client.

Header File:

clCkptExtApi.h

Parameters

ckptHdl

Handle to the client obtained from the clCkptLibraryInitialize() function, designating this particular initialization of the Checkpoint library.

Return values

CL_OK	The API executed successfully.
CL_ERR_INVALID_HANDLE	On passing an invalid handle.

Description:

This function is used to close the association with checkpoint service client. It must be invoked when the services are no longer required. This invocation frees all allocated resources.

Library File:

clCkpt

See Also

clCkptLibraryInitialize()

ClRcT clCkptLibraryInitialize

(

CL_INOUT ClCkptSvcHdlT *

pCkptHdl

)

Initializes the client.

Header File:

clCkptExtApi.h

Parameters

pCkptHdl

(in/out) Handle to the client. This handle designates this particular initialization of the service.

Return values

CL_OK	The API executed successfully.
CL_ERR_NULL_POINTER	When the parameter pCkptHdl passed is a NULL pointer.
CL_ERR_NO_MEMORY	On memory allocation failure.

Description:

This function is used to initialize the client and allocates resources to it. The function returns a handle that associates this particular initialization of the Checkpoint library. This handle must be passed as the first input parameter for all invocations of functions related to this library.

Library File:

clCkpt

See Also

clCkptLibraryFinalize()