fifo_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_FIFO_API_H__
#define CDI_FIFO_API_H__
 
#include <stdbool.h>
#include <stdint.h>
 
#include "cdi_core_api.h"
#include "cdi_os_api.h"
 
//*********************************************************************************************************************
//***************************************** START OF DEFINITIONS AND TYPES ********************************************
//*********************************************************************************************************************
 
typedef struct CdiFifoState* CdiFifoHandle;
 
typedef struct {
    CdiFifoHandle fifo_handle; 
    CdiUserCbParameter fifo_user_cb_param; 
    const void* new_item_data_ptr; 
    void* head_item_data_ptr; 
    void* tail_item_data_ptr; 
} CdiFifoFullCbData;
 
typedef void (*CdiFifoFullCallback)(const CdiFifoFullCbData* cb_data_ptr);
 
typedef struct {
    bool is_read;        
    int head_index;      
    int tail_index;      
    void* item_data_ptr; 
} CdiFifoCbData;
 
typedef void (*CdiFifoCallback)(const CdiFifoCbData* data_ptr);
 
//*********************************************************************************************************************
//******************************************* START OF PUBLIC FUNCTIONS ***********************************************
//*********************************************************************************************************************
 
CDI_INTERFACE bool CdiFifoCreate(const char* name_str, int item_count, int item_byte_size,
                                 CdiFifoFullCallback full_cb_ptr, CdiUserCbParameter full_user_cb_param,
                                 CdiFifoHandle* ret_handle_ptr);
 
CDI_INTERFACE bool CdiFifoRead(CdiFifoHandle handle, int timeout_ms, CdiSignalType abort_wait_signal,
                               void* item_dest_ptr);
 
CDI_INTERFACE void CdiFifoFlush(CdiFifoHandle handle);
 
CDI_INTERFACE bool CdiFifoWrite(CdiFifoHandle handle, int timeout_ms, CdiSignalType abort_wait_signal,
                                const void* item_ptr);
 
CDI_INTERFACE const char* CdiFifoGetName(CdiFifoHandle handle);
 
#ifdef DEBUG
void CdiFifoDebugEnable(CdiFifoHandle handle, CdiFifoCallback cb_ptr);
 
void CdiFifoDebugDisable(CdiFifoHandle handle);
#endif //DEBUG
 
CDI_INTERFACE void CdiFifoDestroy(CdiFifoHandle handle);
 
#endif // CDI_FIFO_API_H__