granicus.if.org Git - apache/blob - docs/manual/mod/mod_socache_redis.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_socache_redis - 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.png" /></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_socache_redis</h1>
  28 <div class="toplang">
  29 <p><span>Available Languages: </span><a href="../en/mod/mod_socache_redis.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>Redis based shared object cache 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>socache_redis_module</td></tr>
  34 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_socache_redis.c</td></tr></table>
  35 <h3>Summary</h3>
  36
  37     <p><code class="module"><a href="../mod/mod_socache_redis.html">mod_socache_redis</a></code> is a shared object cache provider
  38     which provides for creation and access to a cache backed by the
  39     <a href="https://redis.io/">Redis</a>
  40     high-performance, distributed memory object caching system.
  41     </p>
  42
  43
  44     <p>This shared object cache provider's "create" method requires a
  45        comma separated list of memcached host/port specifications. If using
  46        this provider via another modules configuration (such as
  47        <code class="directive"><a href="../mod/mod_ssl.html#sslsessioncache">SSLSessionCache</a></code>), provide
  48        the list of servers as the optional "arg" parameter.</p>
  49
  50     <pre class="prettyprint lang-config">SSLSessionCache redis:redis.example.com:12345,redis2.example.com:12345</pre>
  51
  52
  53     <p>Details of other shared object cache providers can be found
  54     <a href="../socache.html">here</a>.
  55     </p>
  56
  57 </div>
  58 <div id="quickview"><h3 class="directives">Directives</h3>
  59 <ul id="toc">
  60 <li><img alt="" src="../images/down.gif" /> <a href="#redisconnpoolttl">RedisConnPoolTTL</a></li>
  61 <li><img alt="" src="../images/down.gif" /> <a href="#redistimeout">RedisTimeout</a></li>
  62 </ul>
  63 <h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&amp;list_id=144532&amp;product=Apache%20httpd-2&amp;query_format=specific&amp;order=changeddate%20DESC%2Cpriority%2Cbug_severity&amp;component=mod_socache_redis">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=mod_socache_redis">Report a bug</a></li></ul><h3>See also</h3>
  64 <ul class="seealso">
  65 <li><a href="#comments_section">Comments</a></li></ul></div>
  66
  67 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  68 <div class="directive-section"><h2><a name="RedisConnPoolTTL" id="RedisConnPoolTTL">RedisConnPoolTTL</a> <a name="redisconnpoolttl" id="redisconnpoolttl">Directive</a><a title="Permanent link" href="#redisconnpoolttl" class="permalink">&para;</a></h2>
  69 <table class="directive">
  70 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>TTL used for the connection pool with the Redis server(s)</td></tr>
  71 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RedisConnPoolTTL <em>num</em>[<em>units</em>]</code></td></tr>
  72 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>RedisConnPoolTTL 15s</code></td></tr>
  73 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  74 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  75 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_socache_redis</td></tr>
  76 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.5 and later</td></tr>
  77 </table>
  78     <p>Set the time to keep idle connections with the Redis server(s)
  79     alive (threaded platforms only).</p>
  80
  81     <p>Valid values for <code class="directive">RedisConnPoolTTL</code> are times
  82     up to one hour. 0 means no timeout.</p>
  83
  84     <div class="note"><p>This timeout defaults to units of seconds, but accepts
  85     suffixes for milliseconds (ms), seconds (s), minutes (min), and hours (h).
  86     </p></div>
  87
  88     <div class="example"><pre class="prettyprint lang-config"># Set a timeout of 10 minutes
  89 RedisConnPoolTTL 10min
  90 # Set a timeout of 60 seconds
  91 RedisConnPoolTTL 60</pre>
  92 </div>
  93
  94 </div>
  95 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  96 <div class="directive-section"><h2><a name="RedisTimeout" id="RedisTimeout">RedisTimeout</a> <a name="redistimeout" id="redistimeout">Directive</a><a title="Permanent link" href="#redistimeout" class="permalink">&para;</a></h2>
  97 <table class="directive">
  98 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>R/W timeout used for the connection with the Redis server(s)</td></tr>
  99 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RedisTimeout <em>num</em>[<em>units</em>]</code></td></tr>
 100 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>RedisTimeout 5s</code></td></tr>
 101 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
 102 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 103 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_socache_redis</td></tr>
 104 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.5 and later</td></tr>
 105 </table>
 106     <p>Set the Read/Write timeout used for the connection with the Redis
 107     server(s).</p>
 108
 109     <p>Valid values for <code class="directive">RedisTimeout</code> are times
 110     up to one hour. 0 means no timeout.</p>
 111
 112     <div class="note"><p>This timeout defaults to units of seconds, but accepts
 113     suffixes for milliseconds (ms), seconds (s), minutes (min), and hours (h).
 114     </p></div>
 115
 116     <div class="example"><pre class="prettyprint lang-config"># Set a timeout of 10 minutes
 117 RedisTimeout 10min
 118 # Set a timeout of 60 seconds
 119 RedisTimeout 60</pre>
 120 </div>
 121
 122 </div>
 123 </div>
 124 <div class="bottomlang">
 125 <p><span>Available Languages: </span><a href="../en/mod/mod_socache_redis.html" title="English">&nbsp;en&nbsp;</a></p>
 126 </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>
 127 <script type="text/javascript"><!--//--><![CDATA[//><!--
 128 var comments_shortname = 'httpd';
 129 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_socache_redis.html';
 130 (function(w, d) {
 131     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 132         d.write('<div id="comments_thread"><\/div>');
 133         var s = d.createElement('script');
 134         s.type = 'text/javascript';
 135         s.async = true;
 136         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 137         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 138     }
 139     else {
 140         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 141     }
 142 })(window, document);
 143 //--><!]]></script></div><div id="footer">
 144 <p class="apache">Copyright 2018 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>
 145 <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[//><!--
 146 if (typeof(prettyPrint) !== 'undefined') {
 147     prettyPrint();
 148 }
 149 //--><!]]></script>
 150 </body></html>