Gecko [ www.vortexaion.com ]

Name	Size	Permission	Date
ap_compat.h	1.08 KB	-rw-rw-rw-	2006-07-12 00:33
ap_config.h	6.65 KB	-rw-rw-rw-	2012-08-15 03:59
ap_config_layout.h	1.21 KB	-rw-rw-rw-	2022-01-02 15:34
ap_expr.h	14.09 KB	-rw-rw-rw-	2020-02-21 02:33
ap_hooks.h	6.01 KB	-rw-rw-rw-	2011-09-23 22:08
ap_listen.h	5.85 KB	-rw-rw-rw-	2016-05-30 23:26
ap_mmn.h	39.26 KB	-rw-rw-rw-	2023-08-29 11:23
ap_mpm.h	10.68 KB	-rw-rw-rw-	2020-04-23 16:32
ap_provider.h	3.55 KB	-rw-rw-rw-	2012-07-03 23:29
ap_regex.h	11.43 KB	-rw-rw-rw-	2022-02-28 13:56
ap_regkey.h	9.18 KB	-rw-rw-rw-	2011-09-23 17:38
ap_release.h	3.15 KB	-rw-rw-rw-	2023-10-16 17:28
ap_slotmem.h	7.26 KB	-rw-rw-rw-	2013-11-17 22:10
ap_socache.h	9.39 KB	-rw-rw-rw-	2012-02-11 00:47
apache_noprobes.h	15.93 KB	-rw-rw-rw-	2012-04-05 00:11
apr.h	18.28 KB	-rw-rw-rw-	2023-03-27 15:53
apr_allocator.h	6.25 KB	-rw-rw-rw-	2018-08-25 17:48
apr_anylock.h	5.06 KB	-rw-rw-rw-	2007-01-15 21:00
apr_atomic.h	6.25 KB	-rw-rw-rw-	2018-09-17 22:20
apr_base64.h	3.86 KB	-rw-rw-rw-	2012-12-23 00:24
apr_buckets.h	64.71 KB	-rw-rw-rw-	2021-09-18 17:25
apr_crypto.h	20.18 KB	-rw-rw-rw-	2017-06-14 00:28
apr_cstr.h	11.42 KB	-rw-rw-rw-	2016-12-03 22:49
apr_date.h	3.57 KB	-rw-rw-rw-	2007-01-15 21:00
apr_dbd.h	23.88 KB	-rw-rw-rw-	2017-04-02 21:57
apr_dbm.h	8.62 KB	-rw-rw-rw-	2008-11-21 08:20
apr_dso.h	2.73 KB	-rw-rw-rw-	2006-08-03 14:55
apr_encode.h	30.98 KB	-rw-rw-rw-	2022-10-18 11:38
apr_env.h	2.12 KB	-rw-rw-rw-	2009-09-26 00:07
apr_errno.h	55.08 KB	-rw-rw-rw-	2016-03-03 18:11
apr_escape.h	17.65 KB	-rw-rw-rw-	2018-08-26 14:24
apr_escape_test_char.h	1.4 KB	-rw-rw-rw-	2023-03-27 15:53
apr_file_info.h	17.59 KB	-rw-rw-rw-	2018-08-26 14:01
apr_file_io.h	43.11 KB	-rw-rw-rw-	2017-03-30 23:53
apr_fnmatch.h	6.23 KB	-rw-rw-rw-	2014-04-15 17:55
apr_general.h	7.36 KB	-rw-rw-rw-	2018-08-26 14:01
apr_getopt.h	6 KB	-rw-rw-rw-	2006-08-03 14:55
apr_global_mutex.h	7.38 KB	-rw-rw-rw-	2017-04-08 01:20
apr_hash.h	10.36 KB	-rw-rw-rw-	2020-11-08 10:13
apr_hooks.h	12.71 KB	-rw-rw-rw-	2013-10-03 17:32
apr_inherit.h	2.14 KB	-rw-rw-rw-	2013-10-03 17:29
apr_ldap.h	5.76 KB	-rw-rw-rw-	2023-01-24 11:36
apr_ldap_init.h	5.81 KB	-rw-rw-rw-	2009-02-19 10:04
apr_ldap_option.h	8.65 KB	-rw-rw-rw-	2009-02-19 10:04
apr_ldap_rebind.h	3.19 KB	-rw-rw-rw-	2009-02-19 10:04
apr_ldap_url.h	3.83 KB	-rw-rw-rw-	2009-02-19 10:04
apr_lib.h	8.47 KB	-rw-rw-rw-	2014-01-16 22:26
apr_md4.h	4.55 KB	-rw-rw-rw-	2007-01-15 21:00
apr_md5.h	6.37 KB	-rw-rw-rw-	2012-07-06 15:41
apr_memcache.h	17.25 KB	-rw-rw-rw-	2010-11-26 16:39
apr_mmap.h	5.18 KB	-rw-rw-rw-	2013-10-03 17:29
apr_network_io.h	36.95 KB	-rw-rw-rw-	2019-05-04 18:44
apr_optional.h	2.8 KB	-rw-rw-rw-	2007-01-15 21:00
apr_optional_hooks.h	3.9 KB	-rw-rw-rw-	2013-10-03 17:32
apr_perms_set.h	1.93 KB	-rw-rw-rw-	2014-04-28 16:08
apr_poll.h	21.04 KB	-rw-rw-rw-	2016-03-25 03:19
apr_pools.h	31.73 KB	-rw-rw-rw-	2022-06-18 00:09
apr_portable.h	20.56 KB	-rw-rw-rw-	2018-08-26 14:01
apr_proc_mutex.h	7.04 KB	-rw-rw-rw-	2017-04-08 01:20
apr_queue.h	4.12 KB	-rw-rw-rw-	2013-10-03 17:32
apr_random.h	5.07 KB	-rw-rw-rw-	2007-07-21 06:16
apr_redis.h	16.07 KB	-rw-rw-rw-	2017-09-27 20:02
apr_reslist.h	7.19 KB	-rw-rw-rw-	2013-10-03 17:32
apr_ring.h	19.28 KB	-rw-rw-rw-	2022-01-06 14:11
apr_rmm.h	4.8 KB	-rw-rw-rw-	2007-01-15 21:00
apr_sdbm.h	6.14 KB	-rw-rw-rw-	2007-10-23 13:59
apr_sha1.h	3.91 KB	-rw-rw-rw-	2007-01-15 21:00
apr_shm.h	9.48 KB	-rw-rw-rw-	2014-04-28 17:15
apr_signal.h	2.8 KB	-rw-rw-rw-	2007-08-05 19:48
apr_siphash.h	6.16 KB	-rw-rw-rw-	2017-06-15 00:00
apr_skiplist.h	14.56 KB	-rw-rw-rw-	2018-08-25 17:48
apr_strings.h	14.92 KB	-rw-rw-rw-	2018-08-26 14:01
apr_strmatch.h	2.69 KB	-rw-rw-rw-	2007-01-15 21:00
apr_support.h	1.65 KB	-rw-rw-rw-	2006-08-03 14:55
apr_tables.h	19.4 KB	-rw-rw-rw-	2020-11-08 09:24
apr_thread_cond.h	5.53 KB	-rw-rw-rw-	2007-06-29 21:20
apr_thread_mutex.h	4.51 KB	-rw-rw-rw-	2017-04-08 01:20
apr_thread_pool.h	11.14 KB	-rw-rw-rw-	2008-05-07 23:45
apr_thread_proc.h	36.11 KB	-rw-rw-rw-	2019-03-08 16:52
apr_thread_rwlock.h	4.78 KB	-rw-rw-rw-	2006-08-03 14:55
apr_time.h	7.62 KB	-rw-rw-rw-	2016-03-05 03:40
apr_uri.h	6.61 KB	-rw-rw-rw-	2009-01-07 22:39
apr_user.h	5.34 KB	-rw-rw-rw-	2013-10-03 17:29
apr_uuid.h	2.13 KB	-rw-rw-rw-	2007-01-15 21:00
apr_version.h	5.44 KB	-rw-rw-rw-	2023-04-13 11:38
apr_want.h	3.01 KB	-rw-rw-rw-	2012-08-15 00:48
apr_xlate.h	6.42 KB	-rw-rw-rw-	2007-01-15 21:00
apr_xml.h	12.54 KB	-rw-rw-rw-	2016-06-14 01:57
apu.h	4.76 KB	-rw-rw-rw-	2023-01-24 11:36
apu_errno.h	5.49 KB	-rw-rw-rw-	2009-01-07 22:35
apu_version.h	4.33 KB	-rw-rw-rw-	2023-02-01 09:56
apu_want.h	1.55 KB	-rw-rw-rw-	2023-01-24 11:36
cache_common.h	2.02 KB	-rw-rw-rw-	2013-05-29 00:30
expat.h	43.55 KB	-rw-rw-rw-	2022-10-25 19:09
heartbeat.h	1.62 KB	-rw-rw-rw-	2014-06-17 16:06
http_config.h	57.78 KB	-rw-rw-rw-	2022-02-23 16:39
http_connection.h	7.15 KB	-rw-rw-rw-	2021-09-26 18:11
http_core.h	37.25 KB	-rw-rw-rw-	2023-08-29 11:23
http_log.h	36.82 KB	-rw-rw-rw-	2016-08-25 16:48
http_main.h	3.25 KB	-rw-rw-rw-	2012-03-26 02:24
http_protocol.h	42.06 KB	-rw-rw-rw-	2022-06-01 16:34
http_request.h	26.34 KB	-rw-rw-rw-	2021-08-10 12:27
http_ssl.h	14.93 KB	-rw-rw-rw-	2022-08-22 00:26
http_vhost.h	4.61 KB	-rw-rw-rw-	2021-05-27 17:08
httpd.h	94.69 KB	-rw-rw-rw-	2022-03-09 16:04
mod_auth.h	4.55 KB	-rw-rw-rw-	2020-02-21 02:33
mod_cache.h	7.27 KB	-rw-rw-rw-	2011-12-03 20:02
mod_cgi.h	2.5 KB	-rw-rw-rw-	2011-09-23 17:38
mod_core.h	3.43 KB	-rw-rw-rw-	2012-09-24 13:49
mod_dav.h	100.22 KB	-rw-rw-rw-	2023-01-09 16:52
mod_dbd.h	4.18 KB	-rw-rw-rw-	2011-09-23 17:38
mod_http2.h	4.69 KB	-rw-rw-rw-	2023-08-29 11:23
mod_include.h	4.01 KB	-rw-rw-rw-	2011-09-23 17:38
mod_log_config.h	2.5 KB	-rw-rw-rw-	2011-09-23 17:38
mod_proxy.h	64.99 KB	-rw-rw-rw-	2023-03-31 18:33
mod_request.h	1.65 KB	-rw-rw-rw-	2011-02-18 20:40
mod_rewrite.h	1.41 KB	-rw-rw-rw-	2014-01-23 16:33
mod_so.h	1.23 KB	-rw-rw-rw-	2011-11-30 12:21
mod_ssl.h	4.99 KB	-rw-rw-rw-	2019-07-30 15:23
mod_ssl_openssl.h	4.79 KB	-rw-rw-rw-	2019-07-30 15:23
mod_status.h	2.45 KB	-rw-rw-rw-	2006-07-12 00:33
mod_watchdog.h	7.55 KB	-rw-rw-rw-	2014-09-05 18:19
mpm_common.h	17.39 KB	-rw-rw-rw-	2021-08-10 12:43
os.h	4.5 KB	-rw-rw-rw-	2021-04-21 05:10
scoreboard.h	9.98 KB	-rw-rw-rw-	2020-02-21 02:33
util_cfgtree.h	3.17 KB	-rw-rw-rw-	2011-09-23 17:38
util_charset.h	2.28 KB	-rw-rw-rw-	2014-11-01 11:19
util_cookies.h	4.99 KB	-rw-rw-rw-	2012-01-09 15:18
util_ebcdic.h	2.78 KB	-rw-rw-rw-	2014-11-01 11:19
util_fcgi.h	10.02 KB	-rw-rw-rw-	2020-02-21 02:33
util_filter.h	26.46 KB	-rw-rw-rw-	2013-04-15 16:37
util_ldap.h	18.33 KB	-rw-rw-rw-	2023-07-07 16:03
util_md5.h	2.19 KB	-rw-rw-rw-	2014-07-17 02:11
util_mutex.h	9.29 KB	-rw-rw-rw-	2011-10-09 22:35
util_script.h	9.8 KB	-rw-rw-rw-	2012-01-09 15:18
util_time.h	4.22 KB	-rw-rw-rw-	2023-07-18 01:16
util_varbuf.h	8.28 KB	-rw-rw-rw-	2014-07-19 21:22
util_xml.h	1.36 KB	-rw-rw-rw-	2014-07-19 21:22
zconf.h	16.83 KB	-rw-rw-rw-	2023-04-18 01:35
zlib.h	96.4 KB	-rw-rw-rw-	2023-08-18 12:45

