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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 * @brief Apache Listeners Library
21 * @defgroup APACHE_CORE_LISTEN Apache Listeners Library
22 * @ingroup APACHE_CORE
29 #include "apr_network_io.h"
31 #include "http_config.h"
37 typedef struct ap_slave_t ap_slave_t;
38 typedef struct ap_listen_rec ap_listen_rec;
39 typedef apr_status_t (*accept_function)(void **csd, ap_listen_rec *lr, apr_pool_t *ptrans);
42 * @brief Apache's listeners record.
44 * These are used in the Multi-Processing Modules
45 * to setup all of the sockets for the MPM to listen to and accept on.
47 struct ap_listen_rec {
49 * The next listener in the list
57 * The sockaddr the socket should bind to
59 apr_sockaddr_t *bind_addr;
61 * The accept function for this socket
63 accept_function accept_func;
65 * Is this socket currently active
69 * The default protocol for this listening socket.
77 * The global list of ap_listen_rec structures
79 AP_DECLARE_DATA extern ap_listen_rec *ap_listeners;
81 AP_DECLARE_DATA extern ap_listen_rec **mpm_listen;
83 AP_DECLARE_DATA extern int enable_default_listener;
85 AP_DECLARE_DATA extern int num_buckets;
87 AP_DECLARE_DATA extern int have_so_reuseport;
90 * Setup all of the defaults for the listener list
92 AP_DECLARE(void) ap_listen_pre_config(void);
95 * Loop through the global ap_listen_rec list and create all of the required
96 * sockets. This executes the listen and bind on the sockets.
97 * @param s The global server_rec
98 * @return The number of open sockets.
100 AP_DECLARE(int) ap_setup_listeners(server_rec *s);
102 /**This function duplicates ap_listeners.
103 * @param s The global server_rec
104 * @param p The config pool
105 * @param num_buckets The total number of listener buckets.
107 AP_DECLARE(apr_status_t) ap_duplicate_listeners(server_rec *s, apr_pool_t *p, int num_buckets);
111 * Loop through the global ap_listen_rec list and close each of the sockets.
113 AP_DECLARE_NONSTD(void) ap_close_listeners(void);
118 AP_DECLARE_NONSTD(int) ap_close_selected_listeners(ap_slave_t *);
120 /* Although these functions are exported from libmain, they are not really
121 * public functions. These functions are actually called while parsing the
122 * config file, when one of the LISTEN_COMMANDS directives is read. These
123 * should not ever be called by external modules. ALL MPMs should include
124 * LISTEN_COMMANDS in their command_rec table so that these functions are
127 AP_DECLARE_NONSTD(const char *) ap_set_listenbacklog(cmd_parms *cmd, void *dummy, const char *arg);
128 AP_DECLARE_NONSTD(const char *) ap_set_listener(cmd_parms *cmd, void *dummy,
129 int argc, char *const argv[]);
130 AP_DECLARE_NONSTD(const char *) ap_set_send_buffer_size(cmd_parms *cmd, void *dummy,
132 AP_DECLARE_NONSTD(const char *) ap_set_receive_buffer_size(cmd_parms *cmd,
136 #define LISTEN_COMMANDS \
137 AP_INIT_TAKE1("ListenBacklog", ap_set_listenbacklog, NULL, RSRC_CONF, \
138 "Maximum length of the queue of pending connections, as used by listen(2)"), \
139 AP_INIT_TAKE_ARGV("Listen", ap_set_listener, NULL, RSRC_CONF, \
140 "A port number or a numeric IP address and a port number, and an optional protocol"), \
141 AP_INIT_TAKE1("SendBufferSize", ap_set_send_buffer_size, NULL, RSRC_CONF, \
142 "Send buffer size in bytes"), \
143 AP_INIT_TAKE1("ReceiveBufferSize", ap_set_receive_buffer_size, NULL, \
144 RSRC_CONF, "Receive buffer size in bytes")