clCntApi.h File Reference

Header file of Clovis Container Related APIs. More...

#include <clCommon.h>
#include <clRuleApi.h>

Go to the source code of this file.

Typedefs
typedef ClPtrT	ClCntArgHandleT
	Handle of the argument which will be passed to callback functions.
typedef ClPtrT	ClCntDataHandleT
	Handle of the data.
typedef void(*	ClCntDeleteCallbackT )(CL_IN ClCntKeyHandleT userKey, CL_IN ClCntDataHandleT userData)
	Gets called While destroying the node of the container.
typedef ClPtrT	ClCntHandleT
	Handle of the container.
typedef ClUint32T(*	ClCntHashCallbackT )(CL_IN ClCntKeyHandleT userKey)
	Gets called While doing hash table related operations.
typedef ClInt32T(*	ClCntKeyCompareCallbackT )(CL_IN ClCntKeyHandleT key1, CL_IN ClCntKeyHandleT key2)
	Compares the two keys.
typedef ClPtrT	ClCntKeyHandleT
	Handle of the key handle.
typedef ClPtrT	ClCntNodeHandleT
	Handle of the container Node.
typedef ClRcT(*	ClCntWalkCallbackT )(CL_IN ClCntKeyHandleT userKey, CL_IN ClCntDataHandleT userData, CL_IN ClCntArgHandleT userArg, CL_IN ClUint32T dataLength)
	Gets called While performing container walk operation.

Enumerations
enum	ClCntKeyTypeT {   CL_CNT_UNIQUE_KEY = 1,   CL_CNT_NON_UNIQUE_KEY = 2,   CL_CNT_INVALID_KEY_TYPE }
	This enum describes type of the container. More...

Functions
ClRcT	clCntAllNodesDelete (CL_IN ClCntHandleT containerHandle)
	Deletes all the nodes from the Container.
ClRcT	clCntAllNodesForKeyDelete (CL_IN ClCntHandleT containerHandle, CL_IN ClCntKeyHandleT userKey)
ClRcT	clCntDataForKeyGet (CL_IN ClCntHandleT containerHandle, CL_IN ClCntKeyHandleT userKey, CL_OUT ClCntDataHandleT *pUserData)
	Returns the user-data associated with a specified key.
ClRcT	clCntDelete (CL_IN ClCntHandleT containerHandle)
	Destroys the Container.
ClRcT	clCntFirstNodeGet (CL_IN ClCntHandleT containerHandle, CL_OUT ClCntNodeHandleT *pNodeHandle)
	Returns the first node from the Container.
ClRcT	clCntHashtblCreate (CL_IN ClUint32T numberOfBuckets, CL_IN ClCntKeyCompareCallbackT fpKeyCompare, CL_IN ClCntHashCallbackT fpHashFunction, CL_IN ClCntDeleteCallbackT fpUserDeleteCallback, CL_IN ClCntDeleteCallbackT fpUserDestroyCallback, CL_IN ClCntKeyTypeT containerKeyType, CL_IN ClCntHandleT *pContainerHandle)
	Creates the hash table.
ClRcT	clCntKeySizeGet (CL_IN ClCntHandleT containerHandle, CL_IN ClCntKeyHandleT userKey, CL_OUT ClUint32T *pSize)
	Returns the number of nodes associated with a user-key.
ClRcT	clCntLastNodeGet (CL_IN ClCntHandleT containerHandle, CL_OUT ClCntNodeHandleT *pNodeHandle)
	Returns the last node from the Container.
ClRcT	clCntLlistCreate (CL_IN ClCntKeyCompareCallbackT fpKeyCompare, CL_IN ClCntDeleteCallbackT fpUserDeleteCallback, CL_IN ClCntDeleteCallbackT fpUserDestroyCallback, CL_IN ClCntKeyTypeT containerKeyType, CL_OUT ClCntHandleT *pContainerHandle)
	Creates the container doubly linked list.
ClRcT	clCntNextNodeGet (CL_IN ClCntHandleT containerHandle, CL_IN ClCntNodeHandleT currentNodeHandle, CL_OUT ClCntNodeHandleT *pNextNodeHandle)
	Returns the next node from the Container.
