From: Jim Jagielski <jim@apache.org>
Date: Mon, 27 Sep 2010 17:22:58 +0000 (+0000)
Subject: Update doccos and explain clear/clean of shared mem
X-Git-Tag: 2.3.9~410
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=69a6715e4b500abdbac15c425cd366e5a3f115d9;p=thirdparty%2Fapache%2Fhttpd.git

Update doccos and explain clear/clean of shared mem
as well as persist


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1001824 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/docs/manual/mod/mod_slotmem_shm.xml b/docs/manual/mod/mod_slotmem_shm.xml
index 49384205697..4dad3f10b8e 100644
--- a/docs/manual/mod/mod_slotmem_shm.xml
+++ b/docs/manual/mod/mod_slotmem_shm.xml
@@ -34,6 +34,13 @@
     in which the datasets are organized in "slots."
     </p>
 
+    <p>All shared memory is cleared and cleaned with each
+    restart, whether graceful or not. The data itself is
+    stored and restored within a file noted by the <code>name</code>
+    parameter in the <code>create</code> and <code>attach</code>
+    calls.
+    </p>
+
     <p><code>mod_slotmem_shm</code> provides the following API functions:
     </p>
 
@@ -42,10 +49,19 @@
       <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, 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>
+      <dd>create a new slotmem with each item size is item_size. <code>name</code> is the filename for the persistant store of
+      the shared memory. Values are:
+       <dl>
+         <dt><code>anonymous</code></dt>
+         <dd><code>$server_root/logs/anonymous.slotmem</code></dd>
+         <dt><code>:module_name.c</code></dt>
+         <dd><code>$server_root/logs/module_name.c.slotmem</code></dd>
+         <dt><code>"absolute-file-name"</code></dt>
+         <dd><code>$absolute-file-name.slotmem</code></dd>
+       </dl>
 
       <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>
+      <dd>attach to an existing slotmem. See <code>create</code> for description of <code>name</code> parameter.</dd>
 
       <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>