2 * Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 1998-2001 Internet Software Consortium.
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11 * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15 * PERFORMANCE OF THIS SOFTWARE.
18 /* $Id: sockaddr.h,v 1.35.2.2 2004/03/09 06:12:01 marka Exp $ */
20 #ifndef ISC_SOCKADDR_H
21 #define ISC_SOCKADDR_H 1
25 #include <isc/types.h>
30 struct sockaddr_in sin;
31 struct sockaddr_in6 sin6;
33 unsigned int length; /* XXXRTH beginning? */
34 ISC_LINK(struct isc_sockaddr) link;
37 typedef ISC_LIST(struct isc_sockaddr) isc_sockaddrlist_t;
42 isc_sockaddr_equal(const isc_sockaddr_t *a, const isc_sockaddr_t *b);
44 * Return ISC_TRUE iff the socket addresses 'a' and 'b' are equal.
48 isc_sockaddr_eqaddr(const isc_sockaddr_t *a, const isc_sockaddr_t *b);
50 * Return ISC_TRUE iff the address parts of the socket addresses
51 * 'a' and 'b' are equal, ignoring the ports.
55 isc_sockaddr_eqaddrprefix(const isc_sockaddr_t *a, const isc_sockaddr_t *b,
56 unsigned int prefixlen);
58 * Return ISC_TRUE iff the most significant 'prefixlen' bits of the
59 * socket addresses 'a' and 'b' are equal, ignoring the ports.
63 isc_sockaddr_hash(const isc_sockaddr_t *sockaddr, isc_boolean_t address_only);
65 * Return a hash value for the socket address 'sockaddr'. If 'address_only'
66 * is ISC_TRUE, the hash value will not depend on the port.
70 isc_sockaddr_any(isc_sockaddr_t *sockaddr);
72 * Return the IPv4 wildcard address.
76 isc_sockaddr_any6(isc_sockaddr_t *sockaddr);
78 * Return the IPv6 wildcard address.
82 isc_sockaddr_anyofpf(isc_sockaddr_t *sockaddr, int family);
84 * Set '*sockaddr' to the wildcard address of protocol family
88 * 'family' is AF_INET or AF_INET6.
92 isc_sockaddr_fromin(isc_sockaddr_t *sockaddr, const struct in_addr *ina,
95 * Construct an isc_sockaddr_t from an IPv4 address and port.
99 isc_sockaddr_fromin6(isc_sockaddr_t *sockaddr, const struct in6_addr *ina6,
102 * Construct an isc_sockaddr_t from an IPv6 address and port.
106 isc_sockaddr_v6fromin(isc_sockaddr_t *sockaddr, const struct in_addr *ina,
109 * Construct an IPv6 isc_sockaddr_t representing a mapped IPv4 address.
113 isc_sockaddr_fromnetaddr(isc_sockaddr_t *sockaddr, const isc_netaddr_t *na,
116 * Construct an isc_sockaddr_t from an isc_netaddr_t and port.
120 isc_sockaddr_pf(const isc_sockaddr_t *sockaddr);
122 * Get the protocol family of 'sockaddr'.
126 * 'sockaddr' is a valid sockaddr with an address family of AF_INET
131 * The protocol family of 'sockaddr', e.g. PF_INET or PF_INET6.
135 isc_sockaddr_setport(isc_sockaddr_t *sockaddr, in_port_t port);
137 * Set the port of 'sockaddr' to 'port'.
141 isc_sockaddr_getport(isc_sockaddr_t *sockaddr);
143 * Get the port stored in 'sockaddr'.
147 isc_sockaddr_totext(const isc_sockaddr_t *sockaddr, isc_buffer_t *target);
149 * Append a text representation of 'sockaddr' to the buffer 'target'.
150 * The text will include both the IP address (v4 or v6) and the port.
151 * The text is null terminated, but the terminating null is not
152 * part of the buffer's used region.
156 * ISC_R_NOSPACE The text or the null termination did not fit.
160 isc_sockaddr_format(isc_sockaddr_t *sa, char *array, unsigned int size);
162 * Format a human-readable representation of the socket address '*sa'
163 * into the character array 'array', which is of size 'size'.
164 * The resulting string is guaranteed to be null-terminated.
168 isc_sockaddr_ismulticast(isc_sockaddr_t *sa);
170 * Returns ISC_TRUE if the address is a multicast address
174 isc_sockaddr_isexperimental(isc_sockaddr_t *sa);
176 * Returns ISC_TRUE if the address is a experimental (CLASS E) address.
179 #define ISC_SOCKADDR_FORMATSIZE \
180 sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:XXX.XXX.XXX.XXX#YYYYY")
182 * Minimum size of array to pass to isc_sockaddr_format().
187 #endif /* ISC_SOCKADDR_H */