mod_slotmem_shm.html.en revision fd9abdda70912b99b24e3bf1a38f26fde908a74c
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
fd9abdda70912b99b24e3bf1a38f26fde908a74cnd<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
fd9abdda70912b99b24e3bf1a38f26fde908a74cnd<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd This file is generated from xml source: DO NOT EDIT
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
96ad5d81ee4a2cc66a4ae19893efc8aa6d06fae7jailletc<title>mod_slotmem_shm - Apache HTTP Server Version 2.5</title>
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" />
2e545ce2450a9953665f701bb05350f0d3f26275nd<script src="/style/scripts/prettify.min.js" type="text/javascript">
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<link href="/images/favicon.ico" rel="shortcut icon" /></head>
af33a4994ae2ff15bc67d19ff1a7feb906745bf8rbowen<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/quickreference.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>
f2dddcb17c7d7e94cc69563d3c99f9d035224ecctrawick<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>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>
27a7b74f8c50bd6074b0c71fae9927a71fde5b3fjim <dd>create a new slotmem with each item size is item_size. <code>name</code> is used to generate a filename for the persistent store of
27a7b74f8c50bd6074b0c71fae9927a71fde5b3fjim the shared memory if configured. Values are:
27a7b74f8c50bd6074b0c71fae9927a71fde5b3fjim <dd><code>Anonymous shared memory and no persistent store</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>
27a7b74f8c50bd6074b0c71fae9927a71fde5b3fjim <dt>apr_status_t grab(ap_slotmem_instance_t *s, unsigned int *item_id);</dt>
60b985952fbefc0e3a43dfe6847a6bceee698b58jim <dd>grab or allocate the first free slot and mark as in-use (does not do any data copying)</dd>
60b985952fbefc0e3a43dfe6847a6bceee698b58jim <dt>apr_status_t fgrab(ap_slotmem_instance_t *s, unsigned int item_id);</dt>
60b985952fbefc0e3a43dfe6847a6bceee698b58jim <dd>forced grab or allocate the specified 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>
727872d18412fc021f03969b8641810d8896820bhumbedooh</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>
727872d18412fc021f03969b8641810d8896820bhumbedoohvar comments_shortname = 'httpd';
cc7e1025de9ac63bd4db6fe7f71c158b2cf09fe4humbedoohvar comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_slotmem_shm.html';
0d0ba3a410038e179b695446bb149cce6264e0abnd(function(w, d) {
cc7e1025de9ac63bd4db6fe7f71c158b2cf09fe4humbedooh if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
727872d18412fc021f03969b8641810d8896820bhumbedooh d.write('<div id="comments_thread"><\/div>');
0d0ba3a410038e179b695446bb149cce6264e0abnd var s = d.createElement('script');
ac082aefa89416cbdc9a1836eaf3bed9698201c8humbedooh s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
0d0ba3a410038e179b695446bb149cce6264e0abnd (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
727872d18412fc021f03969b8641810d8896820bhumbedooh d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
0d0ba3a410038e179b695446bb149cce6264e0abnd})(window, document);
205f749042ed530040a4f0080dbcb47ceae8a374rjung<p class="apache">Copyright 2015 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>
af33a4994ae2ff15bc67d19ff1a7feb906745bf8rbowen<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/quickreference.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[//><!--
0d0ba3a410038e179b695446bb149cce6264e0abndif (typeof(prettyPrint) !== 'undefined') {
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd prettyPrint();