/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/**
* \file basic_mempool.h
* \brief Implementation of a basic memory pool.
* \author Mike Becker
* \author Olaf Wintermann
* \version 3.0
* \copyright 2-Clause BSD License
*/
#ifndef UCX_BASIC_MEMPOOL_H
#define UCX_BASIC_MEMPOOL_H
#include "mempool.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* Basic array-based memory pool.
*/
struct cx_basic_mempool_s {
/** Inherit base structure members. */
CxMempool base;
/** List of pointers to pooled memory. */
void **data;
/** Number of pooled memory items. */
size_t ndata;
/** Memory pool size. */
size_t size;
};
/**
* Creates a basic array-based memory pool.
*
* @param capacity the initial capacity of the pool
* @return the created memory pool or \c NULL if allocation failed
*/
__attribute__((__warn_unused_result__))
CxMempool *cxBasicMempoolCreate(size_t capacity);
#ifdef __cplusplus
} // extern "C"
#endif
#endif // UCX_BASIC_MEMPOOL_H