* Some minor cleanups in netlink code

[catta] / avahi-common / address.h

diff --git a/avahi-common/address.h b/avahi-common/address.h
index cc7eaa21faa71be458bb1125813e97d2cd0516c7..665c9c7dc76b56cd16772d599692cebad4e75083 100644 (file)
--- a/avahi-common/address.h
+++ b/avahi-common/address.h
@@ -29,10 +29,12 @@
 
 #include <avahi-common/cdecl.h>
 
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
 AVAHI_C_DECL_BEGIN
+#endif
 
 /** Protocol family specification, takes the values AVAHI_PROTO_INET, AVAHI_PROTO_INET6, AVAHI_PROTO_UNSPEC */
-typedef char AvahiProtocol;
+typedef int AvahiProtocol;
 
 /** Numeric network interface index. Takes OS dependent values and the special constant AVAHI_IF_UNSPEC  */
 typedef int AvahiIfIndex;
@@ -46,14 +48,21 @@ enum {
 
 /** 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 */
@@ -90,13 +99,13 @@ AvahiAddress *avahi_address_from_sockaddr(const struct sockaddr* sa, AvahiAddres
 /** 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
@@ -112,6 +121,8 @@ 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