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 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  33 AVAHI_C_DECL_BEGIN
  34 #endif
  35
  36 /** Protocol family specification, takes the values AVAHI_PROTO_INET, AVAHI_PROTO_INET6, AVAHI_PROTO_UNSPEC */
  37 typedef int AvahiProtocol;
  38
  39 /** Numeric network interface index. Takes OS dependent values and the special constant AVAHI_IF_UNSPEC  */
  40 typedef int AvahiIfIndex;
  41
  42 /** Values for AvahiProtocol */
  43 enum {
  44     AVAHI_PROTO_INET = 0,     /**< IPv4 */
  45     AVAHI_PROTO_INET6 = 1,   /**< IPv6 */
  46     AVAHI_PROTO_UNSPEC = -1  /**< Unspecified/all protocol(s) */
  47 };
  48
  49 /** Special values for AvahiIfIndex */
  50 enum {
  51     AVAHI_IF_UNSPEC = -1       /**< Unspecified/all interface(s) */
  52 };
  53
  54 /** Return TRUE if the specified interface index is valid */
  55 #define AVAHI_IF_VALID(ifindex) (((ifindex) >= 0) || ((ifindex) == AVAHI_PROTO_UNSPEC))
  56
  57 /** Return TRUE if the specified protocol is valid */
  58 #define AVAHI_PROTO_VALID(protocol) (((protocol) == AVAHI_PROTO_INET) || ((protocol) == AVAHI_PROTO_INET6) || ((protocol) == AVAHI_PROTO_UNSPEC))
  59
  60 /** An IPv4 address */
  61 typedef struct {
  62     uint32_t address; /**< Address data in network byte order. */
  63 } AvahiIPv4Address;
  64
  65
  66 /** An IPv6 address */
  67 typedef struct {
  68     uint8_t address[16]; /**< Address data */
  69 } AvahiIPv6Address;
  70
  71 /** Protocol (address family) independent address structure */
  72 typedef struct {
  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 independant data field */
  79     } data;
  80 } AvahiAddress;
  81
  82 /** Return the address data size of the specified address. (4 for IPv4, 16 for IPv6) */
  83 size_t avahi_address_get_size(const AvahiAddress *a);
  84
  85 /** Compare two addresses. Returns 0 when equal, a negative value when a < b, a positive value when a > b. */
  86 int avahi_address_cmp(const AvahiAddress *a, const AvahiAddress *b);
  87
  88 /** Convert the specified address *a to a human readable character string */
  89 char *avahi_address_snprint(char *ret_s, size_t length, const AvahiAddress *a);
  90
  91 /** Convert the specifeid human readable character string to an
  92  * address structure. Set af to AVAHI_UNSPEC for automatic address
  93  * family detection. */
  94 AvahiAddress *avahi_address_parse(const char *s, AvahiProtocol af, AvahiAddress *ret_addr);
  95
  96 /** Make an address structture of a sockaddr structure */
  97 AvahiAddress *avahi_address_from_sockaddr(const struct sockaddr* sa, AvahiAddress *ret_addr);
  98
  99 /** Return the port number of a sockaddr structure (either IPv4 or IPv6) */
 100 uint16_t avahi_port_from_sockaddr(const struct sockaddr* sa);
 101
 102 /** Generate the DNS reverse lookup name for an IPv4 address. avahi_free() the result! */
 103 char* avahi_reverse_lookup_name_ipv4(const AvahiIPv4Address *a);
 104
 105 /** Generate the modern DNS reverse lookup name for an IPv6 address, ending in ipv6.arpa. avahi_free() the result! */
 106 char* avahi_reverse_lookup_name_ipv6_arpa(const AvahiIPv6Address *a);
 107
 108 /** Generate the historic DNS reverse lookup name for an IPv6 address, ending in ipv6.int. avahi_free() the result! */
 109 char* avahi_reverse_lookup_name_ipv6_int(const AvahiIPv6Address *a);
 110
 111 /** Check whether the specified IPv6 address is in fact an
 112  * encapsulated IPv4 address, returns 1 if yes, 0 otherwise */
 113 int avahi_address_is_ipv4_in_ipv6(const AvahiAddress *a);
 114
 115 /** Map AVAHI_PROTO_xxx constants to Unix AF_xxx constants */
 116 int avahi_proto_to_af(AvahiProtocol proto);
 117
 118 /** Map Unix AF_xxx constants to AVAHI_PROTO_xxx constants */
 119 AvahiProtocol avahi_af_to_proto(int af);
 120
 121 /** Return a textual representation of the specified protocol number. i.e. "IPv4", "IPv6" or "UNSPEC" */
 122 const char* avahi_proto_to_string(AvahiProtocol proto);
 123
 124 #ifndef DOXYGEN_SHOULD_SKIP_THIS
 125 AVAHI_C_DECL_END
 126 #endif
 127
 128 #endif