]> granicus.if.org Git - apache/blobdiff - include/ap_listen.h
ap_expr related fixes/enhancements:
[apache] / include / ap_listen.h
index bdcea6a53dc052c167c61f365e1b5a06984441ee..c275e8cb02d9d0dbef2e8c26aae16df231dc8ebf 100644 (file)
@@ -1,9 +1,9 @@
-/* Copyright 1999-2005 The Apache Software Foundation or its licensors, as
- * applicable.
- *
- * 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
  *
  * limitations under the License.
  */
 
+/**
+ * @file  ap_listen.h
+ * @brief Apache Listeners Library
+ *
+ * @defgroup APACHE_CORE_LISTEN Apache Listeners Library
+ * @ingroup  APACHE_CORE
+ * @{
+ */
+
 #ifndef AP_LISTEN_H
 #define AP_LISTEN_H
 
 #include "httpd.h"
 #include "http_config.h"
 
-/**
- * @package Apache Listeners Library
- */
+#ifdef __cplusplus
+extern "C" {
+#endif
 
+typedef struct ap_slave_t ap_slave_t;
 typedef struct ap_listen_rec ap_listen_rec;
 typedef apr_status_t (*accept_function)(void **csd, ap_listen_rec *lr, apr_pool_t *ptrans);
 
 /**
- * Apache's listeners record.  These are used in the Multi-Processing Modules
+ * @brief Apache's listeners record.  
+ *
+ * These are used in the Multi-Processing Modules
  * to setup all of the sockets for the MPM to listen to and accept on.
  */
 struct ap_listen_rec {
@@ -53,7 +65,12 @@ struct ap_listen_rec {
      * Is this socket currently active 
      */
     int active;
-/* more stuff here, like which protocol is bound to the port */
+    /**
+     * The default protocol for this listening socket.
+     */
+    const char* protocol;
+
+    ap_slave_t *slave;
 };
 
 /**
@@ -65,17 +82,24 @@ AP_DECLARE_DATA extern ap_listen_rec *ap_listeners;
  * Setup all of the defaults for the listener list
  */
 AP_DECLARE(void) ap_listen_pre_config(void);
-#if !defined(SPMT_OS2_MPM)
+
 /**
  * Loop through the global ap_listen_rec list and create all of the required
  * sockets.  This executes the listen and bind on the sockets.
  * @param s The global server_rec
  * @return The number of open sockets.
- * @warning This function is not available to Windows platforms, or the
- * Prefork or SPMT_OS2 MPMs.
  */ 
 AP_DECLARE(int) ap_setup_listeners(server_rec *s);
-#endif
+
+/**
+ * Loop through the global ap_listen_rec list and close each of the sockets.
+ */
+AP_DECLARE_NONSTD(void) ap_close_listeners(void);
+
+/**
+ * FIXMEDOC
+ */
+AP_DECLARE_NONSTD(int) ap_close_selected_listeners(ap_slave_t *);
 
 /* Although these functions are exported from libmain, they are not really
  * public functions.  These functions are actually called while parsing the
@@ -85,16 +109,27 @@ AP_DECLARE(int) ap_setup_listeners(server_rec *s);
  * called.
  */ 
 AP_DECLARE_NONSTD(const char *) ap_set_listenbacklog(cmd_parms *cmd, void *dummy, const char *arg);
-AP_DECLARE_NONSTD(const char *) ap_set_listener(cmd_parms *cmd, void *dummy, const char *ips);
+AP_DECLARE_NONSTD(const char *) ap_set_listener(cmd_parms *cmd, void *dummy, 
+                                                int argc, char *const argv[]);
 AP_DECLARE_NONSTD(const char *) ap_set_send_buffer_size(cmd_parms *cmd, void *dummy,
                                    const char *arg);
+AP_DECLARE_NONSTD(const char *) ap_set_receive_buffer_size(cmd_parms *cmd,
+                                                           void *dummy,
+                                                           const char *arg);
 
 #define LISTEN_COMMANDS        \
 AP_INIT_TAKE1("ListenBacklog", ap_set_listenbacklog, NULL, RSRC_CONF, \
   "Maximum length of the queue of pending connections, as used by listen(2)"), \
-AP_INIT_TAKE1("Listen", ap_set_listener, NULL, RSRC_CONF, \
-  "A port number or a numeric IP address and a port number"), \
+AP_INIT_TAKE_ARGV("Listen", ap_set_listener, NULL, RSRC_CONF, \
+  "A port number or a numeric IP address and a port number, and an optional protocol"), \
 AP_INIT_TAKE1("SendBufferSize", ap_set_send_buffer_size, NULL, RSRC_CONF, \
-  "Send buffer size in bytes")
+  "Send buffer size in bytes"), \
+AP_INIT_TAKE1("ReceiveBufferSize", ap_set_receive_buffer_size, NULL, \
+              RSRC_CONF, "Receive buffer size in bytes")
+
+#ifdef __cplusplus
+}
+#endif
 
 #endif
+/** @} */