mirror of
https://github.com/apache/httpd.git
synced 2025-08-13 14:40:20 +00:00
a015503f65
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1329931 13f79535-47bb-0310-9956-ffa450edef68
257 lines
16 KiB
XML
257 lines
16 KiB
XML
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
|
||
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
||
This file is generated from xml source: DO NOT EDIT
|
||
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
||
-->
|
||
<title>mod_cache_socache - Apache HTTP Server</title>
|
||
<link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
|
||
<link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
|
||
<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" />
|
||
<script src="../style/scripts/prettify.js" type="text/javascript">
|
||
</script>
|
||
|
||
<link href="../images/favicon.ico" rel="shortcut icon" /></head>
|
||
<body>
|
||
<div id="page-header">
|
||
<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
|
||
<p class="apache">Apache HTTP Server Version 2.5</p>
|
||
<img alt="" src="../images/feather.gif" /></div>
|
||
<div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
|
||
<div id="path">
|
||
<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>
|
||
<div id="page-content">
|
||
<div id="preamble"><h1>Apache Module mod_cache_socache</h1>
|
||
<div class="toplang">
|
||
<p><span>Available Languages: </span><a href="../en/mod/mod_cache_socache.html" title="English"> en </a></p>
|
||
</div>
|
||
<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Shared object cache (socache) based storage module for the
|
||
HTTP caching filter.</td></tr>
|
||
<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
|
||
<tr><th><a href="module-dict.html#ModuleIdentifier">Module<EFBFBD>Identifier:</a></th><td>cache_socache_module</td></tr>
|
||
<tr><th><a href="module-dict.html#SourceFile">Source<EFBFBD>File:</a></th><td>mod_cache_socache.c</td></tr></table>
|
||
<h3>Summary</h3>
|
||
|
||
<p><code class="module"><a href="../mod/mod_cache_socache.html">mod_cache_socache</a></code> implements a shared object cache
|
||
(socache) based storage manager for <code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code>.</p>
|
||
|
||
<p>The headers and bodies of cached responses are combined, and stored
|
||
underneath a single key in the shared object cache. A
|
||
<a href="../socache.html">number of implementations</a> of shared object
|
||
caches are available to choose from.</p>
|
||
|
||
<p>Multiple content negotiated responses can be stored concurrently,
|
||
however the caching of partial content is not yet supported by this
|
||
module.</p>
|
||
|
||
<div class="example"><p><code>
|
||
# Turn on caching<br />
|
||
CacheSocache shmcb<br />
|
||
CacheSocacheMaxSize 102400<br />
|
||
<Location /foo><br />
|
||
<span class="indent">
|
||
CacheEnable socache<br />
|
||
</span>
|
||
</Location><br />
|
||
<br />
|
||
# Fall back to the disk cache<br />
|
||
CacheSocache shmcb<br />
|
||
CacheSocacheMaxSize 102400<br />
|
||
<Location /foo><br />
|
||
<span class="indent">
|
||
CacheEnable socache<br />
|
||
CacheEnable disk<br />
|
||
</span>
|
||
</Location><br />
|
||
</code></p></div>
|
||
|
||
<div class="note"><h3>Note:</h3>
|
||
<p><code class="module"><a href="../mod/mod_cache_socache.html">mod_cache_socache</a></code> requires the services of
|
||
<code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code>, which must be loaded before
|
||
mod_cache_socache.</p>
|
||
</div>
|
||
</div>
|
||
<div id="quickview"><h3 class="directives">Directives</h3>
|
||
<ul id="toc">
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#cachesocache">CacheSocache</a></li>
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#cachesocachemaxsize">CacheSocacheMaxSize</a></li>
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#cachesocachemaxtime">CacheSocacheMaxTime</a></li>
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#cachesocachemintime">CacheSocacheMinTime</a></li>
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#cachesocachereadsize">CacheSocacheReadSize</a></li>
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#cachesocachereadtime">CacheSocacheReadTime</a></li>
|
||
</ul>
|
||
<h3>See also</h3>
|
||
<ul class="seealso">
|
||
<li><code class="module"><a href="../mod/mod_cache.html">mod_cache</a></code></li>
|
||
<li><code class="module"><a href="../mod/mod_cache_disk.html">mod_cache_disk</a></code></li>
|
||
<li><a href="../caching.html">Caching Guide</a></li>
|
||
</ul></div>
|
||
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="directive-section"><h2><a name="CacheSocache" id="CacheSocache">CacheSocache</a> <a name="cachesocache" id="cachesocache">Directive</a></h2>
|
||
<table class="directive">
|
||
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The directory root under which cache files are
|
||
stored</td></tr>
|
||
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheSocache <var>type[:args]</var></code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
|
||
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
|
||
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache_socache</td></tr>
|
||
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.5 and later</td></tr>
|
||
</table>
|
||
<p>The <code class="directive">CacheSocache</code> directive defines the name of
|
||
the shared object cache implementation to use, followed by optional
|
||
arguments for that implementation. A <a href="../socache.html">number of
|
||
implementations</a> of shared object caches are available to choose
|
||
from.</p>
|
||
|
||
<div class="example"><p><code>
|
||
CacheSocache shmcb
|
||
</code></p></div>
|
||
|
||
</div>
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="directive-section"><h2><a name="CacheSocacheMaxSize" id="CacheSocacheMaxSize">CacheSocacheMaxSize</a> <a name="cachesocachemaxsize" id="cachesocachemaxsize">Directive</a></h2>
|
||
<table class="directive">
|
||
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The maximum size (in bytes) of an entry to be placed in the
|
||
cache</td></tr>
|
||
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheSocacheMaxSize <var>bytes</var></code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheSocacheMaxSize 102400</code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
|
||
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
|
||
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache_socache</td></tr>
|
||
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.5 and later</td></tr>
|
||
</table>
|
||
<p>The <code class="directive">CacheSocacheMaxSize</code> directive sets the
|
||
maximum size, in bytes, for the combined headers and body of a document
|
||
to be considered for storage in the cache. The larger the headers that
|
||
are stored alongside the body, the smaller the body may be.</p>
|
||
|
||
<p>The <code class="module"><a href="../mod/mod_cache_socache.html">mod_cache_socache</a></code> module will only attempt to
|
||
cache responses that have an explicit content length, or that are small
|
||
enough to be written in one pass. This is done to allow the
|
||
<code class="module"><a href="../mod/mod_cache_disk.html">mod_cache_disk</a></code> module to have an opportunity to cache
|
||
responses larger than those cacheable within
|
||
<code class="module"><a href="../mod/mod_cache_socache.html">mod_cache_socache</a></code>.</p>
|
||
|
||
<div class="example"><p><code>
|
||
CacheSocacheMaxSize 102400
|
||
</code></p></div>
|
||
|
||
</div>
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="directive-section"><h2><a name="CacheSocacheMaxTime" id="CacheSocacheMaxTime">CacheSocacheMaxTime</a> <a name="cachesocachemaxtime" id="cachesocachemaxtime">Directive</a></h2>
|
||
<table class="directive">
|
||
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The maximum time (in seconds) for a document to be placed in the
|
||
cache</td></tr>
|
||
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheSocacheMaxTime <var>seconds</var></code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheSocacheMaxTime 86400</code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
|
||
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
|
||
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache_socache</td></tr>
|
||
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.5 and later</td></tr>
|
||
</table>
|
||
<p>The <code class="directive">CacheSocacheMaxTime</code> directive sets the
|
||
maximum freshness lifetime, in seconds, for a document to be stored in
|
||
the cache. This value overrides the freshness lifetime defined for the
|
||
document by the HTTP protocol.</p>
|
||
|
||
<div class="example"><p><code>
|
||
CacheSocacheMaxTime 86400
|
||
</code></p></div>
|
||
|
||
</div>
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="directive-section"><h2><a name="CacheSocacheMinTime" id="CacheSocacheMinTime">CacheSocacheMinTime</a> <a name="cachesocachemintime" id="cachesocachemintime">Directive</a></h2>
|
||
<table class="directive">
|
||
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The maximum time (in seconds) for a document to be placed in the
|
||
cache</td></tr>
|
||
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheSocacheMinTime <var>seconds</var></code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheSocacheMinTime 600</code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
|
||
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
|
||
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache_socache</td></tr>
|
||
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.5 and later</td></tr>
|
||
</table>
|
||
<p>The <code class="directive">CacheSocacheMinTime</code> directive sets the
|
||
amount of seconds beyond the freshness lifetime of the response that the
|
||
response should be cached for in the shared object cache. If a response is
|
||
only stored for its freshness lifetime, there will be no opportunity to
|
||
revalidate the response to make it fresh again.</p>
|
||
|
||
<div class="example"><p><code>
|
||
CacheSocacheMinTime 600
|
||
</code></p></div>
|
||
|
||
</div>
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="directive-section"><h2><a name="CacheSocacheReadSize" id="CacheSocacheReadSize">CacheSocacheReadSize</a> <a name="cachesocachereadsize" id="cachesocachereadsize">Directive</a></h2>
|
||
<table class="directive">
|
||
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The minimum size (in bytes) of the document to read and be cached
|
||
before sending the data downstream</td></tr>
|
||
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheSocacheReadSize <var>bytes</var></code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheSocacheReadSize 0</code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
|
||
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
|
||
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache_socache</td></tr>
|
||
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.5 and later</td></tr>
|
||
</table>
|
||
<p>The <code class="directive">CacheSocacheReadSize</code> directive sets the
|
||
minimum amount of data, in bytes, to be read from the backend before the
|
||
data is sent to the client. The default of zero causes all data read of
|
||
any size to be passed downstream to the client immediately as it arrives.
|
||
Setting this to a higher value causes the disk cache to buffer at least
|
||
this amount before sending the result to the client. This can improve
|
||
performance when caching content from a slow reverse proxy.</p>
|
||
|
||
<p>This directive only takes effect when the data is being saved to the
|
||
cache, as opposed to data being served from the cache.</p>
|
||
|
||
<div class="example"><p><code>
|
||
CacheReadSize 102400
|
||
</code></p></div>
|
||
|
||
</div>
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="directive-section"><h2><a name="CacheSocacheReadTime" id="CacheSocacheReadTime">CacheSocacheReadTime</a> <a name="cachesocachereadtime" id="cachesocachereadtime">Directive</a></h2>
|
||
<table class="directive">
|
||
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The minimum time (in milliseconds) that should elapse while reading
|
||
before data is sent downstream</td></tr>
|
||
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CacheSocacheReadTime <var>milliseconds</var></code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CacheSocacheReadTime 0</code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
|
||
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
|
||
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_cache_socache</td></tr>
|
||
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.5 and later</td></tr>
|
||
</table>
|
||
<p>The <code class="directive">CacheSocacheReadTime</code> directive sets the minimum amount
|
||
of elapsed time that should pass before making an attempt to send data
|
||
downstream to the client. During the time period, data will be buffered
|
||
before sending the result to the client. This can improve performance when
|
||
caching content from a reverse proxy.</p>
|
||
|
||
<p>The default of zero disables this option.</p>
|
||
|
||
<p>This directive only takes effect when the data is being saved to the
|
||
cache, as opposed to data being served from the cache. It is recommended
|
||
that this option be used alongside the
|
||
<code class="directive"><a href="#cachesocachereadsize">CacheSocacheReadSize</a></code> directive
|
||
to ensure that the server does not buffer excessively should data arrive faster
|
||
than expected.</p>
|
||
|
||
<div class="example"><p><code>
|
||
CacheSocacheReadTime 1000
|
||
</code></p></div>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="bottomlang">
|
||
<p><span>Available Languages: </span><a href="../en/mod/mod_cache_socache.html" title="English"> en </a></p>
|
||
</div><div id="footer">
|
||
<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>
|
||
<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript">
|
||
if (typeof(prettyPrint) !== undefined) {
|
||
prettyPrint();
|
||
}
|
||
</script>
|
||
</body></html> |