From 228d1d39800cd29792da8d6449c85b81d121208a Mon Sep 17 00:00:00 2001 From: Victor Julien Date: Wed, 22 Jan 2014 16:24:02 +0100 Subject: [PATCH] pool: document some of the Pool:: fields. --- src/util-pool.h | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/util-pool.h b/src/util-pool.h index 33f038a4e9..5ad26b4873 100644 --- a/src/util-pool.h +++ b/src/util-pool.h @@ -43,7 +43,8 @@ typedef struct PoolBucket_ { typedef struct Pool_ { uint32_t max_buckets; uint32_t preallocated; - uint32_t allocated; + uint32_t allocated; /**< counter of data elements, both currently in + * the pool and outside of it (outstanding) */ uint32_t alloc_list_size; @@ -64,8 +65,9 @@ typedef struct Pool_ { void (*Free)(void *); uint32_t elt_size; - uint32_t outstanding; - uint32_t max_outstanding; + uint32_t outstanding; /**< counter of data items 'in use'. Pretty much + * the diff between PoolGet and PoolReturn */ + uint32_t max_outstanding; /**< max value of outstanding we saw */ } Pool; /* prototypes */