qtip.h

Go to the documentation of this file.

 
#ifndef QTIP_H
#define QTIP_H
 
#ifdef __cplusplus
// clang-format off
#define QTIP_CPP_SUPPORT_START extern "C" {
#define QTIP_CPP_SUPPORT_END }
#define QTIP_IS_CPP (1U)
#else
#define QTIP_CPP_SUPPORT_START
#define QTIP_CPP_SUPPORT_END
#define QTIP_IS_CPP (0U)
// clang-format on
#endif
 
QTIP_CPP_SUPPORT_START
 
#include <stdbool.h>
#include <stddef.h>
 
/*
 * Public defines
 */
#ifndef SIZE_TYPE
#define SIZE_TYPE size_t 
#else
#include <stdint.h>
#endif
 
/*
 * Public typedefs
 */
typedef SIZE_TYPE qtipSize_t; 
 
/*
 * Public Enum
 */
 
typedef enum
{
    QTIP_STATUS_OK,           
    QTIP_STATUS_FULL,         
    QTIP_STATUS_EMPTY,        
    QTIP_STATUS_NULL_PTR,     
    QTIP_STATUS_INVALID_SIZE, 
    QTIP_STATUS_LOCKED        
} qtipStatus_t;
 
/*
 * Public Structs
 */
 
typedef struct
{
    qtipSize_t maxItems; 
    qtipSize_t qty;      
    void* start;         
    qtipSize_t front;    
    qtipSize_t rear;     
    size_t itemSize;     
#ifndef DISABLE_LOCK
    bool locked; 
#endif
#ifndef DISABLE_TELEMETRY
    size_t processed; 
    size_t total;     
#endif
} qtipContext_t;
 
/*
 * Public API
 */
 
qtipStatus_t qtip_init(qtipContext_t* pContext, void* pQueue, qtipSize_t maxItems, size_t itemSize);
 
qtipStatus_t qtip_put(qtipContext_t* pContext, void* pItem);
 
qtipStatus_t qtip_pop(qtipContext_t* pContext, void* pItem);
 
qtipStatus_t qtip_peek(qtipContext_t* pContext, void* pBuffer, qtipSize_t* pSize);
 
qtipStatus_t qtip_purge(qtipContext_t* pContext);
 
qtipStatus_t qtip_get_front(qtipContext_t* pContext, void* pItem);
 
qtipStatus_t qtip_get_rear(qtipContext_t* pContext, void* pItem);
 
#ifndef REDUCED_API
 
qtipStatus_t qtip_is_full(qtipContext_t* pContext);
 
qtipStatus_t qtip_is_empty(qtipContext_t* pContext);
 
qtipStatus_t qtip_count_items(qtipContext_t* pContext, qtipSize_t* pResult);
 
qtipStatus_t qtip_get_item_index(qtipContext_t* pContext, qtipSize_t index, void* pItem);
 
qtipStatus_t qtip_remove_item_index(qtipContext_t* pContext, qtipSize_t index);
 
qtipStatus_t qtip_get_pop_index(qtipContext_t* pContext, qtipSize_t index, void* pItem);
 
#endif // REDUCED_API
 
#ifndef DISABLE_LOCK
 
qtipStatus_t qtip_is_locked(qtipContext_t* pContext);
 
qtipStatus_t qtip_lock(qtipContext_t* pContext);
 
qtipStatus_t qtip_unlock(qtipContext_t* pContext);
 
#endif // DISABLE_LOCK
 
#ifndef DISABLE_TELEMETRY
 
qtipStatus_t qtip_total_enqueued_items(qtipContext_t* pContext, size_t* pResult);
 
qtipStatus_t qtip_total_processed_items(qtipContext_t* pContext, size_t* pResult);
 
#endif // DISABLE_TELEMETRY
 
#endif // QTIP_H
 
QTIP_CPP_SUPPORT_END