bucketLib.h

Go to the documentation of this file.

/*************************************************************************\
* Copyright (c) 2002 The University of Chicago, as Operator of Argonne
*     National Laboratory.
* Copyright (c) 2002 The Regents of the University of California, as
*     Operator of Los Alamos National Laboratory.
* EPICS BASE is distributed subject to a Software License Agreement found
* in file LICENSE that is included with this distribution.
\*************************************************************************/
#ifndef INCbucketLibh
#define INCbucketLibh

#ifdef __cplusplus
extern "C" {
#endif

#include "errMdef.h"
#include "epicsTypes.h"
#include "libComAPI.h"

typedef unsigned        BUCKETID;

typedef enum {bidtUnsigned, bidtPointer, bidtString} buckTypeOfId;

typedef struct item{
    struct item     *pItem;
    const void      *pId;
    const void      *pApp;
    buckTypeOfId    type;
}ITEM;

typedef struct bucket{
    ITEM            **pTable;
    void            *freeListPVT;
    unsigned        hashIdMask;
    unsigned        hashIdNBits;
    unsigned        nInUse;
}BUCKET;
LIBCOM_API BUCKET * epicsStdCall bucketCreate (unsigned nHashTableEntries);
LIBCOM_API int epicsStdCall bucketFree (BUCKET *prb);
LIBCOM_API int epicsStdCall bucketShow (BUCKET *prb);

LIBCOM_API int epicsStdCall bucketAddItemUnsignedId (BUCKET *prb,
        const unsigned *pId, const void *pApp);
LIBCOM_API int epicsStdCall bucketAddItemPointerId (BUCKET *prb,
        void * const *pId, const void *pApp);
LIBCOM_API int epicsStdCall bucketAddItemStringId (BUCKET *prb,
        const char *pId, const void *pApp);
LIBCOM_API int epicsStdCall bucketRemoveItemUnsignedId (BUCKET *prb, const unsigned *pId);
LIBCOM_API int epicsStdCall bucketRemoveItemPointerId (BUCKET *prb, void * const *pId);
LIBCOM_API int epicsStdCall bucketRemoveItemStringId (BUCKET *prb, const char *pId);
LIBCOM_API void * epicsStdCall bucketLookupItemUnsignedId (BUCKET *prb, const unsigned *pId);
LIBCOM_API void * epicsStdCall bucketLookupItemPointerId (BUCKET *prb, void * const *pId);
LIBCOM_API void * epicsStdCall bucketLookupItemStringId (BUCKET *prb, const char *pId);

LIBCOM_API void * epicsStdCall bucketLookupAndRemoveItemUnsignedId (BUCKET *prb, const unsigned *pId);
LIBCOM_API void * epicsStdCall bucketLookupAndRemoveItemPointerId (BUCKET *prb, void * const *pId);
LIBCOM_API void * epicsStdCall bucketLookupAndRemoveItemStringId (BUCKET *prb, const char *pId);


#define BUCKET_SUCCESS      S_bucket_success

#define S_bucket_success    0

#define S_bucket_noMemory   (M_bucket | 1)  /*Memory allocation failed*/

#define S_bucket_idInUse    (M_bucket | 2)  /*Identifier already in use*/

#define S_bucket_uknId      (M_bucket | 3)  /*Unknown identifier*/

#ifdef __cplusplus
}
#endif

#endif /*INCbucketLibh*/