Apache Portable Runtime

apr_network_io.h

Go to the documentation of this file.
00001 /* Licensed to the Apache Software Foundation (ASF) under one or more
00002  * contributor license agreements.  See the NOTICE file distributed with
00003  * this work for additional information regarding copyright ownership.
00004  * The ASF licenses this file to You under the Apache License, Version 2.0
00005  * (the "License"); you may not use this file except in compliance with
00006  * the License.  You may obtain a copy of the License at
00007  *
00008  *     http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 
00017 #ifndef APR_NETWORK_IO_H
00018 #define APR_NETWORK_IO_H
00019 /**
00020  * @file apr_network_io.h
00021  * @brief APR Network library
00022  */
00023 
00024 #include "apr.h"
00025 #include "apr_pools.h"
00026 #include "apr_file_io.h"
00027 #include "apr_errno.h"
00028 #include "apr_inherit.h" 
00029 #include "apr_perms_set.h"
00030 
00031 #if APR_HAVE_NETINET_IN_H
00032 #include <netinet/in.h>
00033 #endif
00034 #if APR_HAVE_SYS_UN_H
00035 #include <sys/un.h>
00036 #endif
00037 
00038 #ifdef __cplusplus
00039 extern "C" {
00040 #endif /* __cplusplus */
00041 
00042 /**
00043  * @defgroup apr_network_io Network Routines
00044  * @ingroup APR 
00045  * @{
00046  */
00047 
00048 #ifndef APR_MAX_SECS_TO_LINGER
00049 /** Maximum seconds to linger */
00050 #define APR_MAX_SECS_TO_LINGER 30
00051 #endif
00052 
00053 #ifndef APRMAXHOSTLEN
00054 /** Maximum hostname length */
00055 #define APRMAXHOSTLEN 256
00056 #endif
00057 
00058 #ifndef APR_ANYADDR
00059 /** Default 'any' address */
00060 #define APR_ANYADDR "0.0.0.0"
00061 #endif
00062 
00063 /**
00064  * @defgroup apr_sockopt Socket option definitions
00065  * @{
00066  */
00067 #define APR_SO_LINGER        1    /**< Linger */
00068 #define APR_SO_KEEPALIVE     2    /**< Keepalive */
00069 #define APR_SO_DEBUG         4    /**< Debug */
00070 #define APR_SO_NONBLOCK      8    /**< Non-blocking IO */
00071 #define APR_SO_REUSEADDR     16   /**< Reuse addresses */
00072 #define APR_SO_SNDBUF        64   /**< Send buffer */
00073 #define APR_SO_RCVBUF        128  /**< Receive buffer */
00074 #define APR_SO_DISCONNECTED  256  /**< Disconnected */
00075 #define APR_TCP_NODELAY      512  /**< For SCTP sockets, this is mapped
00076                                    * to STCP_NODELAY internally.
00077                                    */
00078 #define APR_TCP_NOPUSH       1024 /**< No push */
00079 #define APR_RESET_NODELAY    2048 /**< This flag is ONLY set internally
00080                                    * when we set APR_TCP_NOPUSH with
00081                                    * APR_TCP_NODELAY set to tell us that
00082                                    * APR_TCP_NODELAY should be turned on
00083                                    * again when NOPUSH is turned off
00084                                    */
00085 #define APR_INCOMPLETE_READ 4096  /**< Set on non-blocking sockets
00086                                    * (timeout != 0) on which the
00087                                    * previous read() did not fill a buffer
00088                                    * completely.  the next apr_socket_recv() 
00089                                    * will first call select()/poll() rather than
00090                                    * going straight into read().  (Can also
00091                                    * be set by an application to force a
00092                                    * select()/poll() call before the next
00093                                    * read, in cases where the app expects
00094                                    * that an immediate read would fail.)
00095                                    */
00096 #define APR_INCOMPLETE_WRITE 8192 /**< like APR_INCOMPLETE_READ, but for write
00097                                    * @see APR_INCOMPLETE_READ
00098                                    */
00099 #define APR_IPV6_V6ONLY     16384 /**< Don't accept IPv4 connections on an
00100                                    * IPv6 listening socket.
00101                                    */
00102 #define APR_TCP_DEFER_ACCEPT 32768 /**< Delay accepting of new connections 
00103                                     * until data is available.
00104                                     * @see apr_socket_accept_filter
00105                                     */
00106 #define APR_SO_BROADCAST     65536 /**< Allow broadcast
00107                                     */
00108 #define APR_SO_FREEBIND     131072 /**< Allow binding to addresses not owned
00109                                     * by any interface
00110                                     */
00111 
00112 /** @} */
00113 
00114 /** Define what type of socket shutdown should occur. */
00115 typedef enum {
00116     APR_SHUTDOWN_READ,          /**< no longer allow read request */
00117     APR_SHUTDOWN_WRITE,         /**< no longer allow write requests */
00118     APR_SHUTDOWN_READWRITE      /**< no longer allow read or write requests */
00119 } apr_shutdown_how_e;
00120 
00121 #define APR_IPV4_ADDR_OK  0x01  /**< @see apr_sockaddr_info_get() */
00122 #define APR_IPV6_ADDR_OK  0x02  /**< @see apr_sockaddr_info_get() */
00123 
00124 #if (!APR_HAVE_IN_ADDR)
00125 /**
00126  * We need to make sure we always have an in_addr type, so APR will just
00127  * define it ourselves, if the platform doesn't provide it.
00128  */
00129 struct in_addr {
00130     apr_uint32_t  s_addr; /**< storage to hold the IP# */
00131 };
00132 #endif
00133 
00134 /** @def APR_INADDR_NONE
00135  * Not all platforms have a real INADDR_NONE.  This macro replaces
00136  * INADDR_NONE on all platforms.
00137  */
00138 #ifdef INADDR_NONE
00139 #define APR_INADDR_NONE INADDR_NONE
00140 #else
00141 #define APR_INADDR_NONE ((unsigned int) 0xffffffff)
00142 #endif
00143 
00144 /**
00145  * @def APR_INET
00146  * Not all platforms have these defined, so we'll define them here
00147  * The default values come from FreeBSD 4.1.1
00148  */
00149 #define APR_INET     AF_INET
00150 /** @def APR_UNSPEC
00151  * Let the system decide which address family to use
00152  */
00153 #ifdef AF_UNSPEC
00154 #define APR_UNSPEC   AF_UNSPEC
00155 #else
00156 #define APR_UNSPEC   0
00157 #endif
00158 #if APR_HAVE_IPV6
00159 /** @def APR_INET6
00160 * IPv6 Address Family. Not all platforms may have this defined.
00161 */
00162 
00163 #define APR_INET6    AF_INET6
00164 #endif
00165 
00166 #if APR_HAVE_SOCKADDR_UN
00167 #if defined (AF_UNIX)
00168 #define APR_UNIX    AF_UNIX
00169 #elif defined(AF_LOCAL)
00170 #define APR_UNIX    AF_LOCAL
00171 #else
00172 #error "Neither AF_UNIX nor AF_LOCAL is defined"
00173 #endif
00174 #else /* !APR_HAVE_SOCKADDR_UN */
00175 #if defined (AF_UNIX)
00176 #define APR_UNIX    AF_UNIX
00177 #elif defined(AF_LOCAL)
00178 #define APR_UNIX    AF_LOCAL
00179 #else
00180 /* TODO: Use a smarter way to detect unique APR_UNIX value */
00181 #define APR_UNIX    1234
00182 #endif
00183 #endif
00184 
00185 /**
00186  * @defgroup IP_Proto IP Protocol Definitions for use when creating sockets
00187  * @{
00188  */
00189 #define APR_PROTO_TCP       6   /**< TCP  */
00190 #define APR_PROTO_UDP      17   /**< UDP  */
00191 #define APR_PROTO_SCTP    132   /**< SCTP */
00192 /** @} */
00193 
00194 /**
00195  * Enum used to denote either the local and remote endpoint of a
00196  * connection.
00197  */
00198 typedef enum {
00199     APR_LOCAL,   /**< Socket information for local end of connection */
00200     APR_REMOTE   /**< Socket information for remote end of connection */
00201 } apr_interface_e;
00202 
00203 /**
00204  * The specific declaration of inet_addr's ... some platforms fall back
00205  * inet_network (this is not good, but necessary)
00206  */
00207 
00208 #if APR_HAVE_INET_ADDR
00209 #define apr_inet_addr    inet_addr
00210 #elif APR_HAVE_INET_NETWORK        /* only DGUX, as far as I know */
00211 /**
00212  * @warning
00213  * not generally safe... inet_network() and inet_addr() perform
00214  * different functions */
00215 #define apr_inet_addr    inet_network
00216 #endif
00217 
00218 /** A structure to represent sockets */
00219 typedef struct apr_socket_t     apr_socket_t;
00220 /**
00221  * A structure to encapsulate headers and trailers for apr_socket_sendfile
00222  */
00223 typedef struct apr_hdtr_t       apr_hdtr_t;
00224 /** A structure to represent in_addr */
00225 typedef struct in_addr          apr_in_addr_t;
00226 /** A structure to represent an IP subnet */
00227 typedef struct apr_ipsubnet_t apr_ipsubnet_t;
00228 
00229 /** @remark use apr_uint16_t just in case some system has a short that isn't 16 bits... */
00230 typedef apr_uint16_t            apr_port_t;
00231 
00232 /** @remark It's defined here as I think it should all be platform safe...
00233  * @see apr_sockaddr_t
00234  */
00235 typedef struct apr_sockaddr_t apr_sockaddr_t;
00236 /**
00237  * APRs socket address type, used to ensure protocol independence
00238  */
00239 struct apr_sockaddr_t {
00240     /** The pool to use... */
00241     apr_pool_t *pool;
00242     /** The hostname */
00243     char *hostname;
00244     /** Either a string of the port number or the service name for the port */
00245     char *servname;
00246     /** The numeric port */
00247     apr_port_t port;
00248     /** The family */
00249     apr_int32_t family;
00250     /** How big is the sockaddr we're using? */
00251     apr_socklen_t salen;
00252     /** How big is the ip address structure we're using? */
00253     int ipaddr_len;
00254     /** How big should the address buffer be?  16 for v4 or 46 for v6
00255      *  used in inet_ntop... */
00256     int addr_str_len;
00257     /** This points to the IP address structure within the appropriate
00258      *  sockaddr structure.  */
00259     void *ipaddr_ptr;
00260     /** If multiple addresses were found by apr_sockaddr_info_get(), this 
00261      *  points to a representation of the next address. */
00262     apr_sockaddr_t *next;
00263     /** Union of either IPv4 or IPv6 sockaddr. */
00264     union {
00265         /** IPv4 sockaddr structure */
00266         struct sockaddr_in sin;
00267 #if APR_HAVE_IPV6
00268         /** IPv6 sockaddr structure */
00269         struct sockaddr_in6 sin6;
00270 #endif
00271 #if APR_HAVE_SA_STORAGE
00272         /** Placeholder to ensure that the size of this union is not
00273          * dependent on whether APR_HAVE_IPV6 is defined. */
00274         struct sockaddr_storage sas;
00275 #endif
00276 #if APR_HAVE_SOCKADDR_UN
00277         /** Unix domain socket sockaddr structure */
00278         struct sockaddr_un unx;
00279 #endif
00280     } sa;
00281 };
00282 
00283 #if APR_HAS_SENDFILE
00284 /** 
00285  * Support reusing the socket on platforms which support it (from disconnect,
00286  * specifically Win32.
00287  * @remark Optional flag passed into apr_socket_sendfile() 
00288  */
00289 #define APR_SENDFILE_DISCONNECT_SOCKET      1
00290 #endif
00291 
00292 /** A structure to encapsulate headers and trailers for apr_socket_sendfile */
00293 struct apr_hdtr_t {
00294     /** An iovec to store the headers sent before the file. */
00295     struct iovec* headers;
00296     /** number of headers in the iovec */
00297     int numheaders;
00298     /** An iovec to store the trailers sent after the file. */
00299     struct iovec* trailers;
00300     /** number of trailers in the iovec */
00301     int numtrailers;
00302 };
00303 
00304 /* function definitions */
00305 
00306 /**
00307  * Create a socket.
00308  * @param new_sock The new socket that has been set up.
00309  * @param family The address family of the socket (e.g., APR_INET).
00310  * @param type The type of the socket (e.g., SOCK_STREAM).
00311  * @param protocol The protocol of the socket (e.g., APR_PROTO_TCP).
00312  * @param cont The pool for the apr_socket_t and associated storage.
00313  * @note The pool will be used by various functions that operate on the
00314  *       socket. The caller must ensure that it is not used by other threads
00315  *       at the same time.
00316  */
00317 APR_DECLARE(apr_status_t) apr_socket_create(apr_socket_t **new_sock, 
00318                                             int family, int type,
00319                                             int protocol,
00320                                             apr_pool_t *cont);
00321 
00322 /**
00323  * Shutdown either reading, writing, or both sides of a socket.
00324  * @param thesocket The socket to close 
00325  * @param how How to shutdown the socket.  One of:
00326  * <PRE>
00327  *            APR_SHUTDOWN_READ         no longer allow read requests
00328  *            APR_SHUTDOWN_WRITE        no longer allow write requests
00329  *            APR_SHUTDOWN_READWRITE    no longer allow read or write requests 
00330  * </PRE>
00331  * @see apr_shutdown_how_e
00332  * @remark This does not actually close the socket descriptor, it just
00333  *      controls which calls are still valid on the socket.
00334  */
00335 APR_DECLARE(apr_status_t) apr_socket_shutdown(apr_socket_t *thesocket,
00336                                               apr_shutdown_how_e how);
00337 
00338 /**
00339  * Close a socket.
00340  * @param thesocket The socket to close 
00341  */
00342 APR_DECLARE(apr_status_t) apr_socket_close(apr_socket_t *thesocket);
00343 
00344 /**
00345  * Bind the socket to its associated port
00346  * @param sock The socket to bind 
00347  * @param sa The socket address to bind to
00348  * @remark This may be where we will find out if there is any other process
00349  *      using the selected port.
00350  */
00351 APR_DECLARE(apr_status_t) apr_socket_bind(apr_socket_t *sock, 
00352                                           apr_sockaddr_t *sa);
00353 
00354 /**
00355  * Listen to a bound socket for connections.
00356  * @param sock The socket to listen on 
00357  * @param backlog The number of outstanding connections allowed in the sockets
00358  *                listen queue.  If this value is less than zero, the listen
00359  *                queue size is set to zero.  
00360  */
00361 APR_DECLARE(apr_status_t) apr_socket_listen(apr_socket_t *sock, 
00362                                             apr_int32_t backlog);
00363 
00364 /**
00365  * Accept a new connection request
00366  * @param new_sock A copy of the socket that is connected to the socket that
00367  *                 made the connection request.  This is the socket which should
00368  *                 be used for all future communication.
00369  * @param sock The socket we are listening on.
00370  * @param connection_pool The pool for the new socket.
00371  * @note The pool will be used by various functions that operate on the
00372  *       socket. The caller must ensure that it is not used by other threads
00373  *       at the same time.
00374  */
00375 APR_DECLARE(apr_status_t) apr_socket_accept(apr_socket_t **new_sock, 
00376                                             apr_socket_t *sock,
00377                                             apr_pool_t *connection_pool);
00378 
00379 /**
00380  * Issue a connection request to a socket either on the same machine 
00381  * or a different one.
00382  * @param sock The socket we wish to use for our side of the connection 
00383  * @param sa The address of the machine we wish to connect to.
00384  */
00385 APR_DECLARE(apr_status_t) apr_socket_connect(apr_socket_t *sock,
00386                                              apr_sockaddr_t *sa);
00387 
00388 /**
00389  * Determine whether the receive part of the socket has been closed by
00390  * the peer (such that a subsequent call to apr_socket_read would
00391  * return APR_EOF), if the socket's receive buffer is empty.  This
00392  * function does not block waiting for I/O.
00393  *
00394  * @param sock The socket to check
00395  * @param atreadeof If APR_SUCCESS is returned, *atreadeof is set to
00396  *                  non-zero if a subsequent read would return APR_EOF
00397  * @return an error is returned if it was not possible to determine the
00398  *         status, in which case *atreadeof is not changed.
00399  */
00400 APR_DECLARE(apr_status_t) apr_socket_atreadeof(apr_socket_t *sock,
00401                                                int *atreadeof);
00402 
00403 /**
00404  * Create apr_sockaddr_t from hostname, address family, and port.
00405  * @param sa The new apr_sockaddr_t.
00406  * @param hostname The hostname or numeric address string to resolve/parse, or
00407  *               NULL to build an address that corresponds to 0.0.0.0 or ::
00408  *               or in case of APR_UNIX family it is absolute socket filename.
00409  * @param family The address family to use, or APR_UNSPEC if the system should 
00410  *               decide.
00411  * @param port The port number.
00412  * @param flags Special processing flags:
00413  * <PRE>
00414  *       APR_IPV4_ADDR_OK          first query for IPv4 addresses; only look
00415  *                                 for IPv6 addresses if the first query failed;
00416  *                                 only valid if family is APR_UNSPEC and hostname
00417  *                                 isn't NULL; mutually exclusive with
00418  *                                 APR_IPV6_ADDR_OK
00419  *       APR_IPV6_ADDR_OK          first query for IPv6 addresses; only look
00420  *                                 for IPv4 addresses if the first query failed;
00421  *                                 only valid if family is APR_UNSPEC and hostname
00422  *                                 isn't NULL and APR_HAVE_IPV6; mutually exclusive
00423  *                                 with APR_IPV4_ADDR_OK
00424  * </PRE>
00425  * @param p The pool for the apr_sockaddr_t and associated storage.
00426  */
00427 APR_DECLARE(apr_status_t) apr_sockaddr_info_get(apr_sockaddr_t **sa,
00428                                           const char *hostname,
00429                                           apr_int32_t family,
00430                                           apr_port_t port,
00431                                           apr_int32_t flags,
00432                                           apr_pool_t *p);
00433 
00434 /**
00435  * Copy apr_sockaddr_t src to dst on pool p.
00436  * @param dst The destination apr_sockaddr_t.
00437  * @param src The source apr_sockaddr_t.
00438  * @param p The pool for the apr_sockaddr_t and associated storage.
00439  */
00440 APR_DECLARE(apr_status_t) apr_sockaddr_info_copy(apr_sockaddr_t **dst,
00441                                                  const apr_sockaddr_t *src,
00442                                                  apr_pool_t *p);
00443 
00444 /**
00445  * Look up the host name from an apr_sockaddr_t.
00446  * @param hostname The hostname.
00447  * @param sa The apr_sockaddr_t.
00448  * @param flags Special processing flags.
00449  * @remark Results can vary significantly between platforms
00450  * when processing wildcard socket addresses.
00451  */
00452 APR_DECLARE(apr_status_t) apr_getnameinfo(char **hostname,
00453                                           apr_sockaddr_t *sa,
00454                                           apr_int32_t flags);
00455 
00456 /**
00457  * Parse hostname/IP address with scope id and port.
00458  *
00459  * Any of the following strings are accepted:
00460  *   8080                  (just the port number)
00461  *   www.apache.org        (just the hostname)
00462  *   www.apache.org:8080   (hostname and port number)
00463  *   [fe80::1]:80          (IPv6 numeric address string only)
00464  *   [fe80::1%eth0]        (IPv6 numeric address string and scope id)
00465  *
00466  * Invalid strings:
00467  *                         (empty string)
00468  *   [abc]                 (not valid IPv6 numeric address string)
00469  *   abc:65536             (invalid port number)
00470  *
00471  * @param addr The new buffer containing just the hostname.  On output, *addr 
00472  *             will be NULL if no hostname/IP address was specfied.
00473  * @param scope_id The new buffer containing just the scope id.  On output, 
00474  *                 *scope_id will be NULL if no scope id was specified.
00475  * @param port The port number.  On output, *port will be 0 if no port was 
00476  *             specified.
00477  *             ### FIXME: 0 is a legal port (per RFC 1700). this should
00478  *             ### return something besides zero if the port is missing.
00479  * @param str The input string to be parsed.
00480  * @param p The pool from which *addr and *scope_id are allocated.
00481  * @remark If scope id shouldn't be allowed, check for scope_id != NULL in 
00482  *         addition to checking the return code.  If addr/hostname should be 
00483  *         required, check for addr == NULL in addition to checking the 
00484  *         return code.
00485  */
00486 APR_DECLARE(apr_status_t) apr_parse_addr_port(char **addr,
00487                                               char **scope_id,
00488                                               apr_port_t *port,
00489                                               const char *str,
00490                                               apr_pool_t *p);
00491 
00492 /**
00493  * Get name of the current machine
00494  * @param buf A buffer to store the hostname in.
00495  * @param len The maximum length of the hostname that can be stored in the
00496  *            buffer provided.  The suggested length is APRMAXHOSTLEN + 1.
00497  * @param cont The pool to use.
00498  * @remark If the buffer was not large enough, an error will be returned.
00499  */
00500 APR_DECLARE(apr_status_t) apr_gethostname(char *buf, int len, apr_pool_t *cont);
00501 
00502 /**
00503  * Return the data associated with the current socket
00504  * @param data The user data associated with the socket.
00505  * @param key The key to associate with the user data.
00506  * @param sock The currently open socket.
00507  */
00508 APR_DECLARE(apr_status_t) apr_socket_data_get(void **data, const char *key,
00509                                               apr_socket_t *sock);
00510 
00511 /**
00512  * Set the data associated with the current socket.
00513  * @param sock The currently open socket.
00514  * @param data The user data to associate with the socket.
00515  * @param key The key to associate with the data.
00516  * @param cleanup The cleanup to call when the socket is destroyed.
00517  */
00518 APR_DECLARE(apr_status_t) apr_socket_data_set(apr_socket_t *sock, void *data,
00519                                               const char *key,
00520                                               apr_status_t (*cleanup)(void*));
00521 
00522 /**
00523  * Send data over a network.
00524  * @param sock The socket to send the data over.
00525  * @param buf The buffer which contains the data to be sent. 
00526  * @param len On entry, the number of bytes to send; on exit, the number
00527  *            of bytes sent.
00528  * @remark
00529  * <PRE>
00530  * This functions acts like a blocking write by default.  To change 
00531  * this behavior, use apr_socket_timeout_set() or the APR_SO_NONBLOCK
00532  * socket option.
00533  *
00534  * It is possible for both bytes to be sent and an error to be returned.
00535  *
00536  * APR_EINTR is never returned.
00537  * </PRE>
00538  */
00539 APR_DECLARE(apr_status_t) apr_socket_send(apr_socket_t *sock, const char *buf, 
00540                                           apr_size_t *len);
00541 
00542 /**
00543  * Send multiple buffers over a network.
00544  * @param sock The socket to send the data over.
00545  * @param vec The array of iovec structs containing the data to send 
00546  * @param nvec The number of iovec structs in the array
00547  * @param len Receives the number of bytes actually written
00548  * @remark
00549  * <PRE>
00550  * This functions acts like a blocking write by default.  To change 
00551  * this behavior, use apr_socket_timeout_set() or the APR_SO_NONBLOCK
00552  * socket option.
00553  * The number of bytes actually sent is stored in argument 4.
00554  *
00555  * It is possible for both bytes to be sent and an error to be returned.
00556  *
00557  * APR_EINTR is never returned.
00558  * </PRE>
00559  */
00560 APR_DECLARE(apr_status_t) apr_socket_sendv(apr_socket_t *sock, 
00561                                            const struct iovec *vec,
00562                                            apr_int32_t nvec, apr_size_t *len);
00563 
00564 /**
00565  * @param sock The socket to send from
00566  * @param where The apr_sockaddr_t describing where to send the data
00567  * @param flags The flags to use
00568  * @param buf  The data to send
00569  * @param len  The length of the data to send
00570  */
00571 APR_DECLARE(apr_status_t) apr_socket_sendto(apr_socket_t *sock, 
00572                                             apr_sockaddr_t *where,
00573                                             apr_int32_t flags, const char *buf, 
00574                                             apr_size_t *len);
00575 
00576 /**
00577  * Read data from a socket.  On success, the address of the peer from
00578  * which the data was sent is copied into the @a from parameter, and the
00579  * @a len parameter is updated to give the number of bytes written to
00580  * @a buf.
00581  *
00582  * @param from Updated with the address from which the data was received
00583  * @param sock The socket to use
00584  * @param flags The flags to use
00585  * @param buf  The buffer to use
00586  * @param len  The length of the available buffer
00587  */
00588 
00589 APR_DECLARE(apr_status_t) apr_socket_recvfrom(apr_sockaddr_t *from, 
00590                                               apr_socket_t *sock,
00591                                               apr_int32_t flags, char *buf, 
00592                                               apr_size_t *len);
00593  
00594 #if APR_HAS_SENDFILE || defined(DOXYGEN)
00595 
00596 /**
00597  * Send a file from an open file descriptor to a socket, along with 
00598  * optional headers and trailers
00599  * @param sock The socket to which we're writing
00600  * @param file The open file from which to read
00601  * @param hdtr A structure containing the headers and trailers to send
00602  * @param offset Offset into the file where we should begin writing
00603  * @param len (input)  - Number of bytes to send from the file 
00604  *            (output) - Number of bytes actually sent, 
00605  *                       including headers, file, and trailers
00606  * @param flags APR flags that are mapped to OS specific flags
00607  * @remark This functions acts like a blocking write by default.  To change 
00608  *         this behavior, use apr_socket_timeout_set() or the
00609  *         APR_SO_NONBLOCK socket option.
00610  * The number of bytes actually sent is stored in the len parameter.
00611  * The offset parameter is passed by reference for no reason; its
00612  * value will never be modified by the apr_socket_sendfile() function.
00613  */
00614 APR_DECLARE(apr_status_t) apr_socket_sendfile(apr_socket_t *sock, 
00615                                               apr_file_t *file,
00616                                               apr_hdtr_t *hdtr,
00617                                               apr_off_t *offset,
00618                                               apr_size_t *len,
00619                                               apr_int32_t flags);
00620 
00621 #endif /* APR_HAS_SENDFILE */
00622 
00623 /**
00624  * Read data from a network.
00625  * @param sock The socket to read the data from.
00626  * @param buf The buffer to store the data in. 
00627  * @param len On entry, the number of bytes to receive; on exit, the number
00628  *            of bytes received.
00629  * @remark
00630  * <PRE>
00631  * This functions acts like a blocking read by default.  To change 
00632  * this behavior, use apr_socket_timeout_set() or the APR_SO_NONBLOCK
00633  * socket option.
00634  * The number of bytes actually received is stored in argument 3.
00635  *
00636  * It is possible for both bytes to be received and an APR_EOF or
00637  * other error to be returned.
00638  *
00639  * APR_EINTR is never returned.
00640  * </PRE>
00641  */
00642 APR_DECLARE(apr_status_t) apr_socket_recv(apr_socket_t *sock, 
00643                                    char *buf, apr_size_t *len);
00644 
00645 /**
00646  * Setup socket options for the specified socket
00647  * @param sock The socket to set up.
00648  * @param opt The option we would like to configure.  One of:
00649  * <PRE>
00650  *            APR_SO_DEBUG      --  turn on debugging information 
00651  *            APR_SO_KEEPALIVE  --  keep connections active
00652  *            APR_SO_LINGER     --  lingers on close if data is present
00653  *            APR_SO_NONBLOCK   --  Turns blocking on/off for socket
00654  *                                  When this option is enabled, use
00655  *                                  the APR_STATUS_IS_EAGAIN() macro to
00656  *                                  see if a send or receive function
00657  *                                  could not transfer data without
00658  *                                  blocking.
00659  *            APR_SO_REUSEADDR  --  The rules used in validating addresses
00660  *                                  supplied to bind should allow reuse
00661  *                                  of local addresses.
00662  *            APR_SO_SNDBUF     --  Set the SendBufferSize
00663  *            APR_SO_RCVBUF     --  Set the ReceiveBufferSize
00664  *            APR_SO_FREEBIND   --  Allow binding to non-local IP address.
00665  * </PRE>
00666  * @param on Value for the option.
00667  */
00668 APR_DECLARE(apr_status_t) apr_socket_opt_set(apr_socket_t *sock,
00669                                              apr_int32_t opt, apr_int32_t on);
00670 
00671 /**
00672  * Setup socket timeout for the specified socket
00673  * @param sock The socket to set up.
00674  * @param t Value for the timeout.
00675  * <PRE>
00676  *   t > 0  -- read and write calls return APR_TIMEUP if specified time
00677  *             elapsess with no data read or written
00678  *   t == 0 -- read and write calls never block
00679  *   t < 0  -- read and write calls block
00680  * </PRE>
00681  */
00682 APR_DECLARE(apr_status_t) apr_socket_timeout_set(apr_socket_t *sock,
00683                                                  apr_interval_time_t t);
00684 
00685 /**
00686  * Query socket options for the specified socket
00687  * @param sock The socket to query
00688  * @param opt The option we would like to query.  One of:
00689  * <PRE>
00690  *            APR_SO_DEBUG      --  turn on debugging information 
00691  *            APR_SO_KEEPALIVE  --  keep connections active
00692  *            APR_SO_LINGER     --  lingers on close if data is present
00693  *            APR_SO_NONBLOCK   --  Turns blocking on/off for socket
00694  *            APR_SO_REUSEADDR  --  The rules used in validating addresses
00695  *                                  supplied to bind should allow reuse
00696  *                                  of local addresses.
00697  *            APR_SO_SNDBUF     --  Set the SendBufferSize
00698  *            APR_SO_RCVBUF     --  Set the ReceiveBufferSize
00699  *            APR_SO_DISCONNECTED -- Query the disconnected state of the socket.
00700  *                                  (Currently only used on Windows)
00701  * </PRE>
00702  * @param on Socket option returned on the call.
00703  */
00704 APR_DECLARE(apr_status_t) apr_socket_opt_get(apr_socket_t *sock, 
00705                                              apr_int32_t opt, apr_int32_t *on);
00706 
00707 /**
00708  * Query socket timeout for the specified socket
00709  * @param sock The socket to query
00710  * @param t Socket timeout returned from the query.
00711  */
00712 APR_DECLARE(apr_status_t) apr_socket_timeout_get(apr_socket_t *sock, 
00713                                                  apr_interval_time_t *t);
00714 
00715 /**
00716  * Query the specified socket if at the OOB/Urgent data mark
00717  * @param sock The socket to query
00718  * @param atmark Is set to true if socket is at the OOB/urgent mark,
00719  *               otherwise is set to false.
00720  */
00721 APR_DECLARE(apr_status_t) apr_socket_atmark(apr_socket_t *sock, 
00722                                             int *atmark);
00723 
00724 /**
00725  * Return an address associated with a socket; either the address to
00726  * which the socket is bound locally or the address of the peer
00727  * to which the socket is connected.
00728  * @param sa The returned apr_sockaddr_t.
00729  * @param which Whether to retrieve the local or remote address
00730  * @param sock The socket to use
00731  */
00732 APR_DECLARE(apr_status_t) apr_socket_addr_get(apr_sockaddr_t **sa,
00733                                               apr_interface_e which,
00734                                               apr_socket_t *sock);
00735  
00736 /**
00737  * Return the IP address (in numeric address string format) in
00738  * an APR socket address.  APR will allocate storage for the IP address 
00739  * string from the pool of the apr_sockaddr_t.
00740  * @param addr The IP address.
00741  * @param sockaddr The socket address to reference.
00742  */
00743 APR_DECLARE(apr_status_t) apr_sockaddr_ip_get(char **addr, 
00744                                               apr_sockaddr_t *sockaddr);
00745 
00746 /**
00747  * Write the IP address (in numeric address string format) of the APR
00748  * socket address @a sockaddr into the buffer @a buf (of size @a buflen).
00749  * @param sockaddr The socket address to reference.
00750  */
00751 APR_DECLARE(apr_status_t) apr_sockaddr_ip_getbuf(char *buf, apr_size_t buflen,
00752                                                  apr_sockaddr_t *sockaddr);
00753 
00754 /**
00755  * See if the IP addresses in two APR socket addresses are
00756  * equivalent.  Appropriate logic is present for comparing
00757  * IPv4-mapped IPv6 addresses with IPv4 addresses.
00758  *
00759  * @param addr1 One of the APR socket addresses.
00760  * @param addr2 The other APR socket address.
00761  * @remark The return value will be non-zero if the addresses
00762  * are equivalent.
00763  */
00764 APR_DECLARE(int) apr_sockaddr_equal(const apr_sockaddr_t *addr1,
00765                                     const apr_sockaddr_t *addr2);
00766 
00767 /**
00768  * See if the IP address in an APR socket address refers to the wildcard
00769  * address for the protocol family (e.g., INADDR_ANY for IPv4).
00770  *
00771  * @param addr The APR socket address to examine.
00772  * @remark The return value will be non-zero if the address is
00773  * initialized and is the wildcard address.
00774  */
00775 APR_DECLARE(int) apr_sockaddr_is_wildcard(const apr_sockaddr_t *addr);
00776 
00777 /**
00778 * Return the type of the socket.
00779 * @param sock The socket to query.
00780 * @param type The returned type (e.g., SOCK_STREAM).
00781 */
00782 APR_DECLARE(apr_status_t) apr_socket_type_get(apr_socket_t *sock,
00783                                               int *type);
00784  
00785 /**
00786  * Given an apr_sockaddr_t and a service name, set the port for the service
00787  * @param sockaddr The apr_sockaddr_t that will have its port set
00788  * @param servname The name of the service you wish to use
00789  */
00790 APR_DECLARE(apr_status_t) apr_getservbyname(apr_sockaddr_t *sockaddr, 
00791                                             const char *servname);
00792 /**
00793  * Build an ip-subnet representation from an IP address and optional netmask or
00794  * number-of-bits.
00795  * @param ipsub The new ip-subnet representation
00796  * @param ipstr The input IP address string
00797  * @param mask_or_numbits The input netmask or number-of-bits string, or NULL
00798  * @param p The pool to allocate from
00799  */
00800 APR_DECLARE(apr_status_t) apr_ipsubnet_create(apr_ipsubnet_t **ipsub, 
00801                                               const char *ipstr, 
00802                                               const char *mask_or_numbits, 
00803                                               apr_pool_t *p);
00804 
00805 /**
00806  * Test the IP address in an apr_sockaddr_t against a pre-built ip-subnet
00807  * representation.
00808  * @param ipsub The ip-subnet representation
00809  * @param sa The socket address to test
00810  * @return non-zero if the socket address is within the subnet, 0 otherwise
00811  */
00812 APR_DECLARE(int) apr_ipsubnet_test(apr_ipsubnet_t *ipsub, apr_sockaddr_t *sa);
00813 
00814 #if APR_HAS_SO_ACCEPTFILTER || defined(DOXYGEN)
00815 /**
00816  * Set an OS level accept filter.
00817  * @param sock The socket to put the accept filter on.
00818  * @param name The accept filter
00819  * @param args Any extra args to the accept filter.  Passing NULL here removes
00820  *             the accept filter. 
00821  * @bug name and args should have been declared as const char *, as they are in
00822  * APR 2.0
00823  */
00824 apr_status_t apr_socket_accept_filter(apr_socket_t *sock, char *name,
00825                                       char *args);
00826 #endif
00827 
00828 /**
00829  * Return the protocol of the socket.
00830  * @param sock The socket to query.
00831  * @param protocol The returned protocol (e.g., APR_PROTO_TCP).
00832  */
00833 APR_DECLARE(apr_status_t) apr_socket_protocol_get(apr_socket_t *sock,
00834                                                   int *protocol);
00835 
00836 /**
00837  * Get the pool used by the socket.
00838  */
00839 APR_POOL_DECLARE_ACCESSOR(socket);
00840 
00841 /**
00842  * Set a socket to be inherited by child processes.
00843  */
00844 APR_DECLARE_INHERIT_SET(socket);
00845 
00846 /**
00847  * Unset a socket from being inherited by child processes.
00848  */
00849 APR_DECLARE_INHERIT_UNSET(socket);
00850 
00851 /**
00852  * Set socket permissions.
00853  */
00854 APR_PERMS_SET_IMPLEMENT(socket);
00855 
00856 /**
00857  * @defgroup apr_mcast IP Multicast
00858  * @{
00859  */
00860 
00861 /**
00862  * Join a Multicast Group
00863  * @param sock The socket to join a multicast group
00864  * @param join The address of the multicast group to join
00865  * @param iface Address of the interface to use.  If NULL is passed, the 
00866  *              default multicast interface will be used. (OS Dependent)
00867  * @param source Source Address to accept transmissions from (non-NULL 
00868  *               implies Source-Specific Multicast)
00869  */
00870 APR_DECLARE(apr_status_t) apr_mcast_join(apr_socket_t *sock,
00871                                          apr_sockaddr_t *join,
00872                                          apr_sockaddr_t *iface,
00873                                          apr_sockaddr_t *source);
00874 
00875 /**
00876  * Leave a Multicast Group.  All arguments must be the same as
00877  * apr_mcast_join.
00878  * @param sock The socket to leave a multicast group
00879  * @param addr The address of the multicast group to leave
00880  * @param iface Address of the interface to use.  If NULL is passed, the 
00881  *              default multicast interface will be used. (OS Dependent)
00882  * @param source Source Address to accept transmissions from (non-NULL 
00883  *               implies Source-Specific Multicast)
00884  */
00885 APR_DECLARE(apr_status_t) apr_mcast_leave(apr_socket_t *sock,
00886                                           apr_sockaddr_t *addr,
00887                                           apr_sockaddr_t *iface,
00888                                           apr_sockaddr_t *source);
00889 
00890 /**
00891  * Set the Multicast Time to Live (ttl) for a multicast transmission.
00892  * @param sock The socket to set the multicast ttl
00893  * @param ttl Time to live to Assign. 0-255, default=1
00894  * @remark If the TTL is 0, packets will only be seen by sockets on 
00895  * the local machine, and only when multicast loopback is enabled.
00896  */
00897 APR_DECLARE(apr_status_t) apr_mcast_hops(apr_socket_t *sock,
00898                                          apr_byte_t ttl);
00899 
00900 /**
00901  * Toggle IP Multicast Loopback
00902  * @param sock The socket to set multicast loopback
00903  * @param opt 0=disable, 1=enable
00904  */
00905 APR_DECLARE(apr_status_t) apr_mcast_loopback(apr_socket_t *sock,
00906                                              apr_byte_t opt);
00907 
00908 
00909 /**
00910  * Set the Interface to be used for outgoing Multicast Transmissions.
00911  * @param sock The socket to set the multicast interface on
00912  * @param iface Address of the interface to use for Multicast
00913  */
00914 APR_DECLARE(apr_status_t) apr_mcast_interface(apr_socket_t *sock,
00915                                               apr_sockaddr_t *iface);
00916 
00917 /** @} */
00918 
00919 /** @} */
00920 
00921 #ifdef __cplusplus
00922 }
00923 #endif
00924 
00925 #endif  /* ! APR_NETWORK_IO_H */
00926 
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines