USA.
***/
+/** \file address.h Definitions and functions to manipulate IP addresses. */
+
#include <sys/socket.h>
#include <inttypes.h>
#include <avahi-common/cdecl.h>
-/** \file address.h Defintions and functions to manipulate IP addresses. */
-
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
AVAHI_C_DECL_BEGIN
+#endif
-/** Protocol family specification, takes the values AVAHI_INET, AVAHI_INET6, AVAHI_UNSPEC */
-typedef unsigned char AvahiProtocol;
+/** Protocol family specification, takes the values AVAHI_PROTO_INET, AVAHI_PROTO_INET6, AVAHI_PROTO_UNSPEC */
+typedef int AvahiProtocol;
/** Numeric network interface index. Takes OS dependent values and the special constant AVAHI_IF_UNSPEC */
typedef int AvahiIfIndex;
/** Values for AvahiProtocol */
enum {
- AVAHI_PROTO_INET = AF_INET, /**< IPv4 */
- AVAHI_PROTO_INET6 = AF_INET6, /**< IPv6 */
- AVAHI_PROTO_UNSPEC = AF_UNSPEC /**< Unspecified/all protocol(s) */
+ AVAHI_PROTO_INET = 0, /**< IPv4 */
+ AVAHI_PROTO_INET6 = 1, /**< IPv6 */
+ AVAHI_PROTO_UNSPEC = -1 /**< Unspecified/all protocol(s) */
};
/** Special values for AvahiIfIndex */
enum {
- AVAHI_IF_UNSPEC = -1 /**< Unspecifed/all interfaces */
+ AVAHI_IF_UNSPEC = -1 /**< Unspecified/all interface(s) */
};
+/** Return TRUE if the specified interface index is valid */
+#define AVAHI_IF_VALID(ifindex) (((ifindex) >= 0) || ((ifindex) == AVAHI_PROTO_UNSPEC))
+
+/** Return TRUE if the specified protocol is valid */
+#define AVAHI_PROTO_VALID(protocol) (((protocol) == AVAHI_PROTO_INET) || ((protocol) == AVAHI_PROTO_INET6) || ((protocol) == AVAHI_PROTO_UNSPEC))
+
/** An IPv4 address */
typedef struct {
uint32_t address; /**< Address data in network byte order. */
} AvahiIPv4Address;
+
/** An IPv6 address */
typedef struct {
uint8_t address[16]; /**< Address data */
/** Protocol (address family) independent address structure */
typedef struct {
- AvahiProtocol family; /**< Address family */
+ AvahiProtocol proto; /**< Address family */
union {
AvahiIPv6Address ipv6; /** Address when IPv6 */
/** Return the port number of a sockaddr structure (either IPv4 or IPv6) */
uint16_t avahi_port_from_sockaddr(const struct sockaddr* sa);
-/** Generate the DNS reverse lookup name for an IPv4 address. g_free() the result! */
+/** Generate the DNS reverse lookup name for an IPv4 address. avahi_free() the result! */
char* avahi_reverse_lookup_name_ipv4(const AvahiIPv4Address *a);
-/** Generate the modern DNS reverse lookup name for an IPv6 address, ending in ipv6.arpa. g_free() the result! */
+/** Generate the modern DNS reverse lookup name for an IPv6 address, ending in ipv6.arpa. avahi_free() the result! */
char* avahi_reverse_lookup_name_ipv6_arpa(const AvahiIPv6Address *a);
-/** Generate the historic DNS reverse lookup name for an IPv6 address, ending in ipv6.int. g_free() the result! */
+/** Generate the historic DNS reverse lookup name for an IPv6 address, ending in ipv6.int. avahi_free() the result! */
char* avahi_reverse_lookup_name_ipv6_int(const AvahiIPv6Address *a);
/** Check whether the specified IPv6 address is in fact an
* encapsulated IPv4 address, returns 1 if yes, 0 otherwise */
int avahi_address_is_ipv4_in_ipv6(const AvahiAddress *a);
+/** Map AVAHI_PROTO_xxx constants to Unix AF_xxx constants */
+int avahi_proto_to_af(AvahiProtocol proto);
+
+/** Map Unix AF_xxx constants to AVAHI_PROTO_xxx constants */
+AvahiProtocol avahi_af_to_proto(int af);
+
+/** Return a textual representation of the specified protocol number. i.e. "IPv4", "IPv6" or "UNSPEC" */
+const char* avahi_proto_to_string(AvahiProtocol proto);
+
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
AVAHI_C_DECL_END
+#endif
#endif