1 /* ====================================================================
2 * The Apache Software License, Version 1.1
4 * Copyright (c) 2000 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
59 #include "apr_network_io.h"
66 * @package Apache connection library
71 * Create a new connection.
72 * @param p Pool to allocate data structures out of
73 * @param server The server to create the connection for
74 * @param inout The socket to use for all communication with the client
75 * @param remaddr The remote address
76 * @param addr The server's local address
77 * @param id ID of this connection; unique at any point in time.
79 conn_rec *ap_new_connection(apr_pool_t *p, server_rec *server,
81 const struct sockaddr_in *remaddr,
82 const struct sockaddr_in *saddr, long id);
85 * Create a new connection using APR primitives. This is basically a
86 * wrapper around ap_new_connection
87 * @param p Pool to allocate data structures out of.
88 * @param server The server to create the connection for
89 * @param conn_socket The socket we are creating the connection on.
90 * @param id ID of this connection; unique at any point in time.
92 conn_rec *ap_new_apr_connection(apr_pool_t *p, server_rec *server,
93 apr_socket_t *conn_socket, long id);
96 * This is the protocol module driver. This calls all of the
97 * pre-connection and connection hooks for all protocol modules.
98 * @param c The connection on which the request is read
99 * @deffunc void ap_process_connection(conn_rec *)
101 AP_CORE_DECLARE(void) ap_process_connection(conn_rec *);
104 * The http pre-protocol handler. This makes sets up Apache to serve http
106 * @param c The connection on which the request is read
107 * @return OK or DECLINED
109 int ap_pre_http_connection(conn_rec *);
112 * The http protocol handler. This makes Apache serve http requests
113 * @param c The connection on which the request is read
114 * @return OK or DECLINED
116 int ap_process_http_connection(conn_rec *);
119 * This function is responsible for the following cases:
121 * we now proceed to read from the client until we get EOF, or until
122 * MAX_SECS_TO_LINGER has passed. the reasons for doing this are
123 * documented in a draft:
125 * http://www.ics.uci.edu/pub/ietf/http/draft-ietf-http-connection-00.txt
127 * in a nutshell -- if we don't make this effort we risk causing
128 * TCP RST packets to be sent which can tear down a connection before
129 * all the response data has been sent to the client.
131 * @param c The connection we are closing
133 void ap_lingering_close(conn_rec *);
138 * This hook gives protocol modules an opportunity to set everything up
139 * before calling the protocol handler. ALL pre-connection hooks are
141 * @param c The connection on which the request has been received.
142 * @return OK or DECLINED
143 * @deffunc int ap_run_pre_connection(conn_rec *c)
145 AP_DECLARE_HOOK(int,pre_connection,(conn_rec *))
148 * This hook implements different protocols. After a connection has been
149 * established, the protocol module must read and serve the request. This
150 * function does that for each protocol module. The first protocol module
151 * to handle the request is the last module run.
152 * @param c The connection on which the request has been received.
153 * @return OK or DECLINED
154 * @deffunc int ap_run_process_connection(conn_rec *c)
156 AP_DECLARE_HOOK(int,process_connection,(conn_rec *))
162 #endif /* !APACHE_HTTP_REQUEST_H */