Modules
	Acessors
	File/Directory Accessor directives.

	Remote Host Resolution

Classes
struct	require_line
	A structure to keep track of authorization requirements. More...

struct	core_request_config
	Per-request configuration. More...

struct	core_dir_config
	Per-directory configuration. More...

struct	core_server_config

struct	core_filter_ctx

struct	core_net_rec

struct	ap_LINK_insert_network_bucket_t

union	ap_mgmt_value

struct	ap_mgmt_item_t

struct	ap_LINK_get_mgmt_items_t

struct	ap_errorlog_info

struct	ap_errorlog_handler

struct	ap_errorlog_format_item

struct	ap_LINK_error_log_t

struct	ap_LINK_get_pollfd_from_conn_t

Macros
#define	SATISFY_ALL 0

#define	SATISFY_ANY 1

#define	SATISFY_NOSPEC 2

#define	AP_MIN_BYTES_TO_WRITE 8000

#define	AP_DEFAULT_MAX_INTERNAL_REDIRECTS 10

#define	AP_DEFAULT_MAX_SUBREQ_DEPTH 10

#define	AP_CORE_MODULE_INDEX 0

#define	ap_get_core_module_config(v) (((void **)(v))[AP_CORE_MODULE_INDEX])

#define	ap_set_core_module_config(v, val) ((((void **)(v))[AP_CORE_MODULE_INDEX]) = (val))

#define	AP_NOTE_DIRECTORY_WALK 0

#define	AP_NOTE_LOCATION_WALK 1

#define	AP_NOTE_FILE_WALK 2

#define	AP_NOTE_IF_WALK 3

#define	AP_NUM_STD_NOTES 4

#define	ETAG_UNSET 0

#define	ETAG_NONE (1 << 0)

#define	ETAG_MTIME (1 << 1)

#define	ETAG_INODE (1 << 2)

#define	ETAG_SIZE (1 << 3)

#define	ETAG_DIGEST (1 << 4)

#define	ETAG_ALL (ETAG_MTIME \| ETAG_INODE \| ETAG_SIZE)

#define	ETAG_BACKWARD (ETAG_MTIME \| ETAG_SIZE)

#define	AP_CORE_CONFIG_OFF (0)

#define	AP_CORE_CONFIG_ON (1)

#define	AP_CORE_CONFIG_UNSET (2)

#define	AP_CORE_MERGE_FLAG(field, to, base, over)

#define	AP_SENDFILE_ENABLED(x) ((x) == ENABLE_SENDFILE_ON ? APR_SENDFILE_ENABLED : 0)

#define	AP_ERRORLOG_FLAG_FIELD_SEP 1

#define	AP_ERRORLOG_FLAG_MESSAGE 2

#define	AP_ERRORLOG_FLAG_REQUIRED 4

#define	AP_ERRORLOG_FLAG_NULL_AS_HYPHEN 8

#define	AP_SQ_MAIN_STATE 0

#define	AP_SQ_RUN_MODE 1

#define	AP_SQ_CONFIG_GEN 2

#define	AP_SQ_NOT_SUPPORTED -1

#define	AP_SQ_MS_INITIAL_STARTUP 1

#define	AP_SQ_MS_CREATE_PRE_CONFIG 2

#define	AP_SQ_MS_DESTROY_CONFIG 3

#define	AP_SQ_MS_CREATE_CONFIG 4

#define	AP_SQ_MS_RUN_MPM 5

#define	AP_SQ_MS_EXITING 6

#define	AP_SQ_RM_UNKNOWN 1

#define	AP_SQ_RM_NORMAL 2

#define	AP_SQ_RM_CONFIG_TEST 3

#define	AP_SQ_RM_CONFIG_DUMP 4

Typedefs
typedef struct require_line	require_line

typedef unsigned char	allow_options_t

typedef unsigned int	overrides_t

typedef unsigned long	etag_components_t

typedef struct core_output_filter_ctx	core_output_filter_ctx_t

typedef struct core_filter_ctx	core_ctx_t

typedef struct core_net_rec	core_net_rec

typedef apr_status_t	ap_HOOK_insert_network_bucket_t(conn_rec c, apr_bucket_brigade bb, apr_socket_t *socket)

typedef struct ap_LINK_insert_network_bucket_t	ap_LINK_insert_network_bucket_t

typedef struct ap_LINK_get_mgmt_items_t	ap_LINK_get_mgmt_items_t

typedef void()	apr_OFN_ap_logio_add_bytes_out_t(conn_rec *c, apr_off_t bytes)

typedef void()	apr_OFN_ap_logio_add_bytes_in_t(conn_rec *c, apr_off_t bytes)

typedef apr_off_t()	apr_OFN_ap_logio_get_last_bytes_t(conn_rec *c)

typedef struct ap_errorlog_info	ap_errorlog_info

typedef int	ap_errorlog_handler_fn_t(const ap_errorlog_info info, const char arg, char *buf, int buflen)

typedef struct ap_errorlog_handler	ap_errorlog_handler

typedef struct ap_LINK_error_log_t	ap_LINK_error_log_t

