More docs for mod_example.c

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@95571 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/modules/experimental/mod_example.c b/modules/experimental/mod_example.c
index 61592b20e3d67e02ea916a4dc6f60db9ca3dd337..d741d11b155605154d6afc4032edc137045499a8 100644 (file)
--- a/modules/experimental/mod_example.c
+++ b/modules/experimental/mod_example.c
@@ -1021,8 +1021,11 @@ static int x_quick_handler(request_rec *r, int lookup_uri)
 }
 
 /*
- * This routine is called to perform any module-specific fixing of header
- * fields, et cetera.  It is invoked just before any content-handler.
+ * This routine is called just after the server accepts the connection,
+ * but before it is handed off to a protocol module to be served.  The point
+ * of this hook is to allow modules an opportunity to modify the connection
+ * as soon as possible. The core server uses this phase to setup the
+ * connection record based on the type of connection that is being used.
  *
  * The return value is OK, DECLINED, or HTTP_mumble.  If we return OK, the
  * server will still call any remaining modules with an handler for this
@@ -1042,6 +1045,19 @@ static int x_pre_connection(conn_rec *c, void *csd)
     return OK;
 }
 
+/* This routine is used to actually process the connection that was received.
+ * Only protocol modules should implement this hook, as it gives them an
+ * opportunity to replace the standard HTTP processing with processing for
+ * some other protocol.  Both echo and POP3 modules are available as
+ * examples.
+ *
+ * The return VALUE is OK, DECLINED, or HTTP_mumble.  If we return OK, no 
+ * further modules are called for this phase.
+ */
+static int x_process_connection(conn_rec *c)
+{
+}
+
 /*
  * This routine is called after the request has been read but before any other
  * phases have been processed.  This allows us to make decisions based upon