svn commit: r372096 - /httpd/httpd/trunk/modules/cache/mod_cache.h

[ia...@apache.org]

Author: ianh
Date: Tue Jan 24 20:03:31 2006
New Revision: 372096

URL: http://svn.apache.org/viewcvs?rev=372096&view=rev
Log:
add Colm's explanation of the cache_info structure from his explaination on dev@
Message-ID: <20...@dochas.stdlib.net>

Modified:
    httpd/httpd/trunk/modules/cache/mod_cache.h

Modified: httpd/httpd/trunk/modules/cache/mod_cache.h
URL: http://svn.apache.org/viewcvs/httpd/httpd/trunk/modules/cache/mod_cache.h?rev=372096&r1=372095&r2=372096&view=diff
==============================================================================
--- httpd/httpd/trunk/modules/cache/mod_cache.h (original)
+++ httpd/httpd/trunk/modules/cache/mod_cache.h Tue Jan 24 20:03:31 2006
@@ -159,10 +159,21 @@
 /* cache info information */
 typedef struct cache_info cache_info;
 struct cache_info {
-    int status;
-    apr_time_t date;
+    /** 
+     * HTTP status code of the cached entity. Though not neccessarily the
+     * status code finally issued to the request. 
+     */
+    int status; 
+    /** 
+     * the original time corresponding to the 'Date:' header of the request 
+     * served 
+     */
+    apr_time_t date; 
+    /** a time when the cached entity is due to expire */
     apr_time_t expire;
+    /** r->request_time from the same request */
     apr_time_t request_time;
+    /** apr_time_now() at the time the entity was acutally cached */
     apr_time_t response_time;
 };