Add the missing minor bump of r550519.

[apache] / include / http_connection.h

diff --git a/include/http_connection.h b/include/http_connection.h
index 1550fe385e9b1e08f2c62c168bb392d2b4d0c19a..fdd2e535d8ce42a4798ef2ca0f212175f9d915df 100644 (file)
--- a/include/http_connection.h
+++ b/include/http_connection.h
@@ -1,8 +1,9 @@
-/* Copyright 1999-2004 The Apache Software Foundation
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+/* Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
@@ -13,6 +14,15 @@
  * limitations under the License.
  */
 
+/**
+ * @file  http_connection.h
+ * @brief Apache connection library
+ *
+ * @defgroup APACHE_CORE_CONNECTION Connection Library
+ * @ingroup  APACHE_CORE
+ * @{
+ */
+
 #ifndef APACHE_HTTP_CONNECTION_H
 #define APACHE_HTTP_CONNECTION_H
 
@@ -23,10 +33,11 @@
 #ifdef __cplusplus
 extern "C" {
 #endif
-
 /**
- * @package Apache connection library
+ * @file  http_connection.h
+ * @brief Apache connection library
  */
+
 #ifdef CORE_PRIVATE
 /**
  * This is the protocol module driver.  This calls all of the
@@ -35,10 +46,13 @@ extern "C" {
  * @param csd The mechanism on which this connection is to be read.  
  *            Most times this will be a socket, but it is up to the module
  *            that accepts the request to determine the exact type.
- * @deffunc void ap_process_connection(conn_rec *c, void *csd)
  */
 AP_CORE_DECLARE(void) ap_process_connection(conn_rec *c, void *csd);
 
+/**
+ * Flushes all remain data in the client send buffer
+ * @param c The connection to flush
+ */
 AP_CORE_DECLARE(void) ap_flush_conn(conn_rec *c);
 
 /**
@@ -69,10 +83,12 @@ AP_DECLARE(void) ap_lingering_close(conn_rec *c);
  * if it encounters a fatal error condition.
  *
  * @param p The pool from which to allocate the connection record
+ * @param server The server record to create the connection too. 
  * @param csd The socket that has been accepted
  * @param conn_id A unique identifier for this connection.  The ID only
  *                needs to be unique at that time, not forever.
  * @param sbh A handle to scoreboard information for this connection.
+ * @param alloc The bucket allocator to use for all bucket/brigade creations
  * @return An allocated connection record or NULL.
  */
 AP_DECLARE_HOOK(conn_rec *, create_connection,
@@ -88,7 +104,6 @@ AP_DECLARE_HOOK(conn_rec *, create_connection,
  *            Most times this will be a socket, but it is up to the module
  *            that accepts the request to determine the exact type.
  * @return OK or DECLINED
- * @deffunc int ap_run_pre_connection(conn_rec *c, void *csd)
  */
 AP_DECLARE_HOOK(int,pre_connection,(conn_rec *c, void *csd))
 
@@ -99,12 +114,37 @@ AP_DECLARE_HOOK(int,pre_connection,(conn_rec *c, void *csd))
  * to handle the request is the last module run.
  * @param c The connection on which the request has been received.
  * @return OK or DECLINED
- * @deffunc int ap_run_process_connection(conn_rec *c)
  */
 AP_DECLARE_HOOK(int,process_connection,(conn_rec *c))
 
+/** End Of Connection (EOC) bucket */
+AP_DECLARE_DATA extern const apr_bucket_type_t ap_bucket_type_eoc;
+
+/**
+ * Determine if a bucket is an End Of Connection (EOC) bucket
+ * @param e The bucket to inspect
+ * @return true or false
+ */
+#define AP_BUCKET_IS_EOC(e)         (e->type == &ap_bucket_type_eoc)
+
+/**
+ * Make the bucket passed in an End Of Connection (EOC) bucket
+ * @param b The bucket to make into an EOC bucket
+ * @return The new bucket, or NULL if allocation failed
+ */
+AP_DECLARE(apr_bucket *) ap_bucket_eoc_make(apr_bucket *b);
+
+/**
+ * Create a bucket referring to an End Of Connection (EOC). This indicates
+ * that the connection will be closed.
+ * @param list The freelist from which this bucket should be allocated
+ * @return The new bucket, or NULL if allocation failed
+ */
+AP_DECLARE(apr_bucket *) ap_bucket_eoc_create(apr_bucket_alloc_t *list);
+
 #ifdef __cplusplus
 }
 #endif
 
 #endif /* !APACHE_HTTP_REQUEST_H */
+/** @} */