clQueueApi.h

Go to the documentation of this file.

/*
 * Copyright (C) 2002-2012 OpenClovis Solutions Inc.  All Rights Reserved.
 *
 * This file is available  under  a  commercial  license  from  the
 * copyright  holder or the GNU General Public License Version 2.0.
 * 
 * The source code for  this program is not published  or otherwise 
 * divested of  its trade secrets, irrespective  of  what  has been 
 * deposited with the U.S. Copyright office.
 * 
 * This program is distributed in the  hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied  warranty  of 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
 * General Public License for more details.
 * 
 * For more  information, see  the file  COPYING provided with this
 * material.
 */
/*******************************************************************************
 * ModuleName  : utils
 * File        : clQueueApi.h
 *******************************************************************************/

/*******************************************************************************
 * Description :
 *
 * A simple queue implementation.
 *
 *
 *****************************************************************************/

/*************************************************************************/
/************************** QUEUE APIs ***********************************/
/*************************************************************************/
/*                                                                                                           */
/* clQueueCreate                                                                             */
/* clQueueNodeInsert                                                                 */
/* clQueueNodeDelete                                                             */
/* clQueueWalk                                                                               */
/* clQueueSizeGet                                                                                */
/* clQueueDelete                                                                                 */
/*                                                                                                           */
/*************************************************************************/

#ifndef _CL_QUEUE_API_H_
#define _CL_QUEUE_API_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <clCommon.h>

typedef ClPtrT ClQueueT;

typedef ClHandleT ClQueueNodeT; // Mynk NTC

typedef ClPtrT ClQueueDataT;


typedef ClRcT   (*ClQueueWalkCallbackT)(CL_IN ClQueueDataT userData,
                                        CL_IN void         *userArg);
typedef void   (*ClQueueDequeueCallbackT)(CL_IN ClQueueDataT userData);

extern ClRcT clQueueCreate(CL_IN  ClUint32T                 maxSize,
                           CL_IN  ClQueueDequeueCallbackT   fpUserDequeueCallBack,
                           CL_IN  ClQueueDequeueCallbackT   fpUserDestroyCallBack,
                           CL_OUT ClQueueT                  *pQueueHandle);
extern ClRcT clQueueNodeInsert(CL_IN ClQueueT     queueHandle,
                               CL_IN ClQueueDataT userData);
extern ClRcT clQueueNodeDelete(CL_IN  ClQueueT   queueHandle,
                               CL_OUT ClQueueDataT* userData);

extern ClRcT clQueueWalk(CL_IN ClQueueT              queueHandle,
                         CL_IN ClQueueWalkCallbackT  fpUserWalkFunction,
                         CL_IN void*                 userArg);
extern ClRcT clQueueSizeGet(CL_IN  ClQueueT   queueHandle,
                            CL_OUT ClUint32T  *pSize);

extern ClRcT clQueueDelete(CL_IN ClQueueT* pQueueHandle);

#ifdef __cplusplus
}
#endif

#endif /* _CL_QUEUE_API_H_ */