mod_slotmem_shm.html.en revision 19737f4fbef1805f9c3e9e045bb6d710a1e5e10f
<?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">
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 rel="stylesheet" type="text/css" href="/style/css/prettify.css" />
</script>
<body>
<div id="page-header">
<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p>
<p class="apache">Apache HTTP Server Version 2.5</p>
<div id="path">
<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.5</a> > <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"> en </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#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>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 <code>name</code>
parameter in the <code>create</code> and <code>attach</code>
calls. If not specified with an absolute path, the file will be
created relative to the path specified by the
<code class="directive"><a href="/mod/core.html#defaultruntimedir">DefaultRuntimeDir</a></code> directive.
</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. <code>name</code> is the filename for the persistent store of
the shared memory. Values are:
<dl>
<dt><code>"none"</code></dt>
<dd><code>Does not persist shared memory in file.</code></dd>
<dt><code>"file-name"</code></dt>
<dd><code>[DefaultRuntimeDir]/file-name</code></dd>
<dt><code>"/absolute-file-name"</code></dt>
<dd><code>Absolute file name</code></dd>
</dl></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. See <code>create</code> for description of <code>name</code> parameter.</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>
<dt>apr_status_t put(ap_slotmem_instance_t *slot, unsigned int item_id, unsigned char *src, apr_size_t src_len)</dt>
<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>
<ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
</div>
<div class="bottomlang">
<p><span>Available Languages: </span><a href="/en/mod/mod_slotmem_shm.html" title="English"> en </a></p>
</div><div class="top"><a href="#page-header"><img src="/images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>This section is experimental!</strong><br />Comments placed here should not be expected
to last beyond the testing phase of this system, nor do we in any way guarantee that we'll read them.</div>
var lang = 'en';
var disqus_shortname = 'httpd';
var disqus_identifier = window.location.href.replace(/(current|trunk)/, "2.4").replace(/\/[a-z]{2}\//, "/").replace(window.location.protocol, "http:") + '.' + lang;
if (disqus_identifier.indexOf("httpd.apache.org") == -1) {
document.write('<div id="disqus_thread">\n</div>');
(function() {
var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
dsq.src = window.location.protocol + '//' + disqus_shortname + '.disqus.com/embed.js';
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
})();
} else {
document.write("Comments have been disabled for offline viewing.");
}
//--><!]]></script></div><div id="footer">
<p class="apache">Copyright 2012 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="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
if (typeof(prettyPrint) !== undefined) {
prettyPrint();
}
//--><!]]></script>
</body></html>