Apache Portable Runtime
apr_network_io.h
Go to the documentation of this file.
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 */
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 */
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  */
240  /** The pool to use... */
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 */
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? */
254  /** How big should the address buffer be? 16 for v4 or 46 for v6
255  * used in inet_ntop... */
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. */
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 /* APR_SENDFILE_DISCONNECT_SOCKET has been removed in APR 2.0. */
285 #endif
286 
287 /** A structure to encapsulate headers and trailers for apr_socket_sendfile */
288 struct apr_hdtr_t {
289  /** An iovec to store the headers sent before the file. */
290  struct iovec* headers;
291  /** number of headers in the iovec */
293  /** An iovec to store the trailers sent after the file. */
294  struct iovec* trailers;
295  /** number of trailers in the iovec */
297 };
298 
299 /* function definitions */
300 
301 /**
302  * Create a socket.
303  * @param new_sock The new socket that has been set up.
304  * @param family The address family of the socket (e.g., APR_INET).
305  * @param type The type of the socket (e.g., SOCK_STREAM).
306  * @param protocol The protocol of the socket (e.g., APR_PROTO_TCP).
307  * @param cont The pool for the apr_socket_t and associated storage.
308  * @note The pool will be used by various functions that operate on the
309  * socket. The caller must ensure that it is not used by other threads
310  * at the same time.
311  */
313  int family, int type,
314  int protocol,
315  apr_pool_t *cont);
316 
317 /**
318  * Shutdown either reading, writing, or both sides of a socket.
319  * @param thesocket The socket to close
320  * @param how How to shutdown the socket. One of:
321  * <PRE>
322  * APR_SHUTDOWN_READ no longer allow read requests
323  * APR_SHUTDOWN_WRITE no longer allow write requests
324  * APR_SHUTDOWN_READWRITE no longer allow read or write requests
325  * </PRE>
326  * @see apr_shutdown_how_e
327  * @remark This does not actually close the socket descriptor, it just
328  * controls which calls are still valid on the socket.
329  */
331  apr_shutdown_how_e how);
332 
333 /**
334  * Close a socket.
335  * @param thesocket The socket to close
336  */
338 
339 /**
340  * Bind the socket to its associated port
341  * @param sock The socket to bind
342  * @param sa The socket address to bind to
343  * @remark This may be where we will find out if there is any other process
344  * using the selected port.
345  */
347  apr_sockaddr_t *sa);
348 
349 /**
350  * Listen to a bound socket for connections.
351  * @param sock The socket to listen on
352  * @param backlog The number of outstanding connections allowed in the sockets
353  * listen queue. If this value is less than zero, the listen
354  * queue size is set to zero.
355  */
357  apr_int32_t backlog);
358 
359 /**
360  * Accept a new connection request
361  * @param new_sock A copy of the socket that is connected to the socket that
362  * made the connection request. This is the socket which should
363  * be used for all future communication.
364  * @param sock The socket we are listening on.
365  * @param connection_pool The pool for the new socket.
366  * @note The pool will be used by various functions that operate on the
367  * socket. The caller must ensure that it is not used by other threads
368  * at the same time.
369  */
371  apr_socket_t *sock,
372  apr_pool_t *connection_pool);
373 
374 /**
375  * Issue a connection request to a socket either on the same machine
376  * or a different one.
377  * @param sock The socket we wish to use for our side of the connection
378  * @param sa The address of the machine we wish to connect to.
379  */
381  apr_sockaddr_t *sa);
382 
383 /**
384  * Determine whether the receive part of the socket has been closed by
385  * the peer (such that a subsequent call to apr_socket_read would
386  * return APR_EOF), if the socket's receive buffer is empty. This
387  * function does not block waiting for I/O.
388  *
389  * @param sock The socket to check
390  * @param atreadeof If APR_SUCCESS is returned, *atreadeof is set to
391  * non-zero if a subsequent read would return APR_EOF
392  * @return an error is returned if it was not possible to determine the
393  * status, in which case *atreadeof is not changed.
394  */
396  int *atreadeof);
397 
398 /**
399  * Create apr_sockaddr_t from hostname, address family, and port.
400  * @param sa The new apr_sockaddr_t.
401  * @param hostname The hostname or numeric address string to resolve/parse, or
402  * NULL to build an address that corresponds to 0.0.0.0 or ::
403  * or in case of APR_UNIX family it is absolute socket filename.
404  * @param family The address family to use, or APR_UNSPEC if the system should
405  * decide.
406  * @param port The port number.
407  * @param flags Special processing flags:
408  * <PRE>
409  * APR_IPV4_ADDR_OK first query for IPv4 addresses; only look
410  * for IPv6 addresses if the first query failed;
411  * only valid if family is APR_UNSPEC and hostname
412  * isn't NULL; mutually exclusive with
413  * APR_IPV6_ADDR_OK
414  * APR_IPV6_ADDR_OK first query for IPv6 addresses; only look
415  * for IPv4 addresses if the first query failed;
416  * only valid if family is APR_UNSPEC and hostname
417  * isn't NULL and APR_HAVE_IPV6; mutually exclusive
418  * with APR_IPV4_ADDR_OK
419  * </PRE>
420  * @param p The pool for the apr_sockaddr_t and associated storage.
421  */
423  const char *hostname,
424  apr_int32_t family,
425  apr_port_t port,
426  apr_int32_t flags,
427  apr_pool_t *p);
428 
429 /**
430  * Copy apr_sockaddr_t src to dst on pool p.
431  * @param dst The destination apr_sockaddr_t.
432  * @param src The source apr_sockaddr_t.
433  * @param p The pool for the apr_sockaddr_t and associated storage.
434  */
436  const apr_sockaddr_t *src,
437  apr_pool_t *p);
438 
439 /**
440  * Set the zone of an IPv6 link-local address object.
441  * @param sa Socket address object
442  * @param zone_id Zone ID (textual "eth0" or numeric "3").
443  * @return Returns APR_EBADIP for non-IPv6 socket or an IPv6 address
444  * which isn't link-local.
445  */
447  const char *zone_id);
448 
449 
450 /**
451  * Retrieve the zone of an IPv6 link-local address object.
452  * @param sa Socket address object
453  * @param name If non-NULL, set to the textual representation of the zone id
454  * @param id If non-NULL, set to the integer zone id
455  * @param p Pool from which *name is allocated if used.
456  * @return Returns APR_EBADIP for non-IPv6 socket or socket without any zone id
457  * set, or other error if the interface could not be mapped to a name.
458  * @remark Both name and id may be NULL, neither are modified if
459  * non-NULL in error cases.
460  */
462  const char **name,
463  apr_uint32_t *id,
464  apr_pool_t *p);
465 
466 /**
467  * Look up the host name from an apr_sockaddr_t.
468  * @param hostname The hostname.
469  * @param sa The apr_sockaddr_t.
470  * @param flags Special processing flags.
471  * @remark Results can vary significantly between platforms
472  * when processing wildcard socket addresses.
473  */
475  apr_sockaddr_t *sa,
476  apr_int32_t flags);
477 
478 /**
479  * Parse hostname/IP address with scope id and port.
480  *
481  * Any of the following strings are accepted:
482  * 8080 (just the port number)
483  * www.apache.org (just the hostname)
484  * www.apache.org:8080 (hostname and port number)
485  * [fe80::1]:80 (IPv6 numeric address string only)
486  * [fe80::1%eth0] (IPv6 numeric address string and scope id)
487  *
488  * Invalid strings:
489  * (empty string)
490  * [abc] (not valid IPv6 numeric address string)
491  * abc:65536 (invalid port number)
492  *
493  * @param addr The new buffer containing just the hostname. On output, *addr
494  * will be NULL if no hostname/IP address was specfied.
495  * @param scope_id The new buffer containing just the scope id. On output,
496  * *scope_id will be NULL if no scope id was specified.
497  * @param port The port number. On output, *port will be 0 if no port was
498  * specified.
499  * ### FIXME: 0 is a legal port (per RFC 1700). this should
500  * ### return something besides zero if the port is missing.
501  * @param str The input string to be parsed.
502  * @param p The pool from which *addr and *scope_id are allocated.
503  * @remark If scope id shouldn't be allowed, check for scope_id != NULL in
504  * addition to checking the return code. If addr/hostname should be
505  * required, check for addr == NULL in addition to checking the
506  * return code.
507  */
509  char **scope_id,
510  apr_port_t *port,
511  const char *str,
512  apr_pool_t *p);
513 
514 /**
515  * Get name of the current machine
516  * @param buf A buffer to store the hostname in.
517  * @param len The maximum length of the hostname that can be stored in the
518  * buffer provided. The suggested length is APRMAXHOSTLEN + 1.
519  * @param cont The pool to use.
520  * @remark If the buffer was not large enough, an error will be returned.
521  */
523 
524 /**
525  * Return the data associated with the current socket
526  * @param data The user data associated with the socket.
527  * @param key The key to associate with the user data.
528  * @param sock The currently open socket.
529  */
530 APR_DECLARE(apr_status_t) apr_socket_data_get(void **data, const char *key,
531  apr_socket_t *sock);
532 
533 /**
534  * Set the data associated with the current socket.
535  * @param sock The currently open socket.
536  * @param data The user data to associate with the socket.
537  * @param key The key to associate with the data.
538  * @param cleanup The cleanup to call when the socket is destroyed.
539  */
541  const char *key,
542  apr_status_t (*cleanup)(void*));
543 
544 /**
545  * Send data over a network.
546  * @param sock The socket to send the data over.
547  * @param buf The buffer which contains the data to be sent.
548  * @param len On entry, the number of bytes to send; on exit, the number
549  * of bytes sent.
550  * @remark
551  * <PRE>
552  * This functions acts like a blocking write by default. To change
553  * this behavior, use apr_socket_timeout_set() or the APR_SO_NONBLOCK
554  * socket option.
555  *
556  * It is possible for both bytes to be sent and an error to be returned.
557  *
558  * APR_EINTR is never returned.
559  * </PRE>
560  */
562  apr_size_t *len);
563 
564 /**
565  * Send multiple buffers over a network.
566  * @param sock The socket to send the data over.
567  * @param vec The array of iovec structs containing the data to send
568  * @param nvec The number of iovec structs in the array
569  * @param len Receives the number of bytes actually written
570  * @remark
571  * <PRE>
572  * This functions acts like a blocking write by default. To change
573  * this behavior, use apr_socket_timeout_set() or the APR_SO_NONBLOCK
574  * socket option.
575  * The number of bytes actually sent is stored in argument 4.
576  *
577  * It is possible for both bytes to be sent and an error to be returned.
578  *
579  * APR_EINTR is never returned.
580  * </PRE>
581  */
583  const struct iovec *vec,
584  apr_int32_t nvec, apr_size_t *len);
585 
586 /**
587  * @param sock The socket to send from
588  * @param where The apr_sockaddr_t describing where to send the data
589  * @param flags The flags to use
590  * @param buf The data to send
591  * @param len The length of the data to send
592  */
594  apr_sockaddr_t *where,
595  apr_int32_t flags, const char *buf,
596  apr_size_t *len);
597 
598 /**
599  * Read data from a socket. On success, the address of the peer from
600  * which the data was sent is copied into the @a from parameter, and the
601  * @a len parameter is updated to give the number of bytes written to
602  * @a buf.
603  *
604  * @param from Updated with the address from which the data was received
605  * @param sock The socket to use
606  * @param flags The flags to use
607  * @param buf The buffer to use
608  * @param len The length of the available buffer
609  */
610 
612  apr_socket_t *sock,
613  apr_int32_t flags, char *buf,
614  apr_size_t *len);
615 
616 #if APR_HAS_SENDFILE || defined(DOXYGEN)
617 
618 /**
619  * Send a file from an open file descriptor to a socket, along with
620  * optional headers and trailers
621  * @param sock The socket to which we're writing
622  * @param file The open file from which to read
623  * @param hdtr A structure containing the headers and trailers to send
624  * @param offset Offset into the file where we should begin writing
625  * @param len (input) - Number of bytes to send from the file
626  * (output) - Number of bytes actually sent,
627  * including headers, file, and trailers
628  * @param flags APR flags that are mapped to OS specific flags
629  * @remark This functions acts like a blocking write by default. To change
630  * this behavior, use apr_socket_timeout_set() or the
631  * APR_SO_NONBLOCK socket option.
632  * The number of bytes actually sent is stored in the len parameter.
633  * The offset parameter is passed by reference for no reason; its
634  * value will never be modified by the apr_socket_sendfile() function.
635  * It is possible for both bytes to be sent and an error to be returned.
636  */
638  apr_file_t *file,
639  apr_hdtr_t *hdtr,
640  apr_off_t *offset,
641  apr_size_t *len,
642  apr_int32_t flags);
643 
644 #endif /* APR_HAS_SENDFILE */
645 
646 /**
647  * Read data from a network.
648  * @param sock The socket to read the data from.
649  * @param buf The buffer to store the data in.
650  * @param len On entry, the number of bytes to receive; on exit, the number
651  * of bytes received.
652  * @remark
653  * <PRE>
654  * This functions acts like a blocking read by default. To change
655  * this behavior, use apr_socket_timeout_set() or the APR_SO_NONBLOCK
656  * socket option.
657  * The number of bytes actually received is stored in argument 3.
658  *
659  * It is possible for both bytes to be received and an APR_EOF or
660  * other error to be returned.
661  *
662  * APR_EINTR is never returned.
663  * </PRE>
664  */
666  char *buf, apr_size_t *len);
667 
668 /**
669  * Wait for a socket to be ready for input or output
670  * @param sock the socket to wait on
671  * @param direction whether to wait for reading or writing to be ready
672  * @remark Will time out if socket has a time out set for it
673  * @remark direction can be either APR_WAIT_READ or APR_WAIT_WRITE
674  */
676  apr_wait_type_t direction);
677 
678 /**
679  * Setup socket options for the specified socket
680  * @param sock The socket to set up.
681  * @param opt The option we would like to configure. One of:
682  * <PRE>
683  * APR_SO_DEBUG -- turn on debugging information
684  * APR_SO_KEEPALIVE -- keep connections active
685  * APR_SO_LINGER -- lingers on close if data is present
686  * APR_SO_NONBLOCK -- Turns blocking on/off for socket
687  * When this option is enabled, use
688  * the APR_STATUS_IS_EAGAIN() macro to
689  * see if a send or receive function
690  * could not transfer data without
691  * blocking.
692  * APR_SO_REUSEADDR -- The rules used in validating addresses
693  * supplied to bind should allow reuse
694  * of local addresses.
695  * APR_SO_SNDBUF -- Set the SendBufferSize
696  * APR_SO_RCVBUF -- Set the ReceiveBufferSize
697  * APR_SO_FREEBIND -- Allow binding to non-local IP address.
698  * </PRE>
699  * @param on Value for the option.
700  */
702  apr_int32_t opt, apr_int32_t on);
703 
704 /**
705  * Setup socket timeout for the specified socket
706  * @param sock The socket to set up.
707  * @param t Value for the timeout.
708  * <PRE>
709  * t > 0 -- read and write calls return APR_TIMEUP if specified time
710  * elapsess with no data read or written
711  * t == 0 -- read and write calls never block
712  * t < 0 -- read and write calls block
713  * </PRE>
714  */
717 
718 /**
719  * Query socket options for the specified socket
720  * @param sock The socket to query
721  * @param opt The option we would like to query. One of:
722  * <PRE>
723  * APR_SO_DEBUG -- turn on debugging information
724  * APR_SO_KEEPALIVE -- keep connections active
725  * APR_SO_LINGER -- lingers on close if data is present
726  * APR_SO_NONBLOCK -- Turns blocking on/off for socket
727  * APR_SO_REUSEADDR -- The rules used in validating addresses
728  * supplied to bind should allow reuse
729  * of local addresses.
730  * APR_SO_SNDBUF -- Set the SendBufferSize
731  * APR_SO_RCVBUF -- Set the ReceiveBufferSize
732  * APR_SO_DISCONNECTED -- Query the disconnected state of the socket.
733  * (Currently only used on Windows)
734  * </PRE>
735  * @param on Socket option returned on the call.
736  */
738  apr_int32_t opt, apr_int32_t *on);
739 
740 /**
741  * Query socket timeout for the specified socket
742  * @param sock The socket to query
743  * @param t Socket timeout returned from the query.
744  */
747 
748 /**
749  * Query the specified socket if at the OOB/Urgent data mark
750  * @param sock The socket to query
751  * @param atmark Is set to true if socket is at the OOB/urgent mark,
752  * otherwise is set to false.
753  */
755  int *atmark);
756 
757 /**
758  * Return an address associated with a socket; either the address to
759  * which the socket is bound locally or the address of the peer
760  * to which the socket is connected.
761  * @param sa The returned apr_sockaddr_t.
762  * @param which Whether to retrieve the local or remote address
763  * @param sock The socket to use
764  */
766  apr_interface_e which,
767  apr_socket_t *sock);
768 
769 /**
770  * Return the IP address (in numeric address string format) in
771  * an APR socket address. APR will allocate storage for the IP address
772  * string from the pool of the apr_sockaddr_t.
773  * @param addr The IP address.
774  * @param sockaddr The socket address to reference.
775  */
777  apr_sockaddr_t *sockaddr);
778 
779 /**
780  * Write the IP address (in numeric address string format) of the APR
781  * socket address @a sockaddr into the buffer @a buf (of size @a buflen).
782  * @param sockaddr The socket address to reference.
783  */
784 APR_DECLARE(apr_status_t) apr_sockaddr_ip_getbuf(char *buf, apr_size_t buflen,
785  apr_sockaddr_t *sockaddr);
786 
787 /**
788  * See if the IP addresses in two APR socket addresses are
789  * equivalent. Appropriate logic is present for comparing
790  * IPv4-mapped IPv6 addresses with IPv4 addresses.
791  *
792  * @param addr1 One of the APR socket addresses.
793  * @param addr2 The other APR socket address.
794  * @remark The return value will be non-zero if the addresses
795  * are equivalent.
796  */
798  const apr_sockaddr_t *addr2);
799 
800 /**
801  * See if the IP address in an APR socket address refers to the wildcard
802  * address for the protocol family (e.g., INADDR_ANY for IPv4).
803  *
804  * @param addr The APR socket address to examine.
805  * @remark The return value will be non-zero if the address is
806  * initialized and is the wildcard address.
807  */
809 
810 /**
811 * Return the type of the socket.
812 * @param sock The socket to query.
813 * @param type The returned type (e.g., SOCK_STREAM).
814 */
816  int *type);
817 
818 /**
819  * Given an apr_sockaddr_t and a service name, set the port for the service
820  * @param sockaddr The apr_sockaddr_t that will have its port set
821  * @param servname The name of the service you wish to use
822  */
824  const char *servname);
825 /**
826  * Build an ip-subnet representation from an IP address and optional netmask or
827  * number-of-bits.
828  * @param ipsub The new ip-subnet representation
829  * @param ipstr The input IP address string
830  * @param mask_or_numbits The input netmask or number-of-bits string, or NULL
831  * @param p The pool to allocate from
832  */
834  const char *ipstr,
835  const char *mask_or_numbits,
836  apr_pool_t *p);
837 
838 /**
839  * Test the IP address in an apr_sockaddr_t against a pre-built ip-subnet
840  * representation.
841  * @param ipsub The ip-subnet representation
842  * @param sa The socket address to test
843  * @return non-zero if the socket address is within the subnet, 0 otherwise
844  */
846 
847 #if APR_HAS_SO_ACCEPTFILTER || defined(DOXYGEN)
848 /**
849  * Set an OS level accept filter.
850  * @param sock The socket to put the accept filter on.
851  * @param name The accept filter
852  * @param args Any extra args to the accept filter. Passing NULL here removes
853  * the accept filter.
854  */
856  const char *args);
857 #endif
858 
859 /**
860  * Return the protocol of the socket.
861  * @param sock The socket to query.
862  * @param protocol The returned protocol (e.g., APR_PROTO_TCP).
863  */
865  int *protocol);
866 
867 /**
868  * Get the pool used by the socket.
869  */
871 
872 /**
873  * Set a socket to be inherited by child processes.
874  */
876 
877 /**
878  * Unset a socket from being inherited by child processes.
879  */
881 
882 /**
883  * Set socket permissions.
884  */
886 
887 /**
888  * @defgroup apr_mcast IP Multicast
889  * @{
890  */
891 
892 /**
893  * Join a Multicast Group
894  * @param sock The socket to join a multicast group
895  * @param join The address of the multicast group to join
896  * @param iface Address of the interface to use. If NULL is passed, the
897  * default multicast interface will be used. (OS Dependent)
898  * @param source Source Address to accept transmissions from (non-NULL
899  * implies Source-Specific Multicast)
900  */
902  apr_sockaddr_t *join,
903  apr_sockaddr_t *iface,
904  apr_sockaddr_t *source);
905 
906 /**
907  * Leave a Multicast Group. All arguments must be the same as
908  * apr_mcast_join.
909  * @param sock The socket to leave a multicast group
910  * @param addr The address of the multicast group to leave
911  * @param iface Address of the interface to use. If NULL is passed, the
912  * default multicast interface will be used. (OS Dependent)
913  * @param source Source Address to accept transmissions from (non-NULL
914  * implies Source-Specific Multicast)
915  */
917  apr_sockaddr_t *addr,
918  apr_sockaddr_t *iface,
919  apr_sockaddr_t *source);
920 
921 /**
922  * Set the Multicast Time to Live (ttl) for a multicast transmission.
923  * @param sock The socket to set the multicast ttl
924  * @param ttl Time to live to Assign. 0-255, default=1
925  * @remark If the TTL is 0, packets will only be seen by sockets on
926  * the local machine, and only when multicast loopback is enabled.
927  */
929  apr_byte_t ttl);
930 
931 /**
932  * Toggle IP Multicast Loopback
933  * @param sock The socket to set multicast loopback
934  * @param opt 0=disable, 1=enable
935  */
937  apr_byte_t opt);
938 
939 
940 /**
941  * Set the Interface to be used for outgoing Multicast Transmissions.
942  * @param sock The socket to set the multicast interface on
943  * @param iface Address of the interface to use for Multicast
944  */
946  apr_sockaddr_t *iface);
947 
948 /** @} */
949 
950 /** @} */
951 
952 #ifdef __cplusplus
953 }
954 #endif
955 
956 #endif /* ! APR_NETWORK_IO_H */
957 
APR Platform Definitions.
APR Error Codes.
APR File I/O Handling.
APR File Handle Inheritance Helpers.
#define APR_DECLARE_INHERIT_SET(type)
Definition: apr_inherit.h:35
#define APR_DECLARE_INHERIT_UNSET(type)
Definition: apr_inherit.h:47
APR Process Locking Routines.
APR memory allocation.
int apr_status_t
Definition: apr_errno.h:44
struct apr_file_t apr_file_t
Definition: apr_file_io.h:195
apr_status_t apr_mcast_hops(apr_socket_t *sock, apr_byte_t ttl)
apr_status_t apr_mcast_join(apr_socket_t *sock, apr_sockaddr_t *join, apr_sockaddr_t *iface, apr_sockaddr_t *source)
apr_status_t apr_mcast_loopback(apr_socket_t *sock, apr_byte_t opt)
apr_status_t apr_mcast_interface(apr_socket_t *sock, apr_sockaddr_t *iface)
apr_status_t apr_mcast_leave(apr_socket_t *sock, apr_sockaddr_t *addr, apr_sockaddr_t *iface, apr_sockaddr_t *source)
apr_status_t apr_socket_sendto(apr_socket_t *sock, apr_sockaddr_t *where, apr_int32_t flags, const char *buf, apr_size_t *len)
apr_status_t apr_socket_opt_set(apr_socket_t *sock, apr_int32_t opt, apr_int32_t on)
apr_status_t apr_sockaddr_zone_set(apr_sockaddr_t *sa, const char *zone_id)
apr_status_t apr_socket_listen(apr_socket_t *sock, apr_int32_t backlog)
apr_status_t apr_socket_opt_get(apr_socket_t *sock, apr_int32_t opt, apr_int32_t *on)
apr_interface_e
Definition: apr_network_io.h:198
int apr_sockaddr_equal(const apr_sockaddr_t *addr1, const apr_sockaddr_t *addr2)
apr_status_t apr_socket_accept_filter(apr_socket_t *sock, const char *name, const char *args)
apr_status_t apr_socket_accept(apr_socket_t **new_sock, apr_socket_t *sock, apr_pool_t *connection_pool)
apr_status_t apr_socket_atmark(apr_socket_t *sock, int *atmark)
apr_status_t apr_socket_wait(apr_socket_t *sock, apr_wait_type_t direction)
apr_status_t apr_ipsubnet_create(apr_ipsubnet_t **ipsub, const char *ipstr, const char *mask_or_numbits, apr_pool_t *p)
apr_status_t apr_socket_sendfile(apr_socket_t *sock, apr_file_t *file, apr_hdtr_t *hdtr, apr_off_t *offset, apr_size_t *len, apr_int32_t flags)
apr_status_t apr_sockaddr_info_copy(apr_sockaddr_t **dst, const apr_sockaddr_t *src, apr_pool_t *p)
apr_status_t apr_socket_create(apr_socket_t **new_sock, int family, int type, int protocol, apr_pool_t *cont)
struct apr_socket_t apr_socket_t
Definition: apr_network_io.h:219
apr_status_t apr_socket_bind(apr_socket_t *sock, apr_sockaddr_t *sa)
apr_status_t apr_gethostname(char *buf, int len, apr_pool_t *cont)
apr_status_t apr_getnameinfo(char **hostname, apr_sockaddr_t *sa, apr_int32_t flags)
apr_status_t apr_socket_recvfrom(apr_sockaddr_t *from, apr_socket_t *sock, apr_int32_t flags, char *buf, apr_size_t *len)
apr_status_t apr_socket_close(apr_socket_t *thesocket)
apr_status_t apr_sockaddr_ip_getbuf(char *buf, apr_size_t buflen, apr_sockaddr_t *sockaddr)
apr_status_t apr_socket_type_get(apr_socket_t *sock, int *type)
apr_status_t apr_socket_connect(apr_socket_t *sock, apr_sockaddr_t *sa)
apr_status_t apr_parse_addr_port(char **addr, char **scope_id, apr_port_t *port, const char *str, apr_pool_t *p)
apr_status_t apr_socket_send(apr_socket_t *sock, const char *buf, apr_size_t *len)
apr_status_t apr_socket_timeout_set(apr_socket_t *sock, apr_interval_time_t t)
apr_status_t apr_socket_sendv(apr_socket_t *sock, const struct iovec *vec, apr_int32_t nvec, apr_size_t *len)
APR_PERMS_SET_IMPLEMENT(socket)
apr_status_t apr_sockaddr_info_get(apr_sockaddr_t **sa, const char *hostname, apr_int32_t family, apr_port_t port, apr_int32_t flags, apr_pool_t *p)
apr_status_t apr_socket_timeout_get(apr_socket_t *sock, apr_interval_time_t *t)
apr_status_t apr_sockaddr_zone_get(const apr_sockaddr_t *sa, const char **name, apr_uint32_t *id, apr_pool_t *p)
apr_uint16_t apr_port_t
Definition: apr_network_io.h:230
apr_status_t apr_socket_recv(apr_socket_t *sock, char *buf, apr_size_t *len)
int apr_ipsubnet_test(apr_ipsubnet_t *ipsub, apr_sockaddr_t *sa)
apr_status_t apr_sockaddr_ip_get(char **addr, apr_sockaddr_t *sockaddr)
int apr_sockaddr_is_wildcard(const apr_sockaddr_t *addr)
apr_status_t apr_socket_atreadeof(apr_socket_t *sock, int *atreadeof)
apr_status_t apr_socket_protocol_get(apr_socket_t *sock, int *protocol)
apr_status_t apr_socket_shutdown(apr_socket_t *thesocket, apr_shutdown_how_e how)
struct apr_ipsubnet_t apr_ipsubnet_t
Definition: apr_network_io.h:227
apr_status_t apr_socket_addr_get(apr_sockaddr_t **sa, apr_interface_e which, apr_socket_t *sock)
struct in_addr apr_in_addr_t
Definition: apr_network_io.h:225
apr_status_t apr_getservbyname(apr_sockaddr_t *sockaddr, const char *servname)
apr_shutdown_how_e
Definition: apr_network_io.h:115
apr_status_t apr_socket_data_get(void **data, const char *key, apr_socket_t *sock)
apr_status_t apr_socket_data_set(apr_socket_t *sock, void *data, const char *key, apr_status_t(*cleanup)(void *))
@ APR_LOCAL
Definition: apr_network_io.h:199
@ APR_REMOTE
Definition: apr_network_io.h:200
@ APR_SHUTDOWN_WRITE
Definition: apr_network_io.h:117
@ APR_SHUTDOWN_READ
Definition: apr_network_io.h:116
@ APR_SHUTDOWN_READWRITE
Definition: apr_network_io.h:118
#define APR_DECLARE(type)
Definition: apr.h:516
#define APR_POOL_DECLARE_ACCESSOR(type)
Definition: apr_pools.h:81
struct apr_pool_t apr_pool_t
Definition: apr_pools.h:60
apr_int64_t apr_interval_time_t
Definition: apr_time.h:55
Definition: apr_network_io.h:288
struct iovec * trailers
Definition: apr_network_io.h:294
int numheaders
Definition: apr_network_io.h:292
int numtrailers
Definition: apr_network_io.h:296
struct iovec * headers
Definition: apr_network_io.h:290
Definition: apr_network_io.h:239
apr_port_t port
Definition: apr_network_io.h:247
union apr_sockaddr_t::@6 sa
apr_pool_t * pool
Definition: apr_network_io.h:241
char * servname
Definition: apr_network_io.h:245
void * ipaddr_ptr
Definition: apr_network_io.h:259
apr_sockaddr_t * next
Definition: apr_network_io.h:262
struct sockaddr_in sin
Definition: apr_network_io.h:266
int ipaddr_len
Definition: apr_network_io.h:253
char * hostname
Definition: apr_network_io.h:243
int addr_str_len
Definition: apr_network_io.h:256
struct sockaddr_in6 sin6
Definition: apr_network_io.h:269
struct sockaddr_un unx
Definition: apr_network_io.h:278
apr_int32_t family
Definition: apr_network_io.h:249
struct sockaddr_storage sas
Definition: apr_network_io.h:274
apr_socklen_t salen
Definition: apr_network_io.h:251