typedef const char *()	apr_OFN_ap_ident_lookup_t(request_rec *r)

typedef int()	apr_OFN_authz_some_auth_required_t(request_rec *r)

typedef const char *()	apr_OFN_authn_ap_auth_type_t(request_rec *r)

typedef const char *()	apr_OFN_authn_ap_auth_name_t(request_rec *r)

typedef int()	apr_OFN_access_compat_ap_satisfies_t(request_rec *r)

typedef apr_status_t	ap_HOOK_get_pollfd_from_conn_t(conn_rec c, struct apr_pollfd_t pfd, apr_interval_time_t *ptimeout)

typedef struct ap_LINK_get_pollfd_from_conn_t	ap_LINK_get_pollfd_from_conn_t

Enumerations
enum	server_signature_e { srv_sig_unset , srv_sig_off , srv_sig_on , srv_sig_withmail }
	Server Signature Enumeration. More...

enum	ap_mgmt_type_e { ap_mgmt_type_string , ap_mgmt_type_long , ap_mgmt_type_hash }

Functions
int	ap_allow_options (request_rec *r)

int	ap_allow_overrides (request_rec *r)

const char *	ap_document_root (request_rec *r)

const char *	ap_get_remote_logname (request_rec *r)

char *	ap_construct_url (apr_pool_t p, const char uri, request_rec *r)

const char *	ap_get_server_name (request_rec *r)

const char *	ap_get_server_name_for_url (request_rec *r)

apr_port_t	ap_get_server_port (const request_rec *r)

apr_size_t	ap_get_read_buf_size (const request_rec *r)

apr_off_t	ap_get_limit_req_body (const request_rec *r)

apr_size_t	ap_get_limit_xml_body (const request_rec *r)

void	ap_custom_response (request_rec r, int status, const char string)

int	ap_is_recursion_limit_exceeded (const request_rec *r)

int	ap_exists_config_define (const char *name)

int	ap_core_translate (request_rec *r)

const char *	ap_auth_type (request_rec *r)

const char *	ap_auth_name (request_rec *r)

int	ap_satisfies (request_rec *r)

void *	ap_get_core_module_config (const ap_conf_vector_t *cv)

void	ap_set_core_module_config (ap_conf_vector_t cv, void val)

apr_socket_t *	ap_get_conn_socket (conn_rec *c)

apr_size_t	ap_register_request_note (void)

void **	ap_get_request_note (request_rec *r, apr_size_t note_num)

void	ap_add_output_filters_by_type (request_rec *r)

void	ap_core_reorder_directories (apr_pool_t , server_rec )

void	ap_add_per_dir_conf (server_rec s, void dir_config)

void	ap_add_per_url_conf (server_rec s, void url_config)

void	ap_add_file_conf (apr_pool_t p, core_dir_config conf, void *url_config)

const char *	ap_add_if_conf (apr_pool_t p, core_dir_config conf, void *url_config)

const char *	ap_limit_section (cmd_parms cmd, void dummy, const char *arg)

apr_status_t	ap_core_input_filter (ap_filter_t f, apr_bucket_brigade b, ap_input_mode_t mode, apr_read_type_e block, apr_off_t readbytes)

apr_status_t	ap_core_output_filter (ap_filter_t f, apr_bucket_brigade b)

const char *	ap_get_server_protocol (server_rec *s)

void	ap_set_server_protocol (server_rec s, const char proto)

void	ap_hook_insert_network_bucket (ap_HOOK_insert_network_bucket_t pf, const char const aszPre, const char const *aszSucc, int nOrder)

apr_status_t	ap_run_insert_network_bucket (conn_rec c, apr_bucket_brigade bb, apr_socket_t *socket)

apr_array_header_t *	ap_hook_get_insert_network_bucket (void)

void	ap_hook_get_mgmt_items (ap_HOOK_get_mgmt_items_t pf, const char const aszPre, const char const *aszSucc, int nOrder)

int	ap_run_get_mgmt_items (apr_pool_t p, const char val, apr_hash_t *ht)

apr_array_header_t *	ap_hook_get_get_mgmt_items (void)

void	ap_register_errorlog_handler (apr_pool_t p, char tag, ap_errorlog_handler_fn_t *handler, int flags)

void	ap_hook_error_log (ap_HOOK_error_log_t pf, const char const aszPre, const char const *aszSucc, int nOrder)

void	ap_run_error_log (const ap_errorlog_info info, const char errstr)

apr_array_header_t *	ap_hook_get_error_log (void)

void	ap_register_log_hooks (apr_pool_t *p)

void	ap_register_config_hooks (apr_pool_t *p)

int	ap_state_query (int query_code)

void	ap_hook_get_pollfd_from_conn (ap_HOOK_get_pollfd_from_conn_t pf, const char const aszPre, const char const *aszSucc, int nOrder)

apr_status_t	ap_run_get_pollfd_from_conn (conn_rec c, struct apr_pollfd_t pfd, apr_interval_time_t *ptimeout)

apr_array_header_t *	ap_hook_get_get_pollfd_from_conn (void)

apr_status_t	ap_get_pollfd_from_conn (conn_rec c, struct apr_pollfd_t pfd, apr_interval_time_t *ptimeout)

