From: Jim Jagielski Date: Fri, 15 May 2009 14:37:10 +0000 (+0000) Subject: 1st step of man changes for slotmem refactor X-Git-Tag: 2.3.3~582 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=f54f524675e5453eab4cd46bdd1f30b1f87c4014;p=apache 1st step of man changes for slotmem refactor git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@775157 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/mod/mod_plainmem.xml b/docs/manual/mod/mod_plainmem.xml index 1fc088288b..be327fbbd3 100644 --- a/docs/manual/mod/mod_plainmem.xml +++ b/docs/manual/mod/mod_plainmem.xml @@ -20,25 +20,23 @@ limitations under the License. --> - + -mod_plainmem +mod_slotmem_shm Slot-based shared memory provider. Extension -mod_plainmem.c -plainmem_module +mod_slotmem_shm.c +mod_slotmem_shm_module

-

mod_plainmem is a memory provider which +

mod_slotmem_shm is a memory provider which provides for creation and access to a plain memory segment - in which the datasets are organized in "slots." Although - it can be used directly, normally mod_slotmem - is used as a front-end. + in which the datasets are organized in "slots."

If the memory needs to be shared between threads and processes, a better provider would be - mod_sharedmem. + mod_slotmem_plain.

mod_plainmem provides the following @@ -46,22 +44,22 @@

