1 /* ====================================================================
2 * The Apache Software License, Version 1.1
4 * Copyright (c) 2000-2001 The Apache Software Foundation. All rights
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
19 * 3. The end-user documentation included with the redistribution,
20 * if any, must include the following acknowledgment:
21 * "This product includes software developed by the
22 * Apache Software Foundation (http://www.apache.org/)."
23 * Alternately, this acknowledgment may appear in the software itself,
24 * if and wherever such third-party acknowledgments normally appear.
26 * 4. The names "Apache" and "Apache Software Foundation" must
27 * not be used to endorse or promote products derived from this
28 * software without prior written permission. For written
29 * permission, please contact apache@apache.org.
31 * 5. Products derived from this software may not be called "Apache",
32 * nor may "Apache" appear in their name, without prior written
33 * permission of the Apache Software Foundation.
35 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47 * ====================================================================
49 * This software consists of voluntary contributions made by many
50 * individuals on behalf of the Apache Software Foundation. For more
51 * information on the Apache Software Foundation, please see
52 * <http://www.apache.org/>.
55 #ifndef APACHE_HTTP_CONNECTION_H
56 #define APACHE_HTTP_CONNECTION_H
58 #include "apr_hooks.h"
59 #include "apr_network_io.h"
66 * @package Apache connection library
71 * This is the protocol module driver. This calls all of the
72 * pre-connection and connection hooks for all protocol modules.
73 * @param c The connection on which the request is read
74 * @deffunc void ap_process_connection(conn_rec *)
76 AP_CORE_DECLARE(void) ap_process_connection(conn_rec *);
78 AP_CORE_DECLARE(void) ap_flush_conn(conn_rec *c);
81 * This function is responsible for the following cases:
83 * we now proceed to read from the client until we get EOF, or until
84 * MAX_SECS_TO_LINGER has passed. the reasons for doing this are
85 * documented in a draft:
87 * http://www.ics.uci.edu/pub/ietf/http/draft-ietf-http-connection-00.txt
89 * in a nutshell -- if we don't make this effort we risk causing
90 * TCP RST packets to be sent which can tear down a connection before
91 * all the response data has been sent to the client.
93 * @param c The connection we are closing
95 AP_DECLARE(void) ap_lingering_close(conn_rec *c);
100 * This hook gives protocol modules an opportunity to set everything up
101 * before calling the protocol handler. All pre-connection hooks are
102 * run until one returns something other than ok or decline
103 * @param c The connection on which the request has been received.
104 * @return OK or DECLINED
105 * @deffunc int ap_run_pre_connection(conn_rec *c)
107 AP_DECLARE_HOOK(int,pre_connection,(conn_rec *c))
110 * This hook implements different protocols. After a connection has been
111 * established, the protocol module must read and serve the request. This
112 * function does that for each protocol module. The first protocol module
113 * to handle the request is the last module run.
114 * @param c The connection on which the request has been received.
115 * @return OK or DECLINED
116 * @deffunc int ap_run_process_connection(conn_rec *c)
118 AP_DECLARE_HOOK(int,process_connection,(conn_rec *c))
121 * This hook allows modules to create connections. After the connection
122 * has been accepted, the socket is passed to this function to actually
123 * insert all filters that operate on the network, and create the connection
124 * record. The first module to create a connection is the last module
126 * @param p The pool from which to allocate the connection record
127 * @param csd The socket that has been accepted
128 * @param conn_id A unique identifier for this connection. The ID only
129 * needs to be unique at that time, not forever.
130 * @param sbh A handle to scoreboard information for this connection.
131 * @return An allocated connection record or NULL.
133 AP_DECLARE_HOOK(conn_rec *, create_connection,
134 (apr_pool_t *p, server_rec *server, apr_socket_t *csd, int conn_id, void *sbh))
140 #endif /* !APACHE_HTTP_REQUEST_H */