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

   1 /* ====================================================================
   2  * The Apache Software License, Version 1.1
   3  *
   4  * Copyright (c) 2000-2001 The Apache Software Foundation.  All rights
   5  * reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  *
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in
  16  *    the documentation and/or other materials provided with the
  17  *    distribution.
  18  *
  19  * 3. The end-user documentation included with the redistribution,
  20  *    if any, must include the following acknowledgment:
  21  *       "This product includes software developed by the
  22  *        Apache Software Foundation (http://www.apache.org/)."
  23  *    Alternately, this acknowledgment may appear in the software itself,
  24  *    if and wherever such third-party acknowledgments normally appear.
  25  *
  26  * 4. The names "Apache" and "Apache Software Foundation" must
  27  *    not be used to endorse or promote products derived from this
  28  *    software without prior written permission. For written
  29  *    permission, please contact apache@apache.org.
  30  *
  31  * 5. Products derived from this software may not be called "Apache",
  32  *    nor may "Apache" appear in their name, without prior written
  33  *    permission of the Apache Software Foundation.
  34  *
  35  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46  * SUCH DAMAGE.
  47  * ====================================================================
  48  *
  49  * This software consists of voluntary contributions made by many
  50  * individuals on behalf of the Apache Software Foundation.  For more
  51  * information on the Apache Software Foundation, please see
  52  * <http://www.apache.org/>.
  53  */
  54
  55 #ifndef AP_LISTEN_H
  56 #define AP_LISTEN_H
  57
  58 #include "apr_network_io.h"
  59 #include "httpd.h"
  60 #include "http_config.h"
  61 #include "mpm.h"
  62
  63 /**
  64  * @package Apache Listeners Library
  65  */
  66
  67 typedef struct ap_listen_rec ap_listen_rec;
  68
  69 /**
  70  * Apache's listeners record.  These are used in the Multi-Processing Modules
  71  * to setup all of the sockets for the MPM to listen to and accept on.
  72  */
  73 struct ap_listen_rec {
  74     /**
  75      * The next listener in the list
  76      */
  77     ap_listen_rec *next;
  78     /**
  79      * The actual socket
  80      */
  81     apr_socket_t *sd;
  82     /**
  83      * The sockaddr the socket should bind to
  84      */
  85     apr_sockaddr_t *bind_addr;
  86     /**
  87      * Is this socket currently active
  88      */
  89     int active;
  90 #ifdef WIN32
  91     /**
  92      * Windows only.  The number of completion ports currently listening to
  93      * this socket
  94      */
  95     int count;
  96 #endif
  97 /* more stuff here, like which protocol is bound to the port */
  98 };
  99
 100 /**
 101  * The global list of ap_listen_rec structures
 102  */
 103 extern ap_listen_rec *ap_listeners;
 104
 105 /**
 106  * Setup all of the defaults for the listener list
 107  */
 108 void ap_listen_pre_config(void);
 109 #if !defined(WIN32) && !defined(SPMT_OS2_MPM)
 110 /**
 111  * Loop through the global ap_listen_rec list and create all of the required
 112  * sockets.  This executes the listen and bind on the sockets.
 113  * @param s The global server_rec
 114  * @return The number of open sockets.
 115  * @warning This function is not available to Windows platforms, or the
 116  * Prefork or SPMT_OS2 MPMs.
 117  */
 118 int ap_setup_listeners(server_rec *s);
 119 #endif
 120 /* Split into two #if's to make the exports scripts easier.
 121  */
 122 #if defined(WIN32) || defined(SPMT_OS2_MPM)
 123 /**
 124  * Create and open a socket on the specified port.  This includes listening
 125  * and binding the socket.
 126  * @param process The process record for the currently running server
 127  * @param port The port to open a socket on.
 128  * @return The number of open sockets
 129  * @warning This function is only available to Windows platforms, or the
 130  * Prefork or SPMT_OS2 MPMs.
 131  */
 132 int ap_listen_open(process_rec *process, apr_port_t port);
 133 #endif
 134
 135 /* Although these functions are exported from libmain, they are not really
 136  * public functions.  These functions are actually called while parsing the
 137  * config file, when one of the LISTEN_COMMANDS directives is read.  These
 138  * should not ever be called by external modules.  ALL MPMs should include
 139  * LISTEN_COMMANDS in their command_rec table so that these functions are
 140  * called.
 141  */
 142 const char *ap_set_listenbacklog(cmd_parms *cmd, void *dummy, const char *arg);
 143 const char *ap_set_listener(cmd_parms *cmd, void *dummy, const char *ips);
 144 const char *ap_set_send_buffer_size(cmd_parms *cmd, void *dummy,
 145                                     const char *arg);
 146
 147 #define LISTEN_COMMANDS \
 148 AP_INIT_TAKE1("ListenBacklog", ap_set_listenbacklog, NULL, RSRC_CONF, \
 149   "Maximum length of the queue of pending connections, as used by listen(2)"), \
 150 AP_INIT_TAKE1("Listen", ap_set_listener, NULL, RSRC_CONF, \
 151   "A port number or a numeric IP address and a port number"), \
 152 AP_INIT_TAKE1("SendBufferSize", ap_set_send_buffer_size, NULL, RSRC_CONF, \
 153   "Send buffer size in bytes"),
 154
 155 #endif