2 * This file is part of DisOrder
3 * Copyright (C) 2006 Richard Kettlewell
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
21 * @brief Object caching
23 * There is a single cache for the whole process. Objects of different types
24 * are distinguished. Objects might be thrown out of the cache at any point.
30 /* Defines a cache mapping keys to typed data items */
32 /** @brief Type of a cache object */
34 /** @brief Lifetime for objects of this type (seconds) */
38 void cache_put(const struct cache_type *type,
39 const char *key, const void *value);
40 /* Inserts KEY into the cache with value VALUE. If KEY is already
41 * present it is overwritten. */
43 const void *cache_get(const struct cache_type *type, const char *key);
44 /* Get a value from the cache. */
46 void cache_expire(void);
47 /* Expire values from the cache */
49 void cache_clean(const struct cache_type *type);
50 /* Clean all elements of a particular type, or all elements if TYPE=0 */
52 size_t cache_count(void);
53 /* Return the size of the cache */