chiark - git - mdw - disorder/blob - lib/cache.h

   1 /*
   2  * This file is part of DisOrder
   3  * Copyright (C) 2006 Richard Kettlewell
   4  *
   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.
   9  *
  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.
  14  *
  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
  18  * USA
  19  */
  20
  21 #ifndef CACHE_H
  22 #define CACHE_H
  23
  24 /* Defines a cache mapping keys to typed data items */
  25
  26 struct cache_type {
  27   int lifetime;                         /* Lifetime of a cache entry */
  28 };
  29
  30 void cache_put(const struct cache_type *type,
  31                const char *key, const void *value);
  32 /* Inserts KEY into the cache with value VALUE.  If KEY is already
  33  * present it is overwritten. */
  34
  35 const void *cache_get(const struct cache_type *type, const char *key);
  36 /* Get a value from the cache. */
  37
  38 void cache_expire(void);
  39 /* Expire values from the cache */
  40
  41 void cache_clean(const struct cache_type *type);
  42 /* Clean all elements of a particular type, or all elements if TYPE=0 */
  43
  44 size_t cache_count(void);
  45 /* Return the size of the cache */
  46
  47 #endif /* CACHE_H */
  48
  49 /*
  50 Local Variables:
  51 c-basic-offset:2
  52 comment-column:40
  53 fill-column:79
  54 indent-tabs-mode:nil
  55 End:
  56 */