From 69a6715e4b500abdbac15c425cd366e5a3f115d9 Mon Sep 17 00:00:00 2001 From: Jim Jagielski Date: Mon, 27 Sep 2010 17:22:58 +0000 Subject: [PATCH] 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 --- docs/manual/mod/mod_slotmem_shm.xml | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/docs/manual/mod/mod_slotmem_shm.xml b/docs/manual/mod/mod_slotmem_shm.xml index 4938420569..4dad3f10b8 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."

+

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 name + parameter in the create and attach + calls. +

+

mod_slotmem_shm provides the following API functions:

@@ -42,10 +49,19 @@
call the callback on all worker slots
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.
+
create a new slotmem with each item size is item_size. name is the filename for the persistant store of + the shared memory. Values are: +
+
anonymous
+
$server_root/logs/anonymous.slotmem
+
:module_name.c
+
$server_root/logs/module_name.c.slotmem
+
"absolute-file-name"
+
$absolute-file-name.slotmem
+
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.
+
attach to an existing slotmem. See create for description of name parameter.
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.
-- 2.50.1