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