Changeset 45903 in vbox for trunk/include

Timestamp:

May 6, 2013 11:38:45 AM (12 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

85529

Message:

memcache.h/.cpp: doc updates

File:

• trunk/include/iprt/memcache.h (modified) (1 diff)

trunk/include/iprt/memcache.h

@@ -38 +38 @@
  *
  * Optimized allocation, initialization, freeing and destruction of memory
- * objects of the same kind and size.
+ * objects of the same kind and size.  Objects are constructed once, then
+ * allocated and freed one or more times, until finally destructed together with
+ * the cache (RTMemCacheDestroy).  It's expected behavior, even when pfnCtor is
+ * NULL, that the user will be store information that should be persistent
+ * across RTMemCacheFree calls.
+ *
+ * The objects are zeroed prior to calling pfnCtor. For obvious reasons, the
+ * objects are not touched by the cache after that, so that RTMemCacheAlloc will
+ * return the object in the same state as when it as handed to RTMemCacheFree.
+ *
+ * @todo A callback for the reuse (at alloc time) might be of interest.
  *
  * @{