1
0
mirror of https://github.com/apache/httpd.git synced 2025-11-06 16:49:32 +03:00
Files
apache/docs/manual/mod/mod_sharedmem.xml
André Malo 52956ee79b fixup properties
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@768069 13f79535-47bb-0310-9956-ffa450edef68
2009-04-23 21:54:09 +00:00

66 lines
2.5 KiB
XML

<?xml version="1.0"?>
<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
<!-- $LastChangedRevision$ -->
<!--
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>