ap_listen.h revision 1075efe007e7af339bde09cbb175d4f4d676eeb5
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb/* Licensed to the Apache Software Foundation (ASF) under one or more
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * contributor license agreements. See the NOTICE file distributed with
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * this work for additional information regarding copyright ownership.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * The ASF licenses this file to You under the Apache License, Version 2.0
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * (the "License"); you may not use this file except in compliance with
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * the License. You may obtain a copy of the License at
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * Unless required by applicable law or agreed to in writing, software
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * distributed under the License is distributed on an "AS IS" BASIS,
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * See the License for the specific language governing permissions and
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * limitations under the License.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * @brief Apache Listeners Library
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * @defgroup APACHE_CORE_LISTEN Apache Listeners Library
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * @ingroup APACHE_CORE
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbextern "C" {
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbtypedef apr_status_t (*accept_function)(void **csd, ap_listen_rec *lr, apr_pool_t *ptrans);
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * @brief Apache's listeners record.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * These are used in the Multi-Processing Modules
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * to setup all of the sockets for the MPM to listen to and accept on.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * The next listener in the list
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * The actual socket
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * The sockaddr the socket should bind to
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * The accept function for this socket
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * Is this socket currently active
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * The default protocol for this listening socket.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb const char* protocol;
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * The global list of ap_listen_rec structures
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * Setup all of the defaults for the listener list
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * Loop through the global ap_listen_rec list and create all of the required
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * sockets. This executes the listen and bind on the sockets.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * @param s The global server_rec
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * @return The number of open sockets.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * Loop through the global ap_listen_rec list and close each of the sockets.
a2a0abd88b19e042a3eb2a9fa1702c25ad51303dwrowe/* Although these functions are exported from libmain, they are not really
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * public functions. These functions are actually called while parsing the
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * config file, when one of the LISTEN_COMMANDS directives is read. These
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * should not ever be called by external modules. ALL MPMs should include
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * LISTEN_COMMANDS in their command_rec table so that these functions are
b45c1c292ff1fa635004ae81fa691f8cb3cdda85rbbAP_DECLARE_NONSTD(const char *) ap_set_listenbacklog(cmd_parms *cmd, void *dummy, const char *arg);
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbAP_DECLARE_NONSTD(const char *) ap_set_listener(cmd_parms *cmd, void *dummy,
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbAP_DECLARE_NONSTD(const char *) ap_set_send_buffer_size(cmd_parms *cmd, void *dummy,
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb const char *arg);
a2a0abd88b19e042a3eb2a9fa1702c25ad51303dwroweAP_DECLARE_NONSTD(const char *) ap_set_receive_buffer_size(cmd_parms *cmd,
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb const char *arg);
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbAP_INIT_TAKE1("ListenBacklog", ap_set_listenbacklog, NULL, RSRC_CONF, \
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb "Maximum length of the queue of pending connections, as used by listen(2)"), \
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbAP_INIT_TAKE_ARGV("Listen", ap_set_listener, NULL, RSRC_CONF, \
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb "A port number or a numeric IP address and a port number, and an optional protocol"), \
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbAP_INIT_TAKE1("SendBufferSize", ap_set_send_buffer_size, NULL, RSRC_CONF, \
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb "Send buffer size in bytes"), \
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbAP_INIT_TAKE1("ReceiveBufferSize", ap_set_receive_buffer_size, NULL, \