gnore some more files

[catta] / avahi-common / address.h

diff --git a/avahi-common/address.h b/avahi-common/address.h
index 60495a327c71ab1c594e6c09e8c539f565c13332..f1ac42859f06d98494dd7398c48b64800a9953c0 100644 (file)
--- a/avahi-common/address.h
+++ b/avahi-common/address.h
@@ -29,31 +29,43 @@
 
 #include <avahi-common/cdecl.h>
 
+#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) */
 };
 
+/** Maximum size of an address in string form */
+#define AVAHI_ADDRESS_STR_MAX 40 /* IPv6 Max = 4*8 + 7 + 1 for NUL */
+
+/** 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 */
@@ -61,7 +73,7 @@ typedef struct {
 
 /** Protocol (address family) independent address structure */
 typedef struct {
-    AvahiProtocol family; /**< Address family */
+    AvahiProtocol proto; /**< Address family */
 
     union {
         AvahiIPv6Address ipv6;  /** Address when IPv6 */
@@ -76,7 +88,7 @@ size_t avahi_address_get_size(const AvahiAddress *a);
 /** Compare two addresses. Returns 0 when equal, a negative value when a < b, a positive value when a > b. */
 int avahi_address_cmp(const AvahiAddress *a, const AvahiAddress *b);
 
-/** Convert the specified address *a to a human readable character string */
+/** Convert the specified address *a to a human readable character string, use AVAHI_ADDRESS_STR_MAX to allocate an array of the right size */
 char *avahi_address_snprint(char *ret_s, size_t length, const AvahiAddress *a);
 
 /** Convert the specifeid human readable character string to an
@@ -90,19 +102,27 @@ 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! */
-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! */
-char* avahi_reverse_lookup_name_ipv6_int(const AvahiIPv6Address *a);
+/** 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(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