Rename

/* 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
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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"
#include "apr_hooks.h"

#include "cache_common.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(type)            type
#define CACHE_DECLARE_NONSTD(type)     type
#define CACHE_DECLARE_DATA
#elif defined(CACHE_DECLARE_STATIC)
#define CACHE_DECLARE(type)            type __stdcall
#define CACHE_DECLARE_NONSTD(type)     type
#define CACHE_DECLARE_DATA
#elif defined(CACHE_DECLARE_EXPORT)
#define CACHE_DECLARE(type)            __declspec(dllexport) type __stdcall
#define CACHE_DECLARE_NONSTD(type)     __declspec(dllexport) type
#define CACHE_DECLARE_DATA             __declspec(dllexport)
#else
#define CACHE_DECLARE(type)            __declspec(dllimport) type __stdcall
#define CACHE_DECLARE_NONSTD(type)     __declspec(dllimport) type
#define CACHE_DECLARE_DATA             __declspec(dllimport)
#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
     */
    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 actually cached */
    apr_time_t response_time;
    /**
     * HTTP status code of the cached entity. Though not necessarily the
     * status code finally issued to the request.
     */
    int status;
    /* cached cache-control */
    cache_control_t control;
};

/* cache handle information */
typedef struct cache_object cache_object_t;
struct cache_object {
    const char *key;
    cache_object_t *next;
    cache_info info;
    /* Opaque portion (specific to the implementation) of the cache object */
    void *vobj;
};

