"Fossies" - the Fresh Open Source Software Archive

Member "apr-1.7.0/include/apr_network_io.h" (12 Dec 2017, 36873 Bytes) of package /linux/www/apr-1.7.0.tar.bz2:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) C and C++ source code syntax highlighting (style: standard) with prefixed line numbers and code folding option. Alternatively you can here view or download the uninterpreted source code file. For more information about "apr_network_io.h" see the Fossies "Dox" file reference documentation and the latest Fossies "Diffs" side-by-side code changes report: 1.6.5_vs_1.7.0.

    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 #ifndef APR_NETWORK_IO_H
   18 #define APR_NETWORK_IO_H
   19 /**
   20  * @file apr_network_io.h
   21  * @brief APR Network library
   22  */
   23 
   24 #include "apr.h"
   25 #include "apr_pools.h"
   26 #include "apr_file_io.h"
   27 #include "apr_errno.h"
   28 #include "apr_inherit.h" 
   29 #include "apr_perms_set.h"
   30 
   31 #if APR_HAVE_NETINET_IN_H
   32 #include <netinet/in.h>
   33 #endif
   34 #if APR_HAVE_SYS_UN_H
   35 #include <sys/un.h>
   36 #endif
   37 
   38 #ifdef __cplusplus
   39 extern "C" {
   40 #endif /* __cplusplus */
   41 
   42 /**
   43  * @defgroup apr_network_io Network Routines
   44  * @ingroup APR 
   45  * @{
   46  */
   47 
   48 #ifndef APR_MAX_SECS_TO_LINGER
   49 /** Maximum seconds to linger */
   50 #define APR_MAX_SECS_TO_LINGER 30
   51 #endif
   52 
   53 #ifndef APRMAXHOSTLEN
   54 /** Maximum hostname length */
   55 #define APRMAXHOSTLEN 256
   56 #endif
   57 
   58 #ifndef APR_ANYADDR
   59 /** Default 'any' address */
   60 #define APR_ANYADDR "0.0.0.0"
   61 #endif
   62 
   63 /**
   64  * @defgroup apr_sockopt Socket option definitions
   65  * @{
   66  */
   67 #define APR_SO_LINGER        1    /**< Linger */
   68 #define APR_SO_KEEPALIVE     2    /**< Keepalive */
   69 #define APR_SO_DEBUG         4    /**< Debug */
   70 #define APR_SO_NONBLOCK      8    /**< Non-blocking IO */
   71 #define APR_SO_REUSEADDR     16   /**< Reuse addresses */
   72 #define APR_SO_SNDBUF        64   /**< Send buffer */
   73 #define APR_SO_RCVBUF        128  /**< Receive buffer */
   74 #define APR_SO_DISCONNECTED  256  /**< Disconnected */
   75 #define APR_TCP_NODELAY      512  /**< For SCTP sockets, this is mapped
   76                                    * to STCP_NODELAY internally.
   77                                    */
   78 #define APR_TCP_NOPUSH       1024 /**< No push */
   79 #define APR_RESET_NODELAY    2048 /**< This flag is ONLY set internally
   80                                    * when we set APR_TCP_NOPUSH with
   81                                    * APR_TCP_NODELAY set to tell us that
   82                                    * APR_TCP_NODELAY should be turned on
   83                                    * again when NOPUSH is turned off
   84                                    */
   85 #define APR_INCOMPLETE_READ 4096  /**< Set on non-blocking sockets
   86                    * (timeout != 0) on which the
   87                    * previous read() did not fill a buffer
   88                    * completely.  the next apr_socket_recv() 
   89                                    * will first call select()/poll() rather than
   90                    * going straight into read().  (Can also
   91                    * be set by an application to force a
   92                    * select()/poll() call before the next
   93                    * read, in cases where the app expects
   94                    * that an immediate read would fail.)
   95                    */
   96 #define APR_INCOMPLETE_WRITE 8192 /**< like APR_INCOMPLETE_READ, but for write
   97                                    * @see APR_INCOMPLETE_READ
   98                                    */
   99 #define APR_IPV6_V6ONLY     16384 /**< Don't accept IPv4 connections on an
  100                                    * IPv6 listening socket.
  101                                    */
  102 #define APR_TCP_DEFER_ACCEPT 32768 /**< Delay accepting of new connections 
  103                                     * until data is available.
  104                                     * @see apr_socket_accept_filter
  105                                     */
  106 #define APR_SO_BROADCAST     65536 /**< Allow broadcast
  107                                     */
  108 #define APR_SO_FREEBIND     131072 /**< Allow binding to addresses not owned
  109                                     * by any interface
  110                                     */
  111 
  112 /** @} */
  113 
  114 /** Define what type of socket shutdown should occur. */
  115 typedef enum {
  116     APR_SHUTDOWN_READ,          /**< no longer allow read request */
  117     APR_SHUTDOWN_WRITE,         /**< no longer allow write requests */
  118     APR_SHUTDOWN_READWRITE      /**< no longer allow read or write requests */
  119 } apr_shutdown_how_e;
  120 
  121 #define APR_IPV4_ADDR_OK  0x01  /**< @see apr_sockaddr_info_get() */
  122 #define APR_IPV6_ADDR_OK  0x02  /**< @see apr_sockaddr_info_get() */
  123 
  124 #if (!APR_HAVE_IN_ADDR)
  125 /**
  126  * We need to make sure we always have an in_addr type, so APR will just
  127  * define it ourselves, if the platform doesn't provide it.
  128  */
  129 struct in_addr {
  130     apr_uint32_t  s_addr; /**< storage to hold the IP# */
  131 };
  132 #endif
  133 
  134 /** @def APR_INADDR_NONE
  135  * Not all platforms have a real INADDR_NONE.  This macro replaces
  136  * INADDR_NONE on all platforms.
  137  */
  138 #ifdef INADDR_NONE
  139 #define APR_INADDR_NONE INADDR_NONE
  140 #else
  141 #define APR_INADDR_NONE ((unsigned int) 0xffffffff)
  142 #endif
  143 
  144 /**
  145  * @def APR_INET
  146  * Not all platforms have these defined, so we'll define them here
  147  * The default values come from FreeBSD 4.1.1
  148  */
  149 #define APR_INET     AF_INET
  150 /** @def APR_UNSPEC
  151  * Let the system decide which address family to use
  152  */
  153 #ifdef AF_UNSPEC
  154 #define APR_UNSPEC   AF_UNSPEC
  155 #else
  156 #define APR_UNSPEC   0
  157 #endif
  158 #if APR_HAVE_IPV6
  159 /** @def APR_INET6
  160 * IPv6 Address Family. Not all platforms may have this defined.
  161 */
  162 
  163 #define APR_INET6    AF_INET6
  164 #endif
  165 
  166 #if APR_HAVE_SOCKADDR_UN
  167 #if defined (AF_UNIX)
  168 #define APR_UNIX    AF_UNIX
  169 #elif defined(AF_LOCAL)
  170 #define APR_UNIX    AF_LOCAL
  171 #else
  172 #error "Neither AF_UNIX nor AF_LOCAL is defined"
  173 #endif
  174 #else /* !APR_HAVE_SOCKADDR_UN */
  175 #if defined (AF_UNIX)
  176 #define APR_UNIX    AF_UNIX
  177 #elif defined(AF_LOCAL)
  178 #define APR_UNIX    AF_LOCAL
  179 #else
  180 /* TODO: Use a smarter way to detect unique APR_UNIX value */
  181 #define APR_UNIX    1234
  182 #endif
  183 #endif
  184 
  185 /**
  186  * @defgroup IP_Proto IP Protocol Definitions for use when creating sockets
  187  * @{
  188  */
  189 #define APR_PROTO_TCP       6   /**< TCP  */
  190 #define APR_PROTO_UDP      17   /**< UDP  */
  191 #define APR_PROTO_SCTP    132   /**< SCTP */
  192 /** @} */
  193 
  194 /**
  195  * Enum used to denote either the local and remote endpoint of a
  196  * connection.
  197  */
  198 typedef enum {
  199     APR_LOCAL,   /**< Socket information for local end of connection */
  200     APR_REMOTE   /**< Socket information for remote end of connection */
  201 } apr_interface_e;
  202 
  203 /**
  204  * The specific declaration of inet_addr's ... some platforms fall back
  205  * inet_network (this is not good, but necessary)
  206  */
  207 
  208 #if APR_HAVE_INET_ADDR
  209 #define apr_inet_addr    inet_addr
  210 #elif APR_HAVE_INET_NETWORK        /* only DGUX, as far as I know */
  211 /**
  212  * @warning
  213  * not generally safe... inet_network() and inet_addr() perform
  214  * different functions */
  215 #define apr_inet_addr    inet_network
  216 #endif
  217 
  218 /** A structure to represent sockets */
  219 typedef struct apr_socket_t     apr_socket_t;
  220 /**
  221  * A structure to encapsulate headers and trailers for apr_socket_sendfile
  222  */
  223 typedef struct apr_hdtr_t       apr_hdtr_t;
  224 /** A structure to represent in_addr */
  225 typedef struct in_addr          apr_in_addr_t;
  226 /** A structure to represent an IP subnet */
  227 typedef struct apr_ipsubnet_t apr_ipsubnet_t;
  228 
  229 /** @remark use apr_uint16_t just in case some system has a short that isn't 16 bits... */
  230 typedef apr_uint16_t            apr_port_t;
  231 
  232 /** @remark It's defined here as I think it should all be platform safe...
  233  * @see apr_sockaddr_t
  234  */
  235 typedef struct apr_sockaddr_t apr_sockaddr_t;
  236 /**
  237  * APRs socket address type, used to ensure protocol independence
  238  */
  239 struct apr_sockaddr_t {
  240     /** The pool to use... */
  241     apr_pool_t *pool;
  242     /** The hostname */
  243     char *hostname;
  244     /** Either a string of the port number or the service name for the port */
  245     char *servname;
  246     /** The numeric port */
  247     apr_port_t port;
  248     /** The family */
  249     apr_int32_t family;
  250     /** How big is the sockaddr we're using? */
  251     apr_socklen_t salen;
  252     /** How big is the ip address structure we're using? */
  253     int ipaddr_len;
  254     /** How big should the address buffer be?  16 for v4 or 46 for v6
  255      *  used in inet_ntop... */
  256     int addr_str_len;
  257     /** This points to the IP address structure within the appropriate
  258      *  sockaddr structure.  */
  259     void *ipaddr_ptr;
  260     /** If multiple addresses were found by apr_sockaddr_info_get(), this 
  261      *  points to a representation of the next address. */
  262     apr_sockaddr_t *next;
  263     /** Union of either IPv4 or IPv6 sockaddr. */
  264     union {
  265         /** IPv4 sockaddr structure */
  266         struct sockaddr_in sin;
  267 #if APR_HAVE_IPV6
  268         /** IPv6 sockaddr structure */
  269         struct sockaddr_in6 sin6;
  270 #endif
  271 #if APR_HAVE_SA_STORAGE
  272         /** Placeholder to ensure that the size of this union is not
  273          * dependent on whether APR_HAVE_IPV6 is defined. */
  274         struct sockaddr_storage sas;
  275 #endif
  276 #if APR_HAVE_SOCKADDR_UN
  277         /** Unix domain socket sockaddr structure */
  278         struct sockaddr_un unx;
  279 #endif
  280     } sa;
  281 };
  282 
  283 #if APR_HAS_SENDFILE
  284 /** 
  285  * Support reusing the socket on platforms which support it (from disconnect,
  286  * specifically Win32.
  287  * @remark Optional flag passed into apr_socket_sendfile() 
  288  */
  289 #define APR_SENDFILE_DISCONNECT_SOCKET      1
  290 #endif
  291 
  292 /** A structure to encapsulate headers and trailers for apr_socket_sendfile */
  293 struct apr_hdtr_t {
  294     /** An iovec to store the headers sent before the file. */
  295     struct iovec* headers;
  296     /** number of headers in the iovec */
  297     int numheaders;
  298     /** An iovec to store the trailers sent after the file. */
  299     struct iovec* trailers;
  300     /** number of trailers in the iovec */
  301     int numtrailers;
  302 };
  303 
  304 /* function definitions */
  305 
  306 /**
  307  * Create a socket.
  308  * @param new_sock The new socket that has been set up.
  309  * @param family The address family of the socket (e.g., APR_INET).
  310  * @param type The type of the socket (e.g., SOCK_STREAM).
  311  * @param protocol The protocol of the socket (e.g., APR_PROTO_TCP).
  312  * @param cont The pool for the apr_socket_t and associated storage.
  313  * @note The pool will be used by various functions that operate on the
  314  *       socket. The caller must ensure that it is not used by other threads
  315  *       at the same time.
  316  */
  317 APR_DECLARE(apr_status_t) apr_socket_create(apr_socket_t **new_sock, 
  318                                             int family, int type,
  319                                             int protocol,
  320                                             apr_pool_t *cont);
  321 
  322 /**
  323  * Shutdown either reading, writing, or both sides of a socket.
  324  * @param thesocket The socket to close 
  325  * @param how How to shutdown the socket.  One of:
  326  * <PRE>
  327  *            APR_SHUTDOWN_READ         no longer allow read requests
  328  *            APR_SHUTDOWN_WRITE        no longer allow write requests
  329  *            APR_SHUTDOWN_READWRITE    no longer allow read or write requests 
  330  * </PRE>
  331  * @see apr_shutdown_how_e
  332  * @remark This does not actually close the socket descriptor, it just
  333  *      controls which calls are still valid on the socket.
  334  */
  335 APR_DECLARE(apr_status_t) apr_socket_shutdown(apr_socket_t *thesocket,
  336                                               apr_shutdown_how_e how);
  337 
  338 /**
  339  * Close a socket.
  340  * @param thesocket The socket to close 
  341  */
  342 APR_DECLARE(apr_status_t) apr_socket_close(apr_socket_t *thesocket);
  343 
  344 /**
  345  * Bind the socket to its associated port
  346  * @param sock The socket to bind 
  347  * @param sa The socket address to bind to
  348  * @remark This may be where we will find out if there is any other process
  349  *      using the selected port.
  350  */
  351 APR_DECLARE(apr_status_t) apr_socket_bind(apr_socket_t *sock, 
  352                                           apr_sockaddr_t *sa);
  353 
  354 /**
  355  * Listen to a bound socket for connections.
  356  * @param sock The socket to listen on 
  357  * @param backlog The number of outstanding connections allowed in the sockets
  358  *                listen queue.  If this value is less than zero, the listen
  359  *                queue size is set to zero.  
  360  */
  361 APR_DECLARE(apr_status_t) apr_socket_listen(apr_socket_t *sock, 
  362                                             apr_int32_t backlog);
  363 
  364 /**
  365  * Accept a new connection request
  366  * @param new_sock A copy of the socket that is connected to the socket that
  367  *                 made the connection request.  This is the socket which should
  368  *                 be used for all future communication.
  369  * @param sock The socket we are listening on.
  370  * @param connection_pool The pool for the new socket.
  371  * @note The pool will be used by various functions that operate on the
  372  *       socket. The caller must ensure that it is not used by other threads
  373  *       at the same time.
  374  */
  375 APR_DECLARE(apr_status_t) apr_socket_accept(apr_socket_t **new_sock, 
  376                                             apr_socket_t *sock,
  377                                             apr_pool_t *connection_pool);
  378 
  379 /**
  380  * Issue a connection request to a socket either on the same machine 
  381  * or a different one.
  382  * @param sock The socket we wish to use for our side of the connection 
  383  * @param sa The address of the machine we wish to connect to.
  384  */
  385 APR_DECLARE(apr_status_t) apr_socket_connect(apr_socket_t *sock,
  386                                              apr_sockaddr_t *sa);
  387 
  388 /**
  389  * Determine whether the receive part of the socket has been closed by
  390  * the peer (such that a subsequent call to apr_socket_read would
  391  * return APR_EOF), if the socket's receive buffer is empty.  This
  392  * function does not block waiting for I/O.
  393  *
  394  * @param sock The socket to check
  395  * @param atreadeof If APR_SUCCESS is returned, *atreadeof is set to
  396  *                  non-zero if a subsequent read would return APR_EOF
  397  * @return an error is returned if it was not possible to determine the
  398  *         status, in which case *atreadeof is not changed.
  399  */
  400 APR_DECLARE(apr_status_t) apr_socket_atreadeof(apr_socket_t *sock,
  401                                                int *atreadeof);
  402 
  403 /**
  404  * Create apr_sockaddr_t from hostname, address family, and port.
  405  * @param sa The new apr_sockaddr_t.
  406  * @param hostname The hostname or numeric address string to resolve/parse, or
  407  *               NULL to build an address that corresponds to 0.0.0.0 or ::
  408  *               or in case of APR_UNIX family it is absolute socket filename.
  409  * @param family The address family to use, or APR_UNSPEC if the system should 
  410  *               decide.
  411  * @param port The port number.
  412  * @param flags Special processing flags:
  413  * <PRE>
  414  *       APR_IPV4_ADDR_OK          first query for IPv4 addresses; only look
  415  *                                 for IPv6 addresses if the first query failed;
  416  *                                 only valid if family is APR_UNSPEC and hostname
  417  *                                 isn't NULL; mutually exclusive with
  418  *                                 APR_IPV6_ADDR_OK
  419  *       APR_IPV6_ADDR_OK          first query for IPv6 addresses; only look
  420  *                                 for IPv4 addresses if the first query failed;
  421  *                                 only valid if family is APR_UNSPEC and hostname
  422  *                                 isn't NULL and APR_HAVE_IPV6; mutually exclusive
  423  *                                 with APR_IPV4_ADDR_OK
  424  * </PRE>
  425  * @param p The pool for the apr_sockaddr_t and associated storage.
  426  */
  427 APR_DECLARE(apr_status_t) apr_sockaddr_info_get(apr_sockaddr_t **sa,
  428                                           const char *hostname,
  429                                           apr_int32_t family,
  430                                           apr_port_t port,
  431                                           apr_int32_t flags,
  432                                           apr_pool_t *p);
  433 
  434 /**
  435  * Copy apr_sockaddr_t src to dst on pool p.
  436  * @param dst The destination apr_sockaddr_t.
  437  * @param src The source apr_sockaddr_t.
  438  * @param p The pool for the apr_sockaddr_t and associated storage.
  439  */
  440 APR_DECLARE(apr_status_t) apr_sockaddr_info_copy(apr_sockaddr_t **dst,
  441                                                  const apr_sockaddr_t *src,
  442                                                  apr_pool_t *p);
  443 
  444 /* Set the zone of an IPv6 link-local address object.
  445  * @param sa Socket address object
  446  * @param zone_id Zone ID (textual "eth0" or numeric "3").
  447  * @return Returns APR_EBADIP for non-IPv6 socket or an IPv6 address
  448  * which isn't link-local.
  449  */
  450 APR_DECLARE(apr_status_t) apr_sockaddr_zone_set(apr_sockaddr_t *sa,
  451                                                 const char *zone_id);
  452 
  453 
  454 /* Retrieve the zone of an IPv6 link-local address object.
  455  * @param sa Socket address object
  456  * @param name If non-NULL, set to the textual representation of the zone id
  457  * @param id If non-NULL, set to the integer zone id
  458  * @param p Pool from which *name is allocated if used.
  459  * @return Returns APR_EBADIP for non-IPv6 socket or socket without any zone id
  460  * set, or other error if the interface could not be mapped to a name.
  461  * @remark Both name and id may be NULL, neither are modified if
  462  * non-NULL in error cases.
  463  */
  464 APR_DECLARE(apr_status_t) apr_sockaddr_zone_get(const apr_sockaddr_t *sa,
  465                                                 const char **name,
  466                                                 apr_uint32_t *id,
  467                                                 apr_pool_t *p);                                                
  468     
  469 /**
  470  * Look up the host name from an apr_sockaddr_t.
  471  * @param hostname The hostname.
  472  * @param sa The apr_sockaddr_t.
  473  * @param flags Special processing flags.
  474  * @remark Results can vary significantly between platforms
  475  * when processing wildcard socket addresses.
  476  */
  477 APR_DECLARE(apr_status_t) apr_getnameinfo(char **hostname,
  478                                           apr_sockaddr_t *sa,
  479                                           apr_int32_t flags);
  480 
  481 /**
  482  * Parse hostname/IP address with scope id and port.
  483  *
  484  * Any of the following strings are accepted:
  485  *   8080                  (just the port number)
  486  *   www.apache.org        (just the hostname)
  487  *   www.apache.org:8080   (hostname and port number)
  488  *   [fe80::1]:80          (IPv6 numeric address string only)
  489  *   [fe80::1%eth0]        (IPv6 numeric address string and scope id)
  490  *
  491  * Invalid strings:
  492  *                         (empty string)
  493  *   [abc]                 (not valid IPv6 numeric address string)
  494  *   abc:65536             (invalid port number)
  495  *
  496  * @param addr The new buffer containing just the hostname.  On output, *addr 
  497  *             will be NULL if no hostname/IP address was specfied.
  498  * @param scope_id The new buffer containing just the scope id.  On output, 
  499  *                 *scope_id will be NULL if no scope id was specified.
  500  * @param port The port number.  On output, *port will be 0 if no port was 
  501  *             specified.
  502  *             ### FIXME: 0 is a legal port (per RFC 1700). this should
  503  *             ### return something besides zero if the port is missing.
  504  * @param str The input string to be parsed.
  505  * @param p The pool from which *addr and *scope_id are allocated.
  506  * @remark If scope id shouldn't be allowed, check for scope_id != NULL in 
  507  *         addition to checking the return code.  If addr/hostname should be 
  508  *         required, check for addr == NULL in addition to checking the 
  509  *         return code.
  510  */
  511 APR_DECLARE(apr_status_t) apr_parse_addr_port(char **addr,
  512                                               char **scope_id,
  513                                               apr_port_t *port,
  514                                               const char *str,
  515                                               apr_pool_t *p);
  516 
  517 /**
  518  * Get name of the current machine
  519  * @param buf A buffer to store the hostname in.
  520  * @param len The maximum length of the hostname that can be stored in the
  521  *            buffer provided.  The suggested length is APRMAXHOSTLEN + 1.
  522  * @param cont The pool to use.
  523  * @remark If the buffer was not large enough, an error will be returned.
  524  */
  525 APR_DECLARE(apr_status_t) apr_gethostname(char *buf, int len, apr_pool_t *cont);
  526 
  527 /**
  528  * Return the data associated with the current socket
  529  * @param data The user data associated with the socket.
  530  * @param key The key to associate with the user data.
  531  * @param sock The currently open socket.
  532  */
  533 APR_DECLARE(apr_status_t) apr_socket_data_get(void **data, const char *key,
  534                                               apr_socket_t *sock);
  535 
  536 /**
  537  * Set the data associated with the current socket.
  538  * @param sock The currently open socket.
  539  * @param data The user data to associate with the socket.
  540  * @param key The key to associate with the data.
  541  * @param cleanup The cleanup to call when the socket is destroyed.
  542  */
  543 APR_DECLARE(apr_status_t) apr_socket_data_set(apr_socket_t *sock, void *data,
  544                                               const char *key,
  545                                               apr_status_t (*cleanup)(void*));
  546 
  547 /**
  548  * Send data over a network.
  549  * @param sock The socket to send the data over.
  550  * @param buf The buffer which contains the data to be sent. 
  551  * @param len On entry, the number of bytes to send; on exit, the number
  552  *            of bytes sent.
  553  * @remark
  554  * <PRE>
  555  * This functions acts like a blocking write by default.  To change 
  556  * this behavior, use apr_socket_timeout_set() or the APR_SO_NONBLOCK
  557  * socket option.
  558  *
  559  * It is possible for both bytes to be sent and an error to be returned.
  560  *
  561  * APR_EINTR is never returned.
  562  * </PRE>
  563  */
  564 APR_DECLARE(apr_status_t) apr_socket_send(apr_socket_t *sock, const char *buf, 
  565                                           apr_size_t *len);
  566 
  567 /**
  568  * Send multiple buffers over a network.
  569  * @param sock The socket to send the data over.
  570  * @param vec The array of iovec structs containing the data to send 
  571  * @param nvec The number of iovec structs in the array
  572  * @param len Receives the number of bytes actually written
  573  * @remark
  574  * <PRE>
  575  * This functions acts like a blocking write by default.  To change 
  576  * this behavior, use apr_socket_timeout_set() or the APR_SO_NONBLOCK
  577  * socket option.
  578  * The number of bytes actually sent is stored in argument 4.
  579  *
  580  * It is possible for both bytes to be sent and an error to be returned.
  581  *
  582  * APR_EINTR is never returned.
  583  * </PRE>
  584  */
  585 APR_DECLARE(apr_status_t) apr_socket_sendv(apr_socket_t *sock, 
  586                                            const struct iovec *vec,
  587                                            apr_int32_t nvec, apr_size_t *len);
  588 
  589 /**
  590  * @param sock The socket to send from
  591  * @param where The apr_sockaddr_t describing where to send the data
  592  * @param flags The flags to use
  593  * @param buf  The data to send
  594  * @param len  The length of the data to send
  595  */
  596 APR_DECLARE(apr_status_t) apr_socket_sendto(apr_socket_t *sock, 
  597                                             apr_sockaddr_t *where,
  598                                             apr_int32_t flags, const char *buf, 
  599                                             apr_size_t *len);
  600 
  601 /**
  602  * Read data from a socket.  On success, the address of the peer from
  603  * which the data was sent is copied into the @a from parameter, and the
  604  * @a len parameter is updated to give the number of bytes written to
  605  * @a buf.
  606  *
  607  * @param from Updated with the address from which the data was received
  608  * @param sock The socket to use
  609  * @param flags The flags to use
  610  * @param buf  The buffer to use
  611  * @param len  The length of the available buffer
  612  */
  613 
  614 APR_DECLARE(apr_status_t) apr_socket_recvfrom(apr_sockaddr_t *from, 
  615                                               apr_socket_t *sock,
  616                                               apr_int32_t flags, char *buf, 
  617                                               apr_size_t *len);
  618  
  619 #if APR_HAS_SENDFILE || defined(DOXYGEN)
  620 
  621 /**
  622  * Send a file from an open file descriptor to a socket, along with 
  623  * optional headers and trailers
  624  * @param sock The socket to which we're writing
  625  * @param file The open file from which to read
  626  * @param hdtr A structure containing the headers and trailers to send
  627  * @param offset Offset into the file where we should begin writing
  628  * @param len (input)  - Number of bytes to send from the file 
  629  *            (output) - Number of bytes actually sent, 
  630  *                       including headers, file, and trailers
  631  * @param flags APR flags that are mapped to OS specific flags
  632  * @remark This functions acts like a blocking write by default.  To change 
  633  *         this behavior, use apr_socket_timeout_set() or the
  634  *         APR_SO_NONBLOCK socket option.
  635  * The number of bytes actually sent is stored in the len parameter.
  636  * The offset parameter is passed by reference for no reason; its
  637  * value will never be modified by the apr_socket_sendfile() function.
  638  */
  639 APR_DECLARE(apr_status_t) apr_socket_sendfile(apr_socket_t *sock, 
  640                                               apr_file_t *file,
  641                                               apr_hdtr_t *hdtr,
  642                                               apr_off_t *offset,
  643                                               apr_size_t *len,
  644                                               apr_int32_t flags);
  645 
  646 #endif /* APR_HAS_SENDFILE */
  647 
  648 /**
  649  * Read data from a network.
  650  * @param sock The socket to read the data from.
  651  * @param buf The buffer to store the data in. 
  652  * @param len On entry, the number of bytes to receive; on exit, the number
  653  *            of bytes received.
  654  * @remark
  655  * <PRE>
  656  * This functions acts like a blocking read by default.  To change 
  657  * this behavior, use apr_socket_timeout_set() or the APR_SO_NONBLOCK
  658  * socket option.
  659  * The number of bytes actually received is stored in argument 3.
  660  *
  661  * It is possible for both bytes to be received and an APR_EOF or
  662  * other error to be returned.
  663  *
  664  * APR_EINTR is never returned.
  665  * </PRE>
  666  */
  667 APR_DECLARE(apr_status_t) apr_socket_recv(apr_socket_t *sock, 
  668                                    char *buf, apr_size_t *len);
  669 
  670 /**
  671  * Setup socket options for the specified socket
  672  * @param sock The socket to set up.
  673  * @param opt The option we would like to configure.  One of:
  674  * <PRE>
  675  *            APR_SO_DEBUG      --  turn on debugging information 
  676  *            APR_SO_KEEPALIVE  --  keep connections active
  677  *            APR_SO_LINGER     --  lingers on close if data is present
  678  *            APR_SO_NONBLOCK   --  Turns blocking on/off for socket
  679  *                                  When this option is enabled, use
  680  *                                  the APR_STATUS_IS_EAGAIN() macro to
  681  *                                  see if a send or receive function
  682  *                                  could not transfer data without
  683  *                                  blocking.
  684  *            APR_SO_REUSEADDR  --  The rules used in validating addresses
  685  *                                  supplied to bind should allow reuse
  686  *                                  of local addresses.
  687  *            APR_SO_SNDBUF     --  Set the SendBufferSize
  688  *            APR_SO_RCVBUF     --  Set the ReceiveBufferSize
  689  *            APR_SO_FREEBIND   --  Allow binding to non-local IP address.
  690  * </PRE>
  691  * @param on Value for the option.
  692  */
  693 APR_DECLARE(apr_status_t) apr_socket_opt_set(apr_socket_t *sock,
  694                                              apr_int32_t opt, apr_int32_t on);
  695 
  696 /**
  697  * Setup socket timeout for the specified socket
  698  * @param sock The socket to set up.
  699  * @param t Value for the timeout.
  700  * <PRE>
  701  *   t > 0  -- read and write calls return APR_TIMEUP if specified time
  702  *             elapsess with no data read or written
  703  *   t == 0 -- read and write calls never block
  704  *   t < 0  -- read and write calls block
  705  * </PRE>
  706  */
  707 APR_DECLARE(apr_status_t) apr_socket_timeout_set(apr_socket_t *sock,
  708                                                  apr_interval_time_t t);
  709 
  710 /**
  711  * Query socket options for the specified socket
  712  * @param sock The socket to query
  713  * @param opt The option we would like to query.  One of:
  714  * <PRE>
  715  *            APR_SO_DEBUG      --  turn on debugging information 
  716  *            APR_SO_KEEPALIVE  --  keep connections active
  717  *            APR_SO_LINGER     --  lingers on close if data is present
  718  *            APR_SO_NONBLOCK   --  Turns blocking on/off for socket
  719  *            APR_SO_REUSEADDR  --  The rules used in validating addresses
  720  *                                  supplied to bind should allow reuse
  721  *                                  of local addresses.
  722  *            APR_SO_SNDBUF     --  Set the SendBufferSize
  723  *            APR_SO_RCVBUF     --  Set the ReceiveBufferSize
  724  *            APR_SO_DISCONNECTED -- Query the disconnected state of the socket.
  725  *                                  (Currently only used on Windows)
  726  * </PRE>
  727  * @param on Socket option returned on the call.
  728  */
  729 APR_DECLARE(apr_status_t) apr_socket_opt_get(apr_socket_t *sock, 
  730                                              apr_int32_t opt, apr_int32_t *on);
  731 
  732 /**
  733  * Query socket timeout for the specified socket
  734  * @param sock The socket to query
  735  * @param t Socket timeout returned from the query.
  736  */
  737 APR_DECLARE(apr_status_t) apr_socket_timeout_get(apr_socket_t *sock, 
  738                                                  apr_interval_time_t *t);
  739 
  740 /**
  741  * Query the specified socket if at the OOB/Urgent data mark
  742  * @param sock The socket to query
  743  * @param atmark Is set to true if socket is at the OOB/urgent mark,
  744  *               otherwise is set to false.
  745  */
  746 APR_DECLARE(apr_status_t) apr_socket_atmark(apr_socket_t *sock, 
  747                                             int *atmark);
  748 
  749 /**
  750  * Return an address associated with a socket; either the address to
  751  * which the socket is bound locally or the address of the peer
  752  * to which the socket is connected.
  753  * @param sa The returned apr_sockaddr_t.
  754  * @param which Whether to retrieve the local or remote address
  755  * @param sock The socket to use
  756  */
  757 APR_DECLARE(apr_status_t) apr_socket_addr_get(apr_sockaddr_t **sa,
  758                                               apr_interface_e which,
  759                                               apr_socket_t *sock);
  760  
  761 /**
  762  * Return the IP address (in numeric address string format) in
  763  * an APR socket address.  APR will allocate storage for the IP address 
  764  * string from the pool of the apr_sockaddr_t.
  765  * @param addr The IP address.
  766  * @param sockaddr The socket address to reference.
  767  */
  768 APR_DECLARE(apr_status_t) apr_sockaddr_ip_get(char **addr, 
  769                                               apr_sockaddr_t *sockaddr);
  770 
  771 /**
  772  * Write the IP address (in numeric address string format) of the APR
  773  * socket address @a sockaddr into the buffer @a buf (of size @a buflen).
  774  * @param sockaddr The socket address to reference.
  775  */
  776 APR_DECLARE(apr_status_t) apr_sockaddr_ip_getbuf(char *buf, apr_size_t buflen,
  777                                                  apr_sockaddr_t *sockaddr);
  778 
  779 /**
  780  * See if the IP addresses in two APR socket addresses are
  781  * equivalent.  Appropriate logic is present for comparing
  782  * IPv4-mapped IPv6 addresses with IPv4 addresses.
  783  *
  784  * @param addr1 One of the APR socket addresses.
  785  * @param addr2 The other APR socket address.
  786  * @remark The return value will be non-zero if the addresses
  787  * are equivalent.
  788  */
  789 APR_DECLARE(int) apr_sockaddr_equal(const apr_sockaddr_t *addr1,
  790                                     const apr_sockaddr_t *addr2);
  791 
  792 /**
  793  * See if the IP address in an APR socket address refers to the wildcard
  794  * address for the protocol family (e.g., INADDR_ANY for IPv4).
  795  *
  796  * @param addr The APR socket address to examine.
  797  * @remark The return value will be non-zero if the address is
  798  * initialized and is the wildcard address.
  799  */
  800 APR_DECLARE(int) apr_sockaddr_is_wildcard(const apr_sockaddr_t *addr);
  801 
  802 /**
  803 * Return the type of the socket.
  804 * @param sock The socket to query.
  805 * @param type The returned type (e.g., SOCK_STREAM).
  806 */
  807 APR_DECLARE(apr_status_t) apr_socket_type_get(apr_socket_t *sock,
  808                                               int *type);
  809  
  810 /**
  811  * Given an apr_sockaddr_t and a service name, set the port for the service
  812  * @param sockaddr The apr_sockaddr_t that will have its port set
  813  * @param servname The name of the service you wish to use
  814  */
  815 APR_DECLARE(apr_status_t) apr_getservbyname(apr_sockaddr_t *sockaddr, 
  816                                             const char *servname);
  817 /**
  818  * Build an ip-subnet representation from an IP address and optional netmask or
  819  * number-of-bits.
  820  * @param ipsub The new ip-subnet representation
  821  * @param ipstr The input IP address string
  822  * @param mask_or_numbits The input netmask or number-of-bits string, or NULL
  823  * @param p The pool to allocate from
  824  */
  825 APR_DECLARE(apr_status_t) apr_ipsubnet_create(apr_ipsubnet_t **ipsub, 
  826                                               const char *ipstr, 
  827                                               const char *mask_or_numbits, 
  828                                               apr_pool_t *p);
  829 
  830 /**
  831  * Test the IP address in an apr_sockaddr_t against a pre-built ip-subnet
  832  * representation.
  833  * @param ipsub The ip-subnet representation
  834  * @param sa The socket address to test
  835  * @return non-zero if the socket address is within the subnet, 0 otherwise
  836  */
  837 APR_DECLARE(int) apr_ipsubnet_test(apr_ipsubnet_t *ipsub, apr_sockaddr_t *sa);
  838 
  839 #if APR_HAS_SO_ACCEPTFILTER || defined(DOXYGEN)
  840 /**
  841  * Set an OS level accept filter.
  842  * @param sock The socket to put the accept filter on.
  843  * @param name The accept filter
  844  * @param args Any extra args to the accept filter.  Passing NULL here removes
  845  *             the accept filter. 
  846  * @bug name and args should have been declared as const char *, as they are in
  847  * APR 2.0
  848  */
  849 apr_status_t apr_socket_accept_filter(apr_socket_t *sock, char *name,
  850                                       char *args);
  851 #endif
  852 
  853 /**
  854  * Return the protocol of the socket.
  855  * @param sock The socket to query.
  856  * @param protocol The returned protocol (e.g., APR_PROTO_TCP).
  857  */
  858 APR_DECLARE(apr_status_t) apr_socket_protocol_get(apr_socket_t *sock,
  859                                                   int *protocol);
  860 
  861 /**
  862  * Get the pool used by the socket.
  863  */
  864 APR_POOL_DECLARE_ACCESSOR(socket);
  865 
  866 /**
  867  * Set a socket to be inherited by child processes.
  868  */
  869 APR_DECLARE_INHERIT_SET(socket);
  870 
  871 /**
  872  * Unset a socket from being inherited by child processes.
  873  */
  874 APR_DECLARE_INHERIT_UNSET(socket);
  875 
  876 /**
  877  * Set socket permissions.
  878  */
  879 APR_PERMS_SET_IMPLEMENT(socket);
  880 
  881 /**
  882  * @defgroup apr_mcast IP Multicast
  883  * @{
  884  */
  885 
  886 /**
  887  * Join a Multicast Group
  888  * @param sock The socket to join a multicast group
  889  * @param join The address of the multicast group to join
  890  * @param iface Address of the interface to use.  If NULL is passed, the 
  891  *              default multicast interface will be used. (OS Dependent)
  892  * @param source Source Address to accept transmissions from (non-NULL 
  893  *               implies Source-Specific Multicast)
  894  */
  895 APR_DECLARE(apr_status_t) apr_mcast_join(apr_socket_t *sock,
  896                                          apr_sockaddr_t *join,
  897                                          apr_sockaddr_t *iface,
  898                                          apr_sockaddr_t *source);
  899 
  900 /**
  901  * Leave a Multicast Group.  All arguments must be the same as
  902  * apr_mcast_join.
  903  * @param sock The socket to leave a multicast group
  904  * @param addr The address of the multicast group to leave
  905  * @param iface Address of the interface to use.  If NULL is passed, the 
  906  *              default multicast interface will be used. (OS Dependent)
  907  * @param source Source Address to accept transmissions from (non-NULL 
  908  *               implies Source-Specific Multicast)
  909  */
  910 APR_DECLARE(apr_status_t) apr_mcast_leave(apr_socket_t *sock,
  911                                           apr_sockaddr_t *addr,
  912                                           apr_sockaddr_t *iface,
  913                                           apr_sockaddr_t *source);
  914 
  915 /**
  916  * Set the Multicast Time to Live (ttl) for a multicast transmission.
  917  * @param sock The socket to set the multicast ttl
  918  * @param ttl Time to live to Assign. 0-255, default=1
  919  * @remark If the TTL is 0, packets will only be seen by sockets on 
  920  * the local machine, and only when multicast loopback is enabled.
  921  */
  922 APR_DECLARE(apr_status_t) apr_mcast_hops(apr_socket_t *sock,
  923                                          apr_byte_t ttl);
  924 
  925 /**
  926  * Toggle IP Multicast Loopback
  927  * @param sock The socket to set multicast loopback
  928  * @param opt 0=disable, 1=enable
  929  */
  930 APR_DECLARE(apr_status_t) apr_mcast_loopback(apr_socket_t *sock,
  931                                              apr_byte_t opt);
  932 
  933 
  934 /**
  935  * Set the Interface to be used for outgoing Multicast Transmissions.
  936  * @param sock The socket to set the multicast interface on
  937  * @param iface Address of the interface to use for Multicast
  938  */
  939 APR_DECLARE(apr_status_t) apr_mcast_interface(apr_socket_t *sock,
  940                                               apr_sockaddr_t *iface);
  941 
  942 /** @} */
  943 
  944 /** @} */
  945 
  946 #ifdef __cplusplus
  947 }
  948 #endif
  949 
  950 #endif  /* ! APR_NETWORK_IO_H */
  951