git.meshlink.io Git - catta/blob - avahi-core/core.h

   1 #ifndef foocorehfoo
   2 #define foocorehfoo
   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 <stdio.h>
  26 #include <glib.h>
  27
  28 /** An mDNS responder object */
  29 typedef struct AvahiServer AvahiServer;
  30
  31 /** A locally registered DNS resource record */
  32 typedef struct AvahiEntry AvahiEntry;
  33
  34 /** A group of locally registered DNS RRs */
  35 typedef struct AvahiEntryGroup AvahiEntryGroup;
  36
  37 #include <avahi-core/address.h>
  38 #include <avahi-core/rr.h>
  39
  40 /** States of a server object */
  41 typedef enum {
  42     AVAHI_SERVER_INVALID = -1,     /**< Invalid state (initial) */
  43     AVAHI_SERVER_REGISTERING = 0,  /**< Host RRs are being registered */
  44     AVAHI_SERVER_RUNNING,          /**< All host RRs have been established */
  45     AVAHI_SERVER_COLLISION,        /**< There is a collision with a host RR. All host RRs have been withdrawn, the user should set a new host name via avahi_server_set_host_name() */
  46     AVAHI_SERVER_SLEEPING          /**< The host or domain name has changed and the server waits for old entries to be expired */
  47 } AvahiServerState;
  48
  49 /** Flags for server entries */
  50 typedef enum {
  51     AVAHI_ENTRY_NULL = 0,          /**< No special flags */
  52     AVAHI_ENTRY_UNIQUE = 1,        /**< The RRset is intended to be unique */
  53     AVAHI_ENTRY_NOPROBE = 2,       /**< Though the RRset is intended to be unique no probes shall be sent */
  54     AVAHI_ENTRY_NOANNOUNCE = 4     /**< Do not announce this RR to other hosts */
  55 } AvahiEntryFlags;
  56
  57 /** States of an entry group object */
  58 typedef enum {
  59     AVAHI_ENTRY_GROUP_UNCOMMITED = -1,   /**< The group has not yet been commited, the user must still call avahi_entry_group_commit() */
  60     AVAHI_ENTRY_GROUP_REGISTERING = 0,   /**< The entries of the group are currently being registered */
  61     AVAHI_ENTRY_GROUP_ESTABLISHED,       /**< The entries have successfully been established */
  62     AVAHI_ENTRY_GROUP_COLLISION          /**< A name collision for one of the entries in the group has been detected, the entries have been withdrawn */
  63 } AvahiEntryGroupState;
  64
  65 /** Prototype for callback functions which are called whenever the state of an AvahiServer object changes */
  66 typedef void (*AvahiServerCallback) (AvahiServer *s, AvahiServerState state, gpointer userdata);
  67
  68 /** Prototype for callback functions which are called whenever the state of an AvahiEntryGroup object changes */
  69 typedef void (*AvahiEntryGroupCallback) (AvahiServer *s, AvahiEntryGroup *g, AvahiEntryGroupState state, gpointer userdata);
  70
  71 /** Stores configuration options for a server instance */
  72 typedef struct AvahiServerConfig {
  73     gchar *host_name;                      /**< Default host name. If left empty defaults to the result of gethostname(2) of the libc */
  74     gchar *domain_name;                    /**< Default domain name. If left empty defaults to .local */
  75     gboolean use_ipv4;                     /**< Enable IPv4 support */
  76     gboolean use_ipv6;                     /**< Enable IPv6 support */
  77     gboolean register_hinfo;               /**< Register a HINFO record for the host containing the local OS and CPU type */
  78     gboolean register_addresses;           /**< Register A, AAAA and PTR records for all local IP addresses */
  79     gboolean register_workstation;         /**< Register a _workstation._tcp service */
  80     gboolean check_response_ttl;           /**< If enabled the server ignores all incoming responses with IP TTL != 255 */
  81     gboolean announce_domain;              /**< Announce the local domain for browsing */
  82     gboolean use_iff_running;              /**< Require IFF_RUNNING on local network interfaces. This is the official way to check for link beat. Unfortunately this doesn't work with all drivers. So bettere leave this off. */
  83     gboolean enable_reflector;             /**< Reflect incoming mDNS traffic to all local networks. This allows mDNS based network browsing beyond ethernet borders */
  84     gboolean ipv_reflect;                  /**< if enable_reflector is TRUE, enable/disable reflecting between IPv4 and IPv6 */
  85 } AvahiServerConfig;
  86
  87 /** Allocate a new mDNS responder object. */
  88 AvahiServer *avahi_server_new(
  89     GMainContext *c,               /**< The GLIB main loop context to attach to */
  90     const AvahiServerConfig *sc,   /**< If non-NULL a pointer to a configuration structure for the server. The server makes an internal deep copy of this structure, so you may free it using avahi_server_config_done() immediately after calling this function. */
  91     AvahiServerCallback callback,  /**< A callback which is called whenever the state of the server changes */
  92     gpointer userdata              /**< An opaque pointer which is passed to the callback function */);
  93
  94 /** Free an mDNS responder object */
  95 void avahi_server_free(AvahiServer* s);
  96
  97 /** Fill in default values for a server configuration structure. If you
  98  * make use of an AvahiServerConfig structure be sure to initialize
  99  * it with this function for the sake of upwards library
 100  * compatibility. This call may allocate strings on the heap. To
 101  * release this memory make sure to call
 102  * avahi_server_config_done(). If you want to replace any strings in
 103  * the structure be sure to free the strings filled in by this
 104  * function with g_free() first and allocate the replacements with
 105  * g_malloc() (or g_strdup()).*/
 106 AvahiServerConfig* avahi_server_config_init(
 107    AvahiServerConfig *c /**< A structure which shall be filled in */ );
 108
 109 /** Make a deep copy of the configuration structure *c to *ret. */
 110 AvahiServerConfig* avahi_server_config_copy(
 111     AvahiServerConfig *ret /**< destination */,
 112     const AvahiServerConfig *c /**< source */);
 113
 114 /** Free the data in a server configuration structure. */
 115 void avahi_server_config_free(AvahiServerConfig *c);
 116
 117 /** Return the currently chosen domain name of the server object. The
 118  * return value points to an internally allocated string. Be sure to
 119  * make a copy of the string before calling any other library
 120  * functions. */
 121 const gchar* avahi_server_get_domain_name(AvahiServer *s);
 122
 123 /** Return the currently chosen host name. The return value points to a internally allocated string. */
 124 const gchar* avahi_server_get_host_name(AvahiServer *s);
 125
 126 /** Return the currently chosen host name as a FQDN ("fully qualified
 127  * domain name", i.e. the concatenation of the host and domain
 128  * name). The return value points to a internally allocated string. */
 129 const gchar* avahi_server_get_host_name_fqdn(AvahiServer *s);
 130
 131 /** Change the host name of a running mDNS responder. This will drop
 132 all automicatilly generated RRs and readd them with the new
 133 name. Since the responder has to probe for the new RRs this function
 134 takes some time to take effect altough it returns immediately. This
 135 function is intended to be called when a host name conflict is
 136 reported using AvahiServerCallback. The caller should readd all user
 137 defined RRs too since they otherwise continue to point to the outdated
 138 host name..*/
 139 gint avahi_server_set_host_name(AvahiServer *s, const gchar *host_name);
 140
 141 /** Change the domain name of a running mDNS responder. The same rules
 142  * as with avahi_server_set_host_name() apply. */
 143 gint avahi_server_set_domain_name(AvahiServer *s, const gchar *domain_name);
 144
 145 /** Return the opaque user data pointer attached to a server object */
 146 gpointer avahi_server_get_data(AvahiServer *s);
 147
 148 /** Change the opaque user data pointer attached to a server object */
 149 void avahi_server_set_data(AvahiServer *s, gpointer userdata);
 150
 151 /** Return the current state of the server object */
 152 AvahiServerState avahi_server_get_state(AvahiServer *s);
 153
 154 /** Iterate through all local entries of the server. (when g is NULL)
 155  * or of a specified entry group. At the first call state should point
 156  * to a NULL initialized void pointer, That pointer is used to track
 157  * the current iteration. It is not safe to call any other
 158  * avahi_server_xxx() function during the iteration. If the last entry
 159  * has been read, NULL is returned. */
 160 const AvahiRecord *avahi_server_iterate(AvahiServer *s, AvahiEntryGroup *g, void **state);
 161
 162 /** Dump the current server status to the specified FILE object */
 163 void avahi_server_dump(AvahiServer *s, FILE *f);
 164
 165 /** Create a new entry group. The specified callback function is
 166  * called whenever the state of the group changes. Use entry group
 167  * objects to keep track of you RRs. Add new RRs to a group using
 168  * avahi_server_add_xxx(). Make sure to call avahi_entry_group_commit()
 169  * to start the registration process for your RRs */
 170 AvahiEntryGroup *avahi_entry_group_new(AvahiServer *s, AvahiEntryGroupCallback callback, gpointer userdata);
 171
 172 /** Free an entry group. All RRs assigned to the group are removed from the server */
 173 void avahi_entry_group_free(AvahiEntryGroup *g);
 174
 175 /** Commit an entry group. This starts the probing and registration process for all RRs in the group */
 176 gint avahi_entry_group_commit(AvahiEntryGroup *g);
 177
 178 /** Return the current state of the specified entry group */
 179 AvahiEntryGroupState avahi_entry_group_get_state(AvahiEntryGroup *g);
 180
 181 /** Change the opaque user data pointer attached to an entry group object */
 182 void avahi_entry_group_set_data(AvahiEntryGroup *g, gpointer userdata);
 183
 184 /** Return the opaque user data pointer currently set for the entry group object */
 185 gpointer avahi_entry_group_get_data(AvahiEntryGroup *g);
 186
 187 gint avahi_server_add(
 188     AvahiServer *s,
 189     AvahiEntryGroup *g,
 190     gint interface,
 191     guchar protocol,
 192     AvahiEntryFlags flags,
 193     AvahiRecord *r);
 194
 195 gint avahi_server_add_ptr(
 196     AvahiServer *s,
 197     AvahiEntryGroup *g,
 198     gint interface,
 199     guchar protocol,
 200     AvahiEntryFlags flags,
 201     const gchar *name,
 202     const gchar *dest);
 203
 204 gint avahi_server_add_address(
 205     AvahiServer *s,
 206     AvahiEntryGroup *g,
 207     gint interface,
 208     guchar protocol,
 209     AvahiEntryFlags flags,
 210     const gchar *name,
 211     AvahiAddress *a);
 212
 213 gint avahi_server_add_text(
 214     AvahiServer *s,
 215     AvahiEntryGroup *g,
 216     gint interface,
 217     guchar protocol,
 218     AvahiEntryFlags flags,
 219     const gchar *name,
 220     ... /* text records, terminated by NULL */);
 221
 222 gint avahi_server_add_text_va(
 223     AvahiServer *s,
 224     AvahiEntryGroup *g,
 225     gint interface,
 226     guchar protocol,
 227     AvahiEntryFlags flags,
 228     const gchar *name,
 229     va_list va);
 230
 231 gint avahi_server_add_text_strlst(
 232     AvahiServer *s,
 233     AvahiEntryGroup *g,
 234     gint interface,
 235     guchar protocol,
 236     AvahiEntryFlags flags,
 237     const gchar *name,
 238     AvahiStringList *strlst);
 239
 240 gint avahi_server_add_service(
 241     AvahiServer *s,
 242     AvahiEntryGroup *g,
 243     gint interface,
 244     guchar protocol,
 245     const gchar *type,
 246     const gchar *name,
 247     const gchar *domain,
 248     const gchar *host,
 249     guint16 port,
 250     ...  /* text records, terminated by NULL */);
 251
 252 gint avahi_server_add_service_va(
 253     AvahiServer *s,
 254     AvahiEntryGroup *g,
 255     gint interface,
 256     guchar protocol,
 257     const gchar *type,
 258     const gchar *name,
 259     const gchar *domain,
 260     const gchar *host,
 261     guint16 port,
 262     va_list va);
 263
 264 gint avahi_server_add_service_strlst(
 265     AvahiServer *s,
 266     AvahiEntryGroup *g,
 267     gint interface,
 268     guchar protocol,
 269     const gchar *type,
 270     const gchar *name,
 271     const gchar *domain,
 272     const gchar *host,
 273     guint16 port,
 274     AvahiStringList *strlst);
 275
 276 typedef enum {
 277     AVAHI_BROWSER_NEW = 0,
 278     AVAHI_BROWSER_REMOVE = -1
 279 } AvahiBrowserEvent;
 280
 281 typedef enum {
 282     AVAHI_RESOLVER_FOUND = 0,
 283     AVAHI_RESOLVER_TIMEOUT = -1
 284 } AvahiResolverEvent;
 285
 286
 287 typedef struct AvahiRecordBrowser AvahiRecordBrowser;
 288 typedef void (*AvahiRecordBrowserCallback)(AvahiRecordBrowser *b, gint interface, guchar protocol, AvahiBrowserEvent event, AvahiRecord *record, gpointer userdata);
 289 AvahiRecordBrowser *avahi_record_browser_new(AvahiServer *server, gint interface, guchar protocol, AvahiKey *key, AvahiRecordBrowserCallback callback, gpointer userdata);
 290 void avahi_record_browser_free(AvahiRecordBrowser *b);
 291
 292 typedef struct AvahiHostNameResolver AvahiHostNameResolver;
 293 typedef void (*AvahiHostNameResolverCallback)(AvahiHostNameResolver *r, gint interface, guchar protocol, AvahiResolverEvent event, const gchar *host_name, const AvahiAddress *a, gpointer userdata);
 294 AvahiHostNameResolver *avahi_host_name_resolver_new(AvahiServer *server, gint interface, guchar protocol, const gchar *host_name, guchar aprotocol, AvahiHostNameResolverCallback calback, gpointer userdata);
 295 void avahi_host_name_resolver_free(AvahiHostNameResolver *r);
 296
 297 typedef struct AvahiAddressResolver AvahiAddressResolver;
 298 typedef void (*AvahiAddressResolverCallback)(AvahiAddressResolver *r, gint interface, guchar protocol, AvahiResolverEvent event, const AvahiAddress *a, const gchar *host_name, gpointer userdata);
 299 AvahiAddressResolver *avahi_address_resolver_new(AvahiServer *server, gint interface, guchar protocol, const AvahiAddress *address, AvahiAddressResolverCallback calback, gpointer userdata);
 300 void avahi_address_resolver_free(AvahiAddressResolver *r);
 301
 302 /** The type of domain to browse for */
 303 typedef enum {
 304     AVAHI_DOMAIN_BROWSER_REGISTER,          /**< Browse for a list of available registering domains */
 305     AVAHI_DOMAIN_BROWSER_REGISTER_DEFAULT,  /**< Browse for the default registering domain */
 306     AVAHI_DOMAIN_BROWSER_BROWSE,            /**< Browse for a list of available browsing domains */
 307     AVAHI_DOMAIN_BROWSER_BROWSE_DEFAULT     /**< Browse for the default browsing domain */
 308 } AvahiDomainBrowserType;
 309
 310 typedef struct AvahiDomainBrowser AvahiDomainBrowser;
 311 typedef void (*AvahiDomainBrowserCallback)(AvahiDomainBrowser *b, gint interface, guchar protocol, AvahiBrowserEvent event, const gchar *domain, gpointer userdata);
 312 AvahiDomainBrowser *avahi_domain_browser_new(AvahiServer *server, gint interface, guchar protocol, const gchar *domain, AvahiDomainBrowserType type, AvahiDomainBrowserCallback callback, gpointer userdata);
 313 void avahi_domain_browser_free(AvahiDomainBrowser *b);
 314
 315 typedef struct AvahiServiceTypeBrowser AvahiServiceTypeBrowser;
 316 typedef void (*AvahiServiceTypeBrowserCallback)(AvahiServiceTypeBrowser *b, gint interface, guchar protocol, AvahiBrowserEvent event, const gchar *type, const gchar *domain, gpointer userdata);
 317 AvahiServiceTypeBrowser *avahi_service_type_browser_new(AvahiServer *server, gint interface, guchar protocol, const gchar *domain, AvahiServiceTypeBrowserCallback callback, gpointer userdata);
 318 void avahi_service_type_browser_free(AvahiServiceTypeBrowser *b);
 319
 320 typedef struct AvahiServiceBrowser AvahiServiceBrowser;
 321 typedef void (*AvahiServiceBrowserCallback)(AvahiServiceBrowser *b, gint interface, guchar protocol, AvahiBrowserEvent event, const gchar *name, const gchar *type, const gchar *domain, gpointer userdata);
 322 AvahiServiceBrowser *avahi_service_browser_new(AvahiServer *server, gint interface, guchar protocol, const gchar *service_type, const gchar *domain, AvahiServiceBrowserCallback callback, gpointer userdata);
 323 void avahi_service_browser_free(AvahiServiceBrowser *b);
 324
 325 typedef struct AvahiServiceResolver AvahiServiceResolver;
 326 typedef void (*AvahiServiceResolverCallback)(AvahiServiceResolver *r, gint interface, guchar protocol, AvahiResolverEvent event, const gchar *name, const gchar *type, const gchar *domain, const gchar *host_name, const AvahiAddress *a, guint16 port, AvahiStringList *txt, gpointer userdata);
 327 AvahiServiceResolver *avahi_service_resolver_new(AvahiServer *server, gint interface, guchar protocol, const gchar *name, const gchar *type, const gchar *domain, guchar aprotocol, AvahiServiceResolverCallback calback, gpointer userdata);
 328 void avahi_service_resolver_free(AvahiServiceResolver *r);
 329
 330 #endif