1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2 * contributor license agreements. See the NOTICE file distributed with
3 * this work for additional information regarding copyright ownership.
4 * The ASF licenses this file to You under the Apache License, Version 2.0
5 * (the "License"); you may not use this file except in compliance with
6 * the License. You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 * @file http_connection.h
19 * @brief Apache connection library
21 * @defgroup APACHE_CORE_CONNECTION Connection Library
22 * @ingroup APACHE_CORE
26 #ifndef APACHE_HTTP_CONNECTION_H
27 #define APACHE_HTTP_CONNECTION_H
29 #include "apr_hooks.h"
30 #include "apr_network_io.h"
31 #include "apr_buckets.h"
37 * @file http_connection.h
38 * @brief Apache connection library
42 * This is the protocol module driver. This calls all of the
43 * pre-connection and connection hooks for all protocol modules.
44 * @param c The connection on which the request is read
45 * @param csd The mechanism on which this connection is to be read.
46 * Most times this will be a socket, but it is up to the module
47 * that accepts the request to determine the exact type.
49 AP_CORE_DECLARE(void) ap_process_connection(conn_rec *c, void *csd);
52 * Flushes all remain data in the client send buffer
53 * @param c The connection to flush
55 AP_CORE_DECLARE(void) ap_flush_conn(conn_rec *c);
58 * This function is responsible for the following cases:
60 * we now proceed to read from the client until we get EOF, or until
61 * MAX_SECS_TO_LINGER has passed. the reasons for doing this are
62 * documented in a draft:
64 * http://www.ics.uci.edu/pub/ietf/http/draft-ietf-http-connection-00.txt
66 * in a nutshell -- if we don't make this effort we risk causing
67 * TCP RST packets to be sent which can tear down a connection before
68 * all the response data has been sent to the client.
70 * @param c The connection we are closing
72 AP_DECLARE(void) ap_lingering_close(conn_rec *c);
76 * create_connection is a RUN_FIRST hook which allows modules to create
77 * connections. In general, you should not install filters with the
78 * create_connection hook. If you require vhost configuration information
79 * to make filter installation decisions, you must use the pre_connection
80 * or install_network_transport hook. This hook should close the connection
81 * if it encounters a fatal error condition.
83 * @param p The pool from which to allocate the connection record
84 * @param server The server record to create the connection too.
85 * @param csd The socket that has been accepted
86 * @param conn_id A unique identifier for this connection. The ID only
87 * needs to be unique at that time, not forever.
88 * @param sbh A handle to scoreboard information for this connection.
89 * @param alloc The bucket allocator to use for all bucket/brigade creations
90 * @return An allocated connection record or NULL.
92 AP_DECLARE_HOOK(conn_rec *, create_connection,
93 (apr_pool_t *p, server_rec *server, apr_socket_t *csd,
94 long conn_id, void *sbh, apr_bucket_alloc_t *alloc))
97 * This hook gives protocol modules an opportunity to set everything up
98 * before calling the protocol handler. All pre-connection hooks are
99 * run until one returns something other than ok or decline
100 * @param c The connection on which the request has been received.
101 * @param csd The mechanism on which this connection is to be read.
102 * Most times this will be a socket, but it is up to the module
103 * that accepts the request to determine the exact type.
104 * @return OK or DECLINED
106 AP_DECLARE_HOOK(int,pre_connection,(conn_rec *c, void *csd))
109 * This hook implements different protocols. After a connection has been
110 * established, the protocol module must read and serve the request. This
111 * function does that for each protocol module. The first protocol module
112 * to handle the request is the last module run.
113 * @param c The connection on which the request has been received.
114 * @return OK or DECLINED
116 AP_DECLARE_HOOK(int,process_connection,(conn_rec *c))
118 /** End Of Connection (EOC) bucket */
119 AP_DECLARE_DATA extern const apr_bucket_type_t ap_bucket_type_eoc;
122 * Determine if a bucket is an End Of Connection (EOC) bucket
123 * @param e The bucket to inspect
124 * @return true or false
126 #define AP_BUCKET_IS_EOC(e) (e->type == &ap_bucket_type_eoc)
129 * Make the bucket passed in an End Of Connection (EOC) bucket
130 * @param b The bucket to make into an EOC bucket
131 * @return The new bucket, or NULL if allocation failed
133 AP_DECLARE(apr_bucket *) ap_bucket_eoc_make(apr_bucket *b);
136 * Create a bucket referring to an End Of Connection (EOC). This indicates
137 * that the connection will be closed.
138 * @param list The freelist from which this bucket should be allocated
139 * @return The new bucket, or NULL if allocation failed
141 AP_DECLARE(apr_bucket *) ap_bucket_eoc_create(apr_bucket_alloc_t *list);
147 #endif /* !APACHE_HTTP_REQUEST_H */