apr_network_io.h

Go to the documentation of this file.

/* Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef APR_NETWORK_IO_H
#define APR_NETWORK_IO_H
#include "apr.h"
#include "apr_pools.h"
#include "apr_file_io.h"
#include "apr_errno.h"
#include "apr_inherit.h"
#include "apr_perms_set.h"
 
#if APR_HAVE_NETINET_IN_H
#include <netinet/in.h>
#endif
#if APR_HAVE_SYS_UN_H
#include <sys/un.h>
#endif
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#ifndef APR_MAX_SECS_TO_LINGER
#define APR_MAX_SECS_TO_LINGER 30
#endif
 
#ifndef APRMAXHOSTLEN
#define APRMAXHOSTLEN 256
#endif
 
#ifndef APR_ANYADDR
#define APR_ANYADDR "0.0.0.0"
#endif
 
#define APR_SO_LINGER        1    
#define APR_SO_KEEPALIVE     2    
#define APR_SO_DEBUG         4    
#define APR_SO_NONBLOCK      8    
#define APR_SO_REUSEADDR     16   
#define APR_SO_SNDBUF        64   
#define APR_SO_RCVBUF        128  
#define APR_SO_DISCONNECTED  256  
#define APR_TCP_NODELAY      512  
#define APR_TCP_NOPUSH       1024 
#define APR_RESET_NODELAY    2048 
#define APR_INCOMPLETE_READ 4096  
#define APR_INCOMPLETE_WRITE 8192 
#define APR_IPV6_V6ONLY     16384 
#define APR_TCP_DEFER_ACCEPT 32768 
#define APR_SO_BROADCAST     65536 
#define APR_SO_FREEBIND     131072 
typedef enum {
    APR_SHUTDOWN_READ,          
    APR_SHUTDOWN_WRITE,         
    APR_SHUTDOWN_READWRITE      
} apr_shutdown_how_e;
 
#define APR_IPV4_ADDR_OK  0x01  
#define APR_IPV6_ADDR_OK  0x02  
#if (!APR_HAVE_IN_ADDR)
struct in_addr {
    apr_uint32_t  s_addr; 
};
#endif
 
#ifdef INADDR_NONE
#define APR_INADDR_NONE INADDR_NONE
#else
#define APR_INADDR_NONE ((unsigned int) 0xffffffff)
#endif
 
#define APR_INET     AF_INET
#ifdef AF_UNSPEC
#define APR_UNSPEC   AF_UNSPEC
#else
#define APR_UNSPEC   0
#endif
#if APR_HAVE_IPV6
#define APR_INET6    AF_INET6
#endif
 
#if APR_HAVE_SOCKADDR_UN
#if defined (AF_UNIX)
#define APR_UNIX    AF_UNIX
#elif defined(AF_LOCAL)
#define APR_UNIX    AF_LOCAL
#else
#error "Neither AF_UNIX nor AF_LOCAL is defined"
#endif
#else /* !APR_HAVE_SOCKADDR_UN */
#if defined (AF_UNIX)
#define APR_UNIX    AF_UNIX
#elif defined(AF_LOCAL)
#define APR_UNIX    AF_LOCAL
#else
/* TODO: Use a smarter way to detect unique APR_UNIX value */
#define APR_UNIX    1234
#endif
#endif
 
#define APR_PROTO_TCP       6   
#define APR_PROTO_UDP      17   
#define APR_PROTO_SCTP    132   
typedef enum {
    APR_LOCAL,   
    APR_REMOTE   
} apr_interface_e;
 
#if APR_HAVE_INET_ADDR
#define apr_inet_addr    inet_addr
#elif APR_HAVE_INET_NETWORK        /* only DGUX, as far as I know */
#define apr_inet_addr    inet_network
#endif
 
typedef struct apr_socket_t     apr_socket_t;
typedef struct apr_hdtr_t       apr_hdtr_t;
typedef struct in_addr          apr_in_addr_t;
typedef struct apr_ipsubnet_t apr_ipsubnet_t;
 
typedef apr_uint16_t            apr_port_t;
 
