summaryrefslogtreecommitdiffstats
path: root/docs/manual/mod/mod_slotmem_shm.html.en
diff options
context:
space:
mode:
authorAndré Malo <nd@apache.org>2009-06-07 15:03:50 +0200
committerAndré Malo <nd@apache.org>2009-06-07 15:03:50 +0200
commit6b4c0b4280aac374134059d3a6c9d8cd3f2b3b3e (patch)
tree41f5785cf7c68287fdafc656db12ec50d8cf760a /docs/manual/mod/mod_slotmem_shm.html.en
parentapparently a paste error (diff)
downloadapache2-6b4c0b4280aac374134059d3a6c9d8cd3f2b3b3e.tar.xz
apache2-6b4c0b4280aac374134059d3a6c9d8cd3f2b3b3e.zip
update transformation
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@782383 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'docs/manual/mod/mod_slotmem_shm.html.en')
-rw-r--r--docs/manual/mod/mod_slotmem_shm.html.en84
1 files changed, 84 insertions, 0 deletions
diff --git a/docs/manual/mod/mod_slotmem_shm.html.en b/docs/manual/mod/mod_slotmem_shm.html.en
new file mode 100644
index 0000000000..f8d246c019
--- /dev/null
+++ b/docs/manual/mod/mod_slotmem_shm.html.en
@@ -0,0 +1,84 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
+ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ This file is generated from xml source: DO NOT EDIT
+ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ -->
+<title>mod_slotmem_shm - Apache HTTP Server</title>
+<link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
+<link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
+<link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
+<link href="../images/favicon.ico" rel="shortcut icon" /></head>
+<body>
+<div id="page-header">
+<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
+<p class="apache">Apache HTTP Server Version 2.3</p>
+<img alt="" src="../images/feather.gif" /></div>
+<div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
+<div id="path">
+<a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.3</a> &gt; <a href="./">Modules</a></div>
+<div id="page-content">
+<div id="preamble"><h1>Apache Module mod_slotmem_shm</h1>
+<div class="toplang">
+<p><span>Available Languages: </span><a href="../en/mod/mod_slotmem_shm.html" title="English">&nbsp;en&nbsp;</a></p>
+</div>
+<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Slot-based shared memory provider.</td></tr>
+<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
+<tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>mod_slotmem_shm_module</td></tr>
+<tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_slotmem_shm.c</td></tr></table>
+<h3>Summary</h3>
+
+ <p><code>mod_slotmem_shm</code> is a memory provider which
+ provides for creation and access to a shared memory segment
+ in which the datasets are organized in "slots."
+ </p>
+
+ <p><code>mod_slotmem_shm</code> provides the following API functions:
+ </p>
+
+ <dl>
+ <dt>apr_status_t doall(ap_slotmem_instance_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 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>
+
+ <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>
+
+ <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>
+
+ <dt>apr_status_t get(ap_slotmem_instance_t *s, unsigned int item_id, unsigned char *dest, apr_size_t dest_len)</dt>
+ <dd>get/read the memory from this slot to dest</dd>
+
+ <dt>apr_status_t put(ap_slotmem_instance_t *slot, unsigned int item_id, unsigned char *src, apr_size_t src_len)</dt>
+ <dd>put/write the data from src to this slot</dd>
+
+ <dt>unsigned int num_slots(ap_slotmem_instance_t *s)</dt>
+ <dd>return the total number of slots in the segment</dd>
+
+ <dt>apr_size_t slot_size(ap_slotmem_instance_t *s)</dt>
+ <dd>return the total data size, in bytes, of a slot in the segment</dd>
+
+ <dt>apr_status_t grab(ap_slotmem_instance_t *s, unsigned int item_id);</dt>
+ <dd>grab or allocate a slot and mark as in-use (does not do any data copying)</dd>
+
+ <dt>apr_status_t release(ap_slotmem_instance_t *s, unsigned int item_id);</dt>
+ <dd>release or free a slot and mark as not in-use (does not do any data copying)</dd>
+ </dl>
+
+</div>
+<div id="quickview"><h3 class="directives">Directives</h3>
+<p>This module provides no
+ directives.</p>
+</div>
+
+</div>
+<div class="bottomlang">
+<p><span>Available Languages: </span><a href="../en/mod/mod_slotmem_shm.html" title="English">&nbsp;en&nbsp;</a></p>
+</div><div id="footer">
+<p class="apache">Copyright 2009 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
+<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
+</body></html> \ No newline at end of file