granicus.if.org Git - apache/blob - docs/manual/mod/mod_socache_shmcb.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
   3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
   4 <!-- $LastChangedRevision$ -->
   5
   6 <!--
   7  Licensed to the Apache Software Foundation (ASF) under one or more
   8  contributor license agreements.  See the NOTICE file distributed with
   9  this work for additional information regarding copyright ownership.
  10  The ASF licenses this file to You under the Apache License, Version 2.0
  11  (the "License"); you may not use this file except in compliance with
  12  the License.  You may obtain a copy of the License at
  13
  14      http://www.apache.org/licenses/LICENSE-2.0
  15
  16  Unless required by applicable law or agreed to in writing, software
  17  distributed under the License is distributed on an "AS IS" BASIS,
  18  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19  See the License for the specific language governing permissions and
  20  limitations under the License.
  21 -->
  22
  23 <modulesynopsis metafile="mod_socache_shmcb.xml.meta">
  24
  25 <name>mod_socache_shmcb</name>
  26 <description>shmcb based shared object cache provider.</description>
  27 <status>Extension</status>
  28 <sourcefile>mod_socache_shmcb.c</sourcefile>
  29 <identifier>socache_shmcb_module</identifier>
  30
  31 <summary>
  32     <p><code>mod_socache_shmcb</code> is a shared object cache provider
  33     which provides for creation and access to a cache backed by a
  34     high-performance cyclic buffer inside a shared memory segment.
  35     </p>
  36
  37     <example>
  38     shmcb:/path/to/datafile(512000)
  39     </example>
  40
  41     <p>If the path is not absolute then it is assumed to be relative to
  42     the <directive module="core">DefaultRuntimeDir</directive>.</p>
  43
  44     <p>Details of other shared object cache providers can be found
  45     <a href="../socache.html">here</a>.
  46     </p>
  47
  48 </summary>
  49
  50 </modulesynopsis>