httpd-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From minf...@apache.org
Subject svn commit: r1210956 - in /httpd/httpd/branches/2.4.x: ./ docs/manual/ docs/manual/mod/
Date Tue, 06 Dec 2011 14:56:59 GMT
Author: minfrin
Date: Tue Dec  6 14:56:59 2011
New Revision: 1210956

URL: http://svn.apache.org/viewvc?rev=1210956&view=rev
Log:
Backport:
Create initial documentation for mod_socache_shmcb, mod_socache_dc,
mod_socache_dbm and mod_socache_memcache.

Added:
    httpd/httpd/branches/2.4.x/docs/manual/mod/mod_socache_dbm.xml
      - copied unchanged from r1210951, httpd/httpd/trunk/docs/manual/mod/mod_socache_dbm.xml
    httpd/httpd/branches/2.4.x/docs/manual/mod/mod_socache_dc.xml
      - copied unchanged from r1210951, httpd/httpd/trunk/docs/manual/mod/mod_socache_dc.xml
    httpd/httpd/branches/2.4.x/docs/manual/mod/mod_socache_memcache.xml
      - copied unchanged from r1210951, httpd/httpd/trunk/docs/manual/mod/mod_socache_memcache.xml
    httpd/httpd/branches/2.4.x/docs/manual/mod/mod_socache_shmcb.xml
      - copied unchanged from r1210951, httpd/httpd/trunk/docs/manual/mod/mod_socache_shmcb.xml
Modified:
    httpd/httpd/branches/2.4.x/   (props changed)
    httpd/httpd/branches/2.4.x/docs/manual/mod/allmodules.xml
    httpd/httpd/branches/2.4.x/docs/manual/mod/mod_ssl.xml
    httpd/httpd/branches/2.4.x/docs/manual/socache.xml

Propchange: httpd/httpd/branches/2.4.x/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Tue Dec  6 14:56:59 2011
@@ -1,3 +1,3 @@
 /httpd/httpd/branches/revert-ap-ldap:1150158-1150173
 /httpd/httpd/branches/wombat-integration:723609-723841
-/httpd/httpd/trunk:1201042,1201111,1201194,1201198,1201202,1202236,1202456,1202886,1203859,1204630,1204968,1204990,1205061,1205075,1205379,1205885,1206291,1206587,1206850,1207719,1208753,1208835,1209053,1209085,1209417,1209432,1209461,1209601,1209603,1209618,1209623,1209741,1209754,1209766,1209776,1209797-1209798,1209811-1209812,1209814,1209908,1209910,1209913,1209916-1209917,1209947,1209952,1210080,1210124,1210130,1210219,1210221,1210252,1210284,1210378,1210725,1210892
+/httpd/httpd/trunk:1201042,1201111,1201194,1201198,1201202,1202236,1202456,1202886,1203859,1204630,1204968,1204990,1205061,1205075,1205379,1205885,1206291,1206587,1206850,1207719,1208753,1208835,1209053,1209085,1209417,1209432,1209461,1209601,1209603,1209618,1209623,1209741,1209754,1209766,1209776,1209797-1209798,1209811-1209812,1209814,1209908,1209910,1209913,1209916-1209917,1209947,1209952,1210080,1210124,1210130,1210219,1210221,1210252,1210284,1210378,1210725,1210892,1210951

Modified: httpd/httpd/branches/2.4.x/docs/manual/mod/allmodules.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/allmodules.xml?rev=1210956&r1=1210955&r2=1210956&view=diff
==============================================================================
--- httpd/httpd/branches/2.4.x/docs/manual/mod/allmodules.xml (original)
+++ httpd/httpd/branches/2.4.x/docs/manual/mod/allmodules.xml Tue Dec  6 14:56:59 2011
@@ -98,6 +98,10 @@
   <modulefile>mod_slotmem_plain.xml</modulefile>
   <modulefile>mod_slotmem_shm.xml</modulefile>
   <modulefile>mod_so.xml</modulefile>
+  <modulefile>mod_socache_dbm.xml</modulefile>
+  <modulefile>mod_socache_dc.xml</modulefile>
+  <modulefile>mod_socache_memcache.xml</modulefile>
+  <modulefile>mod_socache_shmcb.xml</modulefile>
   <modulefile>mod_speling.xml</modulefile>
   <modulefile>mod_ssl.xml</modulefile>
   <modulefile>mod_status.xml</modulefile>

Modified: httpd/httpd/branches/2.4.x/docs/manual/mod/mod_ssl.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_ssl.xml?rev=1210956&r1=1210955&r2=1210956&view=diff
==============================================================================
--- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_ssl.xml (original)
+++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_ssl.xml Tue Dec  6 14:56:59 2011
@@ -453,7 +453,7 @@ The following five storage <em>type</em>
     processes.  This session cache may suffer reliability issues under
     high load.</p></li>
 
