]> granicus.if.org Git - apache/blob - include/ap_listen.h
Create wrapper API for apr_random;
[apache] / include / ap_listen.h
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
17 /**
18  * @file  ap_listen.h
19  * @brief Apache Listeners Library
20  *
21  * @defgroup APACHE_CORE_LISTEN Apache Listeners Library
22  * @ingroup  APACHE_CORE
23  * @{
24  */
25
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;
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);
40
41 /**
42  * @brief Apache's listeners record.  
43  *
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.
46  */
47 struct ap_listen_rec {
48     /**
49      * The next listener in the list
50      */
51     ap_listen_rec *next;
52     /**
53      * The actual socket 
54      */
55     apr_socket_t *sd;
56     /**
57      * The sockaddr the socket should bind to
58      */
59     apr_sockaddr_t *bind_addr;
60     /**
61      * The accept function for this socket
62      */
63     accept_function accept_func;
64     /**
65      * Is this socket currently active 
66      */
67     int active;
68     /**
69      * The default protocol for this listening socket.
70      */
71     const char* protocol;
72
73     ap_slave_t *slave;
74 };
75
76 /**
77  * The global list of ap_listen_rec structures
78  */
79 AP_DECLARE_DATA extern ap_listen_rec *ap_listeners;
80
81 /**
82  * Setup all of the defaults for the listener list
83  */
84 AP_DECLARE(void) ap_listen_pre_config(void);
85
86 /**
87  * Loop through the global ap_listen_rec list and create all of the required
88  * sockets.  This executes the listen and bind on the sockets.
89  * @param s The global server_rec
90  * @return The number of open sockets.
91  */ 
92 AP_DECLARE(int) ap_setup_listeners(server_rec *s);
93
94 /**
95  * Loop through the global ap_listen_rec list and close each of the sockets.
96  */
97 AP_DECLARE_NONSTD(void) ap_close_listeners(void);
98
99 /**
100  * FIXMEDOC
101  */
102 AP_DECLARE_NONSTD(int) ap_close_selected_listeners(ap_slave_t *);
103
104 /* Although these functions are exported from libmain, they are not really
105  * public functions.  These functions are actually called while parsing the
106  * config file, when one of the LISTEN_COMMANDS directives is read.  These
107  * should not ever be called by external modules.  ALL MPMs should include
108  * LISTEN_COMMANDS in their command_rec table so that these functions are
109  * called.
110  */ 
111 AP_DECLARE_NONSTD(const char *) ap_set_listenbacklog(cmd_parms *cmd, void *dummy, const char *arg);
112 AP_DECLARE_NONSTD(const char *) ap_set_listener(cmd_parms *cmd, void *dummy, 
113                                                 int argc, char *const argv[]);
114 AP_DECLARE_NONSTD(const char *) ap_set_send_buffer_size(cmd_parms *cmd, void *dummy,
115                                     const char *arg);
116 AP_DECLARE_NONSTD(const char *) ap_set_receive_buffer_size(cmd_parms *cmd,
117                                                            void *dummy,
118                                                            const char *arg);
119
120 #define LISTEN_COMMANDS \
121 AP_INIT_TAKE1("ListenBacklog", ap_set_listenbacklog, NULL, RSRC_CONF, \
122   "Maximum length of the queue of pending connections, as used by listen(2)"), \
123 AP_INIT_TAKE_ARGV("Listen", ap_set_listener, NULL, RSRC_CONF, \
124   "A port number or a numeric IP address and a port number, and an optional protocol"), \
125 AP_INIT_TAKE1("SendBufferSize", ap_set_send_buffer_size, NULL, RSRC_CONF, \
126   "Send buffer size in bytes"), \
127 AP_INIT_TAKE1("ReceiveBufferSize", ap_set_receive_buffer_size, NULL, \
128               RSRC_CONF, "Receive buffer size in bytes")
129
130 #ifdef __cplusplus
131 }
132 #endif
133
134 #endif
135 /** @} */