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 
47 struct ap_listen_rec {
67  int active;
71  const char* protocol;
72 
74 
79 
80 };
81 
89 
91 
96 
104 
119  ap_listen_rec ***buckets,
120  int *num_buckets);
121 
126 
132 
137 
138 /* Although these functions are exported from libmain, they are not really
139  * public functions. These functions are actually called while parsing the
140  * config file, when one of the LISTEN_COMMANDS directives is read. These
141  * should not ever be called by external modules. ALL MPMs should include
142  * LISTEN_COMMANDS in their command_rec table so that these functions are
143  * called.
144  */
145 AP_DECLARE_NONSTD(const char *) ap_set_listenbacklog(cmd_parms *cmd, void *dummy, const char *arg);
146 AP_DECLARE_NONSTD(const char *) ap_set_listencbratio(cmd_parms *cmd, void *dummy, const char *arg);
147 AP_DECLARE_NONSTD(const char *) ap_set_listener(cmd_parms *cmd, void *dummy,
148  int argc, char *const argv[]);
149 AP_DECLARE_NONSTD(const char *) ap_set_send_buffer_size(cmd_parms *cmd, void *dummy,
150  const char *arg);
152  void *dummy,
153  const char *arg);
154 
156  void *dummy,
157  int flag);
158 
159 #define LISTEN_COMMANDS \
160 AP_INIT_TAKE1("ListenBacklog", ap_set_listenbacklog, NULL, RSRC_CONF, \
161  "Maximum length of the queue of pending connections, as used by listen(2)"), \
162 AP_INIT_TAKE1("ListenCoresBucketsRatio", ap_set_listencbratio, NULL, RSRC_CONF, \
163  "Ratio between the number of CPU cores (online) and the number of listeners buckets"), \
164 AP_INIT_TAKE_ARGV("Listen", ap_set_listener, NULL, RSRC_CONF, \
165  "A port number or a numeric IP address and a port number, and an optional protocol"), \
166 AP_INIT_TAKE1("SendBufferSize", ap_set_send_buffer_size, NULL, RSRC_CONF, \
167  "Send buffer size in bytes"), \
168 AP_INIT_TAKE1("ReceiveBufferSize", ap_set_receive_buffer_size, NULL, \
169  RSRC_CONF, "Receive buffer size in bytes"), \
170 AP_INIT_FLAG("AcceptErrorsNonFatal", ap_set_accept_errors_nonfatal, NULL, \
171  RSRC_CONF, "Some accept() errors are not fatal to the process")
172 #ifdef __cplusplus
173 }
174 #endif
175 
176 #endif
177 
const char * ap_set_listener(cmd_parms *cmd, void *dummy, int argc, char *const argv[])
int active
Definition: ap_listen.h:67
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:71
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:55
accept_function accept_func
Definition: ap_listen.h:63
#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:47
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:1313
const char * ap_set_receive_buffer_size(cmd_parms *cmd, void *dummy, const char *arg)
apr_sockaddr_t * bind_addr
Definition: ap_listen.h:59
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
ap_slave_t * slave
Definition: ap_listen.h:73
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)
int use_specific_errors
Definition: ap_listen.h:78
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:51