MEM_CacheLimiterC-Api.h

Go to the documentation of this file.

/*
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * 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 (at your option) 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * Contributor(s): Peter Schlaile <peter@schlaile.de> 2005
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#ifndef MEM_CACHELIMITERC_API_H
#define MEM_CACHELIMITERC_API_H

#ifdef __cplusplus
extern "C" {
#endif
    
struct MEM_CacheLimiter_s;
struct MEM_CacheLimiterHandle_s;

typedef struct MEM_CacheLimiter_s MEM_CacheLimiterC;
typedef struct MEM_CacheLimiterHandle_s MEM_CacheLimiterHandleC;

/* function used to remove data from memory */
typedef void(*MEM_CacheLimiter_Destruct_Func)(void*);

/* function used to measure stored data element size */
typedef intptr_t(*MEM_CacheLimiter_DataSize_Func) (void*);

#ifndef MEM_CACHELIMITER_H
extern void MEM_CacheLimiter_set_maximum(int m);
extern int MEM_CacheLimiter_get_maximum(void);
#endif // MEM_CACHELIMITER_H

extern MEM_CacheLimiterC * new_MEM_CacheLimiter(
    MEM_CacheLimiter_Destruct_Func data_destructor,
    MEM_CacheLimiter_DataSize_Func data_size);

extern void delete_MEM_CacheLimiter(MEM_CacheLimiterC * This);

extern MEM_CacheLimiterHandleC * MEM_CacheLimiter_insert(
    MEM_CacheLimiterC * This, void * data);

extern void MEM_CacheLimiter_enforce_limits(MEM_CacheLimiterC * This);

extern void MEM_CacheLimiter_unmanage(MEM_CacheLimiterHandleC * handle);


extern void MEM_CacheLimiter_touch(MEM_CacheLimiterHandleC * handle);

extern void MEM_CacheLimiter_ref(MEM_CacheLimiterHandleC * handle);

extern void MEM_CacheLimiter_unref(MEM_CacheLimiterHandleC * handle);

extern int MEM_CacheLimiter_get_refcount(MEM_CacheLimiterHandleC * handle);

extern void * MEM_CacheLimiter_get(MEM_CacheLimiterHandleC * handle);

#ifdef __cplusplus
}
#endif


#endif // MEM_CACHELIMITERC_API_H