apr_status_t slotmem_do(ap_slotmem_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool)
apr_status_t do(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 slotmem_create(ap_slotmem_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, int item_num, apr_pool_t *pool): create a new slotmem with each item size is item_size.
apr_status_t slotmem_attach(ap_slotmem_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, int *item_num, apr_pool_t *pool): attach to an existing slotmem.
apr_status_t slotmem_mem(ap_slotmem_t *s, int item_id, void**mem): get the memory associated with this worker slot.
apr_status_t dptr(ap_slotmem_instance_t *s, int item_id, void**mem): get the direct pointer to the memory associated with this worker slot.
apr_status_t slotmem_lock(ap_slotmem_t *s)
apr_status_t lock(ap_slotmem_instance_t *s): lock the memory segment
(apr_status_t slotmem_unlock(ap_slotmem_t *s)
(apr_status_t unlock(ap_slotmem_instance_t *s): unlock the memory segment

diff --git a/docs/manual/mod/mod_sharedmem.xml b/docs/manual/mod/mod_sharedmem.xml index 6b9b244179..3d5e01ac86 100644 --- a/docs/manual/mod/mod_sharedmem.xml +++ b/docs/manual/mod/mod_sharedmem.xml @@ -20,20 +20,18 @@ limitations under the License. --> - + -mod_sharedmem +mod_slotmem_shm Slot-based shared memory provider. Extension -mod_sharedmem.c -sharedmem_module +mod_slotmem_shm.c +mod_slotmem_shm_module

-

mod_sharedmem is a memory provider which +

mod_slotmem_shm is a memory provider which provides for creation and access to a shared memory segment - in which the datasets are organized in "slots." Although - it can be used directly, normally mod_slotmem - is used as a front-end. + in which the datasets are organized in "slots."

mod_sharedmem provides the following @@ -41,22 +39,22 @@

apr_status_t slotmem_do(ap_slotmem_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool)
apr_status_t do(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 slotmem_create(ap_slotmem_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, int item_num, apr_pool_t *pool): create a new slotmem with each item size is item_size.
apr_status_t slotmem_attach(ap_slotmem_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, int *item_num, apr_pool_t *pool): attach to an existing slotmem.
apr_status_t slotmem_mem(ap_slotmem_t *s, int item_id, void**mem): get the memory associated with this worker slot.
apr_status_t dptr(ap_slotmem_instance_t *s, int item_id, void**mem): get the direct pointer to the memory associated with this worker slot.
apr_status_t slotmem_lock(ap_slotmem_t *s)
apr_status_t lock(ap_slotmem_instance_t *s): lock the memory segment
(apr_status_t slotmem_unlock(ap_slotmem_t *s)
(apr_status_t unlock(ap_slotmem_instance_t *s): unlock the memory segment

diff --git a/docs/manual/mod/mod_slotmem.html b/docs/manual/mod/mod_slotmem.html deleted file mode 100644 index 0c8ad8043d..0000000000 --- a/docs/manual/mod/mod_slotmem.html +++ /dev/null @@ -1,5 +0,0 @@ -# GENERATED FROM XML -- DO NOT EDIT - -URI: mod_slotmem.html.en -Content-Language: en -Content-type: text/html; charset=ISO-8859-1 diff --git a/docs/manual/mod/mod_slotmem.html.en b/docs/manual/mod/mod_slotmem.html.en deleted file mode 100644 index 3724aafbdc..0000000000 --- a/docs/manual/mod/mod_slotmem.html.en +++ /dev/null @@ -1,83 +0,0 @@ - - - -mod_slotmem - Apache HTTP Server - - - - - - -

-

-Apache > HTTP Server > Documentation > Version 2.3 > Modules

-

-

Apache Module mod_slotmem

-

-

Available Languages: en

-

- - - -

Description:	Slot-based memory implementation API.
Status:	Extension
Module Identifier:	slotmem_module
Source File:	mod_slotmem.c

-

Summary

- -

mod_slotmem provides an interface to a - memory allocation implementation which is based on the - concept of datasets being in various "slots" within - a larger memory segment. As such, it is similar in - concept to a generic table or array. The real use of - the module is as a front-end to various providers - (such as mod_sharedmem) which deal - with the actual implementations. This allows modules - to use a single API for memory usage, to matter what - the underlying implementation is. -

- -

mod_slotmem provides the following - API functions: -

- -

ap_slotmem_storage_method *ap_slotmem_method(const char *provider): obtain the provider method desired
apr_status_t ap_slotmem_do(ap_slotmem_storage_method *sm, ap_slotmem_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool): call the callback on all worker slots
apr_status_t ap_slotmem_create(ap_slotmem_storage_method *sm, ap_slotmem_t **new, const char *name, apr_size_t item_size, int item_num, apr_pool_t *pool): create a new slotmem with each item size is item_size.
apr_status_t ap_slotmem_attach(ap_slotmem_storage_method *sm, ap_slotmem_t **new, const char *name, apr_size_t *item_size, int *item_num, apr_pool_t *pool): attach to an existing slotmem.
apr_status_t ap_slotmem_mem(ap_slotmem_storage_method *sm, ap_slotmem_t *s, int item_id, void**mem): get the memory associated with this worker slot.
apr_status_t ap_slotmem_lock(ap_slotmem_storage_method *sm, ap_slotmem_t *s): lock the memory segment
(apr_status_t ap_slotmem_unlock(ap_slotmem_storage_method *sm, ap_slotmem_t *s): unlock the memory segment

- -

-

Directives

-

This module provides no - directives.

-

- -

-

-

Available Languages: en

-

- \ No newline at end of file diff --git a/docs/manual/mod/mod_slotmem.xml b/docs/manual/mod/mod_slotmem.xml deleted file mode 100644 index 8d6b8854ac..0000000000 --- a/docs/manual/mod/mod_slotmem.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - - - -mod_slotmem -Slot-based memory implementation API. -Extension -mod_slotmem.c -slotmem_module - -

-

mod_slotmem provides an interface to a - memory allocation implementation which is based on the - concept of datasets being in various "slots" within - a larger memory segment. As such, it is similar in - concept to a generic table or array. The real use of - the module is as a front-end to various providers - (such as mod_sharedmem) which deal - with the actual implementations. This allows modules - to use a single API for memory usage, to matter what - the underlying implementation is. -

- -

mod_slotmem provides the following - API functions: -

- -

ap_slotmem_storage_method *ap_slotmem_method(const char *provider): obtain the provider method desired
apr_status_t ap_slotmem_do(ap_slotmem_storage_method *sm, ap_slotmem_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool): call the callback on all worker slots
apr_status_t ap_slotmem_create(ap_slotmem_storage_method *sm, ap_slotmem_t **new, const char *name, apr_size_t item_size, int item_num, apr_pool_t *pool): create a new slotmem with each item size is item_size.
apr_status_t ap_slotmem_attach(ap_slotmem_storage_method *sm, ap_slotmem_t **new, const char *name, apr_size_t *item_size, int *item_num, apr_pool_t *pool): attach to an existing slotmem.
apr_status_t ap_slotmem_mem(ap_slotmem_storage_method *sm, ap_slotmem_t *s, int item_id, void**mem): get the memory associated with this worker slot.
apr_status_t ap_slotmem_lock(ap_slotmem_storage_method *sm, ap_slotmem_t *s): lock the memory segment
(apr_status_t ap_slotmem_unlock(ap_slotmem_storage_method *sm, ap_slotmem_t *s): unlock the memory segment

- -

- - diff --git a/docs/manual/mod/mod_slotmem.xml.meta b/docs/manual/mod/mod_slotmem.xml.meta deleted file mode 100644 index 253bca1bf2..0000000000 --- a/docs/manual/mod/mod_slotmem.xml.meta +++ /dev/null @@ -1,12 +0,0 @@ - - - - - mod_slotmem - /mod/ - .. - - - en - -