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

   1 #ifndef foorrhfoo
   2 #define foorrhfoo
   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 #include <glib.h>
  26
  27 #include <avahi-common/strlst.h>
  28 #include <avahi-common/address.h>
  29
  30
  31 /** DNS record types, see RFC 1035 */
  32 enum {
  33     AVAHI_DNS_TYPE_A = 0x01,
  34     AVAHI_DNS_TYPE_NS = 0x02,
  35     AVAHI_DNS_TYPE_CNAME = 0x05,
  36     AVAHI_DNS_TYPE_SOA = 0x06,
  37     AVAHI_DNS_TYPE_PTR = 0x0C,
  38     AVAHI_DNS_TYPE_HINFO = 0x0D,
  39     AVAHI_DNS_TYPE_MX = 0x0F,
  40     AVAHI_DNS_TYPE_TXT = 0x10,
  41     AVAHI_DNS_TYPE_AAAA = 0x1C,
  42     AVAHI_DNS_TYPE_SRV = 0x21,
  43     AVAHI_DNS_TYPE_ANY = 0xFF /**< Special query type for requesting all records */
  44 };
  45
  46 /** DNS record classes, see RFC 1035 */
  47 enum {
  48     AVAHI_DNS_CLASS_IN = 0x01,          /**< Probably the only class we will ever use */
  49     AVAHI_DNS_CLASS_ANY = 0xFF,         /**< Special query type for requesting all records */
  50     AVAHI_DNS_CACHE_FLUSH = 0x8000,     /**< Not really a class but a bit which may be set in response packets, see mDNS spec for more information */
  51     AVAHI_DNS_UNICAST_RESPONSE = 0x8000 /**< Not really a class but a bit which may be set in query packets, see mDNS spec for more information */
  52 };
  53
  54 /** The default TTL for RRs which contain a host name of some kind. */
  55 #define AVAHI_DEFAULT_TTL_HOST_NAME (120)
  56
  57 /** The default TTL for all other records. */
  58 #define AVAHI_DEFAULT_TTL (75*60)
  59
  60 /** Encapsulates a DNS query key consisting of class, type and
  61     name. Use avahi_key_ref()/avahi_key_unref() for manipulating the
  62     reference counter. The structure is intended to be treated as "immutable", no
  63     changes should be imposed after creation */
  64 typedef struct {
  65     guint ref;         /**< Reference counter */
  66     gchar *name;       /**< Record name */
  67     guint16 class;     /**< Record class, one of the AVAHI_DNS_CLASS_xxx constants */
  68     guint16 type;      /**< Record type, one of the AVAHI_DNS_TYPE_xxx constants */
  69 } AvahiKey;
  70
  71 /** Encapsulates a DNS resource record. The structure is intended to
  72  * be treated as "immutable", no changes should be imposed after
  73  * creation. */
  74 typedef struct  {
  75     guint ref;       /**< Reference counter */
  76     AvahiKey *key;   /**< Reference to the query key of thsi record */
  77
  78     guint32 ttl;     /**< DNS TTL of this record */
  79
  80     union {
  81
  82
  83         struct {
  84             gpointer data;
  85             guint16 size;
  86         } generic; /**< Generic record data for unknown types */
  87
  88
  89         struct {
  90             guint16 priority;
  91             guint16 weight;
  92             guint16 port;
  93             gchar *name;
  94         } srv; /**< Data for SRV records */
  95
  96         struct {
  97             gchar *name;
  98         } ptr; /**< Data for PTR an CNAME records */
  99
 100         struct {
 101             gchar *cpu;
 102             gchar *os;
 103         } hinfo; /**< Data for HINFO records */
 104
 105         struct {
 106             AvahiStringList *string_list;
 107         } txt; /**< Data for TXT records */
 108
 109         struct {
 110             AvahiIPv4Address address;
 111         } a; /**< Data for A records */
 112
 113         struct {
 114             AvahiIPv6Address address;
 115         } aaaa; /**< Data for AAAA records */
 116
 117     } data; /**< Record data */
 118
 119 } AvahiRecord;
 120
 121 /** Create a new AvahiKey object. The reference counter will be set to 1. */
 122 AvahiKey *avahi_key_new(const gchar *name, guint16 class, guint16 type);
 123
 124 /** Increase the reference counter of an AvahiKey object by one */
 125 AvahiKey *avahi_key_ref(AvahiKey *k);
 126
 127 /** Decrease the reference counter of an AvahiKey object by one */
 128 void avahi_key_unref(AvahiKey *k);
 129
 130 /** Check whether two AvahiKey object contain the same
 131  * data. AVAHI_DNS_CLASS_ANY/AVAHI_DNS_TYPE_ANY are treated like any
 132  * other class/type. */
 133 gboolean avahi_key_equal(const AvahiKey *a, const AvahiKey *b);
 134
 135 /** Match a key to a key pattern. The pattern has a type of
 136 AVAHI_DNS_CLASS_ANY, the classes are taken to be equal. Same for the
 137 type. If the pattern has neither class nor type with ANY constants,
 138 this function is identical to avahi_key_equal(). In contrast to
 139 avahi_equal() this function is not commutative. */
 140 gboolean avahi_key_pattern_match(const AvahiKey *pattern, const AvahiKey *k);
 141
 142 /** Check whether a key is a pattern key, i.e. the class/type has a
 143  * value of AVAHI_DNS_CLASS_ANY/AVAHI_DNS_TYPE_ANY */
 144 gboolean avahi_key_is_pattern(const AvahiKey *k);
 145
 146 /** Return a numeric hash value for a key for usage in hash tables. */
 147 guint avahi_key_hash(const AvahiKey *k);
 148
 149 /** Create a new record object. Record data should be filled in right after creation. The reference counter is set to 1. */
 150 AvahiRecord *avahi_record_new(AvahiKey *k, guint32 ttl);
 151
 152 /** Create a new record object. Record data should be filled in right after creation. The reference counter is set to 1. */
 153 AvahiRecord *avahi_record_new_full(const gchar *name, guint16 class, guint16 type, guint32 ttl);
 154
 155 /** Increase the reference counter of an AvahiRecord by one. */
 156 AvahiRecord *avahi_record_ref(AvahiRecord *r);
 157
 158 /** Decrease the reference counter of an AvahiRecord by one. */
 159 void avahi_record_unref(AvahiRecord *r);
 160
 161 /** Return a textual representation of the specified DNS class. The
 162  * returned pointer points to a read only internal string. */
 163 const gchar *avahi_dns_class_to_string(guint16 class);
 164
 165 /** Return a textual representation of the specified DNS class. The
 166  * returned pointer points to a read only internal string. */
 167 const gchar *avahi_dns_type_to_string(guint16 type);
 168
 169 /** Create a textual representation of the specified key. g_free() the
 170  * result! */
 171 gchar *avahi_key_to_string(const AvahiKey *k);
 172
 173 /** Create a textual representation of the specified record, similar
 174  * in style to BIND zone file data. g_free() the result! */
 175 gchar *avahi_record_to_string(const AvahiRecord *r);
 176
 177 /** Check whether two records are equal (regardless of the TTL */
 178 gboolean avahi_record_equal_no_ttl(const AvahiRecord *a, const AvahiRecord *b);
 179
 180 /** Make a deep copy of an AvahiRecord object */
 181 AvahiRecord *avahi_record_copy(AvahiRecord *r);
 182
 183 /** Returns a maximum estimate for the space that is needed to store
 184  * this key in a DNS packet. */
 185 guint avahi_key_get_estimate_size(AvahiKey *k);
 186
 187 /** Returns a maximum estimate for the space that is needed to store
 188  * the record in a DNS packet. */
 189 guint avahi_record_get_estimate_size(AvahiRecord *r);
 190
 191 /** Do a mDNS spec conforming lexicographical comparison of the two
 192  * records. Return a negative value if a < b, a positive if a > b,
 193  * zero if equal. */
 194 gint avahi_record_lexicographical_compare(AvahiRecord *a, AvahiRecord *b);
 195
 196 /** Return TRUE if the specified record is an mDNS goodbye record. i.e. TTL is zero. */
 197 gboolean avahi_record_is_goodbye(AvahiRecord *r);
 198
 199 #endif