mod_slotmem_shm.html.en revision 30471a4650391f57975f60bbb6e4a90be7b284bf
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd This file is generated from xml source: DO NOT EDIT
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<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" />
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen<script src="/style/scripts/prettify.js" type="text/javascript">
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<link href="/images/favicon.ico" rel="shortcut icon" /></head>
d229f940abfb2490dee17979e9a5ff31b7012eb5rbowen<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>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div>
3f08db06526d6901aa08c110b5bc7dde6bc39905nd<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>
f086b4b402fa9a2fefc7dda85de2a3cc1cd0a654rjung<p><span>Available Languages: </span><a href="/en/mod/mod_slotmem_shm.html" title="English"> en </a></p>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Slot-based shared memory provider.</td></tr>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>mod_slotmem_shm_module</td></tr>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_slotmem_shm.c</td></tr></table>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd <p><code>mod_slotmem_shm</code> is a memory provider which
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd provides for creation and access to a shared memory segment
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd in which the datasets are organized in "slots."
5da7a94d6237c66b561dfa4add47a3f954ed39e5minfrin <p>All shared memory is cleared and cleaned with each
5da7a94d6237c66b561dfa4add47a3f954ed39e5minfrin restart, whether graceful or not. The data itself is
5da7a94d6237c66b561dfa4add47a3f954ed39e5minfrin stored and restored within a file noted by the <code>name</code>
5da7a94d6237c66b561dfa4add47a3f954ed39e5minfrin parameter in the <code>create</code> and <code>attach</code>
0734f81384d5f2528bb119f89d135043a280d5b2minfrin calls. If not specified with an absolute path, the file will be
0734f81384d5f2528bb119f89d135043a280d5b2minfrin created relative to the path specified by the
0734f81384d5f2528bb119f89d135043a280d5b2minfrin <code class="directive"><a href="/mod/core.html#defaultruntimedir">DefaultRuntimeDir</a></code> directive.
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd <p><code>mod_slotmem_shm</code> provides the following API functions:
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd <dt>apr_status_t doall(ap_slotmem_instance_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool)</dt>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd <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>
5da7a94d6237c66b561dfa4add47a3f954ed39e5minfrin <dd>create a new slotmem with each item size is item_size. <code>name</code> is the filename for the persistent store of
5da7a94d6237c66b561dfa4add47a3f954ed39e5minfrin the shared memory. Values are:
5da7a94d6237c66b561dfa4add47a3f954ed39e5minfrin <dd><code>Does not persist shared memory in file.</code></dd>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd <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>
5da7a94d6237c66b561dfa4add47a3f954ed39e5minfrin <dd>attach to an existing slotmem. See <code>create</code> for description of <code>name</code> parameter.</dd>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd <dt>apr_status_t dptr(ap_slotmem_instance_t *s, unsigned int item_id, void**mem)</dt>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd <dd>get the direct pointer to the memory associated with this worker slot.</dd>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd <dt>apr_status_t get(ap_slotmem_instance_t *s, unsigned int item_id, unsigned char *dest, apr_size_t dest_len)</dt>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd <dt>apr_status_t put(ap_slotmem_instance_t *slot, unsigned int item_id, unsigned char *src, apr_size_t src_len)</dt>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd <dt>unsigned int num_slots(ap_slotmem_instance_t *s)</dt>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd <dd>return the total data size, in bytes, of a slot in the segment</dd>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd <dt>apr_status_t grab(ap_slotmem_instance_t *s, unsigned int item_id);</dt>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd <dd>grab or allocate a slot and mark as in-use (does not do any data copying)</dd>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd <dt>apr_status_t release(ap_slotmem_instance_t *s, unsigned int item_id);</dt>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd <dd>release or free a slot and mark as not in-use (does not do any data copying)</dd>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<div id="quickview"><h3 class="directives">Directives</h3>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<p>This module provides no
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd directives.</p>
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh<ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
f086b4b402fa9a2fefc7dda85de2a3cc1cd0a654rjung<p><span>Available Languages: </span><a href="/en/mod/mod_slotmem_shm.html" title="English"> en </a></p>
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh</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
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedoohto last beyond the testing phase of this system, nor do we in any way guarantee that we'll read them.</div><div id="disqus_thread" /><script type="text/javascript"><!--//--><![CDATA[//><!--
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedoohvar lang = 'en';
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedoohvar disqus_shortname = 'httpd';
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedoohvar disqus_identifier = window.location.href.replace(/(current|trunk)/, "2.4").replace(/\/[a-z]{2}\//, "/").replace(window.location.protocol, "http:") + '.' + lang;
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedoohif (disqus_identifier.indexOf("httpd.apache.org") != -1) {
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh (function() {
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh dsq.src = window.location.protocol + '//' + disqus_shortname + '.disqus.com/embed.js';
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh var text = document.createTextNode("Comments have been disabled for offline viewing.");
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh document.getElementById('disqus_thread').appendChild(text);
5effc8b39fae5cd169d17f342bfc265705840014rbowen<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>
d229f940abfb2490dee17979e9a5ff31b7012eb5rbowen<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[//><!--
7fec19672a491661b2fe4b29f685bc7f4efa64d4ndif (typeof(prettyPrint) !== undefined) {
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd prettyPrint();