From: Nick Kew <niq@apache.org>
Date: Tue, 1 Mar 2011 02:42:13 +0000 (+0000)
Subject: Document socache and fix the TODO in authn_socache docs.
X-Git-Tag: 2.3.11~4
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=bf38c8efafa8383a2643bbc432d332181d847920;p=apache

Document socache and fix the TODO in authn_socache docs.


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1075625 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/docs/manual/mod/mod_authn_socache.xml b/docs/manual/mod/mod_authn_socache.xml
index 8a0d85c32c..79515115a9 100644
--- a/docs/manual/mod/mod_authn_socache.xml
+++ b/docs/manual/mod/mod_authn_socache.xml
@@ -100,12 +100,11 @@ the load on backends</description>
 <override>None</override>
 
 <usage>
-    <p>This is a server-wide setting.  If not set, your platform's
+    <p>This is a server-wide setting to select a provider for the
+    <a href="../socache.html">shared object cache</a>.
+    Values are "dbm", "dc", "mc", or "shmcb", each subject to the
+    appropriate module being loaded.  If not set, your platform's
        default will be used.</p>
-    <note><title>socache</title>
-      <p>The cache is built on the the <var>socache</var> framework.
-      We need a link here once that's documented!</p>
-    </note>
 </usage>
 </directivesynopsis>
 
diff --git a/docs/manual/sitemap.xml b/docs/manual/sitemap.xml
index 648e42d827..05b169a4f4 100644
--- a/docs/manual/sitemap.xml
+++ b/docs/manual/sitemap.xml
@@ -57,8 +57,10 @@ Documentation</a>.</p>
 <page href="bind.html">Setting which addresses and ports Apache uses</page>
 <page href="mpm.html">Multi-Processing Modules (MPMs)</page>
 <page href="env.html">Environment Variables in Apache</page>
+<page href="expr.html">Expression Parsing in Apache</page>
 <page href="handler.html">Apache's Handler Use</page>
 <page href="filter.html">Filters</page>
+<page href="socache.html">Shared Object Cache Support</page>
 <page href="suexec.html">suEXEC Support</page>
 <page href="misc/perf-tuning.html">Performance Hints</page>
 <page href="http://wiki.apache.org/httpd/FAQ">Frequently Asked Questions</page>
diff --git a/docs/manual/socache.xml b/docs/manual/socache.xml
new file mode 100644
index 0000000000..1206dc00d6
--- /dev/null
+++ b/docs/manual/socache.xml
@@ -0,0 +1,68 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!DOCTYPE manualpage SYSTEM "./style/manualpage.dtd">
+<?xml-stylesheet type="text/xsl" href="./style/manual.en.xsl"?>
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<manualpage metafile="socache.xml.meta">
+
+  <title>Shared Object Cache in Apache HTTP Server</title>
+
+  <summary>
+    <p>The Shared Object Cache provides a means to share simple data
+    across all a server's workers, regardless of <a href="mpm.html">thread
+    and process models</a>.  It is used where the advantages of sharing
+    data across processes outweigh the performance overhead of
+    inter-process communication.</p>
+  </summary>
+
+<seealso><module>mod_socache_dbm</module></seealso>
+<seealso><module>mod_socache_dc</module></seealso>
+<seealso><module>mod_socache_memcache</module></seealso>
+<seealso><module>mod_socache_shmcb</module></seealso>
+
+  <section id="providers">
+    <title>Shared Object Cache Providers</title>
+    <p>The shared object cache as such is an abstraction.  Four different
+    modules implement it.  To use the cache, one or more of these modules
+    must be present, and configured.</p>
+    <p>The only configuration required is to select which cache provider
+    to use.  This is the responsibility of modules using the cache, and
+    they enable selecton using directives such as
+    <directive module="authn_socache">AuthnCacheSOCache</directive>,
+    <directive module="ssl">SSLSessionCache</directive>, and
+    <directive module="ssl">SSLStaplingCache</directive>.</p>
+    <p>Currently available providers are:</p>
+    <dl>
+    <dt><module>mod_socache_dbm</module> ("dbm")</dt>
+    <dd>This makes use of a DBM hash file.
+     The choice of underlying DBM configuration may be configurable
+     if the installed APR version supports multiple DBM implementations.</dd>
+    <dt><module>mod_socache_dc</module> ("dc")</dt>
+    <dd>This makes use of the <a href="http://www.distcache.org/">distcache</a>
+    distributed session caching libraries.</dd>
+    <dt><module>mod_socache_memcache</module> ("mc")</dt>
+    <dd>This makes use of the <a href="http://memcached.org/">memcached</a>
+    high-performance, distributed memory object caching system.</dd>
+    <dt><module>mod_socache_shmcb</module> ("shmcb")</dt>
+    <dd>This makes use of a high-performance cyclic buffer inside a
+     shared memory segment.</dd>
+    </dl>
+  </section>
+
+</manualpage>
diff --git a/docs/manual/socache.xml.meta b/docs/manual/socache.xml.meta
new file mode 100644
index 0000000000..a81dae4f6b
--- /dev/null
+++ b/docs/manual/socache.xml.meta
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!-- GENERATED FROM XML: DO NOT EDIT -->
+
+<metafile reference="socache.xml">
+  <basename>socache</basename>
+  <path>/</path>
+  <relpath>.</relpath>
+
+  <variants>
+    <variant>en</variant>
+  </variants>
+</metafile>