You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by ji...@apache.org on 2009/05/15 20:21:12 UTC
svn commit: r775272 - in /httpd/httpd/trunk:
docs/manual/mod/mod_slotmem_plain.xml docs/manual/mod/mod_slotmem_shm.xml
include/ap_slotmem.h
Author: jim
Date: Fri May 15 18:21:12 2009
New Revision: 775272
URL: http://svn.apache.org/viewvc?rev=775272&view=rev
Log:
dditional docco changes... No functional changes
Modified:
httpd/httpd/trunk/docs/manual/mod/mod_slotmem_plain.xml
httpd/httpd/trunk/docs/manual/mod/mod_slotmem_shm.xml
httpd/httpd/trunk/include/ap_slotmem.h
Modified: httpd/httpd/trunk/docs/manual/mod/mod_slotmem_plain.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_slotmem_plain.xml?rev=775272&r1=775271&r2=775272&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_slotmem_plain.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_slotmem_plain.xml Fri May 15 18:21:12 2009
@@ -39,28 +39,39 @@
<module>mod_slotmem_shm</module>.
</p>
- <p><code>mod_slotmem_plain</code> provides the following
- API functions:
+ <p><code>mod_slotmem_plain</code> provides the following API functions:
</p>
<dl>
- <dt>apr_status_t do(ap_slotmem_instance_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool)</dt>
+ <dt>apr_status_t doall(ap_slotmem_instance_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool)</dt>
<dd>call the callback on all worker slots</dd>
- <dt>apr_status_t create(ap_slotmem_instance_t **new, const char *name, apr_size_t item_size, int item_num, apr_pool_t *pool)</dt>
+ <dt>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)</dt>
<dd>create a new slotmem with each item size is item_size.</dd>
- <dt>apr_status_t attach(ap_slotmem_instance_t **new, const char *name, apr_size_t *item_size, int *item_num, apr_pool_t *pool)</dt>
+ <dt>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)</dt>
<dd>attach to an existing slotmem.</dd>
- <dt>apr_status_t dptr(ap_slotmem_instance_t *s, int item_id, void**mem)</dt>
+ <dt>apr_status_t dptr(ap_slotmem_instance_t *s, unsigned int item_id, void**mem)</dt>
<dd>get the direct pointer to the memory associated with this worker slot.</dd>
- <dt>apr_status_t lock(ap_slotmem_instance_t *s)</dt>
- <dd>lock the memory segment</dd>
+ <dt>apr_status_t get(ap_slotmem_instance_t *s, unsigned int item_id, unsigned char *dest, apr_size_t dest_len)</dt>
+ <dd>get/read the memory from this slot to dest</dd>
- <dt>(apr_status_t unlock(ap_slotmem_instance_t *s)</dt>
- <dd>unlock the memory segment</dd>
+ <dt>apr_status_t put(ap_slotmem_instance_t *slot, unsigned int item_id, unsigned char *src, apr_size_t src_len)</dt>
+ <dd>put/write the data from src to this slot</dd>
+
+ <dt>unsigned int num_slots(ap_slotmem_instance_t *s)</dt>
+ <dd>return the total number of slots in the segment</dd>
+
+ <dt>apr_size_t slot_size(ap_slotmem_instance_t *s)</dt>
+ <dd>return the total data size, in bytes, of a slot in the segment</dd>
+
+ <dt>apr_status_t grab(ap_slotmem_instance_t *s, unsigned int item_id);</dt>
+ <dd>grab or allocate a slot and mark as in-use (does not do any data copying)</dd>
+
+ <dt>apr_status_t release(ap_slotmem_instance_t *s, unsigned int item_id);</dt>
+ <dd>release or free a slot and mark as not in-use (does not do any data copying)</dd>
</dl>
</summary>
Modified: httpd/httpd/trunk/docs/manual/mod/mod_slotmem_shm.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_slotmem_shm.xml?rev=775272&r1=775271&r2=775272&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_slotmem_shm.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_slotmem_shm.xml Fri May 15 18:21:12 2009
@@ -34,28 +34,39 @@
in which the datasets are organized in "slots."
</p>
- <p><code>mod_slotmem_shm</code> provides the following
- API functions:
+ <p><code>mod_slotmem_shm</code> provides the following API functions:
</p>
<dl>
- <dt>apr_status_t do(ap_slotmem_instance_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool)</dt>
+ <dt>apr_status_t doall(ap_slotmem_instance_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool)</dt>
<dd>call the callback on all worker slots</dd>
- <dt>apr_status_t create(ap_slotmem_instance_t **new, const char *name, apr_size_t item_size, int item_num, apr_pool_t *pool)</dt>
+ <dt>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)</dt>
<dd>create a new slotmem with each item size is item_size.</dd>
- <dt>apr_status_t attach(ap_slotmem_instance_t **new, const char *name, apr_size_t *item_size, int *item_num, apr_pool_t *pool)</dt>
+ <dt>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)</dt>
<dd>attach to an existing slotmem.</dd>
- <dt>apr_status_t dptr(ap_slotmem_instance_t *s, int item_id, void**mem)</dt>
+ <dt>apr_status_t dptr(ap_slotmem_instance_t *s, unsigned int item_id, void**mem)</dt>
<dd>get the direct pointer to the memory associated with this worker slot.</dd>
- <dt>apr_status_t lock(ap_slotmem_instance_t *s)</dt>
- <dd>lock the memory segment</dd>
+ <dt>apr_status_t get(ap_slotmem_instance_t *s, unsigned int item_id, unsigned char *dest, apr_size_t dest_len)</dt>
+ <dd>get/read the memory from this slot to dest</dd>
- <dt>(apr_status_t unlock(ap_slotmem_instance_t *s)</dt>
- <dd>unlock the memory segment</dd>
+ <dt>apr_status_t put(ap_slotmem_instance_t *slot, unsigned int item_id, unsigned char *src, apr_size_t src_len)</dt>
+ <dd>put/write the data from src to this slot</dd>
+
+ <dt>unsigned int num_slots(ap_slotmem_instance_t *s)</dt>
+ <dd>return the total number of slots in the segment</dd>
+
+ <dt>apr_size_t slot_size(ap_slotmem_instance_t *s)</dt>
+ <dd>return the total data size, in bytes, of a slot in the segment</dd>
+
+ <dt>apr_status_t grab(ap_slotmem_instance_t *s, unsigned int item_id);</dt>
+ <dd>grab or allocate a slot and mark as in-use (does not do any data copying)</dd>
+
+ <dt>apr_status_t release(ap_slotmem_instance_t *s, unsigned int item_id);</dt>
+ <dd>release or free a slot and mark as not in-use (does not do any data copying)</dd>
</dl>
</summary>
Modified: httpd/httpd/trunk/include/ap_slotmem.h
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/include/ap_slotmem.h?rev=775272&r1=775271&r2=775272&view=diff
==============================================================================
--- httpd/httpd/trunk/include/ap_slotmem.h (original)
+++ httpd/httpd/trunk/include/ap_slotmem.h Fri May 15 18:21:12 2009
@@ -124,7 +124,7 @@
*/
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 @@
*/
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