Variables
ap_filter_rec_t *	ap_subreq_core_filter_handle

ap_filter_rec_t *	ap_core_output_filter_handle

ap_filter_rec_t *	ap_content_length_filter_handle

ap_filter_rec_t *	ap_core_input_filter_handle

Detailed Description

Macro Definition Documentation

◆ AP_CORE_CONFIG_OFF

#define AP_CORE_CONFIG_OFF (0)

Definition at line 504 of file http_core.h.

◆ AP_CORE_CONFIG_ON

#define AP_CORE_CONFIG_ON (1)

Definition at line 505 of file http_core.h.

◆ AP_CORE_CONFIG_UNSET

#define AP_CORE_CONFIG_UNSET (2)

Definition at line 506 of file http_core.h.

◆ AP_CORE_MERGE_FLAG

#define AP_CORE_MERGE_FLAG	(	field,
		to,
		base,
		over
	)

Value:

               to->field = \
               over->field != AP_CORE_CONFIG_UNSET            \
               ? over->field                                  \
               : base->field

Definition at line 509 of file http_core.h.

◆ AP_CORE_MODULE_INDEX

#define AP_CORE_MODULE_INDEX 0

Definition at line 382 of file http_core.h.

◆ AP_DEFAULT_MAX_INTERNAL_REDIRECTS

#define AP_DEFAULT_MAX_INTERNAL_REDIRECTS 10

default maximum of internal redirects

Definition at line 134 of file http_core.h.

◆ AP_DEFAULT_MAX_SUBREQ_DEPTH

#define AP_DEFAULT_MAX_SUBREQ_DEPTH 10

default maximum subrequest nesting level

Definition at line 137 of file http_core.h.

◆ AP_ERRORLOG_FLAG_FIELD_SEP

#define AP_ERRORLOG_FLAG_FIELD_SEP 1

item starts a new field

Definition at line 958 of file http_core.h.

◆ AP_ERRORLOG_FLAG_MESSAGE

#define AP_ERRORLOG_FLAG_MESSAGE 2

item is the actual error message

Definition at line 960 of file http_core.h.

◆ AP_ERRORLOG_FLAG_NULL_AS_HYPHEN

#define AP_ERRORLOG_FLAG_NULL_AS_HYPHEN 8

log zero-length item as '-'

Definition at line 964 of file http_core.h.

◆ AP_ERRORLOG_FLAG_REQUIRED

#define AP_ERRORLOG_FLAG_REQUIRED 4

skip whole line if item is zero-length

Definition at line 962 of file http_core.h.

◆ ap_get_core_module_config

#define ap_get_core_module_config ( v ) (((void **)(v))[AP_CORE_MODULE_INDEX])

Definition at line 383 of file http_core.h.

◆ AP_MIN_BYTES_TO_WRITE

#define AP_MIN_BYTES_TO_WRITE 8000

Make sure we don't write less than 8000 bytes at any one time.

Definition at line 131 of file http_core.h.

◆ AP_NOTE_DIRECTORY_WALK

#define AP_NOTE_DIRECTORY_WALK 0

Definition at line 450 of file http_core.h.

◆ AP_NOTE_FILE_WALK

#define AP_NOTE_FILE_WALK 2

Definition at line 452 of file http_core.h.

◆ AP_NOTE_IF_WALK

#define AP_NOTE_IF_WALK 3

Definition at line 453 of file http_core.h.

◆ AP_NOTE_LOCATION_WALK

#define AP_NOTE_LOCATION_WALK 1

Definition at line 451 of file http_core.h.

◆ AP_NUM_STD_NOTES

#define AP_NUM_STD_NOTES 4

Definition at line 454 of file http_core.h.

◆ AP_SENDFILE_ENABLED

#define AP_SENDFILE_ENABLED ( x ) ((x) == ENABLE_SENDFILE_ON ? APR_SENDFILE_ENABLED : 0)

Definition at line 689 of file http_core.h.

◆ ap_set_core_module_config

#define ap_set_core_module_config	(	v,
		val
	)	((((void **)(v))[AP_CORE_MODULE_INDEX]) = (val))

Definition at line 385 of file http_core.h.

◆ AP_SQ_CONFIG_GEN

#define AP_SQ_CONFIG_GEN 2

generation of the top-level apache parent

Definition at line 1034 of file http_core.h.

◆ AP_SQ_MAIN_STATE

#define AP_SQ_MAIN_STATE 0

current status of the server

Definition at line 1030 of file http_core.h.

◆ AP_SQ_MS_CREATE_CONFIG

#define AP_SQ_MS_CREATE_CONFIG 4

normal configuration run

Definition at line 1051 of file http_core.h.

◆ AP_SQ_MS_CREATE_PRE_CONFIG

#define AP_SQ_MS_CREATE_PRE_CONFIG 2

initial configuration run for setting up log config, etc.

Definition at line 1047 of file http_core.h.

◆ AP_SQ_MS_DESTROY_CONFIG

#define AP_SQ_MS_DESTROY_CONFIG 3

tearing down configuration

Definition at line 1049 of file http_core.h.

