You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by ji...@apache.org on 2019/03/28 10:36:00 UTC
svn commit: r1856468 - in /httpd/httpd/branches/2.4.x/docs/manual/mod:
mod_socache_redis.html mod_socache_redis.html.en mod_socache_redis.xml.meta
Author: jim
Date: Thu Mar 28 10:35:59 2019
New Revision: 1856468
URL: http://svn.apache.org/viewvc?rev=1856468&view=rev
Log:
Add in generated docs
Added:
httpd/httpd/branches/2.4.x/docs/manual/mod/mod_socache_redis.html
httpd/httpd/branches/2.4.x/docs/manual/mod/mod_socache_redis.html.en
httpd/httpd/branches/2.4.x/docs/manual/mod/mod_socache_redis.xml.meta
Added: httpd/httpd/branches/2.4.x/docs/manual/mod/mod_socache_redis.html
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_socache_redis.html?rev=1856468&view=auto
==============================================================================
--- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_socache_redis.html (added)
+++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_socache_redis.html Thu Mar 28 10:35:59 2019
@@ -0,0 +1,5 @@
+# GENERATED FROM XML -- DO NOT EDIT
+
+URI: mod_socache_redis.html.en
+Content-Language: en
+Content-type: text/html; charset=ISO-8859-1
Added: httpd/httpd/branches/2.4.x/docs/manual/mod/mod_socache_redis.html.en
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_socache_redis.html.en?rev=1856468&view=auto
==============================================================================
--- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_socache_redis.html.en (added)
+++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_socache_redis.html.en Thu Mar 28 10:35:59 2019
@@ -0,0 +1,150 @@
+<?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>
+<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
+<!--
+ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ This file is generated from xml source: DO NOT EDIT
+ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ -->
+<title>mod_socache_redis - Apache HTTP Server Version 2.4</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.min.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="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
+<p class="apache">Apache HTTP Server Version 2.4</p>
+<img alt="" src="../images/feather.png" /></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.4</a> > <a href="./">Modules</a></div>
+<div id="page-content">
+<div id="preamble"><h1>Apache Module mod_socache_redis</h1>
+<div class="toplang">
+<p><span>Available Languages: </span><a href="../en/mod/mod_socache_redis.html" title="English"> en </a></p>
+</div>
+<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Redis based shared object cache provider.</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 Identifier:</a></th><td>socache_redis_module</td></tr>
+<tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_socache_redis.c</td></tr></table>
+<h3>Summary</h3>
+
+ <p><code class="module"><a href="../mod/mod_socache_redis.html">mod_socache_redis</a></code> is a shared object cache provider
+ which provides for creation and access to a cache backed by the
+ <a href="https://redis.io/">Redis</a>
+ high-performance, distributed memory object caching system.
+ </p>
+
+
+ <p>This shared object cache provider's "create" method requires a
+ comma separated list of memcached host/port specifications. If using
+ this provider via another modules configuration (such as
+ <code class="directive"><a href="../mod/mod_ssl.html#sslsessioncache">SSLSessionCache</a></code>), provide
+ the list of servers as the optional "arg" parameter.</p>
+
+ <pre class="prettyprint lang-config">SSLSessionCache redis:redis.example.com:12345,redis2.example.com:12345</pre>
+
+
+ <p>Details of other shared object cache providers can be found
+ <a href="../socache.html">here</a>.
+ </p>
+
+</div>
+<div id="quickview"><a href="https://www.apache.org/foundation/contributing.html" class="badge"><img src="https://www.apache.org/images/SupportApache-small.png" alt="Support Apache!" /></a><h3 class="directives">Directives</h3>
+<ul id="toc">
+<li><img alt="" src="../images/down.gif" /> <a href="#redisconnpoolttl">RedisConnPoolTTL</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#redistimeout">RedisTimeout</a></li>
+</ul>
+<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__&list_id=144532&product=Apache%20httpd-2&query_format=specific&order=changeddate%20DESC%2Cpriority%2Cbug_severity&component=mod_socache_redis">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&component=mod_socache_redis">Report a bug</a></li></ul><h3>See also</h3>
+<ul class="seealso">
+<li><a href="#comments_section">Comments</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="RedisConnPoolTTL" id="RedisConnPoolTTL">RedisConnPoolTTL</a> <a name="redisconnpoolttl" id="redisconnpoolttl">Directive</a></h2>
+<table class="directive">
+<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>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RedisConnPoolTTL <em>num</em>[<em>units</em>]</code></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>RedisConnPoolTTL 15s</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_socache_redis</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>Set the time to keep idle connections with the Redis server(s)
+ alive (threaded platforms only).</p>
+
+ <p>Valid values for <code class="directive">RedisConnPoolTTL</code> are times
+ up to one hour. 0 means no timeout.</p>
+
+ <div class="note"><p>This timeout defaults to units of seconds, but accepts
+ suffixes for milliseconds (ms), seconds (s), minutes (min), and hours (h).
+ </p></div>
+
+ <div class="example"><pre class="prettyprint lang-config"># Set a timeout of 10 minutes
+RedisConnPoolTTL 10min
+# Set a timeout of 60 seconds
+RedisConnPoolTTL 60</pre>
+</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="RedisTimeout" id="RedisTimeout">RedisTimeout</a> <a name="redistimeout" id="redistimeout">Directive</a></h2>
+<table class="directive">
+<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>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>RedisTimeout <em>num</em>[<em>units</em>]</code></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>RedisTimeout 5s</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_socache_redis</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>Set the Read/Write timeout used for the connection with the Redis
+ server(s).</p>
+
+ <p>Valid values for <code class="directive">RedisTimeout</code> are times
+ up to one hour. 0 means no timeout.</p>
+
+ <div class="note"><p>This timeout defaults to units of seconds, but accepts
+ suffixes for milliseconds (ms), seconds (s), minutes (min), and hours (h).
+ </p></div>
+
+ <div class="example"><pre class="prettyprint lang-config"># Set a timeout of 10 minutes
+RedisTimeout 10min
+# Set a timeout of 60 seconds
+RedisTimeout 60</pre>
+</div>
+
+</div>
+</div>
+<div class="bottomlang">
+<p><span>Available Languages: </span><a href="../en/mod/mod_socache_redis.html" title="English"> en </a></p>
+</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>
+<script type="text/javascript"><!--//--><![CDATA[//><!--
+var comments_shortname = 'httpd';
+var comments_identifier = 'http://httpd.apache.org/docs/2.4/mod/mod_socache_redis.html';
+(function(w, d) {
+ if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
+ d.write('<div id="comments_thread"><\/div>');
+ var s = d.createElement('script');
+ s.type = 'text/javascript';
+ s.async = true;
+ s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
+ (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
+ }
+ else {
+ d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
+ }
+})(window, document);
+//--><!]]></script></div><div id="footer">
+<p class="apache">Copyright 2019 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="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[//><!--
+if (typeof(prettyPrint) !== 'undefined') {
+ prettyPrint();
+}
+//--><!]]></script>
+</body></html>
\ No newline at end of file
Added: httpd/httpd/branches/2.4.x/docs/manual/mod/mod_socache_redis.xml.meta
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_socache_redis.xml.meta?rev=1856468&view=auto
==============================================================================
--- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_socache_redis.xml.meta (added)
+++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_socache_redis.xml.meta Thu Mar 28 10:35:59 2019
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!-- GENERATED FROM XML: DO NOT EDIT -->
+
+<metafile reference="mod_socache_redis.xml">
+ <basename>mod_socache_redis</basename>
+ <path>/mod/</path>
+ <relpath>..</relpath>
+
+ <variants>
+ <variant>en</variant>
+ </variants>
+</metafile>