rtmempool.h

Go to the documentation of this file.

/*
 * RealTime Memory Pool, heavily based on work by Nedko Arnaudov
 * Copyright (C) 2006-2009 Nedko Arnaudov <nedko@arnaudov.name>
 * Copyright (C) 2013-2016 Filipe Coelho <falktx@falktx.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * For a full copy of the GNU General Public License see the GPL.txt file
 */
 
#ifndef __RTMEMPOOL_H__
#define __RTMEMPOOL_H__
 
#ifdef __cplusplus
# include <cstddef>
#else
# include <stdbool.h>
# include <stddef.h>
#endif

#define RTSAFE_MEMORY_POOL_NAME_MAX 128

typedef void* RtMemPool_Handle;

bool rtsafe_memory_pool_create(RtMemPool_Handle* handlePtr,
                               const char* poolName,
                               size_t dataSize,
                               size_t minPreallocated,
                               size_t maxPreallocated);

void rtsafe_memory_pool_destroy(RtMemPool_Handle handle);

void* rtsafe_memory_pool_allocate_atomic(RtMemPool_Handle handle);

void* rtsafe_memory_pool_allocate_sleepy(RtMemPool_Handle handle);

void rtsafe_memory_pool_deallocate(RtMemPool_Handle handle,
                                   void* memoryPtr);
 
#endif // __RTMEMPOOL_H__