◆ AP_SQ_MS_EXITING

#define AP_SQ_MS_EXITING 6

cleaning up for exit

Definition at line 1055 of file http_core.h.

◆ AP_SQ_MS_INITIAL_STARTUP

#define AP_SQ_MS_INITIAL_STARTUP 1

before the config preflight

Definition at line 1045 of file http_core.h.

◆ AP_SQ_MS_RUN_MPM

#define AP_SQ_MS_RUN_MPM 5

running the MPM

Definition at line 1053 of file http_core.h.

◆ AP_SQ_NOT_SUPPORTED

#define AP_SQ_NOT_SUPPORTED -1

return value for unknown query_code

Definition at line 1041 of file http_core.h.

◆ AP_SQ_RM_CONFIG_DUMP

#define AP_SQ_RM_CONFIG_DUMP 4

only dump some parts of the config

Definition at line 1065 of file http_core.h.

◆ AP_SQ_RM_CONFIG_TEST

#define AP_SQ_RM_CONFIG_TEST 3

config test only

Definition at line 1063 of file http_core.h.

◆ AP_SQ_RM_NORMAL

#define AP_SQ_RM_NORMAL 2

normal operation (server requests or signal server)

Definition at line 1061 of file http_core.h.

◆ AP_SQ_RM_UNKNOWN

#define AP_SQ_RM_UNKNOWN 1

command line not yet parsed

Definition at line 1059 of file http_core.h.

◆ AP_SQ_RUN_MODE

#define AP_SQ_RUN_MODE 1

are we going to serve requests or are we just testing/dumping config

Definition at line 1032 of file http_core.h.

◆ ETAG_ALL

#define ETAG_ALL (ETAG_MTIME | ETAG_INODE | ETAG_SIZE)

Definition at line 499 of file http_core.h.

◆ ETAG_BACKWARD

#define ETAG_BACKWARD (ETAG_MTIME | ETAG_SIZE)

Definition at line 501 of file http_core.h.

◆ ETAG_DIGEST

#define ETAG_DIGEST (1 << 4)

Definition at line 498 of file http_core.h.

◆ ETAG_INODE

#define ETAG_INODE (1 << 2)

Definition at line 496 of file http_core.h.

◆ ETAG_MTIME

#define ETAG_MTIME (1 << 1)

Definition at line 495 of file http_core.h.

◆ ETAG_NONE

#define ETAG_NONE (1 << 0)

Definition at line 494 of file http_core.h.

◆ ETAG_SIZE

#define ETAG_SIZE (1 << 3)

Definition at line 497 of file http_core.h.

◆ ETAG_UNSET

#define ETAG_UNSET 0

Definition at line 493 of file http_core.h.

◆ SATISFY_ALL

#define SATISFY_ALL 0

all of the requirements must be met

Definition at line 123 of file http_core.h.

◆ SATISFY_ANY

#define SATISFY_ANY 1

any of the requirements must be met

Definition at line 125 of file http_core.h.

◆ SATISFY_NOSPEC

#define SATISFY_NOSPEC 2

There are no applicable satisfy lines

Definition at line 127 of file http_core.h.

Typedef Documentation

◆ allow_options_t

typedef unsigned char allow_options_t

Definition at line 482 of file http_core.h.

◆ ap_errorlog_handler

typedef struct ap_errorlog_handler ap_errorlog_handler

◆ ap_errorlog_handler_fn_t

typedef int ap_errorlog_handler_fn_t(const ap_errorlog_info *info, const char *arg, char *buf, int buflen)

callback function prototype for a external errorlog handler

Note: To avoid unbounded memory usage, these functions must not allocate memory from the server, connection, or request pools. If an errorlog handler absolutely needs a pool to pass to other functions, it must create and destroy a sub-pool.

Definition at line 938 of file http_core.h.

◆ ap_errorlog_info

typedef struct ap_errorlog_info ap_errorlog_info

The info structure passed to callback functions of errorlog handlers. Not all information is available in all contexts. In particular, all pointers may be NULL.

◆ ap_HOOK_get_pollfd_from_conn_t

typedef apr_status_t ap_HOOK_get_pollfd_from_conn_t(conn_rec *c, struct apr_pollfd_t *pfd, apr_interval_time_t *ptimeout)

Get a apr_pollfd_t populated with descriptor and descriptor type and the timeout to use for it.

Returns: APR_ENOTIMPL if not supported for a connection.

Definition at line 1073 of file http_core.h.

◆ ap_HOOK_insert_network_bucket_t

typedef apr_status_t ap_HOOK_insert_network_bucket_t(conn_rec *c, apr_bucket_brigade *bb, apr_socket_t *socket)

Insert the network bucket into the core input filter's input brigade. This hook is intended for MPMs or protocol modules that need to do special socket setup.

Parameters

c	The connection
bb	The brigade to insert the bucket into
socket	The socket to put into a bucket

Returns: AP_DECLINED if the current function does not handle this connection, APR_SUCCESS or an error otherwise.

Definition at line 817 of file http_core.h.

◆ ap_LINK_error_log_t

