/*
* This file is part of DisOrder
- * Copyright (C) 2006 Richard Kettlewell
+ * Copyright (C) 2006-2008 Richard Kettlewell
*
- * This program is free software; you can redistribute it and/or modify
+ * 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
+ * the Free Software Foundation, either version 3 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.
- *
+ *
+ * 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+/** @file lib/cache.h
+ * @brief Object caching
+ *
+ * There is a single cache for the whole process. Objects of different types
+ * are distinguished. Objects might be thrown out of the cache at any point.
*/
#ifndef CACHE_H
/* Defines a cache mapping keys to typed data items */
+/** @brief Type of a cache object */
struct cache_type {
- int lifetime; /* Lifetime of a cache entry */
+ /** @brief Lifetime for objects of this type (seconds) */
+ int lifetime;
};
void cache_put(const struct cache_type *type,
void cache_clean(const struct cache_type *type);
/* Clean all elements of a particular type, or all elements if TYPE=0 */
+size_t cache_count(void);
+/* Return the size of the cache */
+
#endif /* CACHE_H */
/*