jwoolley 01/08/31 13:39:09
Modified: include apr_buckets.h
Log:
Flush out some docco updates I've had lying around for ages and forgot about
Revision Changes Path
1.116 +7 -5 apr-util/include/apr_buckets.h
Index: apr_buckets.h
===================================================================
RCS file: /home/cvs/apr-util/include/apr_buckets.h,v
retrieving revision 1.115
retrieving revision 1.116
diff -u -d -u -r1.115 -r1.116
--- apr_buckets.h 2001/08/25 22:58:02 1.115
+++ apr_buckets.h 2001/08/31 20:39:09 1.116
@@ -158,14 +158,16 @@
*/
int num_func;
/**
- * Free the private data and any resources used by the bucket
- * (if they aren't shared with another bucket).
+ * Free the private data and any resources used by the bucket (if they
+ * aren't shared with another bucket). This function is required to be
+ * implemented for all bucket types, though it might be a no-op on some
+ * of them (namely ones that never allocate any private data
structures).
* @param data The private data pointer from the bucket to be destroyed
*/
void (*destroy)(void *data);
/**
- * Read the data from the bucket. This is guaranteed to be implemented
+ * Read the data from the bucket. This is required to be implemented
* for all bucket types.
* @param b The bucket to read from
* @param str A place to store the data read. Allocation should only be
@@ -218,8 +220,8 @@
};
/**
- * apr_bucket structures are allocated on the malloc() heap and
- * their lifetime is controlled by the parent apr_bucket_brigade
+ * apr_bucket structures are allocated from an SMS with apr_sms_malloc()
+ * and their lifetime is controlled by the parent apr_bucket_brigade
* structure. Buckets can move from one brigade to another e.g. by
* calling APR_BRIGADE_CONCAT(). In general the data in a bucket has
* the same lifetime as the bucket and is freed when the bucket is