typedef struct ap_LINK_error_log_t ap_LINK_error_log_t

◆ ap_LINK_get_mgmt_items_t

typedef struct ap_LINK_get_mgmt_items_t ap_LINK_get_mgmt_items_t

◆ ap_LINK_get_pollfd_from_conn_t

typedef struct ap_LINK_get_pollfd_from_conn_t ap_LINK_get_pollfd_from_conn_t

◆ ap_LINK_insert_network_bucket_t

typedef struct ap_LINK_insert_network_bucket_t ap_LINK_insert_network_bucket_t

◆ apr_OFN_access_compat_ap_satisfies_t

typedef int() apr_OFN_access_compat_ap_satisfies_t(request_rec *r)

Definition at line 1015 of file http_core.h.

◆ apr_OFN_ap_ident_lookup_t

typedef const char *() apr_OFN_ap_ident_lookup_t(request_rec *r)

Definition at line 999 of file http_core.h.

◆ apr_OFN_ap_logio_add_bytes_in_t

typedef void() apr_OFN_ap_logio_add_bytes_in_t(conn_rec *c, apr_off_t bytes)

Definition at line 876 of file http_core.h.

◆ apr_OFN_ap_logio_add_bytes_out_t

typedef void() apr_OFN_ap_logio_add_bytes_out_t(conn_rec *c, apr_off_t bytes)

Definition at line 873 of file http_core.h.

◆ apr_OFN_ap_logio_get_last_bytes_t

typedef apr_off_t() apr_OFN_ap_logio_get_last_bytes_t(conn_rec *c)

Definition at line 878 of file http_core.h.

◆ apr_OFN_authn_ap_auth_name_t

typedef const char *() apr_OFN_authn_ap_auth_name_t(request_rec *r)

Definition at line 1008 of file http_core.h.

◆ apr_OFN_authn_ap_auth_type_t

typedef const char *() apr_OFN_authn_ap_auth_type_t(request_rec *r)

Definition at line 1007 of file http_core.h.

◆ apr_OFN_authz_some_auth_required_t

typedef int() apr_OFN_authz_some_auth_required_t(request_rec *r)

Definition at line 1006 of file http_core.h.

◆ core_ctx_t

typedef struct core_filter_ctx core_ctx_t

Definition at line 788 of file http_core.h.

◆ core_net_rec

typedef struct core_net_rec core_net_rec

◆ core_output_filter_ctx_t

typedef struct core_output_filter_ctx core_output_filter_ctx_t

Definition at line 787 of file http_core.h.

◆ etag_components_t

typedef unsigned long etag_components_t

Definition at line 491 of file http_core.h.

◆ overrides_t

typedef unsigned int overrides_t

Definition at line 483 of file http_core.h.

◆ require_line

typedef struct require_line require_line

See also: require_line

Definition at line 311 of file http_core.h.

Enumeration Type Documentation

◆ ap_mgmt_type_e

enum ap_mgmt_type_e

Enumerator
ap_mgmt_type_string
ap_mgmt_type_long
ap_mgmt_type_hash

Definition at line 824 of file http_core.h.

◆ server_signature_e

enum server_signature_e

Server Signature Enumeration.

Enumerator
srv_sig_unset
srv_sig_off
srv_sig_on
srv_sig_withmail

Definition at line 517 of file http_core.h.

Function Documentation

◆ ap_add_file_conf()

void ap_add_file_conf	(	apr_pool_t *	p,
		core_dir_config *	conf,
		void *	url_config
	)

Definition at line 632 of file core.c.

◆ ap_add_if_conf()

const char * ap_add_if_conf	(	apr_pool_t *	p,
		core_dir_config *	conf,
		void *	url_config
	)

Definition at line 644 of file core.c.

◆ ap_add_output_filters_by_type()

void ap_add_output_filters_by_type ( request_rec * r )

◆ ap_add_per_dir_conf()

void ap_add_per_dir_conf	(	server_rec *	s,
		void *	dir_config
	)

Definition at line 616 of file core.c.

◆ ap_add_per_url_conf()

void ap_add_per_url_conf	(	server_rec *	s,
		void *	url_config
	)

Definition at line 624 of file core.c.

◆ ap_allow_options()

int ap_allow_options ( request_rec * r )

Retrieve the value of Options for this request

Parameters

r	The current request

Returns: the Options bitmask

Definition at line 771 of file core.c.

◆ ap_allow_overrides()

int ap_allow_overrides ( request_rec * r )

Retrieve the value of the AllowOverride for this request

Parameters

r	The current request

Returns: the overrides bitmask

Definition at line 779 of file core.c.

◆ ap_auth_name()

const char * ap_auth_name ( request_rec * r )

Return the current Authorization realm

Parameters

r	The current request

Returns: The current authorization realm

Definition at line 807 of file core.c.

◆ ap_auth_type()

const char * ap_auth_type ( request_rec * r )

Return the type of authorization required for this request

Parameters

r	The current request

Returns: The authorization required

Definition at line 793 of file core.c.

◆ ap_construct_url()

char * ap_construct_url	(	apr_pool_t *	p,
		const char *	uri,
		request_rec *	r
	)

