intern/memutil/MEM_CacheLimiterC-Api.h

   1 /*
   2  * ***** BEGIN GPL LICENSE BLOCK *****
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software Foundation,
  16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17  *
  18  * Contributor(s): Peter Schlaile <peter@schlaile.de> 2005
  19  *
  20  * ***** END GPL LICENSE BLOCK *****
  21  */
  22
  23 /** \file memutil/MEM_CacheLimiterC-Api.h
  24  *  \ingroup memutil
  25  */
  26
  27
  28 #ifndef __MEM_CACHELIMITERC_API_H__
  29 #define __MEM_CACHELIMITERC_API_H__
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 struct MEM_CacheLimiter_s;
  36 struct MEM_CacheLimiterHandle_s;
  37
  38 typedef struct MEM_CacheLimiter_s MEM_CacheLimiterC;
  39 typedef struct MEM_CacheLimiterHandle_s MEM_CacheLimiterHandleC;
  40
  41 /* function used to remove data from memory */
  42 typedef void(*MEM_CacheLimiter_Destruct_Func)(void*);
  43
  44 /* function used to measure stored data element size */
  45 typedef size_t(*MEM_CacheLimiter_DataSize_Func) (void*);
  46
  47 #ifndef __MEM_CACHELIMITER_H__
  48 extern void MEM_CacheLimiter_set_maximum(size_t m);
  49 extern int MEM_CacheLimiter_get_maximum(void);
  50 #endif /* __MEM_CACHELIMITER_H__ */
  51 /**
  52  * Create new MEM_CacheLimiter object
  53  * managed objects are destructed with the data_destructor
  54  *
  55  * @param data_destructor
  56  * @return A new MEM_CacheLimter object
  57  */
  58
  59 extern MEM_CacheLimiterC * new_MEM_CacheLimiter(
  60         MEM_CacheLimiter_Destruct_Func data_destructor,
  61         MEM_CacheLimiter_DataSize_Func data_size);
  62
  63 /**
  64  * Delete MEM_CacheLimiter
  65  *
  66  * Frees the memory of the CacheLimiter but does not touch managed objects!
  67  *
  68  * @param This "This" pointer
  69  */
  70
  71 extern void delete_MEM_CacheLimiter(MEM_CacheLimiterC * This);
  72
  73 /**
  74  * Manage object
  75  *
  76  * @param This "This" pointer, data data object to manage
  77  * @return CacheLimiterHandle to ref, unref, touch the managed object
  78  */
  79
  80 extern MEM_CacheLimiterHandleC * MEM_CacheLimiter_insert(
  81         MEM_CacheLimiterC * This, void * data);
  82
  83 /**
  84  * Free objects until memory constraints are satisfied
  85  *
  86  * @param This "This" pointer
  87  */
  88
  89 extern void MEM_CacheLimiter_enforce_limits(MEM_CacheLimiterC * This);
  90
  91 /**
  92  * Unmanage object previously inserted object.
  93  * Does _not_ delete managed object!
  94  *
  95  * @param This "This" pointer, handle of object
  96  */
  97
  98 extern void MEM_CacheLimiter_unmanage(MEM_CacheLimiterHandleC * handle);
  99
 100
 101 /**
 102  * Raise priority of object (put it at the tail of the deletion chain)
 103  *
 104  * @param handle of object
 105  */
 106
 107 extern void MEM_CacheLimiter_touch(MEM_CacheLimiterHandleC * handle);
 108
 109 /**
 110  * Increment reference counter. Objects with reference counter != 0 are _not_
 111  * deleted.
 112  *
 113  * @param handle of object
 114  */
 115
 116 extern void MEM_CacheLimiter_ref(MEM_CacheLimiterHandleC * handle);
 117
 118 /**
 119  * Decrement reference counter. Objects with reference counter != 0 are _not_
 120  * deleted.
 121  *
 122  * @param handle of object
 123  */
 124
 125 extern void MEM_CacheLimiter_unref(MEM_CacheLimiterHandleC * handle);
 126
 127 /**
 128  * Get reference counter.
 129  *
 130  * @param This "This" pointer, handle of object
 131  */
 132
 133 extern int MEM_CacheLimiter_get_refcount(MEM_CacheLimiterHandleC * handle);
 134
 135 /**
 136  * Get pointer to managed object
 137  *
 138  * @param handle of object
 139  */
 140
 141 extern void * MEM_CacheLimiter_get(MEM_CacheLimiterHandleC * handle);
 142
 143 #ifdef __cplusplus
 144 }
 145 #endif
 146
 147
 148 #endif // __MEM_CACHELIMITERC_API_H__