From: Jim Jagielski Date: Fri, 15 May 2009 18:21:12 +0000 (+0000) Subject: dditional docco changes... No functional changes X-Git-Tag: 2.3.3~566 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=804ffff1dafe0664ac1401a8e28c3794adbc25e6;p=thirdparty%2Fapache%2Fhttpd.git dditional docco changes... No functional changes git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@775272 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/mod/mod_slotmem_plain.xml b/docs/manual/mod/mod_slotmem_plain.xml index efebe59304d..1c70f3ce874 100644 --- a/docs/manual/mod/mod_slotmem_plain.xml +++ b/docs/manual/mod/mod_slotmem_plain.xml @@ -39,28 +39,39 @@ mod_slotmem_shm.

-

mod_slotmem_plain provides the following - API functions: +

mod_slotmem_plain provides the following API functions:

-
apr_status_t do(ap_slotmem_instance_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool)
+
apr_status_t doall(ap_slotmem_instance_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool)
call the callback on all worker slots
-
apr_status_t create(ap_slotmem_instance_t **new, const char *name, apr_size_t item_size, int item_num, apr_pool_t *pool)
+
apr_status_t create(ap_slotmem_instance_t **new, const char *name, apr_size_t item_size, unsigned int item_num, ap_slotmem_type_t type, apr_pool_t *pool)
create a new slotmem with each item size is item_size.
-
apr_status_t attach(ap_slotmem_instance_t **new, const char *name, apr_size_t *item_size, int *item_num, apr_pool_t *pool)
+
apr_status_t attach(ap_slotmem_instance_t **new, const char *name, apr_size_t *item_size, unsigned int *item_num, apr_pool_t *pool)
attach to an existing slotmem.
-
apr_status_t dptr(ap_slotmem_instance_t *s, int item_id, void**mem)
+
apr_status_t dptr(ap_slotmem_instance_t *s, unsigned int item_id, void**mem)
get the direct pointer to the memory associated with this worker slot.
-
apr_status_t lock(ap_slotmem_instance_t *s)
-
lock the memory segment
+
apr_status_t get(ap_slotmem_instance_t *s, unsigned int item_id, unsigned char *dest, apr_size_t dest_len)
+
get/read the memory from this slot to dest
-
(apr_status_t unlock(ap_slotmem_instance_t *s)
-
unlock the memory segment
+
apr_status_t put(ap_slotmem_instance_t *slot, unsigned int item_id, unsigned char *src, apr_size_t src_len)
+
put/write the data from src to this slot
+ +
unsigned int num_slots(ap_slotmem_instance_t *s)
+
return the total number of slots in the segment
+ +
apr_size_t slot_size(ap_slotmem_instance_t *s)
+
return the total data size, in bytes, of a slot in the segment
+ +
apr_status_t grab(ap_slotmem_instance_t *s, unsigned int item_id);
+
grab or allocate a slot and mark as in-use (does not do any data copying)
+ +
apr_status_t release(ap_slotmem_instance_t *s, unsigned int item_id);
+
release or free a slot and mark as not in-use (does not do any data copying)
diff --git a/docs/manual/mod/mod_slotmem_shm.xml b/docs/manual/mod/mod_slotmem_shm.xml index fca2fa3ec2a..49384205697 100644 --- a/docs/manual/mod/mod_slotmem_shm.xml +++ b/docs/manual/mod/mod_slotmem_shm.xml @@ -34,28 +34,39 @@ in which the datasets are organized in "slots."

-

mod_slotmem_shm provides the following - API functions: +

mod_slotmem_shm provides the following API functions:

-
apr_status_t do(ap_slotmem_instance_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool)
+
apr_status_t doall(ap_slotmem_instance_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool)
call the callback on all worker slots
-
apr_status_t create(ap_slotmem_instance_t **new, const char *name, apr_size_t item_size, int item_num, apr_pool_t *pool)
+
apr_status_t create(ap_slotmem_instance_t **new, const char *name, apr_size_t item_size, unsigned int item_num, ap_slotmem_type_t type, apr_pool_t *pool)
create a new slotmem with each item size is item_size.
-
apr_status_t attach(ap_slotmem_instance_t **new, const char *name, apr_size_t *item_size, int *item_num, apr_pool_t *pool)
+
apr_status_t attach(ap_slotmem_instance_t **new, const char *name, apr_size_t *item_size, unsigned int *item_num, apr_pool_t *pool)
attach to an existing slotmem.
-
apr_status_t dptr(ap_slotmem_instance_t *s, int item_id, void**mem)
+
apr_status_t dptr(ap_slotmem_instance_t *s, unsigned int item_id, void**mem)
get the direct pointer to the memory associated with this worker slot.
-
apr_status_t lock(ap_slotmem_instance_t *s)
-
lock the memory segment
+
apr_status_t get(ap_slotmem_instance_t *s, unsigned int item_id, unsigned char *dest, apr_size_t dest_len)
+
get/read the memory from this slot to dest
-
(apr_status_t unlock(ap_slotmem_instance_t *s)
-
unlock the memory segment
+
apr_status_t put(ap_slotmem_instance_t *slot, unsigned int item_id, unsigned char *src, apr_size_t src_len)
+
put/write the data from src to this slot
+ +
unsigned int num_slots(ap_slotmem_instance_t *s)
+
return the total number of slots in the segment
+ +
apr_size_t slot_size(ap_slotmem_instance_t *s)
+
return the total data size, in bytes, of a slot in the segment
+ +
apr_status_t grab(ap_slotmem_instance_t *s, unsigned int item_id);
+
grab or allocate a slot and mark as in-use (does not do any data copying)
+ +
apr_status_t release(ap_slotmem_instance_t *s, unsigned int item_id);
+
release or free a slot and mark as not in-use (does not do any data copying)
diff --git a/include/ap_slotmem.h b/include/ap_slotmem.h index 3863810b685..0705e92a96c 100644 --- a/include/ap_slotmem.h +++ b/include/ap_slotmem.h @@ -124,7 +124,7 @@ struct ap_slotmem_provider_t { */ apr_status_t (* dptr)(ap_slotmem_instance_t *s, unsigned int item_id, void**mem); /** - * retrieve the memory associated with this worker slot. + * get/read the memory associated with this worker slot. * @param s ap_slotmem_instance_t to use. * @param item_id item to return for 0 to item_num * @param dest address to store the data @@ -133,7 +133,7 @@ struct ap_slotmem_provider_t { */ apr_status_t (* get)(ap_slotmem_instance_t *s, unsigned int item_id, unsigned char *dest, apr_size_t dest_len); /** - * store the memory associated with this worker slot. + * put/write the memory associated with this worker slot. * @param s ap_slotmem_instance_t to use. * @param item_id item to return for 0 to item_num * @param src address of the data to store in the slot