mod_cache.h revision 6d14bedccc13d7a5f95fb9328eb6d1a07b58731b
/* 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
*
*
* 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.
*/
/**
* @file mod_cache.h
* @brief Main include file for the Apache Transparent Cache
*
* @defgroup MOD_CACHE mod_cache
* @ingroup APACHE_MODS
* @{
*/
#ifndef MOD_CACHE_H
#define MOD_CACHE_H
#include "httpd.h"
#include "apr_date.h"
#include "apr_optional.h"
/* Create a set of CACHE_DECLARE(type), CACHE_DECLARE_NONSTD(type) and
* CACHE_DECLARE_DATA with appropriate export and import tags for the platform
*/
#if !defined(WIN32)
#define CACHE_DECLARE_DATA
#elif defined(CACHE_DECLARE_STATIC)
#define CACHE_DECLARE_DATA
#elif defined(CACHE_DECLARE_EXPORT)
#else
#endif
/* cache info information */
typedef struct cache_info cache_info;
struct cache_info {
/**
* the original time corresponding to the 'Date:' header of the request
* served
*/
/** a time when the cached entity is due to expire */
/** r->request_time from the same request */
/** apr_time_now() at the time the entity was acutally cached */
/**
* HTTP status code of the cached entity. Though not necessarily the
* status code finally issued to the request.
*/
int status;
};
/* cache handle information */
typedef struct cache_object cache_object_t;
struct cache_object {
const char *key;
/* Opaque portion (specific to the implementation) of the cache object */
void *vobj;
};
typedef struct cache_handle cache_handle_t;
struct cache_handle {
};
#define CACHE_PROVIDER_GROUP "cache"
typedef struct {
int (*remove_entity) (cache_handle_t *h);
const char *urlkey);
/* cache_util.c */
/* do a HTTP/1.1 age calculation */
/**
* Check the whether the request allows a cached object to be served as per RFC2616
* section 14.9.4 (Cache Revalidation and Reload Controls)
* @param h cache_handle_t
* @param r request_rec
* @return 0 ==> cache object may not be served, 1 ==> cache object may be served
*/
int dirlength,
const char *name);
/* Create a new table consisting of those elements from an
* headers table that are allowed to be stored in a cache.
*/
apr_table_t *t,
server_rec *s);
/* Create a new table consisting of those elements from an input
* headers table that are allowed to be stored in a cache.
*/
/* Create a new table consisting of those elements from an output
* headers table that are allowed to be stored in a cache;
* ensure there is a content type and capture any errors.
*/
/* hooks */
#endif /*MOD_CACHE_H*/
/** @} */