1<?xml version="1.0" encoding="ISO-8859-1"?> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 3<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!-- 4 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 5 This file is generated from xml source: DO NOT EDIT 6 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 7 --> 8<title>mod_slotmem_shm - Apache HTTP Server</title> 9<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /> 10<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /> 11<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" /> 12<script src="/style/scripts/prettify.min.js" type="text/javascript"> 13</script> 14 15<link href="/images/favicon.ico" rel="shortcut icon" /></head> 16<body> 17<div id="page-header"> 18<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> 19<p class="apache">Apache HTTP Server Version 2.4</p> 20<img alt="" src="/images/feather.gif" /></div> 21<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div> 22<div id="path"> 23<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.4</a> > <a href="./">Modules</a></div> 24<div id="page-content"> 25<div id="preamble"><h1>Apache Module mod_slotmem_shm</h1> 26<div class="toplang"> 27<p><span>Available Languages: </span><a href="/en/mod/mod_slotmem_shm.html" title="English"> en </a> | 28<a href="/fr/mod/mod_slotmem_shm.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a></p> 29</div> 30<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Slot-based shared memory provider.</td></tr> 31<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr> 32<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>slotmem_shm_module</td></tr> 33<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_slotmem_shm.c</td></tr></table> 34<h3>Summary</h3> 35 36 <p><code>mod_slotmem_shm</code> is a memory provider which 37 provides for creation and access to a shared memory segment 38 in which the datasets are organized in "slots." 39 </p> 40 41 <p>All shared memory is cleared and cleaned with each 42 restart, whether graceful or not. The data itself is 43 stored and restored within a file noted by the <code>name</code> 44 parameter in the <code>create</code> and <code>attach</code> 45 calls. If not specified with an absolute path, the file will be 46 created relative to the path specified by the 47 <code class="directive"><a href="/mod/core.html#defaultruntimedir">DefaultRuntimeDir</a></code> directive. 48 </p> 49 50 <p><code>mod_slotmem_shm</code> provides the following API functions: 51 </p> 52 53 <dl> 54 <dt>apr_status_t doall(ap_slotmem_instance_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool)</dt> 55 <dd>call the callback on all worker slots</dd> 56 57 <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> 58 <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 59 the shared memory if configured. Values are: 60 <dl> 61 <dt><code>"none"</code></dt> 62 <dd><code>Anonymous shared memory and no persistent store</code></dd> 63 <dt><code>"file-name"</code></dt> 64 <dd><code>[DefaultRuntimeDir]/file-name</code></dd> 65 <dt><code>"/absolute-file-name"</code></dt> 66 <dd><code>Absolute file name</code></dd> 67 </dl></dd> 68 69 <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> 70 <dd>attach to an existing slotmem. See <code>create</code> for description of <code>name</code> parameter.</dd> 71 72 <dt>apr_status_t dptr(ap_slotmem_instance_t *s, unsigned int item_id, void**mem)</dt> 73 <dd>get the direct pointer to the memory associated with this worker slot.</dd> 74 75 <dt>apr_status_t get(ap_slotmem_instance_t *s, unsigned int item_id, unsigned char *dest, apr_size_t dest_len)</dt> 76 <dd>get/read the memory from this slot to dest</dd> 77 78 <dt>apr_status_t put(ap_slotmem_instance_t *slot, unsigned int item_id, unsigned char *src, apr_size_t src_len)</dt> 79 <dd>put/write the data from src to this slot</dd> 80 81 <dt>unsigned int num_slots(ap_slotmem_instance_t *s)</dt> 82 <dd>return the total number of slots in the segment</dd> 83 84 <dt>apr_size_t slot_size(ap_slotmem_instance_t *s)</dt> 85 <dd>return the total data size, in bytes, of a slot in the segment</dd> 86 87 <dt>apr_status_t grab(ap_slotmem_instance_t *s, unsigned int *item_id);</dt> 88 <dd>grab or allocate the first free slot and mark as in-use (does not do any data copying)</dd> 89 90 <dt>apr_status_t fgrab(ap_slotmem_instance_t *s, unsigned int item_id);</dt> 91 <dd>forced grab or allocate the specified slot and mark as in-use (does not do any data copying)</dd> 92 93 <dt>apr_status_t release(ap_slotmem_instance_t *s, unsigned int item_id);</dt> 94 <dd>release or free a slot and mark as not in-use (does not do any data copying)</dd> 95 </dl> 96 97</div> 98<div id="quickview"><h3 class="directives">Directives</h3> 99<p>This module provides no 100 directives.</p> 101<ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> 102 103</div> 104<div class="bottomlang"> 105<p><span>Available Languages: </span><a href="/en/mod/mod_slotmem_shm.html" title="English"> en </a> | 106<a href="/fr/mod/mod_slotmem_shm.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a></p> 107</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> 108<script type="text/javascript"><!--//--><![CDATA[//><!-- 109var comments_shortname = 'httpd'; 110var comments_identifier = 'http://httpd.apache.org/docs/2.4/mod/mod_slotmem_shm.html'; 111(function(w, d) { 112 if (w.location.hostname.toLowerCase() == "httpd.apache.org") { 113 d.write('<div id="comments_thread"><\/div>'); 114 var s = d.createElement('script'); 115 s.type = 'text/javascript'; 116 s.async = true; 117 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; 118 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); 119 } 120 else { 121 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); 122 } 123})(window, document); 124//--><!]]></script></div><div id="footer"> 125<p class="apache">Copyright 2014 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> 126<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[//><!-- 127if (typeof(prettyPrint) !== 'undefined') { 128 prettyPrint(); 129} 130//--><!]]></script> 131</body></html>