typedef struct apr_sockaddr_t apr_sockaddr_t;
struct apr_sockaddr_t {
    apr_pool_t *pool;
    char *hostname;
    char *servname;
    apr_port_t port;
    apr_int32_t family;
    apr_socklen_t salen;
    int ipaddr_len;
    int addr_str_len;
    void *ipaddr_ptr;
    apr_sockaddr_t *next;
    union {
        struct sockaddr_in sin;
#if APR_HAVE_IPV6
        struct sockaddr_in6 sin6;
#endif
#if APR_HAVE_SA_STORAGE
        struct sockaddr_storage sas;
#endif
#if APR_HAVE_SOCKADDR_UN
        struct sockaddr_un unx;
#endif
    } sa;
};
 
#if APR_HAS_SENDFILE
/* APR_SENDFILE_DISCONNECT_SOCKET has been removed in APR 2.0. */
#endif
 
struct apr_hdtr_t {
    struct iovec* headers;
    int numheaders;
    struct iovec* trailers;
    int numtrailers;
};
 
/* function definitions */
 
APR_DECLARE(apr_status_t) apr_socket_create(apr_socket_t **new_sock,
                                            int family, int type,
                                            int protocol,
                                            apr_pool_t *cont);
 
APR_DECLARE(apr_status_t) apr_socket_shutdown(apr_socket_t *thesocket,
                                              apr_shutdown_how_e how);
 
APR_DECLARE(apr_status_t) apr_socket_close(apr_socket_t *thesocket);
 
APR_DECLARE(apr_status_t) apr_socket_bind(apr_socket_t *sock,
                                          apr_sockaddr_t *sa);
 
APR_DECLARE(apr_status_t) apr_socket_listen(apr_socket_t *sock,
                                            apr_int32_t backlog);
 
APR_DECLARE(apr_status_t) apr_socket_accept(apr_socket_t **new_sock,
                                            apr_socket_t *sock,
                                            apr_pool_t *connection_pool);
 
APR_DECLARE(apr_status_t) apr_socket_connect(apr_socket_t *sock,
                                             apr_sockaddr_t *sa);
 
APR_DECLARE(apr_status_t) apr_socket_atreadeof(apr_socket_t *sock,
                                               int *atreadeof);
 
