cdi_pool_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_POOL_API_H__
#define CDI_POOL_API_H__
 
#include <stdbool.h>
#include <stdint.h>
 
#include "cdi_utility_api.h"
 
//*********************************************************************************************************************
//***************************************** START OF DEFINITIONS AND TYPES ********************************************
//*********************************************************************************************************************
 
// #define USE_MEMORY_POOL_APPENDED_LISTS
 
typedef struct CdiPoolState* CdiPoolHandle;
 
typedef bool (*CdiPoolItemOperatorFunction)(const void* context_ptr, void* item_ptr);
 
typedef struct {
    bool is_put;     
    int num_entries; 
    const void* item_data_ptr; 
} CdiPoolCbData;
 
typedef void (*CdiPoolCallback)(const CdiPoolCbData* data_ptr);
 
//*********************************************************************************************************************
//******************************************* START OF PUBLIC FUNCTIONS ***********************************************
//*********************************************************************************************************************
 
CDI_INTERFACE uint32_t CdiPoolGetSizeNeeded(uint32_t item_count, uint32_t item_byte_size);
 
CDI_INTERFACE bool CdiPoolCreate(const char* name_str, uint32_t item_count, uint32_t grow_count,
                                 uint32_t max_grow_count, uint32_t item_byte_size, bool thread_safe,
                                 CdiPoolHandle* ret_handle_ptr);
 
CDI_INTERFACE bool CdiPoolCreateAndInitItems(const char* name_str, uint32_t item_count, uint32_t grow_count,
                                             uint32_t max_grow_count, uint32_t item_byte_size, bool thread_safe,
                                             CdiPoolHandle* ret_handle_ptr, CdiPoolItemOperatorFunction init_fn,
                                             void* init_context_ptr);
 
CDI_INTERFACE bool CdiPoolCreateUsingExistingBuffer(const char* name_str, uint32_t item_count, uint32_t item_byte_size,
                                                    bool thread_safe, void* buffer_ptr, uint32_t buffer_byte_size,
                                                    uint32_t* buffer_byte_size_needed_ptr,
                                                    CdiPoolHandle* ret_handle_ptr);
 
CDI_INTERFACE bool CdiPoolCreateUsingExistingBufferAndInitItems(const char* name_str, uint32_t item_count,
                                                                uint32_t item_byte_size, bool thread_safe,
                                                                void* buffer_ptr, uint32_t buffer_byte_size,
                                                                uint32_t* buffer_byte_size_needed_ptr,
                                                                CdiPoolHandle* ret_handle_ptr,
                                                                CdiPoolItemOperatorFunction init_fn,
                                                                void* init_context_ptr);
 
CDI_INTERFACE bool CdiPoolPeekInUse(CdiPoolHandle handle, void** ret_item_ptr);
 
CDI_INTERFACE bool CdiPoolGet(CdiPoolHandle handle, void** ret_item_ptr);
 
#ifdef USE_MEMORY_POOL_APPENDED_LISTS
CDI_INTERFACE bool CdiPoolGetAndAppend(CdiPoolHandle handle, void* existing_item_ptr, void** ret_item_ptr);
#endif
 
CDI_INTERFACE void CdiPoolPut(CdiPoolHandle handle, const void* item_ptr);
 
CDI_INTERFACE void CdiPoolPutAll(CdiPoolHandle handle);
 
CDI_INTERFACE const char* CdiPoolGetName(CdiPoolHandle handle);
 
CDI_INTERFACE uint32_t CdiPoolGetItemSize(CdiPoolHandle handle);
 
CDI_INTERFACE int CdiPoolGetFreeItemCount(CdiPoolHandle handle);
 
CDI_INTERFACE int CdiPoolGetTotalItemCount(CdiPoolHandle handle);
 
CDI_INTERFACE bool CdiPoolForEachItem(CdiPoolHandle handle, CdiPoolItemOperatorFunction operator_function,
                                      const void* context_ptr);
 
CDI_INTERFACE void CdiPoolCallbackEnable(CdiPoolHandle handle, CdiPoolCallback cb_ptr);
 
CDI_INTERFACE void CdiPoolCallbackDisable(CdiPoolHandle handle);
 
CDI_INTERFACE void CdiPoolDestroy(CdiPoolHandle handle);
 
#endif // CDI_POOL_API_H__