-<li><code>shm:/path/to/datafile</code>[<code>(</code><em>size</em><code>)</code>]
+<li><code>shmcb:/path/to/datafile</code>[<code>(</code><em>size</em><code>)</code>]
 
     <p>This makes use of a high-performance cyclic buffer
     (approx. <em>size</em> bytes in size) inside a shared memory
@@ -476,7 +476,7 @@ The following five storage <em>type</em>
 
 <example><title>Examples</title>
 SSLSessionCache dbm:/usr/local/apache/logs/ssl_gcache_data<br />
-SSLSessionCache shm:/usr/local/apache/logs/ssl_gcache_data(512000)
+SSLSessionCache shmcb:/usr/local/apache/logs/ssl_gcache_data(512000)
 </example>
 
 <p>The <code>ssl-cache</code> mutex is used to serialize access to

Modified: httpd/httpd/branches/2.4.x/docs/manual/socache.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/socache.xml?rev=1210956&r1=1210955&r2=1210956&view=diff
==============================================================================
--- httpd/httpd/branches/2.4.x/docs/manual/socache.xml (original)
+++ httpd/httpd/branches/2.4.x/docs/manual/socache.xml Tue Dec  6 14:56:59 2011
@@ -45,20 +45,71 @@
     <directive module="ssl">SSLStaplingCache</directive>.</p>
     <p>Currently available providers are:</p>
     <dl>
-    <dt>"dbm" (mod_socache_dbm)</dt>
+    <dt>"dbm" (<module>mod_socache_dbm</module>)</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>"dc" (mod_socache_dc)</dt>
+    <dt>"dc" (<module>mod_socache_dc</module>)</dt>
     <dd>This makes use of the <a href="http://www.distcache.org/">distcache</a>
     distributed session caching libraries.</dd>
-    <dt>"memcache" (mod_socache_memcache)</dt>
+    <dt>"memcache" (<module>mod_socache_memcache</module>)</dt>
     <dd>This makes use of the <a href="http://memcached.org/">memcached</a>
     high-performance, distributed memory object caching system.</dd>
-    <dt>"shmcb" (mod_socache_shmcb)</dt>
+    <dt>"shmcb" (<module>mod_socache_shmcb</module>)</dt>
     <dd>This makes use of a high-performance cyclic buffer inside a
      shared memory segment.</dd>
     </dl>
+
+    <p>The API provides the following functions:</p>
+
+    <dl>
+      <dt>const char *create(ap_socache_instance_t **instance, const char *arg,
+                          apr_pool_t *tmp, apr_pool_t *p);</dt>
+      <dd>Create a session cache based on the given configuration string.
+      The instance pointer returned in the instance paramater will be
+      passed as the first argument to subsequent invocations.</dd>
+
+      <dt>apr_status_t init(ap_socache_instance_t *instance, const char *cname,
+                         const struct ap_socache_hints *hints,
+                         server_rec *s, apr_pool_t *pool)</dt>
+      <dd>Initialize the cache.  The cname must be of maximum length 16
+      characters, and uniquely identifies the consumer of the cache
+      within the server; using the module name is recommended, e.g.
+      "mod_ssl-sess".  This string may be used within a filesystem
+      path so use of only alphanumeric [a-z0-9_-] characters is
+      recommended.  If hints is non-NULL, it gives a set of hints for
+      the provider.  Return APR error code.</dd>
+
+      <dt>void destroy(ap_socache_instance_t *instance, server_rec *s)</dt>
+      <dd>Destroy a given cache instance object.</dd>
+
+      <dt>apr_status_t store(ap_socache_instance_t *instance, server_rec *s,
+                          const unsigned char *id, unsigned int idlen,
+                          apr_time_t expiry,
+                          unsigned char *data, unsigned int datalen,
+                          apr_pool_t *pool)</dt>
+      <dd>Store an object in a cache instance.</dd>
+
+      <dt>apr_status_t retrieve(ap_socache_instance_t *instance, server_rec *s,
+                             const unsigned char *id, unsigned int idlen,
+                             unsigned char *data, unsigned int *datalen,
+                             apr_pool_t *pool)</dt>
+      <dd>Retrieve a cached object.</dd>
+
+      <dt>apr_status_t remove(ap_socache_instance_t *instance, server_rec *s,
+                           const unsigned char *id, unsigned int idlen,
+                           apr_pool_t *pool)</dt>
+      <dd>Remove an object from the cache.</dd>
+
+      <dt>void status(ap_socache_instance_t *instance, request_rec *r, int flags)</dt>
+      <dd>Dump the status of a cache instance for mod_status.</dd>
+
+      <dt>apr_status_t iterate(ap_socache_instance_t *instance, server_rec *s,
+                            void *userctx, ap_socache_iterator_t *iterator,
+                            apr_pool_t *pool)</dt>
+      <dd>Dump all cached objects through an iterator callback.</dd>
+    </dl>
+
   </section>
 
 </manualpage>



Mime
View raw message