build a fully qualified URL from the uri and information in the request rec

Parameters

p	The pool to allocate the URL from
uri	The path to the requested file
r	The current request

Returns: A fully qualified URL

Definition at line 1246 of file core.c.

◆ ap_core_input_filter()

apr_status_t ap_core_input_filter	(	ap_filter_t *	f,
		apr_bucket_brigade *	b,
		ap_input_mode_t	mode,
		apr_read_type_e	block,
		apr_off_t	readbytes
	)

Definition at line 90 of file core_filters.c.

◆ ap_core_output_filter()

apr_status_t ap_core_output_filter	(	ap_filter_t *	f,
		apr_bucket_brigade *	b
	)

< Can write without blocking

Definition at line 453 of file core_filters.c.

◆ ap_core_reorder_directories()

void ap_core_reorder_directories	(	apr_pool_t *	p,
		server_rec *	s
	)

Definition at line 720 of file core.c.

◆ ap_core_translate()

int ap_core_translate ( request_rec * r )

< Module has handled this stage.

Definition at line 4756 of file core.c.

◆ ap_custom_response()

void ap_custom_response	(	request_rec *	r,
		int	status,
		const char *	string
	)

Install a custom response handler for a given status

Parameters

r	The current request
status	The status for which the custom response should be used
string	The custom response. This can be a static string, a file or a URL

Definition at line 1648 of file core.c.

◆ ap_document_root()

const char * ap_document_root ( request_rec * r )

Retrieve the document root for this server

Parameters

r	The current request

Warning: Don't use this! If your request went through a Userdir, or something like that, it'll screw you. But it's back-compatible...

Returns: The document root

Definition at line 829 of file core.c.

◆ ap_exists_config_define()

int ap_exists_config_define ( const char * name )

Check for a definition from the server command line

Parameters

name	The define to check for

Returns: 1 if defined, 0 otherwise

Definition at line 2896 of file core.c.

◆ ap_get_conn_socket()

apr_socket_t * ap_get_conn_socket ( conn_rec * c )

Get the socket from the core network filter. This should be used instead of accessing the core connection config directly.

Parameters

c	The connection record

Returns: The socket

Definition at line 5202 of file core.c.

◆ ap_get_core_module_config()

void * ap_get_core_module_config ( const ap_conf_vector_t * cv )

Accessor for core_module's specific data. Equivalent to ap_get_module_config(cv, &core_module) but more efficient.

Parameters

cv	The vector in which the modules configuration is stored. usually r->per_dir_config or s->module_config

Returns: The module-specific data

Definition at line 126 of file util_debug.c.

◆ ap_get_limit_req_body()

apr_off_t ap_get_limit_req_body ( const request_rec * r )

Return the limit on bytes in request msg body

Parameters

r	The current request

Returns: the maximum number of bytes in the request msg body

Definition at line 1259 of file core.c.

◆ ap_get_limit_xml_body()

apr_size_t ap_get_limit_xml_body ( const request_rec * r )

Return the limit on bytes in XML request msg body

Parameters

r	The current request

Returns: the maximum number of bytes in XML request msg body

Definition at line 3863 of file core.c.

◆ ap_get_pollfd_from_conn()

apr_status_t ap_get_pollfd_from_conn	(	conn_rec *	c,
		struct apr_pollfd_t *	pfd,
		apr_interval_time_t *	ptimeout
	)

Pass in a struct apr_pollfd_t* and get desc_type and desc populated with a suitable value for polling connection input. For primary connection (c->master == NULL), this will be the connection socket. For secondary connections this may differ or not be available at all. Note that APR_NO_DESC may be set to indicate that the connection input is already closed.

Parameters

pfd	the pollfd to set the descriptor in
ptimeout	!= NULL to retrieve the timeout in effect

Returns: ARP_SUCCESS when the information was assigned.

Definition at line 5651 of file core.c.

◆ ap_get_read_buf_size()

apr_size_t ap_get_read_buf_size ( const request_rec * r )

Get the size of read buffers

Parameters

r	The current request

Returns: The read buffers size

Definition at line 1271 of file core.c.

◆ ap_get_remote_logname()

const char * ap_get_remote_logname ( request_rec * r )

Retrieve the login name of the remote user. Undef if it could not be determined

Parameters

r	The current request

Returns: The user logged in to the client machine

Definition at line 1121 of file core.c.

◆ ap_get_request_note()

void ** ap_get_request_note	(	request_rec *	r,
		apr_size_t	note_num
	)

Retrieve a pointer to an element in the core_request_config->notes array

Parameters

r	The request
note_num	A key for the element: either a value obtained from ap_register_request_note() or one of the predefined AP_NOTE_* values.

Returns: NULL if the note_num is invalid, otherwise a pointer to the requested note element.

Remarks: At the start of a request, each note element is NULL. The handle provided by ap_get_request_note() is a pointer-to-pointer so that the caller can point the element to some app-specific data structure. The caller should guarantee that any such structure will last as long as the request itself.

Definition at line 5184 of file core.c.

◆ ap_get_server_name()

const char * ap_get_server_name ( request_rec * r )

Get the current server name from the request

