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

   1 /* ====================================================================
   2  * The Apache Software License, Version 1.1
   3  *
   4  * Copyright (c) 2000 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 "http_config.h"
  60
  61 /**
  62  * @package Apache Listeners Library
  63  */
  64
  65 typedef struct ap_listen_rec ap_listen_rec;
  66
  67 /**
  68  * Apache's listeners record.  These are used in the Multi-Processing Modules
  69  * to setup all of the sockets for the MPM to listen to and accept on.
  70  */
  71 struct ap_listen_rec {
  72     /**
  73      * The next listener in the list
  74      */
  75     ap_listen_rec *next;
  76     /**
  77      * The actual socket
  78      */
  79     apr_socket_t *sd;
  80     /**
  81      * Is this socket currently active
  82      */
  83     int active;
  84 #ifdef WIN32
  85     /**
  86      * Windows only.  The number of completion ports currently listening to
  87      * this socket
  88      */
  89     int count;
  90 #endif
  91 /* more stuff here, like which protocol is bound to the port */
  92 };
  93
  94 /**
  95  * The global list of ap_listen_rec structures
  96  */
  97 extern ap_listen_rec *ap_listeners;
  98
  99 /**
 100  * Setup all of the defaults for the listener list
 101  */
 102 void ap_listen_pre_config(void);
 103 #if !defined(WIN32) && !defined(SPMT_OS2_MPM)
 104 /**
 105  * Loop through the global ap_listen_rec list and create all of the required
 106  * sockets.  This executes the listen and bind on the sockets.
 107  * @param s The global server_rec
 108  * @return The number of open sockets.
 109  * @warning This function is not available to Windows platforms, or the
 110  * Prefork or SPMT_OS2 MPMs.
 111  */
 112 int ap_setup_listeners(server_rec *s);
 113 #else
 114 /**
 115  * Create and open a socket on the specified port.  This includes listening
 116  * and binding the socket.
 117  * @param process The process record for the currently running server
 118  * @param port The port to open a socket on.
 119  * @return The number of open sockets
 120  * @warning This function is only available to Windows platforms, or the
 121  * Prefork or SPMT_OS2 MPMs.
 122  */
 123 int ap_listen_open(process_rec *process, apr_port_t port);
 124 #endif
 125
 126 /* Although these functions are exported from libmain, they are not really
 127  * public functions.  These functions are actually called while parsing the
 128  * config file, when one of the LISTEN_COMMANDS directives is read.  These
 129  * should not ever be called by external modules.  ALL MPMs should include
 130  * LISTEN_COMMANDS in their command_rec table so that these functions are
 131  * called.
 132  */
 133 const char *ap_set_listenbacklog(cmd_parms *cmd, void *dummy, const char *arg);
 134 const char *ap_set_listener(cmd_parms *cmd, void *dummy, const char *ips);
 135 const char *ap_set_send_buffer_size(cmd_parms *cmd, void *dummy,
 136                                     const char *arg);
 137
 138 #define LISTEN_COMMANDS \
 139 AP_INIT_TAKE1("ListenBacklog", ap_set_listenbacklog, NULL, RSRC_CONF, \
 140   "Maximum length of the queue of pending connections, as used by listen(2)"), \
 141 AP_INIT_TAKE1("Listen", ap_set_listener, NULL, RSRC_CONF, \
 142   "A port number or a numeric IP address and a port number"), \
 143 AP_INIT_TAKE1("SendBufferSize", ap_set_send_buffer_size, NULL, RSRC_CONF, \
 144   "Send buffer size in bytes"),
 145
 146 #endif