object_pool.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2019 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#ifndef __UTILS_OBJECT_POOL_H__
#define __UTILS_OBJECT_POOL_H__
 
#include "utils/types.h"
 
#include "zix/sem.h"
 
typedef void * (*ObjectCreatorFunc) (void);
 
typedef struct ObjectPool
{
  int max_objects;
 
  void ** obj_available;
  int     num_obj_available;
 
  ObjectFreeFunc free_func;
 
  ZixSem access_sem;
} ObjectPool;
 
ObjectPool *
object_pool_new (
  ObjectCreatorFunc create_func,
  ObjectFreeFunc    free_func,
  int               max_objects);
 
void *
object_pool_get (ObjectPool * self);
 
int
object_pool_get_num_available (ObjectPool * self);
 
void
object_pool_return (ObjectPool * self, void * object);
 
void
object_pool_free (ObjectPool * self);
 
#endif