typedef struct cache_handle cache_handle_t;
struct cache_handle {
    cache_object_t *cache_obj;
    apr_table_t *req_hdrs;        /* cached request headers */
    apr_table_t *resp_hdrs;       /* cached response headers */
};

#define CACHE_PROVIDER_GROUP "cache"

typedef struct {
    int (*remove_entity) (cache_handle_t *h);
    apr_status_t (*store_headers)(cache_handle_t *h, request_rec *r, cache_info *i);
    apr_status_t (*store_body)(cache_handle_t *h, request_rec *r, apr_bucket_brigade *in,
                           apr_bucket_brigade *out);
    apr_status_t (*recall_headers) (cache_handle_t *h, request_rec *r);
    apr_status_t (*recall_body) (cache_handle_t *h, apr_pool_t *p, apr_bucket_brigade *bb);
    int (*create_entity) (cache_handle_t *h, request_rec *r,
                           const char *urlkey, apr_off_t len, apr_bucket_brigade *bb);
    int (*open_entity) (cache_handle_t *h, request_rec *r,
                           const char *urlkey);
    int (*remove_url) (cache_handle_t *h, request_rec *r);
    apr_status_t (*commit_entity)(cache_handle_t *h, request_rec *r);
    apr_status_t (*invalidate_entity)(cache_handle_t *h, request_rec *r);
} cache_provider;

