Apache2
|
Modules | |
Acessors | |
File/Directory Accessor directives. | |
Remote Host Resolution | |
Data Structures | |
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 |
union | ap_mgmt_value |
struct | ap_mgmt_item_t |
struct | ap_errorlog_info |
struct | ap_errorlog_provider |
struct | ap_errorlog_handler |
struct | ap_errorlog_format_item |
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 ap_errorlog_info | ap_errorlog_info |
typedef struct ap_errorlog_provider | ap_errorlog_provider |
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 |
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 } |
#define AP_CORE_CONFIG_OFF (0) |
#define AP_CORE_CONFIG_ON (1) |
#define AP_CORE_CONFIG_UNSET (2) |
#define AP_CORE_DEFAULT | ( | X, | |
Y, | |||
Z | |||
) | (X ? X->Y : Z) |
Macro to provide a default value if the pointer is not yet initialised
#define AP_CORE_MERGE_FLAG | ( | field, | |
to, | |||
base, | |||
over | |||
) |
#define AP_CORE_MODULE_INDEX 0 |
#define AP_DEFAULT_MAX_INTERNAL_REDIRECTS 10 |
default maximum of internal redirects
#define AP_DEFAULT_MAX_SUBREQ_DEPTH 10 |
default maximum subrequest nesting level
#define AP_ERRORLOG_DEFAULT_PROVIDER "file" |
#define AP_ERRORLOG_FLAG_FIELD_SEP 1 |
item starts a new field
#define AP_ERRORLOG_FLAG_MESSAGE 2 |
item is the actual error message
#define AP_ERRORLOG_FLAG_NULL_AS_HYPHEN 8 |
log zero-length item as '-'
#define AP_ERRORLOG_FLAG_REQUIRED 4 |
skip whole line if item is zero-length
#define AP_ERRORLOG_PROVIDER_ADD_EOL_STR 1 |
add APR_EOL_STR to the end of log message
#define AP_ERRORLOG_PROVIDER_GROUP "error_log_writer" |
#define AP_ERRORLOG_PROVIDER_VERSION "0" |
#define ap_get_core_module_config | ( | v | ) | (((void **)(v))[AP_CORE_MODULE_INDEX]) |
#define AP_MIN_BYTES_TO_WRITE 8000 |
Make sure we don't write less than 8000 bytes at any one time.
#define AP_NOTE_DIRECTORY_WALK 0 |
#define AP_NOTE_FILE_WALK 2 |
#define AP_NOTE_IF_WALK 3 |
#define AP_NOTE_LOCATION_WALK 1 |
#define AP_NUM_STD_NOTES 4 |
#define AP_SENDFILE_ENABLED | ( | x | ) | ((x) == ENABLE_SENDFILE_ON ? APR_SENDFILE_ENABLED : 0) |
#define ap_set_core_module_config | ( | v, | |
val | |||
) | ((((void **)(v))[AP_CORE_MODULE_INDEX]) = (val)) |
#define AP_SQ_CONFIG_GEN 2 |
generation of the top-level apache parent
#define AP_SQ_MAIN_STATE 0 |
current status of the server
#define AP_SQ_MS_CREATE_CONFIG 4 |
normal configuration run
#define AP_SQ_MS_CREATE_PRE_CONFIG 2 |
initial configuration run for setting up log config, etc.
#define AP_SQ_MS_DESTROY_CONFIG 3 |
tearing down configuration
#define AP_SQ_MS_EXITING 6 |
cleaning up for exit
#define AP_SQ_MS_INITIAL_STARTUP 1 |
before the config preflight
#define AP_SQ_MS_RUN_MPM 5 |
running the MPM
#define AP_SQ_NOT_SUPPORTED -1 |
return value for unknown query_code
#define AP_SQ_RM_CONFIG_DUMP 4 |
only dump some parts of the config
#define AP_SQ_RM_CONFIG_TEST 3 |
config test only
#define AP_SQ_RM_NORMAL 2 |
normal operation (server requests or signal server)
#define AP_SQ_RM_UNKNOWN 1 |
command line not yet parsed
#define AP_SQ_RUN_MODE 1 |
are we going to serve requests or are we just testing/dumping config
#define ETAG_ALL (ETAG_MTIME | ETAG_INODE | ETAG_SIZE) |
#define ETAG_BACKWARD (ETAG_MTIME | ETAG_SIZE) |
#define ETAG_DIGEST (1 << 4) |
#define ETAG_INODE (1 << 2) |
#define ETAG_MTIME (1 << 1) |
#define ETAG_NONE (1 << 0) |
#define ETAG_SIZE (1 << 3) |
#define ETAG_UNSET 0 |
#define SATISFY_ALL 0 |
all of the requirements must be met
#define SATISFY_ANY 1 |
any of the requirements must be met
#define SATISFY_NOSPEC 2 |
There are no applicable satisfy lines
typedef unsigned char allow_options_t |
typedef struct ap_errorlog_handler ap_errorlog_handler |
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
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.
typedef struct ap_errorlog_provider ap_errorlog_provider |
typedef unsigned long etag_components_t |
typedef unsigned int overrides_t |
typedef struct require_line require_line |
enum ap_mgmt_type_e |
enum server_signature_e |
int access_compat_ap_satisfies | ( | request_rec * | r | ) |
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 | ||
) |
void ap_add_output_filters_by_type | ( | request_rec * | r | ) |
void ap_add_per_dir_conf | ( | server_rec * | s, |
void * | dir_config | ||
) |
void ap_add_per_url_conf | ( | server_rec * | s, |
void * | url_config | ||
) |
int ap_allow_options | ( | request_rec * | r | ) |
Retrieve the value of Options for this request
r | The current request |
int ap_allow_overrides | ( | request_rec * | r | ) |
Retrieve the value of the AllowOverride for this request
r | The current request |
const char* ap_auth_name | ( | request_rec * | r | ) |
Return the current Authorization realm
r | The current request |
const char* ap_auth_type | ( | request_rec * | r | ) |
Return the type of authorization required for this request
r | The current request |
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
p | The pool to allocate the URL from |
uri | The path to the requested file |
r | The current request |
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 | ||
) |
void ap_core_reorder_directories | ( | apr_pool_t * | , |
server_rec * | |||
) |
int ap_core_translate | ( | request_rec * | r | ) |
Create a slave connection
c | The connection to create the slave connection from/for |
void ap_custom_response | ( | request_rec * | r, |
int | status, | ||
const char * | string | ||
) |
Install a custom response handler for a given status
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 |
const char* ap_document_root | ( | request_rec * | r | ) |
Retrieve the document root for this server
r | The current request |
int ap_exists_config_define | ( | const char * | name | ) |
Check for a definition from the server command line
name | The define to check for |
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.
c | The connection record |
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.
cv | The vector in which the modules configuration is stored. usually r->per_dir_config or s->module_config |
apr_off_t ap_get_limit_req_body | ( | const request_rec * | r | ) |
Return the limit on bytes in request msg body
r | The current request |
apr_size_t ap_get_limit_xml_body | ( | const request_rec * | r | ) |
Return the limit on bytes in XML request msg body
r | The current request |
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.
pfd | the pollfd to set the descriptor in |
ptimeout | != NULL to retrieve the timeout in effect |
apr_size_t ap_get_read_buf_size | ( | const request_rec * | r | ) |
Get the size of read buffers
r | The current request |
const char* ap_get_remote_logname | ( | request_rec * | r | ) |
Retrieve the login name of the remote user. Undef if it could not be determined
r | The current request |
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
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. |
const char* ap_get_server_name | ( | request_rec * | r | ) |
Get the current server name from the request
r | The current request |
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]").
r | The current request |
apr_port_t ap_get_server_port | ( | const request_rec * | r | ) |
Get the current server port
r | The current request |
const char* ap_get_server_protocol | ( | server_rec * | s | ) |
const char* ap_ident_lookup | ( | request_rec * | r | ) |
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
r | The current request |
const char* ap_limit_section | ( | cmd_parms * | cmd, |
void * | dummy, | ||
const char * | arg | ||
) |
void ap_register_config_hooks | ( | apr_pool_t * | p | ) |
void ap_register_errorlog_handler | ( | apr_pool_t * | p, |
char * | tag, | ||
ap_errorlog_handler_fn_t * | handler, | ||
int | flags | ||
) |
Register external errorlog handler
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) |
void ap_register_log_hooks | ( | apr_pool_t * | p | ) |
apr_size_t ap_register_request_note | ( | void | ) |
Reserve an element in the core_request_config->notes array for some application-specific data
int ap_satisfies | ( | request_rec * | r | ) |
How the requires lines must be met.
r | The current request |
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
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.
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 |
void ap_set_server_protocol | ( | server_rec * | s, |
const char * | proto | ||
) |
Query the server for some state information
query_code | Which information is requested |
const char* authn_ap_auth_name | ( | request_rec * | r | ) |
const char* authn_ap_auth_type | ( | request_rec * | r | ) |
int authz_some_auth_required | ( | request_rec * | r | ) |
apr_status_t get_pollfd_from_conn | ( | 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.
apr_status_t insert_network_bucket | ( | 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.
c | The connection |
bb | The brigade to insert the bucket into |
socket | The socket to put into a bucket |
|
extern |
|
extern |
|
extern |
|
extern |
|
extern |
Core is also unlike other modules in being implemented in more than one file... so, data structures are declared here, even though most of the code that cares really is in http_core.c. Also, another accessor.