mod_cache.h revision ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dc
/* Copyright 2000-2004 Apache Software Foundation
*
* Licensed 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.
*/
#ifndef MOD_CACHE_H
#define MOD_CACHE_H
/*
* Main include file for the Apache Transparent Cache
*/
#define CORE_PRIVATE
#include "apr_hooks.h"
#include "apr.h"
#include "apr_lib.h"
#include "apr_strings.h"
#include "apr_buckets.h"
#include "apr_md5.h"
#include "apr_pools.h"
#include "apr_strings.h"
#include "apr_optional.h"
#define APR_WANT_STRFUNC
#include "apr_want.h"
#include "httpd.h"
#include "http_config.h"
#include "ap_config.h"
#include "http_core.h"
#include "http_protocol.h"
#include "http_request.h"
#include "http_vhost.h"
#include "http_main.h"
#include "http_log.h"
#include "http_connection.h"
#include "util_filter.h"
#include "apr_date.h"
#include "apr_uri.h"
#ifdef HAVE_NETDB_H
#include <netdb.h>
#endif
#ifdef HAVE_SYS_SOCKET_H
#endif
#ifdef HAVE_NETINET_IN_H
#endif
#ifdef HAVE_ARPA_INET_H
#endif
/* USE_ATOMICS should be replaced with the appropriate APR feature macro */
#define USE_ATOMICS
#ifdef USE_ATOMICS
#include "apr_atomic.h"
#endif
#ifndef MAX
#define MAX(a,b) ((a) > (b) ? (a) : (b))
#endif
#ifndef MIN
#define MIN(a,b) ((a) < (b) ? (a) : (b))
#endif
/* default completion is 60% */
#define DEFAULT_CACHE_COMPLETION (60)
#define MAX_URL_LENGTH 1024
#define DEFAULT_CACHE_MAXEXPIRE MSEC_ONE_DAY
#define DEFAULT_CACHE_EXPIRE MSEC_ONE_HR
#define DEFAULT_CACHE_LMFACTOR (0.1)
/* Create a set of PROXY_DECLARE(type), PROXY_DECLARE_NONSTD(type) and
* PROXY_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
struct cache_enable {
const char *url;
const char *type;
};
struct cache_disable {
const char *url;
};
/* static information about the local cache */
typedef struct {
int maxex_set;
int defex_set;
double factor; /* factor for estimating expires date */
int factor_set;
int complete; /* Force cache completion after this point */
int complete_set;
/** ignore the last-modified header when deciding to cache this request */
int no_last_mod_ignore;
/** ignore client's requests for uncached responses */
int ignorecachecontrol;
/* cache info information */
typedef struct cache_info cache_info;
struct cache_info {
char *content_type;
char *etag;
char *lastmods; /* last modified of cache entity */
char *filename;
char lastmod_str[APR_RFC822_DATE_LEN];
const char *im; /* If-Match header value */
const char *inm; /* If-None-Match header value */
};
/* cache handle information */
* count must become an apr_off_t, representing
* the potential size of disk cached objects.
* Then dig for
* "XXX Bad Temporary Cast - see cache_object_t notes"
*/
typedef struct cache_object cache_object_t;
struct cache_object {
char *key;
void *vobj; /* Opaque portion (specific to the cache implementation) of the cache object */
int complete;
#ifdef USE_ATOMICS
#else
#endif
};
typedef struct cache_handle cache_handle_t;
struct cache_handle {
int (*remove_entity) (cache_handle_t *h);
};
/* per request cache information */
typedef struct {
const char *types; /* the types of caches allowed */
const char *type; /* the type of cache selected */
int fresh; /* is the entitey fresh? */
int in_checked; /* CACHE_IN must cache the entity */
/* cache_util.c */
/* do a HTTP/1.1 age calculation */
/**
* Check the freshness of the cache object per RFC2616 section 13.2 (Expiration Model)
* @param cache cache_request_rec
* @param r request_rec
* @return 0 ==> cache object is stale, 1 ==> cache object is fresh
*/
int dirlength,
const char *name);
CACHE_DECLARE(const char *)ap_cache_get_cachetype(request_rec *r, cache_server_conf *conf, const char *url);
/* Create a new table consisting of those elements from a request_rec's
* headers_out that are allowed to be stored in a cache
*/
/**
*/
/**
* create a key for the cache based on the request record
* this is the 'default' version, which can be overridden by a default function
*/
const char* cache_create_key( request_rec*r );
/* hooks */
/* 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
const char *urlkey))
#endif /*MOD_CACHE_H*/