| 1 |
#ifndef fooaddresshfoo |
| 2 |
#define fooaddresshfoo |
| 3 |
|
| 4 |
/*** |
| 5 |
This file is part of avahi. |
| 6 |
|
| 7 |
avahi is free software; you can redistribute it and/or modify it |
| 8 |
under the terms of the GNU Lesser General Public License as |
| 9 |
published by the Free Software Foundation; either version 2.1 of the |
| 10 |
License, or (at your option) any later version. |
| 11 |
|
| 12 |
avahi is distributed in the hope that it will be useful, but WITHOUT |
| 13 |
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY |
| 14 |
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General |
| 15 |
Public License for more details. |
| 16 |
|
| 17 |
You should have received a copy of the GNU Lesser General Public |
| 18 |
License along with avahi; if not, write to the Free Software |
| 19 |
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 |
| 20 |
USA. |
| 21 |
***/ |
| 22 |
|
| 23 |
/** \file address.h Definitions and functions to manipulate IP addresses. */ |
| 24 |
|
| 25 |
#include <inttypes.h> |
| 26 |
#include <sys/types.h> |
| 27 |
|
| 28 |
#include "cdecl.h" |
| 29 |
|
| 30 |
AVAHI_C_DECL_BEGIN |
| 31 |
|
| 32 |
/** Protocol family specification, takes the values AVAHI_PROTO_INET, AVAHI_PROTO_INET6, AVAHI_PROTO_UNSPEC */ |
| 33 |
typedef int AvahiProtocol; |
| 34 |
|
| 35 |
/** Numeric network interface index. Takes OS dependent values and the special constant AVAHI_IF_UNSPEC */ |
| 36 |
typedef int AvahiIfIndex; |
| 37 |
|
| 38 |
/** Values for AvahiProtocol */ |
| 39 |
enum { |
| 40 |
AVAHI_PROTO_INET = 0, /**< IPv4 */ |
| 41 |
AVAHI_PROTO_INET6 = 1, /**< IPv6 */ |
| 42 |
AVAHI_PROTO_UNSPEC = -1 /**< Unspecified/all protocol(s) */ |
| 43 |
}; |
| 44 |
|
| 45 |
/** Special values for AvahiIfIndex */ |
| 46 |
enum { |
| 47 |
AVAHI_IF_UNSPEC = -1 /**< Unspecified/all interface(s) */ |
| 48 |
}; |
| 49 |
|
| 50 |
/** Maximum size of an address in string form */ |
| 51 |
#define AVAHI_ADDRESS_STR_MAX 40 /* IPv6 Max = 4*8 + 7 + 1 for NUL */ |
| 52 |
|
| 53 |
/** Return TRUE if the specified interface index is valid */ |
| 54 |
#define AVAHI_IF_VALID(ifindex) (((ifindex) >= 0) || ((ifindex) == AVAHI_IF_UNSPEC)) |
| 55 |
|
| 56 |
/** Return TRUE if the specified protocol is valid */ |
| 57 |
#define AVAHI_PROTO_VALID(protocol) (((protocol) == AVAHI_PROTO_INET) || ((protocol) == AVAHI_PROTO_INET6) || ((protocol) == AVAHI_PROTO_UNSPEC)) |
| 58 |
|
| 59 |
/** An IPv4 address */ |
| 60 |
typedef struct AvahiIPv4Address { |
| 61 |
uint32_t address; /**< Address data in network byte order. */ |
| 62 |
} AvahiIPv4Address; |
| 63 |
|
| 64 |
/** An IPv6 address */ |
| 65 |
typedef struct AvahiIPv6Address { |
| 66 |
uint8_t address[16]; /**< Address data */ |
| 67 |
} AvahiIPv6Address; |
| 68 |
|
| 69 |
/** Protocol (address family) independent address structure */ |
| 70 |
typedef struct AvahiAddress { |
| 71 |
AvahiProtocol proto; /**< Address family */ |
| 72 |
|
| 73 |
union { |
| 74 |
AvahiIPv6Address ipv6; /**< Address when IPv6 */ |
| 75 |
AvahiIPv4Address ipv4; /**< Address when IPv4 */ |
| 76 |
uint8_t data[1]; /**< Type-independent data field */ |
| 77 |
} data; |
| 78 |
} AvahiAddress; |
| 79 |
|
| 80 |
/** @{ \name Comparison */ |
| 81 |
|
| 82 |
/** Compare two addresses. Returns 0 when equal, a negative value when a < b, a positive value when a > b. */ |
| 83 |
int avahi_address_cmp(const AvahiAddress *a, const AvahiAddress *b); |
| 84 |
|
| 85 |
/** @} */ |
| 86 |
|
| 87 |
/** @{ \name String conversion */ |
| 88 |
|
| 89 |
/** Convert the specified address *a to a human readable character string, use AVAHI_ADDRESS_STR_MAX to allocate an array of the right size */ |
| 90 |
char *avahi_address_snprint(char *ret_s, size_t length, const AvahiAddress *a); |
| 91 |
|
| 92 |
/** Convert the specified human readable character string to an |
| 93 |
* address structure. Set af to AVAHI_UNSPEC for automatic address |
| 94 |
* family detection. */ |
| 95 |
AvahiAddress *avahi_address_parse(const char *s, AvahiProtocol af, AvahiAddress *ret_addr); |
| 96 |
|
| 97 |
/** @} */ |
| 98 |
|
| 99 |
/** \cond fulldocs */ |
| 100 |
/** Generate the DNS reverse lookup name for an IPv4 or IPv6 address. */ |
| 101 |
char* avahi_reverse_lookup_name(const AvahiAddress *a, char *ret_s, size_t length); |
| 102 |
/** \endcond */ |
| 103 |
|
| 104 |
/** @{ \name Protocol/address family handling */ |
| 105 |
|
| 106 |
/** Map AVAHI_PROTO_xxx constants to Unix AF_xxx constants */ |
| 107 |
int avahi_proto_to_af(AvahiProtocol proto); |
| 108 |
|
| 109 |
/** Map Unix AF_xxx constants to AVAHI_PROTO_xxx constants */ |
| 110 |
AvahiProtocol avahi_af_to_proto(int af); |
| 111 |
|
| 112 |
/** Return a textual representation of the specified protocol number. i.e. "IPv4", "IPv6" or "UNSPEC" */ |
| 113 |
const char* avahi_proto_to_string(AvahiProtocol proto); |
| 114 |
|
| 115 |
/** @} */ |
| 116 |
|
| 117 |
AVAHI_C_DECL_END |
| 118 |
|
| 119 |
#endif |