From: Graham Leggett Date: Tue, 6 Dec 2011 14:53:23 +0000 (+0000) Subject: Create initial documentation for mod_socache_shmcb, mod_socache_dc, X-Git-Tag: 2.5.0-alpha~7706 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=3775da21590e1ace41239a58ca71785a7f6843c4;p=thirdparty%2Fapache%2Fhttpd.git Create initial documentation for mod_socache_shmcb, mod_socache_dc, mod_socache_dbm and mod_socache_memcache. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1210951 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/mod/allmodules.xml b/docs/manual/mod/allmodules.xml index f5195310484..2e0706ca804 100644 --- a/docs/manual/mod/allmodules.xml +++ b/docs/manual/mod/allmodules.xml @@ -98,6 +98,10 @@ mod_slotmem_plain.xml mod_slotmem_shm.xml mod_so.xml + mod_socache_dbm.xml + mod_socache_dc.xml + mod_socache_memcache.xml + mod_socache_shmcb.xml mod_speling.xml mod_ssl.xml mod_status.xml diff --git a/docs/manual/mod/mod_socache_dbm.xml b/docs/manual/mod/mod_socache_dbm.xml new file mode 100644 index 00000000000..874327e2c9b --- /dev/null +++ b/docs/manual/mod/mod_socache_dbm.xml @@ -0,0 +1,47 @@ + + + + + + + + + +mod_socache_dbm +DBM based shared object cache provider. +Extension +mod_socache_dbm.c +mod_socache_dbm_module + + +

mod_socache_dbm is a shared object cache provider + which provides for creation and access to a cache backed by a + DBM database. +

+ + + dbm:/path/to/datafile + + +

Details of other shared object cache providers can be found + here. +

+ + + + diff --git a/docs/manual/mod/mod_socache_dc.xml b/docs/manual/mod/mod_socache_dc.xml new file mode 100644 index 00000000000..2cd0cb6af34 --- /dev/null +++ b/docs/manual/mod/mod_socache_dc.xml @@ -0,0 +1,44 @@ + + + + + + + + + +mod_socache_dc +Distcache based shared object cache provider. +Extension +mod_socache_dc.c +mod_socache_dc_module + + +

mod_socache_dc is a shared object cache provider + which provides for creation and access to a cache backed by the + distcache + distributed session caching libraries. +

+ +

Details of other shared object cache providers can be found + here. +

+ + + + diff --git a/docs/manual/mod/mod_socache_memcache.xml b/docs/manual/mod/mod_socache_memcache.xml new file mode 100644 index 00000000000..0ef91c69824 --- /dev/null +++ b/docs/manual/mod/mod_socache_memcache.xml @@ -0,0 +1,44 @@ + + + + + + + + + +mod_socache_memcache +Memcache based shared object cache provider. +Extension +mod_socache_memcache.c +mod_socache_memcache_module + + +

mod_socache_memcache is a shared object cache provider + which provides for creation and access to a cache backed by the + memcached + high-performance, distributed memory object caching system. +

+ +

Details of other shared object cache providers can be found + here. +

+ + + + diff --git a/docs/manual/mod/mod_socache_shmcb.xml b/docs/manual/mod/mod_socache_shmcb.xml new file mode 100644 index 00000000000..85d59190344 --- /dev/null +++ b/docs/manual/mod/mod_socache_shmcb.xml @@ -0,0 +1,47 @@ + + + + + + + + + +mod_socache_shmcb +shmcb based shared object cache provider. +Extension +mod_socache_shmcb.c +mod_socache_shmcb_module + + +

mod_socache_shmcb is a shared object cache provider + which provides for creation and access to a cache backed by a + high-performance cyclic buffer inside a shared memory segment. +

+ + + shmcb:/path/to/datafile(512000) + + +

Details of other shared object cache providers can be found + here. +

+ + + + diff --git a/docs/manual/mod/mod_ssl.xml b/docs/manual/mod/mod_ssl.xml index 041446961ea..557f6e5d7c8 100644 --- a/docs/manual/mod/mod_ssl.xml +++ b/docs/manual/mod/mod_ssl.xml @@ -453,7 +453,7 @@ The following five storage types are currently supported:

processes. This session cache may suffer reliability issues under high load.

-
  • shm:/path/to/datafile[(size)] +
  • shmcb:/path/to/datafile[(size)]

    This makes use of a high-performance cyclic buffer (approx. size bytes in size) inside a shared memory @@ -476,7 +476,7 @@ The following five storage types are currently supported:

    Examples SSLSessionCache dbm:/usr/local/apache/logs/ssl_gcache_data
    -SSLSessionCache shm:/usr/local/apache/logs/ssl_gcache_data(512000) +SSLSessionCache shmcb:/usr/local/apache/logs/ssl_gcache_data(512000)

    The ssl-cache mutex is used to serialize access to diff --git a/docs/manual/socache.xml b/docs/manual/socache.xml index 8a7b7d1c0ff..20cae8e65f9 100644 --- a/docs/manual/socache.xml +++ b/docs/manual/socache.xml @@ -45,20 +45,71 @@ SSLStaplingCache.

    Currently available providers are:

    -
    "dbm" (mod_socache_dbm)
    +
    "dbm" (mod_socache_dbm)
    This makes use of a DBM hash file. The choice of underlying DBM used may be configurable if the installed APR version supports multiple DBM implementations.
    -
    "dc" (mod_socache_dc)
    +
    "dc" (mod_socache_dc)
    This makes use of the distcache distributed session caching libraries.
    -
    "memcache" (mod_socache_memcache)
    +
    "memcache" (mod_socache_memcache)
    This makes use of the memcached high-performance, distributed memory object caching system.
    -
    "shmcb" (mod_socache_shmcb)
    +
    "shmcb" (mod_socache_shmcb)
    This makes use of a high-performance cyclic buffer inside a shared memory segment.
    + +

    The API provides the following functions:

    + +
    +
    const char *create(ap_socache_instance_t **instance, const char *arg, + apr_pool_t *tmp, apr_pool_t *p);
    +
    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.
    + +
    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)
    +
    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.
    + +
    void destroy(ap_socache_instance_t *instance, server_rec *s)
    +
    Destroy a given cache instance object.
    + +
    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)
    +
    Store an object in a cache instance.
    + +
    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)
    +
    Retrieve a cached object.
    + +
    apr_status_t remove(ap_socache_instance_t *instance, server_rec *s, + const unsigned char *id, unsigned int idlen, + apr_pool_t *pool)
    +
    Remove an object from the cache.
    + +
    void status(ap_socache_instance_t *instance, request_rec *r, int flags)
    +
    Dump the status of a cache instance for mod_status.
    + +
    apr_status_t iterate(ap_socache_instance_t *instance, server_rec *s, + void *userctx, ap_socache_iterator_t *iterator, + apr_pool_t *pool)
    +
    Dump all cached objects through an iterator callback.
    +
    +