APR_DECLARE(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_DECLARE(apr_status_t) apr_sockaddr_info_copy(apr_sockaddr_t **dst,
                                                 const apr_sockaddr_t *src,
                                                 apr_pool_t *p);
 
APR_DECLARE(apr_status_t) apr_sockaddr_zone_set(apr_sockaddr_t *sa,
                                                const char *zone_id);
 
 
APR_DECLARE(apr_status_t) apr_sockaddr_zone_get(const apr_sockaddr_t *sa,
                                                const char **name,
                                                apr_uint32_t *id,
                                                apr_pool_t *p);
 
APR_DECLARE(apr_status_t) apr_getnameinfo(char **hostname,
                                          apr_sockaddr_t *sa,
                                          apr_int32_t flags);
 
APR_DECLARE(apr_status_t) apr_parse_addr_port(char **addr,
                                              char **scope_id,
                                              apr_port_t *port,
                                              const char *str,
                                              apr_pool_t *p);
 
APR_DECLARE(apr_status_t) apr_gethostname(char *buf, int len, apr_pool_t *cont);
 
APR_DECLARE(apr_status_t) apr_socket_data_get(void **data, const char *key,
                                              apr_socket_t *sock);
 
APR_DECLARE(apr_status_t) apr_socket_data_set(apr_socket_t *sock, void *data,
                                              const char *key,
                                              apr_status_t (*cleanup)(void*));
 
APR_DECLARE(apr_status_t) apr_socket_send(apr_socket_t *sock, const char *buf,
                                          apr_size_t *len);
 
APR_DECLARE(apr_status_t) apr_socket_sendv(apr_socket_t *sock,
                                           const struct iovec *vec,
                                           apr_int32_t nvec, apr_size_t *len);
 
APR_DECLARE(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_DECLARE(apr_status_t) apr_socket_recvfrom(apr_sockaddr_t *from,
                                              apr_socket_t *sock,
                                              apr_int32_t flags, char *buf,
                                              apr_size_t *len);
 
#if APR_HAS_SENDFILE || defined(DOXYGEN)
 
APR_DECLARE(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);
 
#endif /* APR_HAS_SENDFILE */
 
APR_DECLARE(apr_status_t) apr_socket_recv(apr_socket_t *sock,
                                   char *buf, apr_size_t *len);
 
APR_DECLARE(apr_status_t) apr_socket_wait(apr_socket_t *sock,
                                          apr_wait_type_t direction);
 
APR_DECLARE(apr_status_t) apr_socket_opt_set(apr_socket_t *sock,
                                             apr_int32_t opt, apr_int32_t on);
 
APR_DECLARE(apr_status_t) apr_socket_timeout_set(apr_socket_t *sock,
                                                 apr_interval_time_t t);
 
APR_DECLARE(apr_status_t) apr_socket_opt_get(apr_socket_t *sock,
                                             apr_int32_t opt, apr_int32_t *on);
 
APR_DECLARE(apr_status_t) apr_socket_timeout_get(apr_socket_t *sock,
                                                 apr_interval_time_t *t);
 
APR_DECLARE(apr_status_t) apr_socket_atmark(apr_socket_t *sock,
                                            int *atmark);
 
APR_DECLARE(apr_status_t) apr_socket_addr_get(apr_sockaddr_t **sa,
                                              apr_interface_e which,
                                              apr_socket_t *sock);
 
APR_DECLARE(apr_status_t) apr_sockaddr_ip_get(char **addr,
                                              apr_sockaddr_t *sockaddr);
 
APR_DECLARE(apr_status_t) apr_sockaddr_ip_getbuf(char *buf, apr_size_t buflen,
                                                 apr_sockaddr_t *sockaddr);
 
APR_DECLARE(int) apr_sockaddr_equal(const apr_sockaddr_t *addr1,
                                    const apr_sockaddr_t *addr2);
 
APR_DECLARE(int) apr_sockaddr_is_wildcard(const apr_sockaddr_t *addr);
 
APR_DECLARE(apr_status_t) apr_socket_type_get(apr_socket_t *sock,
                                              int *type);
 
APR_DECLARE(apr_status_t) apr_getservbyname(apr_sockaddr_t *sockaddr,
                                            const char *servname);
APR_DECLARE(apr_status_t) apr_ipsubnet_create(apr_ipsubnet_t **ipsub,
                                              const char *ipstr,
                                              const char *mask_or_numbits,
                                              apr_pool_t *p);
 
APR_DECLARE(int) apr_ipsubnet_test(apr_ipsubnet_t *ipsub, apr_sockaddr_t *sa);
 
#if APR_HAS_SO_ACCEPTFILTER || defined(DOXYGEN)
apr_status_t apr_socket_accept_filter(apr_socket_t *sock, const char *name,
                                      const char *args);
#endif
 
APR_DECLARE(apr_status_t) apr_socket_protocol_get(apr_socket_t *sock,
                                                  int *protocol);
 
APR_POOL_DECLARE_ACCESSOR(socket);
 
APR_DECLARE_INHERIT_SET(socket);
 
APR_DECLARE_INHERIT_UNSET(socket);
 
APR_PERMS_SET_IMPLEMENT(socket);
 
APR_DECLARE(apr_status_t) apr_mcast_join(apr_socket_t *sock,
                                         apr_sockaddr_t *join,
                                         apr_sockaddr_t *iface,
                                         apr_sockaddr_t *source);
 
APR_DECLARE(apr_status_t) apr_mcast_leave(apr_socket_t *sock,
                                          apr_sockaddr_t *addr,
                                          apr_sockaddr_t *iface,
                                          apr_sockaddr_t *source);
 
APR_DECLARE(apr_status_t) apr_mcast_hops(apr_socket_t *sock,
                                         apr_byte_t ttl);
 
APR_DECLARE(apr_status_t) apr_mcast_loopback(apr_socket_t *sock,
                                             apr_byte_t opt);
 
 
APR_DECLARE(apr_status_t) apr_mcast_interface(apr_socket_t *sock,
                                              apr_sockaddr_t *iface);
 
#ifdef __cplusplus
}
#endif
 
#endif  /* ! APR_NETWORK_IO_H */