rubbos/app/httpd-2.0.64/include/http_vhost.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 #ifndef APACHE_HTTP_VHOST_H
  18 #define APACHE_HTTP_VHOST_H
  19
  20 #ifdef __cplusplus
  21 extern "C" {
  22 #endif
  23
  24 /**
  25  * @package Virtual Host package
  26  */
  27
  28 /**
  29  * called before any config is read
  30  * @param p Pool to allocate out of
  31  */
  32 AP_DECLARE(void) ap_init_vhost_config(apr_pool_t *p);
  33
  34 /**
  35  * called after the config has been read to compile the tables needed to do
  36  * the run-time vhost lookups
  37  * @param p The pool to allocate out of
  38  * @param main_server The start of the virtual host list
  39  * @deffunc ap_fini_vhost_config(apr_pool_t *p, server_rec *main_server)
  40  */
  41 AP_DECLARE(void) ap_fini_vhost_config(apr_pool_t *p, server_rec *main_server);
  42
  43 /**
  44  * handle addresses in <VirtualHost> statement
  45  * @param p The pool to allocate out of
  46  * @param hostname The hostname in the VirtualHost statement
  47  * @param s The list of Virtual Hosts.
  48  */
  49 const char *ap_parse_vhost_addrs(apr_pool_t *p, const char *hostname, server_rec *s);
  50
  51 /* handle NameVirtualHost directive */
  52 const char *ap_set_name_virtual_host (cmd_parms *cmd, void *dummy,
  53                                       const char *arg);
  54
  55 /**
  56  * Callback function for every Name Based Virtual Host.
  57  * @param baton Opaque user object
  58  * @param conn The current Connection
  59  * @param s The current Server
  60  * @see ap_vhost_iterate_given_conn
  61  * @return 0 on success, any non-zero return will stop the iteration.
  62  */
  63 typedef int(*ap_vhost_iterate_conn_cb)(void* baton, conn_rec* conn, server_rec* s);
  64
  65 /**
  66  * For every virtual host on this connection, call func_cb.
  67  * @param conn The current connection
  68  * @param func_cb Function called for every Name Based Virtual Host for this
  69  *                connection.
  70  * @param baton Opaque object passed to func_cb.
  71  * @return The return value from func_cb.
  72  * @note If func_cb returns non-zero, the function will return at this point,
  73  *       and not continue iterating the virtual hosts.
  74  */
  75 AP_DECLARE(int) ap_vhost_iterate_given_conn(conn_rec *conn,
  76                                             ap_vhost_iterate_conn_cb func_cb,
  77                                             void* baton);
  78
  79 /**
  80  * given an ip address only, give our best guess as to what vhost it is
  81  * @param conn The current connection
  82  */
  83 AP_DECLARE(void) ap_update_vhost_given_ip(conn_rec *conn);
  84
  85 /**
  86  * ap_update_vhost_given_ip is never enough, and this is always called after
  87  * the headers have been read.  It may change r->server.
  88  * @param r The current request
  89  */
  90 AP_DECLARE(void) ap_update_vhost_from_headers(request_rec *r);
  91
  92 /**
  93  * Match the host in the header with the hostname of the server for this
  94  * request.
  95  * @param r The current request
  96  * @param host The hostname in the headers
  97  * @param port The port from the headers
  98  * @return return 1 if the host:port matches any of the aliases of r->server,
  99  * return 0 otherwise
 100  * @deffunc int ap_matches_request_vhost(request_rec *r, const char *host, apr_port_t port)
 101  */
 102 AP_DECLARE(int) ap_matches_request_vhost(request_rec *r, const char *host,
 103     apr_port_t port);
 104
 105 #ifdef __cplusplus
 106 }
 107 #endif
 108
 109 #endif  /* !APACHE_HTTP_VHOST_H */