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 <sys/socket.h>
  28 #include <inttypes.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 /** Return TRUE if the specified interface index is valid */
  53 #define AVAHI_IF_VALID(ifindex) (((ifindex) >= 0) || ((ifindex) == AVAHI_PROTO_UNSPEC))
  54
  55 /** Return TRUE if the specified protocol is valid */
  56 #define AVAHI_PROTO_VALID(protocol) (((protocol) == AVAHI_PROTO_INET) || ((protocol) == AVAHI_PROTO_INET6) || ((protocol) == AVAHI_PROTO_UNSPEC))
  57
  58 /** An IPv4 address */
  59 typedef struct {
  60     uint32_t address; /**< Address data in network byte order. */
  61 } AvahiIPv4Address;
  62
  63
  64 /** An IPv6 address */
  65 typedef struct {
  66     uint8_t address[16]; /**< Address data */
  67 } AvahiIPv6Address;
  68
  69 /** Protocol (address family) independent address structure */
  70 typedef struct {
  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 independant data field */
  77     } data;
  78 } AvahiAddress;
  79
  80 /** Return the address data size of the specified address. (4 for IPv4, 16 for IPv6) */
  81 size_t avahi_address_get_size(const AvahiAddress *a);
  82
  83 /** Compare two addresses. Returns 0 when equal, a negative value when a < b, a positive value when a > b. */
  84 int avahi_address_cmp(const AvahiAddress *a, const AvahiAddress *b);
  85
  86 /** Convert the specified address *a to a human readable character string */
  87 char *avahi_address_snprint(char *ret_s, size_t length, const AvahiAddress *a);
  88
  89 /** Convert the specifeid human readable character string to an
  90  * address structure. Set af to AVAHI_UNSPEC for automatic address
  91  * family detection. */
  92 AvahiAddress *avahi_address_parse(const char *s, AvahiProtocol af, AvahiAddress *ret_addr);
  93
  94 /** Make an address structture of a sockaddr structure */
  95 AvahiAddress *avahi_address_from_sockaddr(const struct sockaddr* sa, AvahiAddress *ret_addr);
  96
  97 /** Return the port number of a sockaddr structure (either IPv4 or IPv6) */
  98 uint16_t avahi_port_from_sockaddr(const struct sockaddr* sa);
  99
 100 /** Generate the DNS reverse lookup name for an IPv4 address. g_free() the result! */
 101 char* avahi_reverse_lookup_name_ipv4(const AvahiIPv4Address *a);
 102
 103 /** Generate the modern DNS reverse lookup name for an IPv6 address, ending in ipv6.arpa. g_free() the result! */
 104 char* avahi_reverse_lookup_name_ipv6_arpa(const AvahiIPv6Address *a);
 105
 106 /** Generate the historic DNS reverse lookup name for an IPv6 address, ending in ipv6.int. g_free() the result! */
 107 char* avahi_reverse_lookup_name_ipv6_int(const AvahiIPv6Address *a);
 108
 109 /** Check whether the specified IPv6 address is in fact an
 110  * encapsulated IPv4 address, returns 1 if yes, 0 otherwise */
 111 int avahi_address_is_ipv4_in_ipv6(const AvahiAddress *a);
 112
 113 /** Map AVAHI_PROTO_xxx constants to Unix AF_xxx constants */
 114 int avahi_proto_to_af(AvahiProtocol proto);
 115
 116 /** Map Unix AF_xxx constants to AVAHI_PROTO_xxx constants */
 117 AvahiProtocol avahi_af_to_proto(int af);
 118
 119 /** Return a textual representation of the specified protocol number. i.e. "IPv4", "IPv6" or "UNSPEC" */
 120 const char* avahi_proto_to_string(AvahiProtocol proto);
 121
 122 AVAHI_C_DECL_END
 123
 124 #endif