granicus.if.org Git - apache/blob - include/http_connection.h

   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
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 /**
  18  * @file  http_connection.h
  19  * @brief Apache connection library
  20  *
  21  * @defgroup APACHE_CORE_CONNECTION Connection Library
  22  * @ingroup  APACHE_CORE
  23  * @{
  24  */
  25
  26 #ifndef APACHE_HTTP_CONNECTION_H
  27 #define APACHE_HTTP_CONNECTION_H
  28
  29 #include "apr_network_io.h"
  30 #include "apr_buckets.h"
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35 /**
  36  * @file  http_connection.h
  37  * @brief Apache connection library
  38  */
  39
  40 /**
  41  * This is the protocol module driver.  This calls all of the
  42  * pre-connection and connection hooks for all protocol modules.
  43  * @param c The connection on which the request is read
  44  * @param csd The mechanism on which this connection is to be read.
  45  *            Most times this will be a socket, but it is up to the module
  46  *            that accepts the request to determine the exact type.
  47  */
  48 AP_CORE_DECLARE(void) ap_process_connection(conn_rec *c, void *csd);
  49
  50 /**
  51  * Flushes all remain data in the client send buffer
  52  * @param c The connection to flush
  53  */
  54 AP_CORE_DECLARE(void) ap_flush_conn(conn_rec *c);
  55
  56 /**
  57  * This function is responsible for the following cases:
  58  * <pre>
  59  * we now proceed to read from the client until we get EOF, or until
  60  * MAX_SECS_TO_LINGER has passed.  the reasons for doing this are
  61  * documented in a draft:
  62  *
  63  * http://www.ics.uci.edu/pub/ietf/http/draft-ietf-http-connection-00.txt
  64  *
  65  * in a nutshell -- if we don't make this effort we risk causing
  66  * TCP RST packets to be sent which can tear down a connection before
  67  * all the response data has been sent to the client.
  68  * </pre>
  69  * @param c The connection we are closing
  70  */
  71 AP_DECLARE(void) ap_lingering_close(conn_rec *c);
  72
  73 AP_DECLARE(int) ap_start_lingering_close(conn_rec *c);
  74
  75 /* Hooks */
  76 /**
  77  * create_connection is a RUN_FIRST hook which allows modules to create
  78  * connections. In general, you should not install filters with the
  79  * create_connection hook. If you require vhost configuration information
  80  * to make filter installation decisions, you must use the pre_connection
  81  * or install_network_transport hook. This hook should close the connection
  82  * if it encounters a fatal error condition.
  83  *
  84  * @param p The pool from which to allocate the connection record
  85  * @param server The server record to create the connection too.
  86  * @param csd The socket that has been accepted
  87  * @param conn_id A unique identifier for this connection.  The ID only
  88  *                needs to be unique at that time, not forever.
  89  * @param sbh A handle to scoreboard information for this connection.
  90  * @param alloc The bucket allocator to use for all bucket/brigade creations
  91  * @return An allocated connection record or NULL.
  92  */
  93 AP_DECLARE_HOOK(conn_rec *, create_connection,
  94                 (apr_pool_t *p, server_rec *server, apr_socket_t *csd,
  95                  long conn_id, void *sbh, apr_bucket_alloc_t *alloc))
  96
  97 /**
  98  * This hook gives protocol modules an opportunity to set everything up
  99  * before calling the protocol handler.  All pre-connection hooks are
 100  * run until one returns something other than ok or decline
 101  * @param c The connection on which the request has been received.
 102  * @param csd The mechanism on which this connection is to be read.
 103  *            Most times this will be a socket, but it is up to the module
 104  *            that accepts the request to determine the exact type.
 105  * @return OK or DECLINED
 106  */
 107 AP_DECLARE_HOOK(int,pre_connection,(conn_rec *c, void *csd))
 108
 109 /**
 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  */
 117 AP_DECLARE_HOOK(int,process_connection,(conn_rec *c))
 118
 119 /** End Of Connection (EOC) bucket */
 120 AP_DECLARE_DATA extern const apr_bucket_type_t ap_bucket_type_eoc;
 121
 122 /**
 123  * Determine if a bucket is an End Of Connection (EOC) bucket
 124  * @param e The bucket to inspect
 125  * @return true or false
 126  */
 127 #define AP_BUCKET_IS_EOC(e)         (e->type == &ap_bucket_type_eoc)
 128
 129 /**
 130  * Make the bucket passed in an End Of Connection (EOC) bucket
 131  * @param b The bucket to make into an EOC bucket
 132  * @return The new bucket, or NULL if allocation failed
 133  */
 134 AP_DECLARE(apr_bucket *) ap_bucket_eoc_make(apr_bucket *b);
 135
 136 /**
 137  * Create a bucket referring to an End Of Connection (EOC). This indicates
 138  * that the connection will be closed.
 139  * @param list The freelist from which this bucket should be allocated
 140  * @return The new bucket, or NULL if allocation failed
 141  */
 142 AP_DECLARE(apr_bucket *) ap_bucket_eoc_create(apr_bucket_alloc_t *list);
 143
 144 #ifdef __cplusplus
 145 }
 146 #endif
 147
 148 #endif  /* !APACHE_HTTP_REQUEST_H */
 149 /** @} */