cdi_queue_api.h

Go to the documentation of this file.

// -------------------------------------------------------------------------------------------
// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
// This file is part of the AWS CDI-SDK, licensed under the BSD 2-Clause "Simplified" License.
// License details at: https://github.com/aws/aws-cdi-sdk/blob/mainline/LICENSE
// -------------------------------------------------------------------------------------------
 
#ifndef CDI_QUEUE_API_H__
#define CDI_QUEUE_API_H__
 
#include <stdbool.h>
#include <stdint.h>
 
#include "cdi_os_api.h"
 
//*********************************************************************************************************************
//***************************************** START OF DEFINITIONS AND TYPES ********************************************
//*********************************************************************************************************************
 
#define CDI_FIXED_QUEUE_SIZE        (0)
 
typedef struct CdiQueueState* CdiQueueHandle;
 
typedef enum {
    kQueueSignalNone, 
 
    kQueueSignalPopWait,
 
    kQueueSignalPushWait,
 
    kQueueSignalPopPushWait, 
 
    kQueueSignalModeMask = 0x7, 
 
    kQueueMultipleWritersFlag = 0x08,  
} CdiQueueSignalMode;
 
typedef struct CdiSinglyLinkedListEntry CdiSinglyLinkedListEntry;
 
//*********************************************************************************************************************
//******************************************* START OF PUBLIC FUNCTIONS ***********************************************
//*********************************************************************************************************************
 
CDI_INTERFACE bool CdiQueueCreate(const char* name_str, uint32_t item_count, uint32_t grow_count,
                                  uint32_t max_grow_count, uint32_t item_byte_size, CdiQueueSignalMode signal_mode,
                                  CdiQueueHandle* ret_handle_ptr);
 
CDI_INTERFACE bool CdiQueuePop(CdiQueueHandle handle, void* item_dest_ptr);
 
CDI_INTERFACE bool CdiQueuePopWait(CdiQueueHandle handle, int timeout_ms, CdiSignalType abort_wait_signal,
                                   void* item_dest_ptr);
 
CDI_INTERFACE bool CdiQueuePopWaitMultiple(CdiQueueHandle handle, int timeout_ms,
                                           CdiSignalType* abort_wait_signal_array, int num_signals,
                                           uint32_t* ret_signal_index_ptr, void* item_dest_ptr);
 
CDI_INTERFACE bool CdiQueuePush(CdiQueueHandle handle, const void* item_ptr);
 
CDI_INTERFACE bool CdiQueuePushWait(CdiQueueHandle handle, int timeout_ms, CdiSignalType abort_wait_signal,
                                    const void* item_ptr);
 
CDI_INTERFACE bool CdiQueuePushWaitMultiple(CdiQueueHandle handle, int timeout_ms,
                                            CdiSignalType* abort_wait_signal_array, int num_signals,
                                            uint32_t* ret_signal_index_ptr, const void* item_ptr);
 
CDI_INTERFACE bool CdiQueueIsEmpty(CdiQueueHandle handle);
 
CDI_INTERFACE void CdiQueueFlush(CdiQueueHandle handle);
 
CDI_INTERFACE CdiSignalType CdiQueueGetPopWaitSignal(CdiQueueHandle handle);
 
CDI_INTERFACE CdiSignalType CdiQueueGetPushWaitSignal(CdiQueueHandle handle);
 
CDI_INTERFACE const char* CdiQueueGetName(CdiQueueHandle handle);
 
typedef struct {
    bool is_pop;        
    CdiSinglyLinkedListEntry* read_ptr;  
    CdiSinglyLinkedListEntry* write_ptr; 
    void* item_data_ptr; 
    int occupancy; 
} CdiQueueCbData;
 
typedef void (*CdiQueueCallback)(const CdiQueueCbData* data_ptr);
 
#ifdef DEBUG
CDI_INTERFACE void CdiQueueDebugEnable(CdiQueueHandle handle, CdiQueueCallback cb_ptr);
 
CDI_INTERFACE void CdiQueueDebugDisable(CdiQueueHandle handle);
#endif //DEBUG
 
CDI_INTERFACE void CdiQueueDestroy(CdiQueueHandle handle);
 
#endif // CDI_QUEUE_API_H__