blob: 5cfdb4f37a2a82f5d83f073628d4d3803c97a551 [file] [log] [blame]
Lars Hjemliee4056b2008-03-27 09:22:13 +01001/*
2 * Since git has it's own cache.h which we include,
3 * lets test on CGIT_CACHE_H to avoid confusion
4 */
5
6#ifndef CGIT_CACHE_H
7#define CGIT_CACHE_H
8
Lars Hjemli939d32f2008-04-28 11:32:42 +02009typedef void (*cache_fill_fn)(void *cbdata);
Lars Hjemliee4056b2008-03-27 09:22:13 +010010
Lars Hjemli939d32f2008-04-28 11:32:42 +020011
12/* Print cached content to stdout, generate the content if necessary.
13 *
14 * Parameters
15 * size max number of cache files
16 * path directory used to store cache files
17 * key the key used to lookup cache files
18 * ttl max cache time in seconds for this key
19 * fn content generator function for this key
20 * cbdata user-supplied data to the content generator function
21 *
22 * Return value
23 * 0 indicates success, everyting else is an error
24 */
25extern int cache_process(int size, const char *path, const char *key, int ttl,
26 cache_fill_fn fn, void *cbdata);
27
28
Lars Hjemli9000bbf2008-04-28 12:10:13 +020029/* List info about all cache entries on stdout */
30extern int cache_ls(const char *path);
31
Lars Hjemli939d32f2008-04-28 11:32:42 +020032/* Print a message to stdout */
Mark Lodatoa4c58d92010-09-04 11:09:57 -040033__attribute__((format (printf,1,2)))
Lars Hjemli939d32f2008-04-28 11:32:42 +020034extern void cache_log(const char *format, ...);
Lars Hjemliee4056b2008-03-27 09:22:13 +010035
Lars Hjemli523a2162009-08-19 17:43:47 +020036extern unsigned long hash_str(const char *str);
37
Lars Hjemliee4056b2008-03-27 09:22:13 +010038#endif /* CGIT_CACHE_H */