Add comments

Jeremy was able to use this correctly without comments, so the code can't be
*that* bad :-)

diff --git a/source/include/memcache.h b/source/include/memcache.h
index 5a0ce63cb76c8d75cab1efbdabe69fd8da25706f..0a596b91a52b2bb2acb70c7c35659655bdce37cd 100644 (file)
--- a/source/include/memcache.h
+++ b/source/include/memcache.h
@@ -1,7 +1,7 @@
 /*
    Unix SMB/CIFS implementation.
    In-memory cache
-   Copyright (C) Volker Lendecke 2005-2007
+   Copyright (C) Volker Lendecke 2007-2008
 
    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
@@ -24,6 +24,15 @@
 
 struct memcache;
 
+/*
+ * A memcache can store different subkeys with overlapping keys, the
+ * memcache_number becomes part of the key. Feel free to add caches of your
+ * own here.
+ *
+ * If you add talloc type caches, also note this in the switch statement in
+ * memcache_is_talloc().
+ */
+
 enum memcache_number {
        STAT_CACHE,
        UID_SID_CACHE,
@@ -38,25 +47,69 @@ enum memcache_number {
        SINGLETON_CACHE
 };
 
+/*
+ * Create a memcache structure. max_size is in bytes, if you set it 0 it will
+ * not forget anything.
+ */
+
 struct memcache *memcache_init(TALLOC_CTX *mem_ctx, size_t max_size);
 
+/*
+ * If you set this global memcache, use it as the default cache when NULL is
+ * passed to the memcache functions below. This is a workaround for many
+ * situations where passing the cache everywhere would be a big hassle.
+ */
+
 void memcache_set_global(struct memcache *cache);
 
+/*
+ * Add a data blob to the cache
+ */
+
 void memcache_add(struct memcache *cache, enum memcache_number n,
                  DATA_BLOB key, DATA_BLOB value);
 
+/*
+ * Add a talloc object to the cache. The difference to memcache_add() is that
+ * when the objects is to be discared, talloc_free is called for it. Also
+ * talloc_move() ownership of the object to the cache.
+ *
+ * Please note that the current implementation has a fixed relationship
+ * between what cache subtypes store talloc objects and which ones store plain
+ * blobs. We can fix this, but for now we don't have a mixed use of blobs vs
+ * talloc objects in the cache types.
+ */
+
 void memcache_add_talloc(struct memcache *cache, enum memcache_number n,
                         DATA_BLOB key, void *ptr);
 
+/*
+ * Delete an object from the cache
+ */
+
 void memcache_delete(struct memcache *cache, enum memcache_number n,
                     DATA_BLOB key);
 
+/*
+ * Look up an object from the cache. Memory still belongs to the cache, so
+ * make a copy of it if needed.
+ */
+
 bool memcache_lookup(struct memcache *cache, enum memcache_number n,
                     DATA_BLOB key, DATA_BLOB *value);
 
+/*
+ * Look up an object from the cache. Memory still belongs to the cache, so
+ * make a copy of it if needed.
+ */
+
 void *memcache_lookup_talloc(struct memcache *cache, enum memcache_number n,
                             DATA_BLOB key);
 
+/*
+ * Flush a complete cache subset.
+ */
+
 void memcache_flush(struct memcache *cache, enum memcache_number n);
 
 #endif