2 * Copyright (C) 1998-2002 Internet Software Consortium.
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM
9 * DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
10 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
11 * INTERNET SOFTWARE CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
12 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
13 * FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
14 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
15 * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18 /* $Id: sockaddr.h,v 1.39 2002/04/03 06:38:36 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.
68 * IPv6 addresses containing mapped IPv4 addresses generate the same hash
69 * value as the equivalent IPv4 address.
73 isc_sockaddr_any(isc_sockaddr_t *sockaddr);
75 * Return the IPv4 wildcard address.
79 isc_sockaddr_any6(isc_sockaddr_t *sockaddr);
81 * Return the IPv6 wildcard address.
85 isc_sockaddr_anyofpf(isc_sockaddr_t *sockaddr, int family);
87 * Set '*sockaddr' to the wildcard address of protocol family
91 * 'family' is AF_INET or AF_INET6.
95 isc_sockaddr_fromin(isc_sockaddr_t *sockaddr, const struct in_addr *ina,
98 * Construct an isc_sockaddr_t from an IPv4 address and port.
102 isc_sockaddr_fromin6(isc_sockaddr_t *sockaddr, const struct in6_addr *ina6,
105 * Construct an isc_sockaddr_t from an IPv6 address and port.
109 isc_sockaddr_v6fromin(isc_sockaddr_t *sockaddr, const struct in_addr *ina,
112 * Construct an IPv6 isc_sockaddr_t representing a mapped IPv4 address.
116 isc_sockaddr_fromnetaddr(isc_sockaddr_t *sockaddr, const isc_netaddr_t *na,
119 * Construct an isc_sockaddr_t from an isc_netaddr_t and port.
123 isc_sockaddr_pf(const isc_sockaddr_t *sockaddr);
125 * Get the protocol family of 'sockaddr'.
129 * 'sockaddr' is a valid sockaddr with an address family of AF_INET
134 * The protocol family of 'sockaddr', e.g. PF_INET or PF_INET6.
138 isc_sockaddr_setport(isc_sockaddr_t *sockaddr, in_port_t port);
140 * Set the port of 'sockaddr' to 'port'.
144 isc_sockaddr_getport(isc_sockaddr_t *sockaddr);
146 * Get the port stored in 'sockaddr'.
150 isc_sockaddr_totext(const isc_sockaddr_t *sockaddr, isc_buffer_t *target);
152 * Append a text representation of 'sockaddr' to the buffer 'target'.
153 * The text will include both the IP address (v4 or v6) and the port.
154 * The text is null terminated, but the terminating null is not
155 * part of the buffer's used region.
159 * ISC_R_NOSPACE The text or the null termination did not fit.
163 isc_sockaddr_format(const isc_sockaddr_t *sa, char *array, unsigned int size);
165 * Format a human-readable representation of the socket address '*sa'
166 * into the character array 'array', which is of size 'size'.
167 * The resulting string is guaranteed to be null-terminated.
171 isc_sockaddr_ismulticast(isc_sockaddr_t *sa);
173 * Returns ISC_TRUE if the address is a multicast address.
177 isc_sockaddr_isexperimental(isc_sockaddr_t *sa);
179 * Returns ISC_TRUE if the address is a experimental (CLASS E) address.
183 isc_sockaddr_islinklocal(isc_sockaddr_t *sa);
185 * Returns ISC_TRUE if the address is a link local addresss.
189 isc_sockaddr_issitelocal(isc_sockaddr_t *sa);
191 * Returns ISC_TRUE if the address is a sitelocal address.
194 #define ISC_SOCKADDR_FORMATSIZE \
195 sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:XXX.XXX.XXX.XXX#YYYYY")
197 * Minimum size of array to pass to isc_sockaddr_format().
202 #endif /* ISC_SOCKADDR_H */