ClRcT	clCntNodeAdd (CL_IN ClCntHandleT containerHandle, CL_IN ClCntKeyHandleT userKey, CL_IN ClCntDataHandleT userData, CL_IN ClRuleExprT *rbeExpression)
	Adds a new node to Container.
ClRcT	clCntNodeAddAndNodeGet (CL_IN ClCntHandleT containerHandle, CL_IN ClCntKeyHandleT userKey, CL_IN ClCntDataHandleT userData, CL_IN ClRuleExprT *pExp, CL_IN ClCntNodeHandleT *pNodeHandle)
	Adds a new node to Container and returns the node handle.
ClRcT	clCntNodeDelete (CL_IN ClCntHandleT containerHandle, CL_IN ClCntNodeHandleT nodeHandle)
	Deletes a specific node from the Container.
ClRcT	clCntNodeFind (CL_IN ClCntHandleT containerHandle, CL_IN ClCntKeyHandleT userKey, CL_IN ClCntNodeHandleT *pNodeHandle)
	Finds a specific node in the Container.
ClRcT	clCntNodeUserDataGet (CL_IN ClCntHandleT containerHandle, CL_IN ClCntNodeHandleT nodeHandle, CL_OUT ClCntDataHandleT *pUserDataHandle)
	Returns the user-data from the node.
ClRcT	clCntNodeUserKeyGet (CL_IN ClCntHandleT containerHandle, CL_IN ClCntNodeHandleT nodeHandle, CL_OUT ClCntKeyHandleT *pUserKey)
	Returns the user-key from the node.
ClRcT	clCntPreviousNodeGet (CL_IN ClCntHandleT containerHandle, CL_IN ClCntNodeHandleT currentNodeHandle, CL_OUT ClCntNodeHandleT *pPreviousNodeHandle)
	Returns the previous node from the Container.
ClRcT	clCntRbtreeCreate (CL_IN ClCntKeyCompareCallbackT fpKeyCompare, CL_IN ClCntDeleteCallbackT fpUserDeleteCallback, CL_IN ClCntDeleteCallbackT fpUserDestroyCallback, CL_IN ClCntKeyTypeT containerKeyType, CL_OUT ClCntHandleT *pContainerHandle)
	Creates the container red black tree.
ClRcT	clCntSizeGet (CL_IN ClCntHandleT containerHandle, CL_OUT ClUint32T *pSize)
	Returns the size of the Container.
ClRcT	clCntThreadSafeHashtblCreate (CL_IN ClUint32T numberOfBuckets, CL_IN ClCntKeyCompareCallbackT fpKeyCompare, CL_IN ClCntHashCallbackT fpHashFunction, CL_IN ClCntDeleteCallbackT fpUserDeleteCallback, CL_IN ClCntDeleteCallbackT fpUserDestroyCallback, CL_IN ClCntKeyTypeT containerKeyType, CL_OUT ClCntHandleT *pContainerHandle)
	Creates a thread safe hash table.
ClRcT	clCntThreadSafeLlistCreate (CL_IN ClCntKeyCompareCallbackT fpKeyCompare, CL_IN ClCntDeleteCallbackT fpUserDeleteCallback, CL_IN ClCntDeleteCallbackT fpUserDestroyCallback, CL_IN ClCntKeyTypeT containerKeyType, CL_OUT ClCntHandleT *pContainerHandle)
	Creates the container doubly linked list with lock variable.
ClRcT	clCntThreadSafeRbtreeCreate (CL_IN ClCntKeyCompareCallbackT fpKeyCompare, CL_IN ClCntDeleteCallbackT fpUserDeleteCallback, CL_IN ClCntDeleteCallbackT fpUserDestroyCallback, CL_IN ClCntKeyTypeT containerKeyType, CL_OUT ClCntHandleT *pContainerHandle)
	Creates the thread safe container red black tree.
ClRcT	clCntWalk (CL_IN ClCntHandleT containerHandle, CL_IN ClCntWalkCallbackT fpUserWalkCallback, CL_IN ClCntArgHandleT userArg, CL_IN ClInt32T length)
	Walks through the Container.

Detailed Description

Header file of Clovis Container Related APIs.