Modules | |
| Core routines | |
| Internal interfaces | |
| Loadable modules | |
| Multi-Processing Modules | |
| Operating System Specific | |
Detailed Description
Top level group of which all other groups are a member
Variable Documentation
◆ aborted
| unsigned conn_rec::aborted |
Are we still talking?
◆ access_count
| unsigned long ap_sload_t::access_count |
◆ add_string
| const char* ap_version_t::add_string |
additional string like "-dev"
◆ addrs
| server_addr_rec* server_rec::addrs |
I haven't got a clue
◆ allowed
| ap_method_mask_t request_rec::allowed |
'allowed' is a bitvector of the allowed methods.
A handler must ensure that the request method is one that it is capable of handling. Generally modules should DECLINE any request methods they do not handle. Prior to aborting the handler like this the handler should set r->allowed to the list of methods that it is willing to handle. This bitvector is used to construct the "Allow:" header required for OPTIONS requests, and HTTP_METHOD_NOT_ALLOWED and HTTP_NOT_IMPLEMENTED status codes.
Since the default_handler deals with OPTIONS, all modules can usually decline to deal with OPTIONS. TRACE is always allowed, modules don't need to set it explicitly.
Since the default_handler will always handle a GET, a module which does not implement GET should probably return HTTP_METHOD_NOT_ALLOWED. Unfortunately this means that a Script GET handler can't be installed by mod_actions.
◆ allowed_methods
| ap_method_list_t* request_rec::allowed_methods |
List of allowed methods
◆ allowed_xmethods
| apr_array_header_t* request_rec::allowed_xmethods |
Array of extension methods
◆ ap_auth_type
| char* request_rec::ap_auth_type |
If an authentication check was made, this gets set to the auth type.
◆ argc
| int process_rec::argc |
Number of command line arguments passed to the program
◆ args
| char* request_rec::args |
The QUERY_ARGS extracted from this request
◆ argv
| const char* const* process_rec::argv |
The command line arguments
◆ assbackwards
| int request_rec::assbackwards |
HTTP/0.9, "simple" request (e.g. GET /foo
w/no headers)
◆ async_filter
| int conn_rec::async_filter |
The minimum level of filter type to allow setaside buckets
◆ base_server
| server_rec* conn_rec::base_server |
Physical vhost this conn came in on
◆ bnotes
| ap_request_bnotes_t request_rec::bnotes |
Request flags associated with this request. Use AP_REQUEST_GET_FLAGS() and AP_REQUEST_SET_FLAGS() to access the elements of this field.
◆ body_indeterminate
| int request_rec::body_indeterminate |
Indicates that the request has a body of unknown length and protocol handlers need to read it, even if only to discard the data. In HTTP/1.1 this is set on chunked transfer encodings, but newer HTTP versions can transfer such bodies by other means. The absence of a "Transfer-Encoding" header is no longer sufficient to conclude that no body is there.
◆ body_table
| apr_table_t* request_rec::body_table |
For ap_body_to_table(): parsed body
◆ bucket_alloc
| struct apr_bucket_alloc_t* conn_rec::bucket_alloc |
The bucket allocator to use for all bucket/brigade creations
◆ busy
| int ap_sload_t::busy |
◆ bytes_sent
| apr_off_t request_rec::bytes_sent |
body byte count, for easy access
◆ bytes_served
| apr_off_t ap_sload_t::bytes_served |
◆ c
| conn_rec* conn_slave_rec::c |
◆ canonical_filename
| char* request_rec::canonical_filename |
The true filename stored in the filesystem, as in the true alpha case and alias correction, e.g. "Image.jpeg" not "IMAGE$1.JPE" on Windows. The core map_to_storage canonicalizes r->filename when they mismatch
◆ cb
| const char*(* ap_dir_match_t::cb) (ap_dir_match_t *w, const char *fname) |
Callback for each file found that matches the wildcard. Return NULL on success, an error string on error.
◆ chunked
| int request_rec::chunked |
sending chunked transfer-coding
◆ clength
| apr_off_t request_rec::clength |
The "real" content length
◆ client_addr
| apr_sockaddr_t* conn_rec::client_addr |
remote address; this is the end-point of the next hop, for the address of the request creator, see useragent_addr in request_rec
◆ client_ip
| char* conn_rec::client_ip |
Client's IP address; this is the end-point of the next hop, for the IP of the request creator, see useragent_ip in request_rec
◆ clogging_input_filters
| unsigned int conn_rec::clogging_input_filters |
Are there any filters that clogg/buffer the input stream, breaking the event mpm.
◆ conn_config
| struct ap_conf_vector_t* conn_rec::conn_config |
Config vector containing pointers to connections per-server config structures.
◆ connection
| conn_rec* request_rec::connection |
The connection to the client
◆ content_encoding
| const char* request_rec::content_encoding |
How to encode the data
◆ content_languages
| apr_array_header_t* request_rec::content_languages |
Array of strings representing the content languages
◆ content_type
| const char* request_rec::content_type |
The content-type for the current request
◆ context
| void* server_rec::context |
Opaque storage location
◆ cs
| conn_state_t* conn_rec::cs |
The current state of this connection; may be NULL if not used by MPM
◆ ctx [1/2]
| void* conn_rec::ctx |
context of this connection
◆ ctx [2/2]
| void* ap_dir_match_t::ctx |
Context for the callback
◆ current_thread
| apr_thread_t* conn_rec::current_thread |
This points to the current thread being used to process this request, over the lifetime of a request, the value may change. Users of the connection record should not rely upon it staying the same between calls that involve the MPM.
◆ defn_line_number
| unsigned server_rec::defn_line_number |
The line of the config file that the server was defined on
◆ defn_name
| const char* server_rec::defn_name |
The path to the config file that the server was defined in
◆ depth
| unsigned int ap_dir_match_t::depth |
Recursion depth safety check
◆ dir
| const char* htaccess_result::dir |
the directory to which this applies
◆ double_reverse [1/2]
| int request_rec::double_reverse |
have we done double-reverse DNS? -1 yes/failure, 0 not yet, 1 yes/success TODO: 2 bit signed bitfield when this structure is compacted
◆ double_reverse [2/2]
| signed int conn_rec::double_reverse |
have we done double-reverse DNS? -1 yes/failure, 0 not yet, 1 yes/success
◆ eos_sent
| int request_rec::eos_sent |
A flag to determine if the eos bucket has been sent yet
◆ err_headers_out
| apr_table_t* request_rec::err_headers_out |
MIME header environment for the response, printed even on errors and persist across internal redirects
◆ error_fname
| char* server_rec::error_fname |
The name of the error log
◆ error_log
| apr_file_t* server_rec::error_log |
A file descriptor that references the error log
◆ errorlog_provider
| struct ap_errorlog_provider* server_rec::errorlog_provider |
External error log writer provider
◆ errorlog_provider_handle
| void* server_rec::errorlog_provider_handle |
Handle to be passed to external log provider's logging method
◆ expecting_100
| unsigned request_rec::expecting_100 |
is client waiting for a 100 response?
◆ filename
| char* request_rec::filename |
The filename on disk corresponding to this response
◆ filter_conn_ctx
| struct ap_filter_conn_ctx* conn_rec::filter_conn_ctx |
Filters private/opaque context for this connection
◆ finfo
| apr_finfo_t request_rec::finfo |
finfo.protection (st_mode) set to zero if no such file
◆ flags
| int ap_dir_match_t::flags |
Flags to indicate whether optional or recursive
◆ flushed
| unsigned int request_rec::flushed |
Whether the response has been flushed through the network, relevant at ap_run_log_transaction() time only. TODO: compact elsewhere
◆ handler
| const char* request_rec::handler |
The handler string that we use to call a handler function
◆ header_only
| int request_rec::header_only |
HEAD request, as opposed to GET
◆ headers_in
| apr_table_t* request_rec::headers_in |
MIME header environment from the request
◆ headers_out
| apr_table_t* request_rec::headers_out |
MIME header environment for the response
◆ host_addr
| apr_sockaddr_t* server_addr_rec::host_addr |
The bound address, for this server
◆ host_port
| apr_port_t server_addr_rec::host_port |
The bound port, for this server
◆ hostname
| const char* request_rec::hostname |
Host, as set by full URI or Host: header. For literal IPv6 addresses, this does NOT include the surrounding [ ]
◆ htaccess [1/2]
| struct ap_conf_vector_t* htaccess_result::htaccess |
the configuration directives
◆ htaccess [2/2]
| const struct htaccess_result* request_rec::htaccess |
A linked list of the .htaccess configuration directives accessed by this request. N.B. always add to the head of the list, never to the end. that way, a sub request's list can (temporarily) point to a parent's list
◆ id
| long conn_rec::id |
ID of this connection; unique at any point in time
◆ idle
| int ap_sload_t::idle |
◆ input_filters [1/2]
| struct ap_filter_t* request_rec::input_filters |
A list of input filters to be used for this request
◆ input_filters [2/2]
| struct ap_filter_t* conn_rec::input_filters |
A list of input filters to be used for this connection
◆ invoke_mtx
| apr_thread_mutex_t* request_rec::invoke_mtx |
Mutex protect callbacks registered with ap_mpm_register_timed_callback from being run before the original handler finishes running
◆ is_virtual
| char server_rec::is_virtual |
true if this is the virtual server
◆ keep_alive
| int server_rec::keep_alive |
Use persistent connections?
◆ keep_alive_max
| int server_rec::keep_alive_max |
Maximum requests per connection
◆ keep_alive_timeout
| apr_interval_time_t server_rec::keep_alive_timeout |
The apr interval we will wait for another request
◆ keep_alive_timeout_set
| unsigned int server_rec::keep_alive_timeout_set |
Whether the keepalive timeout is explicit (1) or inherited (0) from the base server (either first server on the same IP:port or main server)
◆ keepalive
| ap_conn_keepalive_e conn_rec::keepalive |
Are we going to keep the connection alive for another request?
- See also
- ap_conn_keepalive_e
◆ keepalives
| int conn_rec::keepalives |
How many times have we used it?
◆ kept_body
| apr_bucket_brigade* request_rec::kept_body |
The optional kept body of the request.
◆ level
| int ap_logconf::level |
The log level for this server
◆ limit_req_fields
| int server_rec::limit_req_fields |
limit on number of request header fields
◆ limit_req_fieldsize
| int server_rec::limit_req_fieldsize |
limit on size of any request header field
◆ limit_req_line
| int server_rec::limit_req_line |
limit on size of the HTTP request line
◆ loadavg
| float ap_loadavg_t::loadavg |
◆ loadavg15
| float ap_loadavg_t::loadavg15 |
◆ loadavg5
| float ap_loadavg_t::loadavg5 |
◆ local_addr
| apr_sockaddr_t* conn_rec::local_addr |
local address
◆ local_host
| char* conn_rec::local_host |
used for ap_get_server_name when UseCanonicalName is set to DNS (ignores setting of HostnameLookups)
◆ local_ip
| char* conn_rec::local_ip |
server IP address
◆ log [1/3]
| const struct ap_logconf* request_rec::log |
Optional request log level configuration. Will usually point to a server or per_dir config, i.e. must be copied before modifying
◆ log [2/3]
| const struct ap_logconf* conn_rec::log |
Optional connection log level configuration. May point to a server or per_dir config, i.e. must be copied before modifying
◆ log [3/3]
| struct ap_logconf server_rec::log |
The log level configuration
◆ log_id [1/2]
| const char* request_rec::log_id |
Id to identify request in access and error log. Set when the first error log entry for this request is generated.
◆ log_id [2/2]
| const char* conn_rec::log_id |
Id to identify this connection in error log. Set when the first error log entry for this connection is generated.
◆ lookup_defaults
| struct ap_conf_vector_t* server_rec::lookup_defaults |
MIME type info, etc., before we start checking per-directory info
◆ main
| request_rec* request_rec::main |
Pointer to the main request if this is a sub-request (see http_request.h)
◆ major
| int ap_version_t::major |
major number
◆ master
| conn_rec* conn_rec::master |
The "real" master connection. NULL if I am the master.
◆ method
| const char* request_rec::method |
Request method (eg. GET, HEAD, POST, etc.)
◆ method_list
| apr_array_header_t* ap_method_list_t::method_list |
the array used for extension methods
◆ method_mask
| ap_method_mask_t ap_method_list_t::method_mask |
The bitmask used for known methods
◆ method_number
| int request_rec::method_number |
M_GET, M_POST, etc.
◆ minor
| int ap_version_t::minor |
minor number
◆ module_config
| struct ap_conf_vector_t* server_rec::module_config |
Config vector containing pointers to modules' per-server config structures.
◆ module_levels
| signed char* ap_logconf::module_levels |
The per-module log levels
◆ mtime
| apr_time_t request_rec::mtime |
Last modified time of the requested resource
◆ name
| const char* ap_form_pair_t::name |
◆ names
| apr_array_header_t* server_rec::names |
Normal names for ServerAlias servers
◆ next [1/4]
| const struct htaccess_result* htaccess_result::next |
the next one, or NULL if no more; N.B. never change this
◆ next [2/4]
| request_rec* request_rec::next |
Pointer to the redirected request if this is an external redirect
◆ next [3/4]
| server_addr_rec* server_addr_rec::next |
The next server in the list
◆ next [4/4]
| server_rec* server_rec::next |
The next server in the list
◆ no_cache
| int request_rec::no_cache |
This response can not be cached
◆ no_local_copy
| int request_rec::no_local_copy |
There is no local copy of this response
◆ notes [1/2]
| apr_table_t* request_rec::notes |
Notes from one module to another
◆ notes [2/2]
| apr_table_t* conn_rec::notes |
Notes on this connection: send note from one module to another. must remain valid for all requests on this conn
◆ outgoing
| int conn_rec::outgoing |
◆ output_filters [1/2]
| struct ap_filter_t* request_rec::output_filters |
A list of output filters to be used for this request
◆ output_filters [2/2]
| struct ap_filter_t* conn_rec::output_filters |
A list of output filters to be used for this connection
◆ override
| int htaccess_result::override |
the overrides allowed for the .htaccess file
◆ override_list
| apr_table_t* htaccess_result::override_list |
Table of allowed directives for override
◆ override_opts
| int htaccess_result::override_opts |
the override options allowed for the .htaccess file
◆ p
| apr_pool_t* ap_dir_match_t::p |
Pool to use for allocating the result
◆ parsed_uri
| apr_uri_t request_rec::parsed_uri |
A struct containing the components of URI
◆ patch
| int ap_version_t::patch |
patch number
◆ path
| const char* server_rec::path |
Pathname for ServerPath
◆ path_info
| char* request_rec::path_info |
The PATH_INFO extracted from this request
◆ pathlen
| int server_rec::pathlen |
Length of path
◆ pconf
| apr_pool_t* process_rec::pconf |
Configuration pool. Cleared upon restart
◆ per_dir_config
| struct ap_conf_vector_t* request_rec::per_dir_config |
Options set in config files, etc.
◆ pool [1/3]
| apr_pool_t* process_rec::pool |
Global pool. Cleared upon normal exit
◆ pool [2/3]
| apr_pool_t* request_rec::pool |
The pool associated with the request
◆ pool [3/3]
| apr_pool_t* conn_rec::pool |
Pool associated with this connection
◆ port
| apr_port_t server_rec::port |
for redirects, etc.
◆ prefix
| const char* ap_dir_match_t::prefix |
Prefix for log messages
◆ prev
| request_rec* request_rec::prev |
Pointer to the previous request if this is an internal redirect
◆ process
| process_rec* server_rec::process |
The process this server is running in
◆ proto_input_filters
| struct ap_filter_t* request_rec::proto_input_filters |
A list of protocol level input filters to be used for this request
◆ proto_num
| int request_rec::proto_num |
Protocol version number of protocol; 1.1 = 1001
◆ proto_output_filters
| struct ap_filter_t* request_rec::proto_output_filters |
A list of protocol level output filters to be used for this request
◆ protocol
| const char* request_rec::protocol |
Protocol string, as given to us, or HTTP/0.9
◆ proxyreq
| int request_rec::proxyreq |
A proxy request (calculated during post_read_request/translate_name) possible values PROXYREQ_NONE, PROXYREQ_PROXY, PROXYREQ_REVERSE, PROXYREQ_RESPONSE
◆ ptemp
| apr_pool_t* ap_dir_match_t::ptemp |
Temporary pool used for directory traversal
◆ range
| const char* request_rec::range |
The Range: header
◆ read_body
| int request_rec::read_body |
Method for reading the request body (eg. REQUEST_CHUNKED_ERROR, REQUEST_NO_BODY, REQUEST_CHUNKED_DECHUNK, etc...)
◆ read_chunked
| int request_rec::read_chunked |
reading chunked transfer-coding
◆ read_length
| apr_off_t request_rec::read_length |
Number of bytes that have been read from the request body
◆ remaining
| apr_off_t request_rec::remaining |
Remaining bytes left to read from the request body
◆ remote_host
| char* conn_rec::remote_host |
Client's DNS name, if known. NULL if DNS hasn't been checked, "" if it has and no address was found. N.B. Only access this though get_remote_host()
◆ remote_logname
| char* conn_rec::remote_logname |
Only ever set if doing rfc1413 lookups. N.B. Only access this through get_remote_logname()
◆ request_config
| struct ap_conf_vector_t* request_rec::request_config |
Notes on this request
◆ request_time
| apr_time_t request_rec::request_time |
Time when the request started
◆ requests
| apr_array_header_t* conn_rec::requests |
Array of requests being handled under this connection.
◆ sbh
| void* conn_rec::sbh |
handle to scoreboard information for this connection
◆ sense
| conn_sense_e conn_state_t::sense |
Whether to read instead of write, or write instead of read
◆ sent_bodyct
| apr_off_t request_rec::sent_bodyct |
byte count in stream is for body
◆ server
| server_rec* request_rec::server |
The virtual host for this request
◆ server_admin
| char* server_rec::server_admin |
The admin's contact information
◆ server_hostname
| char* server_rec::server_hostname |
The server hostname
◆ server_scheme
| const char* server_rec::server_scheme |
The server request scheme for redirect responses
◆ short_name
| const char* process_rec::short_name |
The program name used to execute the program
◆ slaves
| apr_array_header_t* conn_rec::slaves |
Array of slave connections (conn_slave_rec *) for this connection.
◆ state
| conn_state_e conn_state_t::state |
Current state of the connection
◆ status
| int request_rec::status |
Status line
◆ status_line
| const char* request_rec::status_line |
Status line, if set by script
◆ subprocess_env
| apr_table_t* request_rec::subprocess_env |
Array of environment variables to be used for sub processes
◆ suspended_baton
| void* conn_rec::suspended_baton |
Context under which this connection was suspended
◆ taint
| int request_rec::taint |
Mark the request as potentially tainted. This might become a bitfield if we identify different taints to be flagged. Always use ap_request_tainted() to check taint.
◆ the_request
| char* request_rec::the_request |
First line of request
◆ timeout
| apr_interval_time_t server_rec::timeout |
Timeout, as an apr interval, before we give up
◆ trailers_in
| apr_table_t* request_rec::trailers_in |
MIME trailer environment from the request
◆ trailers_out
| apr_table_t* request_rec::trailers_out |
MIME trailer environment from the response
◆ unparsed_uri
| char* request_rec::unparsed_uri |
The URI without any parsing performed
◆ uri
| char* request_rec::uri |
The path portion of the URI, or "/" if no path provided
◆ used_path_info
| int request_rec::used_path_info |
Flag for the handler to accept or reject path_info on the current request. All modules should respect the AP_REQ_ACCEPT_PATH_INFO and AP_REQ_REJECT_PATH_INFO values, while AP_REQ_DEFAULT_PATH_INFO indicates they may follow existing conventions. This is set to the user's preference upon HOOK_VERY_FIRST of the fixups.
◆ user
| char* request_rec::user |
If an authentication check was made, this gets set to the user name.
◆ useragent_addr
| apr_sockaddr_t* request_rec::useragent_addr |
remote address information from conn_rec, can be overridden if necessary by a module. This is the address that originated the request.
◆ useragent_host
| char* request_rec::useragent_host |
Originator's DNS name, if known. NULL if DNS hasn't been checked, "" if it has and no address was found. N.B. Only access this though ap_get_useragent_host()
◆ useragent_ip
| char* request_rec::useragent_ip |
◆ value
| apr_bucket_brigade* ap_form_pair_t::value |
◆ vhost_lookup_data
| void* conn_rec::vhost_lookup_data |
used by http_vhost.c
◆ virthost
| char* server_addr_rec::virthost |
The name given in "<VirtualHost>"
◆ vlist_validator
| char* request_rec::vlist_validator |
variant list validator (if negotiated)
◆ wild_names
| apr_array_header_t* server_rec::wild_names |
Wildcarded names for ServerAlias servers
