granicus.if.org Git - apache/blob - docs/manual/mod/mod_slotmem_shm.html.en

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