mod_slotmem_shm.html.en revision f2dddcb17c7d7e94cc69563d3c99f9d035224ecc
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin This file is generated from xml source: DO NOT EDIT
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen<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" />
2e545ce2450a9953665f701bb05350f0d3f26275nd<script src="/style/scripts/prettify.js" type="text/javascript">
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<link href="/images/favicon.ico" rel="shortcut icon" /></head>
af33a4994ae2ff15bc67d19ff1a7feb906745bf8rbowen<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>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<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>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<div id="preamble"><h1>Apache Module mod_slotmem_shm</h1>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<p><span>Available Languages: </span><a href="/en/mod/mod_slotmem_shm.html" title="English"> en </a></p>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Slot-based shared memory provider.</td></tr>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
f2dddcb17c7d7e94cc69563d3c99f9d035224ecctrawick<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>slotmem_shm_module</td></tr>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_slotmem_shm.c</td></tr></table>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin <p><code>mod_slotmem_shm</code> is a memory provider which
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin provides for creation and access to a shared memory segment
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin in which the datasets are organized in "slots."
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin <p>All shared memory is cleared and cleaned with each
210ea17a1c4f5dc5b238e54499142d151aea7608covener restart, whether graceful or not. The data itself is
210ea17a1c4f5dc5b238e54499142d151aea7608covener stored and restored within a file noted by the <code>name</code>
210ea17a1c4f5dc5b238e54499142d151aea7608covener parameter in the <code>create</code> and <code>attach</code>
210ea17a1c4f5dc5b238e54499142d151aea7608covener calls. If not specified with an absolute path, the file will be
210ea17a1c4f5dc5b238e54499142d151aea7608covener created relative to the path specified by the
210ea17a1c4f5dc5b238e54499142d151aea7608covener <code class="directive"><a href="/mod/core.html#defaultruntimedir">DefaultRuntimeDir</a></code> directive.
210ea17a1c4f5dc5b238e54499142d151aea7608covener <p><code>mod_slotmem_shm</code> provides the following API functions:
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin <dt>apr_status_t doall(ap_slotmem_instance_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool)</dt>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin <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>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin <dd>create a new slotmem with each item size is item_size. <code>name</code> is the filename for the persistent store of
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin the shared memory. Values are:
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin <dd><code>Does not persist shared memory in file.</code></dd>
cc7e1025de9ac63bd4db6fe7f71c158b2cf09fe4humbedooh <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>
0d0ba3a410038e179b695446bb149cce6264e0abnd <dd>attach to an existing slotmem. See <code>create</code> for description of <code>name</code> parameter.</dd>
727872d18412fc021f03969b8641810d8896820bhumbedooh <dt>apr_status_t dptr(ap_slotmem_instance_t *s, unsigned int item_id, void**mem)</dt>
0d0ba3a410038e179b695446bb149cce6264e0abnd <dd>get the direct pointer to the memory associated with this worker slot.</dd>
0d0ba3a410038e179b695446bb149cce6264e0abnd <dt>apr_status_t get(ap_slotmem_instance_t *s, unsigned int item_id, unsigned char *dest, apr_size_t dest_len)</dt>
ac082aefa89416cbdc9a1836eaf3bed9698201c8humbedooh <dd>get/read the memory from this slot to dest</dd>
0d0ba3a410038e179b695446bb149cce6264e0abnd <dt>apr_status_t put(ap_slotmem_instance_t *slot, unsigned int item_id, unsigned char *src, apr_size_t src_len)</dt>
0d0ba3a410038e179b695446bb149cce6264e0abnd <dt>unsigned int num_slots(ap_slotmem_instance_t *s)</dt>
07dc96d063d49299da433f84b5c5681da9bbdf68rbowen <dt>apr_size_t slot_size(ap_slotmem_instance_t *s)</dt>
af33a4994ae2ff15bc67d19ff1a7feb906745bf8rbowen <dd>return the total data size, in bytes, of a slot in the segment</dd>
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd <dt>apr_status_t grab(ap_slotmem_instance_t *s, unsigned int item_id);</dt>
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd <dd>grab or allocate a slot and mark as in-use (does not do any data copying)</dd>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin <dt>apr_status_t release(ap_slotmem_instance_t *s, unsigned int item_id);</dt>
<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>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_slotmem_shm.html';
if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
d.write('<div id="comments_thread"><\/div>');
var s = d.createElement('script');
s.type = 'text/javascript';
s.async = true;
s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
(d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
<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[//><!--