typedef enum {
    AP_CACHE_HIT,
    AP_CACHE_REVALIDATE,
    AP_CACHE_MISS,
    AP_CACHE_INVALIDATE
} ap_cache_status_e;

#define AP_CACHE_HIT_ENV "cache-hit"
#define AP_CACHE_REVALIDATE_ENV "cache-revalidate"
#define AP_CACHE_MISS_ENV "cache-miss"
#define AP_CACHE_INVALIDATE_ENV "cache-invalidate"
#define AP_CACHE_STATUS_ENV "cache-status"

/* cache_util.c */
/* do a HTTP/1.1 age calculation */
CACHE_DECLARE(apr_time_t) ap_cache_current_age(cache_info *info, const apr_time_t age_value,
                                               apr_time_t now);

CACHE_DECLARE(apr_time_t) ap_cache_hex2usec(const char *x);
CACHE_DECLARE(void) ap_cache_usec2hex(apr_time_t j, char *y);
CACHE_DECLARE(char *) ap_cache_generate_name(apr_pool_t *p, int dirlevels,
                                             int dirlength,
                                             const char *name);
CACHE_DECLARE(const char *)ap_cache_tokstr(apr_pool_t *p, const char *list, const char **str);

/* Create a new table consisting of those elements from an
 * headers table that are allowed to be stored in a cache.
 */
CACHE_DECLARE(apr_table_t *)ap_cache_cacheable_headers(apr_pool_t *pool,
                                                        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.
 */
CACHE_DECLARE(apr_table_t *)ap_cache_cacheable_headers_in(request_rec *r);

/* 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.
 */
CACHE_DECLARE(apr_table_t *)ap_cache_cacheable_headers_out(request_rec *r);

/**
 * Parse the Cache-Control and Pragma headers in one go, marking
 * which tokens appear within the header. Populate the structure
 * passed in.
 */
int ap_cache_control(request_rec *r, cache_control_t *cc, const char *cc_header,
        const char *pragma_header, apr_table_t *headers);

/* hooks */

/**
 * Cache status hook.
 * This hook is called as soon as the cache has made a decision as to whether
 * an entity should be served from cache (hit), should be served from cache
 * after a successful validation (revalidate), or served from the backend
 * and potentially cached (miss).
 *
 * A basic implementation of this hook exists in mod_cache which writes this
 * information to the subprocess environment, and optionally to request
 * headers. Further implementations may add hooks as appropriate to perform
 * more advanced processing, or to store statistics about the cache behaviour.
 */
APR_DECLARE_EXTERNAL_HOOK(cache, CACHE, int, cache_status, (cache_handle_t *h,
                request_rec *r, apr_table_t *headers, ap_cache_status_e status,
                const char *reason))

APR_DECLARE_OPTIONAL_FN(apr_status_t,
                        ap_cache_generate_key,
                        (request_rec *r, apr_pool_t*p, const char **key));

#endif /*MOD_CACHE_H*/
/** @} */