http_protocol.h revision a511a29faf2ff7ead3b67680154a624effb31aaf
842ae4bd224140319ae7feec1872b93dfd491143fielding/* Licensed to the Apache Software Foundation (ASF) under one or more
842ae4bd224140319ae7feec1872b93dfd491143fielding * contributor license agreements. See the NOTICE file distributed with
842ae4bd224140319ae7feec1872b93dfd491143fielding * this work for additional information regarding copyright ownership.
842ae4bd224140319ae7feec1872b93dfd491143fielding * The ASF licenses this file to You under the Apache License, Version 2.0
842ae4bd224140319ae7feec1872b93dfd491143fielding * (the "License"); you may not use this file except in compliance with
842ae4bd224140319ae7feec1872b93dfd491143fielding * the License. You may obtain a copy of the License at
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * Unless required by applicable law or agreed to in writing, software
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * distributed under the License is distributed on an "AS IS" BASIS,
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * See the License for the specific language governing permissions and
ce9621257ef9e54c1bbe5ad8a5f445a1f211c2dcnd * limitations under the License.
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @brief HTTP protocol handling
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @defgroup APACHE_CORE_PROTO HTTP Protocol Handling
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @ingroup APACHE_CORE
2d2eda71267231c2526be701fe655db125852c1ffieldingextern "C" {
52de7a47876ce1748910cf3a0ee97f78842fab54rederpj * This hook allows modules to insert filters for the current error response
52de7a47876ce1748910cf3a0ee97f78842fab54rederpj * @param r the current request
52de7a47876ce1748910cf3a0ee97f78842fab54rederpj * @ingroup hooks
52de7a47876ce1748910cf3a0ee97f78842fab54rederpjAP_DECLARE_HOOK(void,insert_error_filter,(request_rec *r))
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh/** This is an optimization. We keep a record of the filter_rec that
fd492f9543f14fb5bae78e04b135c3448eb9cc56rbb * stores the old_write filter, so that we can avoid strcmp's later.
fd492f9543f14fb5bae78e04b135c3448eb9cc56rbbAP_DECLARE_DATA extern ap_filter_rec_t *ap_old_write_func;
2d2eda71267231c2526be701fe655db125852c1ffielding * Prototypes for routines which either talk directly back to the user,
2d2eda71267231c2526be701fe655db125852c1ffielding * or control the ones that eventually do.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Read a request and fill in the fields.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param c The current connection
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The new request_rec
8af88bd6958b80c224e964892b8237720b13ab1ajerenkrantz * Read the mime-encoded headers.
8af88bd6958b80c224e964892b8237720b13ab1ajerenkrantz * @param r The current request
50e60f30bdc074fbc887f0b98f4d570457ac97c9brianp * Optimized version of ap_get_mime_headers() that requires a
50e60f30bdc074fbc887f0b98f4d570457ac97c9brianp * temporary brigade to work with
50e60f30bdc074fbc887f0b98f4d570457ac97c9brianp * @param r The current request
50e60f30bdc074fbc887f0b98f4d570457ac97c9brianp * @param bb temp brigade
50e60f30bdc074fbc887f0b98f4d570457ac97c9brianpAP_DECLARE(void) ap_get_mime_headers_core(request_rec *r,
bfb62a96023822c56c9120e4ee627d4091cc59c2rbb/* Finish up stuff after a request */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Called at completion of sending the response. It sends the terminating
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * protocol information.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
3d96ee83babeec32482c9082c9426340cee8c44dwroweAP_DECLARE(void) ap_finalize_request_protocol(request_rec *r);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Send error back to client.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
742318b93e89c311f66b55f426c4d9cf2c14628bjim * @param recursive_error last arg indicates error status in case we get
742318b93e89c311f66b55f426c4d9cf2c14628bjim * an error in the process of trying to deal with an ErrorDocument
742318b93e89c311f66b55f426c4d9cf2c14628bjim * to handle some other error. In that case, we print the default
742318b93e89c311f66b55f426c4d9cf2c14628bjim * report for the first thing that went wrong, and more briefly report
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * on the problem with the ErrorDocument.
3d96ee83babeec32482c9082c9426340cee8c44dwroweAP_DECLARE(void) ap_send_error_response(request_rec *r, int recursive_error);
2d2eda71267231c2526be701fe655db125852c1ffielding/* Set last modified header line from the lastmod date of the associated file.
2d2eda71267231c2526be701fe655db125852c1ffielding * Also, set content length.
000b67449410515eac43e76ef6667915bfd4d2abgstein * May return an error status, typically HTTP_NOT_MODIFIED (that when the
2d2eda71267231c2526be701fe655db125852c1ffielding * permit_cache argument is set to one).
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Set the content length for this request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param length The new content length
7bdef86e15d47d16dcbe7a5611683191774bd5fbgsteinAP_DECLARE(void) ap_set_content_length(request_rec *r, apr_off_t length);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Set the keepalive status for this request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return 1 if keepalive can be set, 0 otherwise
742318b93e89c311f66b55f426c4d9cf2c14628bjim * Return the latest rational time from a request/mtime pair. Mtime is
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * returned unless it's in the future, in which case we return the current time.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param mtime The last modified time
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return the latest rational time.
3d96ee83babeec32482c9082c9426340cee8c44dwroweAP_DECLARE(apr_time_t) ap_rationalize_mtime(request_rec *r, apr_time_t mtime);
c9a95767fbf0f5fb0976a06b97a256033925e433rbb * Build the content-type that should be sent to the client from the
c9a95767fbf0f5fb0976a06b97a256033925e433rbb * content-type specified. The following rules are followed:
cf8d02ea0c91653917b044529f3133c5a1bb9200fielding * - if type is NULL or "", return NULL (do not set content-type).
c9a95767fbf0f5fb0976a06b97a256033925e433rbb * - if charset adding is disabled, stop processing and return type.
c9a95767fbf0f5fb0976a06b97a256033925e433rbb * - then, if there are no parameters on type, add the default charset
c9a95767fbf0f5fb0976a06b97a256033925e433rbb * - return type
c9a95767fbf0f5fb0976a06b97a256033925e433rbb * @param r The current request
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @param type The content type
c9a95767fbf0f5fb0976a06b97a256033925e433rbb * @return The content-type
d82d78a97558238d16c52ec5278fe921bb7d7ec3brianpAP_DECLARE(const char *) ap_make_content_type(request_rec *r,
d82d78a97558238d16c52ec5278fe921bb7d7ec3brianp const char *type);
d82d78a97558238d16c52ec5278fe921bb7d7ec3brianp * Precompile metadata structures used by ap_make_content_type()
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @param pool The pool to use for allocations
d82d78a97558238d16c52ec5278fe921bb7d7ec3brianpAP_DECLARE(void) ap_setup_make_content_type(apr_pool_t *pool);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Construct an entity tag from the resource information. If it's a real
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * file, build in some of the file characteristics.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param force_weak Force the entity tag to be weak - it could be modified
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * again in as short an interval.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The entity tag
3d96ee83babeec32482c9082c9426340cee8c44dwroweAP_DECLARE(char *) ap_make_etag(request_rec *r, int force_weak);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Set the E-tag outgoing header
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Set the last modified time for the file being sent
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrintypedef enum {
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * Tests conditional request rules for the If-Match header.
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * @param r The current request
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * @param headers The response headers to check against
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * @return AP_CONDITION_NONE if the header is missing, AP_CONDITION_NOMATCH
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * if the header does not match, AP_CONDITION_STRONG for a strong
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * match. Weak matches are not permitted for the If-Match header.
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrinAP_DECLARE(ap_condition_e) ap_condition_if_match(request_rec *r,
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * Tests conditional request rules for the If-Unmodified-Since header.
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * @param r The current request
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * @param headers The response headers to check against
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * @return AP_CONDITION_NONE if the header is missing, AP_CONDITION_NOMATCH
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * if the header does not match, AP_CONDITION_WEAK if a weak match
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * was present and allowed by RFC2616, AP_CONDITION_STRONG for a
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * strong match.
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrinAP_DECLARE(ap_condition_e) ap_condition_if_unmodified_since(request_rec *r,
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * Tests conditional request rules for the If-None-Match header.
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * @param r The current request
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * @param headers The response headers to check against
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * @return AP_CONDITION_NONE if the header is missing, AP_CONDITION_NOMATCH
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * if the header does not match, AP_CONDITION_WEAK if a weak match
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * was present and allowed by RFC2616, AP_CONDITION_STRONG for a
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * strong match.
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrinAP_DECLARE(ap_condition_e) ap_condition_if_none_match(request_rec *r,
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * Tests conditional request rules for the If-Modified-Since header.
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * @param r The current request
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * @param headers The response headers to check against
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * @return AP_CONDITION_NONE if the header is missing, AP_CONDITION_NOMATCH
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * if the header does not match, AP_CONDITION_WEAK if a weak match
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * was present and allowed by RFC2616, AP_CONDITION_STRONG for a
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * strong match.
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrinAP_DECLARE(ap_condition_e) ap_condition_if_modified_since(request_rec *r,
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * Tests conditional request rules for the If-Range header.
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * @param r The current request
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * @param headers The response headers to check against
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * @return AP_CONDITION_NONE if either the If-Range or Range header is
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * missing, AP_CONDITION_NOMATCH if the header does not match,
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * AP_CONDITION_STRONG for a strong match. Weak matches are not
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrin * permitted for the If-Range header.
eee20257a5ee9228f4aecdf3d3ca68fd0683ff07minfrinAP_DECLARE(ap_condition_e) ap_condition_if_range(request_rec *r,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Implements condition GET rules for HTTP/1.1 specification. This function
742318b93e89c311f66b55f426c4d9cf2c14628bjim * inspects the client headers and determines if the response fulfills
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * the requirements specified.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
78ae1cbba5a848a24ca551629bbf0a90d2b931f0stas * @return OK if the response fulfills the condition GET rules, some
78ae1cbba5a848a24ca551629bbf0a90d2b931f0stas * other status code otherwise
2d2eda71267231c2526be701fe655db125852c1ffielding/* Other ways to send stuff at the client. All of these keep track
2d2eda71267231c2526be701fe655db125852c1ffielding * of bytes_sent automatically. This indirection is intended to make
2d2eda71267231c2526be701fe655db125852c1ffielding * it a little more painless to slide things like HTTP-NG packetization
2d2eda71267231c2526be701fe655db125852c1ffielding * underneath the main body of the code later. In the meantime, it lets
2d2eda71267231c2526be701fe655db125852c1ffielding * us centralize a bit of accounting (bytes_sent).
2d2eda71267231c2526be701fe655db125852c1ffielding * These also return the number of bytes written by the call.
2d2eda71267231c2526be701fe655db125852c1ffielding * They should only be called with a timeout registered, for obvious reaasons.
2d2eda71267231c2526be701fe655db125852c1ffielding * (Ditto the send_header stuff).
742318b93e89c311f66b55f426c4d9cf2c14628bjim * Send an entire file to the client, using sendfile if supported by the
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * current platform
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param fd The file to send.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param offset Offset into the file to start sending.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param length Amount of data to send
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param nbytes Amount of data actually sent
742318b93e89c311f66b55f426c4d9cf2c14628bjimAP_DECLARE(apr_status_t) ap_send_fd(apr_file_t *fd, request_rec *r, apr_off_t offset,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Send an MMAP'ed file to the client
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param mm The MMAP'ed file to send
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param offset The offset into the MMAP to start sending
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param length The amount of data to send
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The number of bytes sent
62db15de4c1f335a64d45821796ae197cff94ef8rbb * Register a new request method, and return the offset that will be
62db15de4c1f335a64d45821796ae197cff94ef8rbb * associated with that method.
62db15de4c1f335a64d45821796ae197cff94ef8rbb * @param p The pool to create registered method numbers from.
62db15de4c1f335a64d45821796ae197cff94ef8rbb * @param methname The name of the new method to register.
fb532d88e92dde225e7e7796dcdec276944bd3e4sf * @return An int value representing an offset into a bitmask.
48d2edbfb84e5559b5da0f8d614ccab805cc67a8rbbAP_DECLARE(int) ap_method_register(apr_pool_t *p, const char *methname);
62db15de4c1f335a64d45821796ae197cff94ef8rbb * Initialize the method_registry and allocate memory for it.
62db15de4c1f335a64d45821796ae197cff94ef8rbb * @param p Pool to allocate memory for the registry from.
62db15de4c1f335a64d45821796ae197cff94ef8rbb * This is a convenience macro to ease with checking a mask
62db15de4c1f335a64d45821796ae197cff94ef8rbb * against a method name.
48d2edbfb84e5559b5da0f8d614ccab805cc67a8rbb ((mask) & (AP_METHOD_BIT << ap_method_number_of((methname))))
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar * Create a new method list with the specified number of preallocated
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar * slots for extension methods.
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar * @param p Pointer to a pool in which the structure should be
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar * allocated.
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar * @param nelts Number of preallocated extension slots
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar * @return Pointer to the newly created structure.
3d96ee83babeec32482c9082c9426340cee8c44dwroweAP_DECLARE(ap_method_list_t *) ap_make_method_list(apr_pool_t *p, int nelts);
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * Copy a method list
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @param dest List to copy to
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @param src List to copy from
3d96ee83babeec32482c9082c9426340cee8c44dwroweAP_DECLARE(void) ap_copy_method_list(ap_method_list_t *dest,
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar * Search for an HTTP method name in an ap_method_list_t structure, and
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar * return true if found.
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar * @param method String containing the name of the method to check.
41287245b1632a4722b55f6dfe5fcf81f361f043wrowe * @param l Pointer to a method list, such as r->allowed_methods.
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar * @return 1 if method is in the list, otherwise 0
3d96ee83babeec32482c9082c9426340cee8c44dwroweAP_DECLARE(int) ap_method_in_list(ap_method_list_t *l, const char *method);
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar * Add an HTTP method name to an ap_method_list_t structure if it isn't
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar * already listed.
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar * @param method String containing the name of the method to check.
41287245b1632a4722b55f6dfe5fcf81f361f043wrowe * @param l Pointer to a method list, such as r->allowed_methods.
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar * @return None.
3d96ee83babeec32482c9082c9426340cee8c44dwroweAP_DECLARE(void) ap_method_list_add(ap_method_list_t *l, const char *method);
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar * Remove an HTTP method name from an ap_method_list_t structure.
41287245b1632a4722b55f6dfe5fcf81f361f043wrowe * @param l Pointer to a method list, such as r->allowed_methods.
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar * @param method String containing the name of the method to remove.
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar * @return None.
3d96ee83babeec32482c9082c9426340cee8c44dwroweAP_DECLARE(void) ap_method_list_remove(ap_method_list_t *l,
11e076839c8d5a82d55e710194d0daac51390dbdsf const char *method);
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar * Reset a method list to be completely empty.
41287245b1632a4722b55f6dfe5fcf81f361f043wrowe * @param l Pointer to a method list, such as r->allowed_methods.
91f0d8da77152d24e4bbb31ce199282b3fd6e3b2coar * @return None.
3d96ee83babeec32482c9082c9426340cee8c44dwroweAP_DECLARE(void) ap_clear_method_list(ap_method_list_t *l);
742318b93e89c311f66b55f426c4d9cf2c14628bjim * Set the content type for this request (r->content_type).
db08da9ddcd65c31f9ea44b823898b72a1b24fbestoddard * @param r The current request
bf648cbfa4a723c9c02fe8444103cd41ed8642d0wrowe * @param ct The new content type
742318b93e89c311f66b55f426c4d9cf2c14628bjim * @warning This function must be called to set r->content_type in order
bf648cbfa4a723c9c02fe8444103cd41ed8642d0wrowe * for the AddOutputFilterByType directive to work correctly.
db08da9ddcd65c31f9ea44b823898b72a1b24fbestoddardAP_DECLARE(void) ap_set_content_type(request_rec *r, const char *ct);
beb207f53c871585c4858040f0a8c0e2005c3c6dcovener * Set the Accept-Ranges header for this response
af7cd2711a9737c0a2aa1b8475455a7dd8ce6113covener * @param r The current request
af7cd2711a9737c0a2aa1b8475455a7dd8ce6113covenerAP_DECLARE(void) ap_set_accept_ranges(request_rec *r);
2d2eda71267231c2526be701fe655db125852c1ffielding/* Hmmm... could macrofy these for now, and maybe forever, though the
2d2eda71267231c2526be701fe655db125852c1ffielding * definitions of the macros would get a whole lot hairier.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Output one character for this request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param c the character to output
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r the current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The number of bytes sent
b5c963a560a55d08763229330dc661b16b726da0sf * Write a buffer for the current request
b5c963a560a55d08763229330dc661b16b726da0sf * @param buf The buffer to write
b5c963a560a55d08763229330dc661b16b726da0sf * @param nbyte The number of bytes to send from the buffer
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The number of bytes sent
b5c963a560a55d08763229330dc661b16b726da0sfAP_DECLARE(int) ap_rwrite(const void *buf, int nbyte, request_rec *r);
b5c963a560a55d08763229330dc661b16b726da0sf * Output a string for the current request
b5c963a560a55d08763229330dc661b16b726da0sf * @param str The string to output
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The number of bytes sent
b5c963a560a55d08763229330dc661b16b726da0sf * @note ap_rputs may be implemented as macro or inline function
2968569cc3b1440bdb874d2d597ea4a49f0c0acfsfstatic APR_INLINE int ap_rputs(const char *str, request_rec *r)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Write an unspecified number of strings to the request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param ... The strings to write
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The number of bytes sent
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Output data to the client in a printf format
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param fmt The format string
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param vlist The arguments to use to fill out the format string
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The number of bytes sent
aecb17a45c6d3ee4729ed5f68dc4270f211ee7a8fieldingAP_DECLARE(int) ap_vrprintf(request_rec *r, const char *fmt, va_list vlist);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Output data to the client in a printf format
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param fmt The format string
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param ... The arguments to use to fill out the format string
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The number of bytes sent
aecb17a45c6d3ee4729ed5f68dc4270f211ee7a8fieldingAP_DECLARE_NONSTD(int) ap_rprintf(request_rec *r, const char *fmt,...)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Flush all of the data for the current request to the client
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
9ed67b66c06749d639e0390a2357f79ced5f0299humbedooh * @return 0 on success, -1 if an error occurred
2d2eda71267231c2526be701fe655db125852c1ffielding * Index used in custom_responses array for a specific error code
2d2eda71267231c2526be701fe655db125852c1ffielding * (only use outside protocol.c is in getting them configured).
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param status HTTP status code
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The index of the response
d839a9822ee53ce00da24c15f2d9fe054233d342gstein * Return the Status-Line for a given status code (excluding the
d839a9822ee53ce00da24c15f2d9fe054233d342gstein * HTTP-Version field). If an invalid or unknown status code is
742318b93e89c311f66b55f426c4d9cf2c14628bjim * passed, "500 Internal Server Error" will be returned.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param status The HTTP status code
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The Status-Line
3d96ee83babeec32482c9082c9426340cee8c44dwroweAP_DECLARE(const char *) ap_get_status_line(int status);
2d2eda71267231c2526be701fe655db125852c1ffielding/* Reading a block of data from the client connection (e.g., POST arg) */
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Setup the client to allow Apache to read the request body.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
742318b93e89c311f66b55f426c4d9cf2c14628bjim * @param read_policy How the server should interpret a chunked
346029f34d03eb20d84fc35664426d3874b00f9ewrowe * transfer-encoding. One of: <pre>
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * REQUEST_NO_BODY Send 413 error if message has any body
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * REQUEST_CHUNKED_ERROR Send 411 error if body without Content-Length
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * REQUEST_CHUNKED_DECHUNK If chunked, remove the chunks for me.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return either OK or an error code
3d96ee83babeec32482c9082c9426340cee8c44dwroweAP_DECLARE(int) ap_setup_client_block(request_rec *r, int read_policy);
742318b93e89c311f66b55f426c4d9cf2c14628bjim * Determine if the client has sent any data. This also sends a
face099b681c052cb1f52176a5499661c44b2982trawick * 100 Continue response to HTTP/1.1 clients, so modules should not be called
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * until the module is ready to read content.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @warning Never call this function more than once.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return 0 if there is no message to read, 1 otherwise
3d96ee83babeec32482c9082c9426340cee8c44dwroweAP_DECLARE(int) ap_should_client_block(request_rec *r);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Call this in a loop. It will put data into a buffer and return the length
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * of the input block
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param buffer The buffer in which to store the data
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param bufsiz The size of the buffer
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return Number of bytes inserted into the buffer. When done reading, 0
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * if EOF, or -1 if there was an error
aecb17a45c6d3ee4729ed5f68dc4270f211ee7a8fieldingAP_DECLARE(long) ap_get_client_block(request_rec *r, char *buffer, apr_size_t bufsiz);
a511a29faf2ff7ead3b67680154a624effb31aafminfrin * Map specific APR codes returned by the filter stack to HTTP error
a511a29faf2ff7ead3b67680154a624effb31aafminfrin * codes, or the default status code provided. Use it as follows:
a511a29faf2ff7ead3b67680154a624effb31aafminfrin * return ap_map_http_response(rv, HTTP_BAD_REQUEST);
a511a29faf2ff7ead3b67680154a624effb31aafminfrin * If the filter has already handled the error, AP_FILTER_ERROR will
a511a29faf2ff7ead3b67680154a624effb31aafminfrin * be returned, which is cleanly passed through.
a511a29faf2ff7ead3b67680154a624effb31aafminfrin * These mappings imply that the filter stack is reading from the
a511a29faf2ff7ead3b67680154a624effb31aafminfrin * downstream client, the proxy will map these codes differently.
a511a29faf2ff7ead3b67680154a624effb31aafminfrin * @param rv APR status code
a511a29faf2ff7ead3b67680154a624effb31aafminfrin * @param status Default HTTP code should the APR code not be recognised
a511a29faf2ff7ead3b67680154a624effb31aafminfrin * @return Mapped HTTP status code
a511a29faf2ff7ead3b67680154a624effb31aafminfrinAP_DECLARE(int) ap_map_http_request_error(apr_status_t rv, int status);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * In HTTP/1.1, any method can have a body. However, most GET handlers
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * wouldn't know what to do with a request body if they received one.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * This helper routine tests for and reads any message body in the request,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * simply discarding whatever it receives. We need to do this because
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * failing to read the request body would cause it to be interpreted
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * as the next request on a persistent connection.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
742318b93e89c311f66b55f426c4d9cf2c14628bjim * @return error status if request is malformed, OK otherwise
3d96ee83babeec32482c9082c9426340cee8c44dwroweAP_DECLARE(int) ap_discard_request_body(request_rec *r);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Setup the output headers so that the client knows how to authenticate
a44d29a3794110c558c940bd903a1930d717a7d7sf * itself the next time, if an authentication request failed.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
a44d29a3794110c558c940bd903a1930d717a7d7sf * @deprecated @see ap_note_auth_failure
3d96ee83babeec32482c9082c9426340cee8c44dwroweAP_DECLARE(void) ap_note_basic_auth_failure(request_rec *r);
a44d29a3794110c558c940bd903a1930d717a7d7sf * @deprecated @see ap_note_auth_failure
3d96ee83babeec32482c9082c9426340cee8c44dwroweAP_DECLARE(void) ap_note_digest_auth_failure(request_rec *r);
a44d29a3794110c558c940bd903a1930d717a7d7sf * This hook allows modules to add support for a specific auth type to
a44d29a3794110c558c940bd903a1930d717a7d7sf * ap_note_auth_failure
a44d29a3794110c558c940bd903a1930d717a7d7sf * @param r the current request
a44d29a3794110c558c940bd903a1930d717a7d7sf * @param auth_type the configured auth_type
a44d29a3794110c558c940bd903a1930d717a7d7sf * @return OK, DECLINED
a44d29a3794110c558c940bd903a1930d717a7d7sfAP_DECLARE_HOOK(int, note_auth_failure, (request_rec *r, const char *auth_type))
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Get the password from the request headers
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param pw The password as set in the headers
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return 0 (OK) if it set the 'pw' argument (and assured
742318b93e89c311f66b55f426c4d9cf2c14628bjim * a correct value in r->user); otherwise it returns
742318b93e89c311f66b55f426c4d9cf2c14628bjim * an error code, either HTTP_INTERNAL_SERVER_ERROR if things are
742318b93e89c311f66b55f426c4d9cf2c14628bjim * really confused, HTTP_UNAUTHORIZED if no authentication at all
742318b93e89c311f66b55f426c4d9cf2c14628bjim * seemed to be in use, or DECLINED if there was authentication but
742318b93e89c311f66b55f426c4d9cf2c14628bjim * it wasn't Basic (in which case, the caller should presumably
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * decline as well).
3d96ee83babeec32482c9082c9426340cee8c44dwroweAP_DECLARE(int) ap_get_basic_auth_pw(request_rec *r, const char **pw);
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * parse_uri: break apart the uri
742318b93e89c311f66b55f426c4d9cf2c14628bjim * @warning Side Effects:
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @li sets r->args to rest after '?' (or NULL if no '?')
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @li sets r->uri to request uri (without r->args part)
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @li sets r->hostname (if not set already) from request (scheme://host:port)
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param uri The uri to break apart
3d96ee83babeec32482c9082c9426340cee8c44dwroweAP_CORE_DECLARE(void) ap_parse_uri(request_rec *r, const char *uri);
fd8b91502bc200ed4cca3810560a2a570522b3debrianp * Get the next line of input for the request
fd8b91502bc200ed4cca3810560a2a570522b3debrianp * @param s The buffer into which to read the line
fd8b91502bc200ed4cca3810560a2a570522b3debrianp * @param n The size of the buffer
fd8b91502bc200ed4cca3810560a2a570522b3debrianp * @param r The request
fd8b91502bc200ed4cca3810560a2a570522b3debrianp * @param fold Whether to merge continuation lines
fd8b91502bc200ed4cca3810560a2a570522b3debrianp * @return The length of the line, if successful
fd8b91502bc200ed4cca3810560a2a570522b3debrianp * n, if the line is too big to fit in the buffer
fd8b91502bc200ed4cca3810560a2a570522b3debrianp * -1 for miscellaneous errors
aa4af3da5c68fe5dbd9d2c3fd7b2fe7103daa2b7dougmAP_DECLARE(int) ap_getline(char *s, int n, request_rec *r, int fold);
fd8b91502bc200ed4cca3810560a2a570522b3debrianp * Get the next line of input for the request
742318b93e89c311f66b55f426c4d9cf2c14628bjim * Note: on ASCII boxes, ap_rgetline is a macro which simply calls
4111de96e9f75c58e77c2bdda23be83b8ebf81ccgregames * ap_rgetline_core to get the line of input.
4111de96e9f75c58e77c2bdda23be83b8ebf81ccgregames * on EBCDIC boxes, ap_rgetline is a wrapper function which
4111de96e9f75c58e77c2bdda23be83b8ebf81ccgregames * translates ASCII protocol lines to the local EBCDIC code page
4111de96e9f75c58e77c2bdda23be83b8ebf81ccgregames * after getting the line of input.
fd8b91502bc200ed4cca3810560a2a570522b3debrianp * @param s Pointer to the pointer to the buffer into which the line
fd8b91502bc200ed4cca3810560a2a570522b3debrianp * should be read; if *s==NULL, a buffer of the necessary size
fd8b91502bc200ed4cca3810560a2a570522b3debrianp * to hold the data will be allocated from the request pool
fd8b91502bc200ed4cca3810560a2a570522b3debrianp * @param n The size of the buffer
45613d36b9466a48def0498cffa07f48980720f8jerenkrantz * @param read The length of the line.
fd8b91502bc200ed4cca3810560a2a570522b3debrianp * @param r The request
fd8b91502bc200ed4cca3810560a2a570522b3debrianp * @param fold Whether to merge continuation lines
50e60f30bdc074fbc887f0b98f4d570457ac97c9brianp * @param bb Working brigade to use when reading buckets
45613d36b9466a48def0498cffa07f48980720f8jerenkrantz * @return APR_SUCCESS, if successful
45613d36b9466a48def0498cffa07f48980720f8jerenkrantz * APR_ENOSPC, if the line is too big to fit in the buffer
45613d36b9466a48def0498cffa07f48980720f8jerenkrantz * Other errors where appropriate
742318b93e89c311f66b55f426c4d9cf2c14628bjimAP_DECLARE(apr_status_t) ap_rgetline(char **s, apr_size_t n,
4111de96e9f75c58e77c2bdda23be83b8ebf81ccgregames#else /* ASCII box */
50e60f30bdc074fbc887f0b98f4d570457ac97c9brianp ap_rgetline_core((s), (n), (read), (r), (fold), (bb))
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh/** @see ap_rgetline */
742318b93e89c311f66b55f426c4d9cf2c14628bjimAP_DECLARE(apr_status_t) ap_rgetline_core(char **s, apr_size_t n,
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Get the method number associated with the given string, assumed to
2d2eda71267231c2526be701fe655db125852c1ffielding * contain an HTTP method. Returns M_INVALID if not recognized.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param method A string containing a valid HTTP method
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The method number
3d96ee83babeec32482c9082c9426340cee8c44dwroweAP_DECLARE(int) ap_method_number_of(const char *method);
344f3bc38dfccf6261d5bb8d689794cde113b3d6coar * Get the method name associated with the given internal method
344f3bc38dfccf6261d5bb8d689794cde113b3d6coar * number. Returns NULL if not recognized.
5a9667916c79d8c699b069068e5570aa1c331c80gstein * @param p A pool to use for temporary allocations.
344f3bc38dfccf6261d5bb8d689794cde113b3d6coar * @param methnum An integer value corresponding to an internal method number
344f3bc38dfccf6261d5bb8d689794cde113b3d6coar * @return The name corresponding to the method number
5a9667916c79d8c699b069068e5570aa1c331c80gsteinAP_DECLARE(const char *) ap_method_name_of(apr_pool_t *p, int methnum);
a2930b0b01bfdbaa9e5c3324266bce9ef74158c2jim/* Hooks */
a2930b0b01bfdbaa9e5c3324266bce9ef74158c2jim * pre_read_request --- run right before read_request_line(),
a2930b0b01bfdbaa9e5c3324266bce9ef74158c2jim * and not run during any subrequests.
a2930b0b01bfdbaa9e5c3324266bce9ef74158c2jim * This hook allows modules to affect the request or connection immediately before
a2930b0b01bfdbaa9e5c3324266bce9ef74158c2jim * the request has been read, and before any other phases have been processes.
a2930b0b01bfdbaa9e5c3324266bce9ef74158c2jim * @param r The current request of the soon-to-be-read request
a2930b0b01bfdbaa9e5c3324266bce9ef74158c2jim * @param c The connection
a2930b0b01bfdbaa9e5c3324266bce9ef74158c2jimAP_DECLARE_HOOK(void,pre_read_request,(request_rec *r, conn_rec *c))
a2930b0b01bfdbaa9e5c3324266bce9ef74158c2jim * post_read_request --- run right after read_request or internal_redirect,
a2930b0b01bfdbaa9e5c3324266bce9ef74158c2jim * and not run during any subrequests.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * This hook allows modules to affect the request immediately after the request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * has been read, and before any other phases have been processes. This allows
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * modules to make decisions based upon the input header fields
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return OK or DECLINED
42ce672c516baf6e4eaed18ccc1647de2d456d8edougmAP_DECLARE_HOOK(int,post_read_request,(request_rec *r))
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * This hook allows modules to perform any module-specific logging activities
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * over and above the normal server things.
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return OK, DECLINED, or HTTP_...
7b6ba9c468f26bdb3492d5e8cb79628a3b04e8c8wrowe * This hook allows modules to retrieve the http scheme for a request. This
7b6ba9c468f26bdb3492d5e8cb79628a3b04e8c8wrowe * allows Apache modules to easily extend the schemes that Apache understands
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
7b6ba9c468f26bdb3492d5e8cb79628a3b04e8c8wrowe * @return The http scheme from the request
7b6ba9c468f26bdb3492d5e8cb79628a3b04e8c8wroweAP_DECLARE_HOOK(const char *,http_scheme,(const request_rec *r))
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * Return the default port from the current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @param r The current request
61fd0cab072a05b855cbef9c585702401ac5ae29rbb * @return The current port
42ce672c516baf6e4eaed18ccc1647de2d456d8edougmAP_DECLARE_HOOK(apr_port_t,default_port,(const request_rec *r))
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh/** @see ap_bucket_type_error */
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @struct ap_bucket_error
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @brief A bucket referring to an HTTP error
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * This bucket can be passed down the filter stack to indicate that an
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * HTTP error occurred while running a filter. In order for this bucket
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * to be used successfully, it MUST be sent as the first bucket in the
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * first brigade to be sent from a given filter.
0de8f88b22d24dd57ed10b96fb594e69b6aa0072jwoolley /** Number of buckets using this memory */
8b7047e519340545e6807c9749576a40a76b6d3frbb /** The error code */
8b7047e519340545e6807c9749576a40a76b6d3frbb /** The error string */
6d00a43be9ab145c89e8cc22bad59e3aa746f761jwoolley const char *data;
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh/** @see ap_bucket_type_error */
9484ae61c7cc5fa8d8d9a836efdbdb1e88d3036dwroweAP_DECLARE_DATA extern const apr_bucket_type_t ap_bucket_type_error;
2e75499d05677dd589f7ce6b5139ae15ba049419jerenkrantz * Determine if a bucket is an error bucket
2e75499d05677dd589f7ce6b5139ae15ba049419jerenkrantz * @param e The bucket to inspect
2e75499d05677dd589f7ce6b5139ae15ba049419jerenkrantz * @return true or false
2e75499d05677dd589f7ce6b5139ae15ba049419jerenkrantz#define AP_BUCKET_IS_ERROR(e) (e->type == &ap_bucket_type_error)
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * Make the bucket passed in an error bucket
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * @param b The bucket to make into an error bucket
742318b93e89c311f66b55f426c4d9cf2c14628bjim * @param error The HTTP error code to put in the bucket.
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * @param buf An optional error string to put in the bucket.
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * @param p A pool to allocate out of.
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * @return The new bucket, or NULL if allocation failed
561e5f16a2f9fb397aac4c283aaa87a752520a4ddougmAP_DECLARE(apr_bucket *) ap_bucket_error_make(apr_bucket *b, int error,
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * Create a bucket referring to an HTTP error.
742318b93e89c311f66b55f426c4d9cf2c14628bjim * @param error The HTTP error code to put in the bucket.
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * @param buf An optional error string to put in the bucket.
2fc50921b88defeb7127985dfe4b4130175e069ejwoolley * @param p A pool to allocate the error string out of.
2fc50921b88defeb7127985dfe4b4130175e069ejwoolley * @param list The bucket allocator from which to allocate the bucket
fcc25eda7b150e226d3c1cdaea66a943d3fdee4erbb * @return The new bucket, or NULL if allocation failed
2fc50921b88defeb7127985dfe4b4130175e069ejwoolleyAP_DECLARE(apr_bucket *) ap_bucket_error_create(int error, const char *buf,
c9a95767fbf0f5fb0976a06b97a256033925e433rbbAP_DECLARE_NONSTD(apr_status_t) ap_byterange_filter(ap_filter_t *f, apr_bucket_brigade *b);
c9a95767fbf0f5fb0976a06b97a256033925e433rbbAP_DECLARE_NONSTD(apr_status_t) ap_http_header_filter(ap_filter_t *f, apr_bucket_brigade *b);
c9a95767fbf0f5fb0976a06b97a256033925e433rbbAP_DECLARE_NONSTD(apr_status_t) ap_content_length_filter(ap_filter_t *,
c9a95767fbf0f5fb0976a06b97a256033925e433rbbAP_DECLARE_NONSTD(apr_status_t) ap_old_write_filter(ap_filter_t *f, apr_bucket_brigade *b);
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * Sett up the protocol fields for subsidiary requests
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @param rnew New Sub Request
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @param r current request
3311183b8638d2ba2ff8496cad5e01c27d329a05ndAP_DECLARE(void) ap_set_sub_req_protocol(request_rec *rnew, const request_rec *r);
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * A wrapup function to keep the internal accounting straight.
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * Indicates that there is no more content coming.
9d129b55f5a43abf43865c6b0eb6dd19bc22aba8ianh * @param sub_r Subrequest that is now compete
3311183b8638d2ba2ff8496cad5e01c27d329a05ndAP_DECLARE(void) ap_finalize_sub_req_protocol(request_rec *sub_r);
f5abdb59b6579717b5de18de9de340f4b67d6f26niq * Send an interim (HTTP 1xx) response immediately.
f5abdb59b6579717b5de18de9de340f4b67d6f26niq * @param r The request
3347ef7496eff25aaca86b2852a14bab667d0e34niq * @param send_headers Whether to send&clear headers in r->headers_out
3347ef7496eff25aaca86b2852a14bab667d0e34niqAP_DECLARE(void) ap_send_interim_response(request_rec *r, int send_headers);
11e076839c8d5a82d55e710194d0daac51390dbdsf#endif /* !APACHE_HTTP_PROTOCOL_H */