Update mergeinfo only: r1735891 was merged to 2.4.x in r1787728.

[apache] / include / http_vhost.h

diff --git a/include/http_vhost.h b/include/http_vhost.h
index c5c034272c0b53e58bf585c4f0abb3b271049ef1..473c9c7d1e92dc3b9249bb675a48e73b138fde74 100644 (file)
--- a/include/http_vhost.h
+++ b/include/http_vhost.h
@@ -1,8 +1,9 @@
-/* Copyright 1999-2004 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_vhost.h
+ * @brief Virtual Host package
+ *
+ * @defgroup APACHE_CORE_VHOST Virtual Host Package
+ * @ingroup  APACHE_CORE
+ * @{
+ */
+
 #ifndef APACHE_HTTP_VHOST_H
 #define APACHE_HTTP_VHOST_H
 
@@ -20,10 +30,6 @@
 extern "C" {
 #endif
 
-/**
- * @package Virtual Host package
- */
-
 /**
  * called before any config is read
  * @param p Pool to allocate out of
@@ -31,34 +37,63 @@ extern "C" {
 AP_DECLARE(void) ap_init_vhost_config(apr_pool_t *p);
 
 /**
- * called after the config has been read to compile the tables needed to do 
+ * called after the config has been read to compile the tables needed to do
  * the run-time vhost lookups
  * @param p The pool to allocate out of
  * @param main_server The start of the virtual host list
- * @deffunc ap_fini_vhost_config(apr_pool_t *p, server_rec *main_server)
  */
 AP_DECLARE(void) ap_fini_vhost_config(apr_pool_t *p, server_rec *main_server);
 
 /**
- * handle addresses in <VirtualHost> statement
+ * handle addresses in "<VirtualHost>" statement
  * @param p The pool to allocate out of
  * @param hostname The hostname in the VirtualHost statement
  * @param s The list of Virtual Hosts.
  */
 const char *ap_parse_vhost_addrs(apr_pool_t *p, const char *hostname, server_rec *s);
 
-/* handle NameVirtualHost directive */
-const char *ap_set_name_virtual_host (cmd_parms *cmd, void *dummy,
-                                     const char *arg);
+/**
+ * handle NameVirtualHost directive
+ * @param cmd Command Parameters structure
+ * @param dummy NOT USED
+ * @param arg a host of the form "<address>[:port]"
+ */
+AP_DECLARE_NONSTD(const char *)ap_set_name_virtual_host(cmd_parms *cmd,
+                                                        void *dummy,
+                                                        const char *arg);
+
+/**
+ * Callback function for every Name Based Virtual Host.
+ * @param baton Opaque user object
+ * @param conn The current Connection
+ * @param s The current Server
+ * @see ap_vhost_iterate_given_conn
+ * @return 0 on success, any non-zero return will stop the iteration.
+ */
+typedef int(*ap_vhost_iterate_conn_cb)(void* baton, conn_rec* conn, server_rec* s);
+
+/**
+ * For every virtual host on this connection, call func_cb.
+ * @param conn The current connection
+ * @param func_cb Function called for every Name Based Virtual Host for this
+ *                connection.
+ * @param baton Opaque object passed to func_cb.
+ * @return The return value from func_cb.
+ * @note If func_cb returns non-zero, the function will return at this point,
+ *       and not continue iterating the virtual hosts.
+ */
+AP_DECLARE(int) ap_vhost_iterate_given_conn(conn_rec *conn,
+                                            ap_vhost_iterate_conn_cb func_cb,
+                                            void* baton);
 
 /**
- * given an ip address only, give our best guess as to what vhost it is 
+ * given an ip address only, give our best guess as to what vhost it is
  * @param conn The current connection
  */
 AP_DECLARE(void) ap_update_vhost_given_ip(conn_rec *conn);
 
 /**
- * ap_update_vhost_given_ip is never enough, and this is always called after 
+ * ap_update_vhost_given_ip is never enough, and this is always called after
  * the headers have been read.  It may change r->server.
  * @param r The current request
  */
@@ -72,7 +107,6 @@ AP_DECLARE(void) ap_update_vhost_from_headers(request_rec *r);
  * @param port The port from the headers
  * @return return 1 if the host:port matches any of the aliases of r->server,
  * return 0 otherwise
- * @deffunc int ap_matches_request_vhost(request_rec *r, const char *host, apr_port_t port)
  */
 AP_DECLARE(int) ap_matches_request_vhost(request_rec *r, const char *host,
     apr_port_t port);
@@ -81,4 +115,5 @@ AP_DECLARE(int) ap_matches_request_vhost(request_rec *r, const char *host,
 }
 #endif
 
-#endif /* !APACHE_HTTP_VHOST_H */
+#endif  /* !APACHE_HTTP_VHOST_H */
+/** @} */