MEM_CacheLimiterC-Api.h

Go to the documentation of this file.

/*
 * 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.
 */
 
#ifndef __MEM_CACHELIMITERC_API_H__
#define __MEM_CACHELIMITERC_API_H__
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "BLI_utildefines.h"
 
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 size_t (*MEM_CacheLimiter_DataSize_Func)(void *);
 
/* function used to measure priority of item when freeing memory */
typedef int (*MEM_CacheLimiter_ItemPriority_Func)(void *, int);
 
/* function to check whether item could be destroyed */
typedef bool (*MEM_CacheLimiter_ItemDestroyable_Func)(void *);
 
#ifndef __MEM_CACHELIMITER_H__
void MEM_CacheLimiter_set_maximum(size_t m);
size_t MEM_CacheLimiter_get_maximum(void);
void MEM_CacheLimiter_set_disabled(bool disabled);
bool MEM_CacheLimiter_is_disabled(void);
#endif /* __MEM_CACHELIMITER_H__ */
 
MEM_CacheLimiterC *new_MEM_CacheLimiter(MEM_CacheLimiter_Destruct_Func data_destructor,
                                        MEM_CacheLimiter_DataSize_Func data_size);
 
void delete_MEM_CacheLimiter(MEM_CacheLimiterC *This);
 
MEM_CacheLimiterHandleC *MEM_CacheLimiter_insert(MEM_CacheLimiterC *This, void *data);
 
void MEM_CacheLimiter_enforce_limits(MEM_CacheLimiterC *This);
 
void MEM_CacheLimiter_unmanage(MEM_CacheLimiterHandleC *handle);
 
void MEM_CacheLimiter_touch(MEM_CacheLimiterHandleC *handle);
 
void MEM_CacheLimiter_ref(MEM_CacheLimiterHandleC *handle);
 
void MEM_CacheLimiter_unref(MEM_CacheLimiterHandleC *handle);
 
int MEM_CacheLimiter_get_refcount(MEM_CacheLimiterHandleC *handle);
 
void *MEM_CacheLimiter_get(MEM_CacheLimiterHandleC *handle);
 
void MEM_CacheLimiter_ItemPriority_Func_set(MEM_CacheLimiterC *This,
                                            MEM_CacheLimiter_ItemPriority_Func item_priority_func);
 
void MEM_CacheLimiter_ItemDestroyable_Func_set(
    MEM_CacheLimiterC *This, MEM_CacheLimiter_ItemDestroyable_Func item_destroyable_func);
 
size_t MEM_CacheLimiter_get_memory_in_use(MEM_CacheLimiterC *This);
 
#ifdef __cplusplus
}
#endif
 
#endif  // __MEM_CACHELIMITERC_API_H__