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