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 2008/12/31 14:22:54 UTC
svn commit: r730386 - in /httpd/httpd/trunk/docs/manual/mod:
mod_plainmem.xml mod_sharedmem.xml mod_slotmem.xml
Author: jim
Date: Wed Dec 31 05:22:54 2008
New Revision: 730386
URL: http://svn.apache.org/viewvc?rev=730386&view=rev
Log:
Stubs for slot/shared/plain memory modules
Added:
httpd/httpd/trunk/docs/manual/mod/mod_plainmem.xml (with props)
httpd/httpd/trunk/docs/manual/mod/mod_sharedmem.xml (with props)
httpd/httpd/trunk/docs/manual/mod/mod_slotmem.xml (with props)
Added: httpd/httpd/trunk/docs/manual/mod/mod_plainmem.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_plainmem.xml?rev=730386&view=auto
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_plainmem.xml (added)
+++ httpd/httpd/trunk/docs/manual/mod/mod_plainmem.xml Wed Dec 31 05:22:54 2008
@@ -0,0 +1,70 @@
+<?xml version="1.0"?>
+<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
+<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
+<!-- $LastChangedRevision: 559006 $ -->
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<modulesynopsis metafile="mod_plainmem.xml.meta">
+
+<name>mod_plainmem</name>
+<description>Slot-based shared memory provider.</description>
+<status>Extension</status>
+<sourcefile>mod_plainmem.c</sourcefile>
+<identifier>plainmem_module</identifier>
+
+<summary>
+ <p><code>mod_plainmem</code> 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 <module>mod_slotmem</module>
+ is used as a front-end.
+ </p>
+
+ <p>If the memory needs to be shared between threads and
+ processes, a better provider would be
+ <module>mod_sharedmem</module>.
+ </p>
+
+ <p><code>mod_plainmem</code> provides the following
+ API functions:
+ </p>
+
+ <dl>
+ <dt>apr_status_t slotmem_do(ap_slotmem_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 slotmem_create(ap_slotmem_t **new, const char *name, apr_size_t item_size, int item_num, apr_pool_t *pool)</dt>
+ <dd>create a new slotmem with each item size is item_size.</dd>
+
+ <dt>apr_status_t slotmem_attach(ap_slotmem_t **new, const char *name, apr_size_t *item_size, int *item_num, apr_pool_t *pool)</dt>
+ <dd>attach to an existing slotmem.</dd>
+
+ <dt>apr_status_t slotmem_mem(ap_slotmem_t *s, int item_id, void**mem)</dt>
+ <dd>get the memory associated with this worker slot.</dd>
+
+ <dt>apr_status_t slotmem_lock(ap_slotmem_t *s)</dt>
+ <dd>lock the memory segment</dd>
+
+ <dt>(apr_status_t slotmem_unlock(ap_slotmem_t *s)</dt>
+ <dd>unlock the memory segment</dd>
+ </dl>
+
+</summary>
+
+</modulesynopsis>
Propchange: httpd/httpd/trunk/docs/manual/mod/mod_plainmem.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: httpd/httpd/trunk/docs/manual/mod/mod_sharedmem.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_sharedmem.xml?rev=730386&view=auto
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_sharedmem.xml (added)
+++ httpd/httpd/trunk/docs/manual/mod/mod_sharedmem.xml Wed Dec 31 05:22:54 2008
@@ -0,0 +1,65 @@
+<?xml version="1.0"?>
+<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
+<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
+<!-- $LastChangedRevision: 559006 $ -->
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<modulesynopsis metafile="mod_sharedmem.xml.meta">
+
+<name>mod_sharedmem</name>
+<description>Slot-based shared memory provider.</description>
+<status>Extension</status>
+<sourcefile>mod_sharedmem.c</sourcefile>
+<identifier>sharedmem_module</identifier>
+
+<summary>
+ <p><code>mod_sharedmem</code> 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 <module>mod_slotmem</module>
+ is used as a front-end.
+ </p>
+
+ <p><code>mod_sharedmem</code> provides the following
+ API functions:
+ </p>
+
+ <dl>
+ <dt>apr_status_t slotmem_do(ap_slotmem_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 slotmem_create(ap_slotmem_t **new, const char *name, apr_size_t item_size, int item_num, apr_pool_t *pool)</dt>
+ <dd>create a new slotmem with each item size is item_size.</dd>
+
+ <dt>apr_status_t slotmem_attach(ap_slotmem_t **new, const char *name, apr_size_t *item_size, int *item_num, apr_pool_t *pool)</dt>
+ <dd>attach to an existing slotmem.</dd>
+
+ <dt>apr_status_t slotmem_mem(ap_slotmem_t *s, int item_id, void**mem)</dt>
+ <dd>get the memory associated with this worker slot.</dd>
+
+ <dt>apr_status_t slotmem_lock(ap_slotmem_t *s)</dt>
+ <dd>lock the memory segment</dd>
+
+ <dt>(apr_status_t slotmem_unlock(ap_slotmem_t *s)</dt>
+ <dd>unlock the memory segment</dd>
+ </dl>
+
+</summary>
+
+</modulesynopsis>
Propchange: httpd/httpd/trunk/docs/manual/mod/mod_sharedmem.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: httpd/httpd/trunk/docs/manual/mod/mod_slotmem.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_slotmem.xml?rev=730386&view=auto
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_slotmem.xml (added)
+++ httpd/httpd/trunk/docs/manual/mod/mod_slotmem.xml Wed Dec 31 05:22:54 2008
@@ -0,0 +1,73 @@
+<?xml version="1.0"?>
+<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
+<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
+<!-- $LastChangedRevision: 559006 $ -->
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<modulesynopsis metafile="mod_slotmem.xml.meta">
+
+<name>mod_slotmem</name>
+<description>Slot-based memory implementation API.</description>
+<status>Extension</status>
+<sourcefile>mod_slotmem.c</sourcefile>
+<identifier>slotmem_module</identifier>
+
+<summary>
+ <p><code>mod_slotmem</code> 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 <module>mod_sharedmem</module>) which deal
+ with the actual implementations. This allows modules
+ to use a single API for memory usage, to matter what
+ the underlying implementation is.
+ </p>
+
+ <p><code>mod_slotmem</code> provides the following
+ API functions:
+ </p>
+
+ <dl>
+ <dt>ap_slotmem_storage_method *ap_slotmem_method(const char *provider)</dt>
+ <dd>obtain the provider method desired</dd>
+
+ <dt>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)</dt>
+ <dd>call the callback on all worker slots</dd>
+
+ <dt>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)</dt>
+ <dd>create a new slotmem with each item size is item_size.</dd>
+
+ <dt>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)</dt>
+ <dd>attach to an existing slotmem.</dd>
+
+ <dt>apr_status_t ap_slotmem_mem(ap_slotmem_storage_method *sm, ap_slotmem_t *s, int item_id, void**mem)</dt>
+ <dd>get the memory associated with this worker slot.</dd>
+
+ <dt>apr_status_t ap_slotmem_lock(ap_slotmem_storage_method *sm, ap_slotmem_t *s)</dt>
+ <dd>lock the memory segment</dd>
+
+ <dt>(apr_status_t ap_slotmem_unlock(ap_slotmem_storage_method *sm, ap_slotmem_t *s)</dt>
+ <dd>unlock the memory segment</dd>
+ </dl>
+
+</summary>
+
+</modulesynopsis>
Propchange: httpd/httpd/trunk/docs/manual/mod/mod_slotmem.xml
------------------------------------------------------------------------------
svn:eol-style = native