git.meshlink.io Git - catta/blob - avahi-common/address.h

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