Parameters

r	The current request

Returns: the server name

Definition at line 1145 of file core.c.

◆ ap_get_server_name_for_url()

const char * ap_get_server_name_for_url ( request_rec * r )

Get the current server name from the request for the purposes of using in a URL. If the server name is an IPv6 literal address, it will be returned in URL format (e.g., "[fe80::1]").

Parameters

r	The current request

Returns: the server name

Definition at line 1187 of file core.c.

◆ ap_get_server_port()

apr_port_t ap_get_server_port ( const request_rec * r )

Get the current server port

Parameters

r	The current request

Returns: The server's port

Definition at line 1199 of file core.c.

◆ ap_get_server_protocol()

const char * ap_get_server_protocol ( server_rec * s )

Definition at line 3084 of file core.c.

◆ ap_hook_error_log()

void ap_hook_error_log	(	ap_HOOK_error_log_t *	pf,
		const char const	aszPre,
		const char const	aszSucc,
		int	nOrder
	)

Definition at line 2004 of file log.c.

◆ ap_hook_get_error_log()

apr_array_header_t * ap_hook_get_error_log ( void )

Definition at line 2004 of file log.c.

◆ ap_hook_get_get_mgmt_items()

apr_array_header_t * ap_hook_get_get_mgmt_items ( void )

Definition at line 103 of file core.c.

◆ ap_hook_get_get_pollfd_from_conn()

apr_array_header_t * ap_hook_get_get_pollfd_from_conn ( void )

Definition at line 113 of file core.c.

◆ ap_hook_get_insert_network_bucket()

apr_array_header_t * ap_hook_get_insert_network_bucket ( void )

Definition at line 108 of file core.c.

◆ ap_hook_get_mgmt_items()

void ap_hook_get_mgmt_items	(	ap_HOOK_get_mgmt_items_t *	pf,
		const char const	aszPre,
		const char const	aszSucc,
		int	nOrder
	)

Definition at line 103 of file core.c.

◆ ap_hook_get_pollfd_from_conn()

void ap_hook_get_pollfd_from_conn	(	ap_HOOK_get_pollfd_from_conn_t *	pf,
		const char const	aszPre,
		const char const	aszSucc,
		int	nOrder
	)

Definition at line 113 of file core.c.

◆ ap_hook_insert_network_bucket()

void ap_hook_insert_network_bucket	(	ap_HOOK_insert_network_bucket_t *	pf,
		const char const	aszPre,
		const char const	aszSucc,
		int	nOrder
	)

Definition at line 108 of file core.c.

◆ ap_is_recursion_limit_exceeded()

int ap_is_recursion_limit_exceeded ( const request_rec * r )

Check if the current request is beyond the configured max. number of redirects or subrequests

Parameters

r	The current request

Returns: true (is exceeded) or false

Definition at line 3992 of file core.c.

◆ ap_limit_section()

const char * ap_limit_section	(	cmd_parms *	cmd,
		void *	dummy,
		const char *	arg
	)

RFC 2616: HTTP

no valid method

Definition at line 2366 of file core.c.

◆ ap_register_config_hooks()

void ap_register_config_hooks ( apr_pool_t * p )

Definition at line 2288 of file config.c.

◆ ap_register_errorlog_handler()

void ap_register_errorlog_handler	(	apr_pool_t *	p,
		char *	tag,
		ap_errorlog_handler_fn_t *	handler,
		int	flags
	)

Register external errorlog handler

Parameters

p	config pool to use
tag	the new format specifier (i.e. the letter after the %)
handler	the handler function
flags	flags (reserved, set to 0)

Definition at line 4407 of file core.c.

◆ ap_register_log_hooks()

void ap_register_log_hooks ( apr_pool_t * p )

Definition at line 941 of file log.c.

◆ ap_register_request_note()

apr_size_t ap_register_request_note ( void )

Reserve an element in the core_request_config->notes array for some application-specific data

Returns: An integer key that can be passed to ap_get_request_note() during request processing to access this element for the current request.

Definition at line 5177 of file core.c.

◆ ap_run_error_log()

void ap_run_error_log	(	const ap_errorlog_info *	info,
		const char *	errstr
	)

Definition at line 2004 of file log.c.

◆ ap_run_get_mgmt_items()

int ap_run_get_mgmt_items	(	apr_pool_t *	p,
		const char *	val,
		apr_hash_t *	ht
	)

< Module has handled this stage.

< Module declines to handle

< Module has handled this stage.

Definition at line 103 of file core.c.

◆ ap_run_get_pollfd_from_conn()

apr_status_t ap_run_get_pollfd_from_conn	(	conn_rec *	c,
		struct apr_pollfd_t *	pfd,
		apr_interval_time_t *	ptimeout
	)

Definition at line 113 of file core.c.

◆ ap_run_insert_network_bucket()

apr_status_t ap_run_insert_network_bucket	(	conn_rec *	c,
		apr_bucket_brigade *	bb,
		apr_socket_t *	socket
	)

Definition at line 108 of file core.c.

◆ ap_satisfies()

int ap_satisfies ( request_rec * r )

How the requires lines must be met.

