Apache2
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
ap_listen.h
Go to the documentation of this file.
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
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16 
26 #ifndef AP_LISTEN_H
27 #define AP_LISTEN_H
28 
29 #include "apr_network_io.h"
30 #include "httpd.h"
31 #include "http_config.h"
32 
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36 
37 typedef struct ap_slave_t ap_slave_t;
39 typedef apr_status_t (*accept_function)(void **csd, ap_listen_rec *lr, apr_pool_t *ptrans);
40 
41 /* Flags for ap_listen_rec.flags */
42 #define AP_LISTEN_SPECIFIC_ERRORS (0x0001)
43 #define AP_LISTEN_FREEBIND (0x0002)
44 #define AP_LISTEN_REUSEPORT (0x0004)
45 #define AP_LISTEN_V6ONLY (0x0008)
46 
53 struct ap_listen_rec {
73  int active;
77  const char* protocol;
78 
80 
85 };
86 
94 
96 
100 AP_DECLARE(void) ap_listen_pre_config(void);
101 
109 
124  ap_listen_rec ***buckets,
125  int *num_buckets);
126 
131 
137 
142 
143 /* Although these functions are exported from libmain, they are not really
144  * public functions. These functions are actually called while parsing the
145  * config file, when one of the LISTEN_COMMANDS directives is read. These
146  * should not ever be called by external modules. ALL MPMs should include
147  * LISTEN_COMMANDS in their command_rec table so that these functions are
148  * called.
149  */
150 AP_DECLARE_NONSTD(const char *) ap_set_listenbacklog(cmd_parms *cmd, void *dummy, const char *arg);
151 AP_DECLARE_NONSTD(const char *) ap_set_listencbratio(cmd_parms *cmd, void *dummy, const char *arg);
152 AP_DECLARE_NONSTD(const char *) ap_set_listener(cmd_parms *cmd, void *dummy,
153  int argc, char *const argv[]);
154 AP_DECLARE_NONSTD(const char *) ap_set_send_buffer_size(cmd_parms *cmd, void *dummy,
155  const char *arg);
157  void *dummy,
158  const char *arg);
159 
161  void *dummy,
162  int flag);
163 
164 #define LISTEN_COMMANDS \
165 AP_INIT_TAKE1("ListenBacklog", ap_set_listenbacklog, NULL, RSRC_CONF, \
166  "Maximum length of the queue of pending connections, as used by listen(2)"), \
167 AP_INIT_TAKE1("ListenCoresBucketsRatio", ap_set_listencbratio, NULL, RSRC_CONF, \
168  "Ratio between the number of CPU cores (online) and the number of listeners buckets"), \
169 AP_INIT_TAKE_ARGV("Listen", ap_set_listener, NULL, RSRC_CONF, \
170  "A port number or a numeric IP address and a port number, and an optional protocol"), \
171 AP_INIT_TAKE1("SendBufferSize", ap_set_send_buffer_size, NULL, RSRC_CONF, \
172  "Send buffer size in bytes"), \
173 AP_INIT_TAKE1("ReceiveBufferSize", ap_set_receive_buffer_size, NULL, \
174  RSRC_CONF, "Receive buffer size in bytes"), \
175 AP_INIT_FLAG("AcceptErrorsNonFatal", ap_set_accept_errors_nonfatal, NULL, \
176  RSRC_CONF, "Some accept() errors are not fatal to the process")
177 #ifdef __cplusplus
178 }
179 #endif
180 
181 #endif
182 
const char * ap_set_listener(cmd_parms *cmd, void *dummy, int argc, char *const argv[])
int active
Definition: ap_listen.h:73
APR Network library.
Apache Configuration.
apr_status_t ap_duplicate_listeners(apr_pool_t *p, server_rec *s, ap_listen_rec ***buckets, int *num_buckets)
const char * protocol
Definition: ap_listen.h:77
apr_status_t(* accept_function)(void **csd, ap_listen_rec *lr, apr_pool_t *ptrans)
Definition: ap_listen.h:39
#define AP_DECLARE(x)
Definition: macros.h:1
apr_socket_t * sd
Definition: ap_listen.h:61
accept_function accept_func
Definition: ap_listen.h:69
#define AP_DECLARE_NONSTD(x)
Definition: macros.h:2
AP_DECLARE_DATA int ap_accept_errors_nonfatal
void ap_close_listeners_ex(ap_listen_rec *listeners)
Apache's listeners record.
Definition: ap_listen.h:53
const char * ap_set_send_buffer_size(cmd_parms *cmd, void *dummy, const char *arg)
void ap_listen_pre_config(void)
const char * ap_set_listenbacklog(cmd_parms *cmd, void *dummy, const char *arg)
Definition: http_config.h:295
HTTP Daemon routines.
const char * ap_set_listencbratio(cmd_parms *cmd, void *dummy, const char *arg)
A structure to store information for each virtual server.
Definition: httpd.h:1370
const char * ap_set_receive_buffer_size(cmd_parms *cmd, void *dummy, const char *arg)
apr_sockaddr_t * bind_addr
Definition: ap_listen.h:65
Definition: apr_arch_networkio.h:37
const char * ap_set_accept_errors_nonfatal(cmd_parms *cmd, void *dummy, int flag)
AP_DECLARE_DATA ap_listen_rec * ap_listeners
apr_uint32_t flags
Definition: ap_listen.h:84
ap_slave_t * slave
Definition: ap_listen.h:79
unsigned int apr_uint32_t
Definition: apr.h:347
int ap_accept_error_is_nonfatal(apr_status_t rv)
void ap_close_listeners(void)
int ap_close_selected_listeners(ap_slave_t *)
apr_pool_t * p
#define AP_DECLARE_DATA
Definition: macros.h:15
AP_DECLARE_DATA int ap_have_so_reuseport
struct apr_pool_t apr_pool_t
Definition: apr_pools.h:60
int apr_status_t
Definition: apr_errno.h:44
int ap_setup_listeners(server_rec *s)
AP_DECLARE_DATA int ap_num_listen_buckets
struct ap_slave_t ap_slave_t
Definition: ap_listen.h:37
Definition: apr_network_io.h:266
ap_listen_rec * next
Definition: ap_listen.h:57