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"
33
typedef struct ap_listen_rec ap_listen_rec;
34
typedef apr_status_t (*accept_function)(void **csd, ap_listen_rec *lr, apr_pool_t *ptrans);
37
* @brief Apache's listeners record.
39
* These are used in the Multi-Processing Modules
40
* to setup all of the sockets for the MPM to listen to and accept on.
42
struct ap_listen_rec {
44
* The next listener in the list
52
* The sockaddr the socket should bind to
54
apr_sockaddr_t *bind_addr;
56
* The accept function for this socket
58
accept_function accept_func;
60
* Is this socket currently active
64
* The default protocol for this listening socket.
70
* The global list of ap_listen_rec structures
72
AP_DECLARE_DATA extern ap_listen_rec *ap_listeners;
75
* Setup all of the defaults for the listener list
77
AP_DECLARE(void) ap_listen_pre_config(void);
80
* Loop through the global ap_listen_rec list and create all of the required
81
* sockets. This executes the listen and bind on the sockets.
82
* @param s The global server_rec
83
* @return The number of open sockets.
85
AP_DECLARE(int) ap_setup_listeners(server_rec *s);
88
* Loop through the global ap_listen_rec list and close each of the sockets.
90
AP_DECLARE_NONSTD(void) ap_close_listeners(void);
92
/* Although these functions are exported from libmain, they are not really
93
* public functions. These functions are actually called while parsing the
94
* config file, when one of the LISTEN_COMMANDS directives is read. These
95
* should not ever be called by external modules. ALL MPMs should include
96
* LISTEN_COMMANDS in their command_rec table so that these functions are
99
AP_DECLARE_NONSTD(const char *) ap_set_listenbacklog(cmd_parms *cmd, void *dummy, const char *arg);
100
AP_DECLARE_NONSTD(const char *) ap_set_listener(cmd_parms *cmd, void *dummy,
101
int argc, char *const argv[]);
102
AP_DECLARE_NONSTD(const char *) ap_set_send_buffer_size(cmd_parms *cmd, void *dummy,
104
AP_DECLARE_NONSTD(const char *) ap_set_receive_buffer_size(cmd_parms *cmd,
108
#define LISTEN_COMMANDS \
109
AP_INIT_TAKE1("ListenBacklog", ap_set_listenbacklog, NULL, RSRC_CONF, \
110
"Maximum length of the queue of pending connections, as used by listen(2)"), \
111
AP_INIT_TAKE_ARGV("Listen", ap_set_listener, NULL, RSRC_CONF, \
112
"A port number or a numeric IP address and a port number, and an optional protocol"), \
113
AP_INIT_TAKE1("SendBufferSize", ap_set_send_buffer_size, NULL, RSRC_CONF, \
114
"Send buffer size in bytes"), \
115
AP_INIT_TAKE1("ReceiveBufferSize", ap_set_receive_buffer_size, NULL, \
116
RSRC_CONF, "Receive buffer size in bytes")