Parameters

r	The current request

Returns

How the requirements must be met. One of:

     SATISFY_ANY    -- any of the requirements must be met.
     SATISFY_ALL    -- all of the requirements must be met.
     SATISFY_NOSPEC -- There are no applicable satisfy lines

Definition at line 821 of file core.c.

◆ ap_set_core_module_config()

void ap_set_core_module_config	(	ap_conf_vector_t *	cv,
		void *	val
	)

Accessor to set core_module's specific data. Equivalent to ap_set_module_config(cv, &core_module, val) but more efficient.

Parameters

cv	The vector in which the modules configuration is stored. usually r->per_dir_config or s->module_config
val	The module-specific data to set

Definition at line 233 of file util_debug.c.

◆ ap_set_server_protocol()

void ap_set_server_protocol	(	server_rec *	s,
		const char *	proto
	)

Definition at line 3090 of file core.c.

◆ ap_state_query()

int ap_state_query ( int query_code )

Query the server for some state information

Parameters

query_code Which information is requested

Returns: the requested state information

Definition at line 5378 of file core.c.

Variable Documentation

◆ ap_content_length_filter_handle

ap_filter_rec_t* ap_content_length_filter_handle

extern

Definition at line 133 of file core.c.

◆ ap_core_input_filter_handle

ap_filter_rec_t* ap_core_input_filter_handle

extern

Definition at line 134 of file core.c.

◆ ap_core_output_filter_handle

ap_filter_rec_t* ap_core_output_filter_handle

extern

Definition at line 132 of file core.c.

◆ ap_subreq_core_filter_handle

ap_filter_rec_t* ap_subreq_core_filter_handle

extern

Definition at line 131 of file core.c.

Modules

Classes

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ AP_CORE_CONFIG_OFF

◆ AP_CORE_CONFIG_ON

◆ AP_CORE_CONFIG_UNSET

◆ AP_CORE_MERGE_FLAG

◆ AP_CORE_MODULE_INDEX

◆ AP_DEFAULT_MAX_INTERNAL_REDIRECTS

◆ AP_DEFAULT_MAX_SUBREQ_DEPTH

◆ AP_ERRORLOG_FLAG_FIELD_SEP

◆ AP_ERRORLOG_FLAG_MESSAGE

◆ AP_ERRORLOG_FLAG_NULL_AS_HYPHEN

◆ AP_ERRORLOG_FLAG_REQUIRED

◆ ap_get_core_module_config

◆ AP_MIN_BYTES_TO_WRITE

◆ AP_NOTE_DIRECTORY_WALK

◆ AP_NOTE_FILE_WALK

◆ AP_NOTE_IF_WALK

◆ AP_NOTE_LOCATION_WALK

◆ AP_NUM_STD_NOTES

◆ AP_SENDFILE_ENABLED

◆ ap_set_core_module_config

◆ AP_SQ_CONFIG_GEN

◆ AP_SQ_MAIN_STATE

◆ AP_SQ_MS_CREATE_CONFIG

◆ AP_SQ_MS_CREATE_PRE_CONFIG

◆ AP_SQ_MS_DESTROY_CONFIG

◆ AP_SQ_MS_EXITING

◆ AP_SQ_MS_INITIAL_STARTUP

◆ AP_SQ_MS_RUN_MPM

◆ AP_SQ_NOT_SUPPORTED

◆ AP_SQ_RM_CONFIG_DUMP

◆ AP_SQ_RM_CONFIG_TEST

◆ AP_SQ_RM_NORMAL

◆ AP_SQ_RM_UNKNOWN

◆ AP_SQ_RUN_MODE

◆ ETAG_ALL

◆ ETAG_BACKWARD

◆ ETAG_DIGEST

◆ ETAG_INODE

◆ ETAG_MTIME

◆ ETAG_NONE

◆ ETAG_SIZE

◆ ETAG_UNSET

◆ SATISFY_ALL

◆ SATISFY_ANY

◆ SATISFY_NOSPEC

Typedef Documentation

◆ allow_options_t

◆ ap_errorlog_handler

◆ ap_errorlog_handler_fn_t

◆ ap_errorlog_info

◆ ap_HOOK_get_pollfd_from_conn_t

◆ ap_HOOK_insert_network_bucket_t

◆ ap_LINK_error_log_t

◆ ap_LINK_get_mgmt_items_t

◆ ap_LINK_get_pollfd_from_conn_t

◆ ap_LINK_insert_network_bucket_t

◆ apr_OFN_access_compat_ap_satisfies_t

◆ apr_OFN_ap_ident_lookup_t

◆ apr_OFN_ap_logio_add_bytes_in_t

◆ apr_OFN_ap_logio_add_bytes_out_t

◆ apr_OFN_ap_logio_get_last_bytes_t

◆ apr_OFN_authn_ap_auth_name_t

◆ apr_OFN_authn_ap_auth_type_t

◆ apr_OFN_authz_some_auth_required_t

◆ core_ctx_t

◆ core_net_rec

◆ core_output_filter_ctx_t

◆ etag_components_t

◆ overrides_t

◆ require_line

Enumeration Type Documentation