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 check_response_ttl;           /**< If enabled the server ignores all incoming responses with IP TTL != 255 */
  80     gboolean announce_domain;              /**< Announce the local domain for browsing */
  81     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. */
  82     gboolean enable_reflector;             /**< Reflect incoming mDNS traffic to all local networks. This allows mDNS based network browsing beyond ethernet borders */
  83     gboolean ipv_reflect;                  /**< if enable_reflector is TRUE, enable/disable reflecting between IPv4 and IPv6 */
  84 } AvahiServerConfig;
  85
  86 /** Allocate a new mDNS responder object. */
  87 AvahiServer *avahi_server_new(
  88     GMainContext *c,               /**< The GLIB main loop context to attach to */
  89     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. */
  90     AvahiServerCallback callback,  /**< A callback which is called whenever the state of the server changes */
  91     gpointer userdata              /**< An opaque pointer which is passed to the callback function */);
  92
  93 /** Free an mDNS responder object */
  94 void avahi_server_free(AvahiServer* s);
  95
  96 /** Fill in default values for a server configuration structure. If you
  97  * make use of an AvahiServerConfig structure be sure to initialize
  98  * it with this function for the sake of upwards library
  99  * compatibility. This call may allocate strings on the heap. To
 100  * release this memory make sure to call
 101  * avahi_server_config_done(). If you want to replace any strings in
 102  * the structure be sure to free the strings filled in by this
 103  * function with g_free() first and allocate the replacements with
 104  * g_malloc() (or g_strdup()).*/
 105 AvahiServerConfig* avahi_server_config_init(
 106    AvahiServerConfig *c /**< A structure which shall be filled in */ );
 107
 108 /** Make a deep copy of the configuration structure *c to *ret. */
 109 AvahiServerConfig* avahi_server_config_copy(
 110     AvahiServerConfig *ret /**< destination */,
 111     const AvahiServerConfig *c /**< source */);
 112
 113 /** Free the data in a server configuration structure. */
 114 void avahi_server_config_free(AvahiServerConfig *c);
 115
 116 /** Return the currently chosen domain name of the server object. The
 117  * return value points to an internally allocated string. Be sure to
 118  * make a copy of the string before calling any other library
 119  * functions. */
 120 const gchar* avahi_server_get_domain_name(AvahiServer *s);
 121
 122 /** Return the currently chosen host name. The return value points to a internally allocated string. */
 123 const gchar* avahi_server_get_host_name(AvahiServer *s);
 124
 125 /** Return the currently chosen host name as a FQDN ("fully qualified
 126  * domain name", i.e. the concatenation of the host and domain
 127  * name). The return value points to a internally allocated string. */
 128 const gchar* avahi_server_get_host_name_fqdn(AvahiServer *s);
 129
 130 void avahi_server_set_host_name(AvahiServer *s, const gchar *host_name);
 131 void avahi_server_set_domain_name(AvahiServer *s, const gchar *domain_name);
 132
 133 gpointer avahi_server_get_data(AvahiServer *s);
 134 void avahi_server_set_data(AvahiServer *s, gpointer userdata);
 135
 136 AvahiServerState avahi_server_get_state(AvahiServer *s);
 137
 138 const AvahiRecord *avahi_server_iterate(AvahiServer *s, AvahiEntryGroup *g, void **state);
 139 void avahi_server_dump(AvahiServer *s, FILE *f);
 140
 141 AvahiEntryGroup *avahi_entry_group_new(AvahiServer *s, AvahiEntryGroupCallback callback, gpointer userdata);
 142 void avahi_entry_group_free(AvahiEntryGroup *g);
 143 void avahi_entry_group_commit(AvahiEntryGroup *g);
 144 AvahiEntryGroupState avahi_entry_group_get_state(AvahiEntryGroup *g);
 145 void avahi_entry_group_set_data(AvahiEntryGroup *g, gpointer userdata);
 146 gpointer avahi_entry_group_get_data(AvahiEntryGroup *g);
 147
 148 void avahi_server_add(
 149     AvahiServer *s,
 150     AvahiEntryGroup *g,
 151     gint interface,
 152     guchar protocol,
 153     AvahiEntryFlags flags,
 154     AvahiRecord *r);
 155
 156 void avahi_server_add_ptr(
 157     AvahiServer *s,
 158     AvahiEntryGroup *g,
 159     gint interface,
 160     guchar protocol,
 161     AvahiEntryFlags flags,
 162     const gchar *name,
 163     const gchar *dest);
 164
 165 void avahi_server_add_address(
 166     AvahiServer *s,
 167     AvahiEntryGroup *g,
 168     gint interface,
 169     guchar protocol,
 170     AvahiEntryFlags flags,
 171     const gchar *name,
 172     AvahiAddress *a);
 173
 174 void avahi_server_add_text(
 175     AvahiServer *s,
 176     AvahiEntryGroup *g,
 177     gint interface,
 178     guchar protocol,
 179     AvahiEntryFlags flags,
 180     const gchar *name,
 181     ... /* text records, terminated by NULL */);
 182
 183 void avahi_server_add_text_va(
 184     AvahiServer *s,
 185     AvahiEntryGroup *g,
 186     gint interface,
 187     guchar protocol,
 188     AvahiEntryFlags flags,
 189     const gchar *name,
 190     va_list va);
 191
 192 void avahi_server_add_text_strlst(
 193     AvahiServer *s,
 194     AvahiEntryGroup *g,
 195     gint interface,
 196     guchar protocol,
 197     AvahiEntryFlags flags,
 198     const gchar *name,
 199     AvahiStringList *strlst);
 200
 201 void avahi_server_add_service(
 202     AvahiServer *s,
 203     AvahiEntryGroup *g,
 204     gint interface,
 205     guchar protocol,
 206     const gchar *type,
 207     const gchar *name,
 208     const gchar *domain,
 209     const gchar *host,
 210     guint16 port,
 211     ...  /* text records, terminated by NULL */);
 212
 213 void avahi_server_add_service_va(
 214     AvahiServer *s,
 215     AvahiEntryGroup *g,
 216     gint interface,
 217     guchar protocol,
 218     const gchar *type,
 219     const gchar *name,
 220     const gchar *domain,
 221     const gchar *host,
 222     guint16 port,
 223     va_list va);
 224
 225 void avahi_server_add_service_strlst(
 226     AvahiServer *s,
 227     AvahiEntryGroup *g,
 228     gint interface,
 229     guchar protocol,
 230     const gchar *type,
 231     const gchar *name,
 232     const gchar *domain,
 233     const gchar *host,
 234     guint16 port,
 235     AvahiStringList *strlst);
 236
 237 typedef enum {
 238     AVAHI_BROWSER_NEW = 0,
 239     AVAHI_BROWSER_REMOVE = -1
 240 } AvahiBrowserEvent;
 241
 242 typedef enum {
 243     AVAHI_RESOLVER_FOUND = 0,
 244     AVAHI_RESOLVER_TIMEOUT = -1
 245 } AvahiResolverEvent;
 246
 247
 248 typedef struct AvahiRecordBrowser AvahiRecordBrowser;
 249 typedef void (*AvahiRecordBrowserCallback)(AvahiRecordBrowser *b, gint interface, guchar protocol, AvahiBrowserEvent event, AvahiRecord *record, gpointer userdata);
 250 AvahiRecordBrowser *avahi_record_browser_new(AvahiServer *server, gint interface, guchar protocol, AvahiKey *key, AvahiRecordBrowserCallback callback, gpointer userdata);
 251 void avahi_record_browser_free(AvahiRecordBrowser *b);
 252
 253 typedef struct AvahiHostNameResolver AvahiHostNameResolver;
 254 typedef void (*AvahiHostNameResolverCallback)(AvahiHostNameResolver *r, gint interface, guchar protocol, AvahiResolverEvent event, const gchar *host_name, const AvahiAddress *a, gpointer userdata);
 255 AvahiHostNameResolver *avahi_host_name_resolver_new(AvahiServer *server, gint interface, guchar protocol, const gchar *host_name, guchar aprotocol, AvahiHostNameResolverCallback calback, gpointer userdata);
 256 void avahi_host_name_resolver_free(AvahiHostNameResolver *r);
 257
 258 typedef struct AvahiAddressResolver AvahiAddressResolver;
 259 typedef void (*AvahiAddressResolverCallback)(AvahiAddressResolver *r, gint interface, guchar protocol, AvahiResolverEvent event, const AvahiAddress *a, const gchar *host_name, gpointer userdata);
 260 AvahiAddressResolver *avahi_address_resolver_new(AvahiServer *server, gint interface, guchar protocol, const AvahiAddress *address, AvahiAddressResolverCallback calback, gpointer userdata);
 261 void avahi_address_resolver_free(AvahiAddressResolver *r);
 262
 263 typedef enum {
 264     AVAHI_DOMAIN_BROWSER_REGISTER,
 265     AVAHI_DOMAIN_BROWSER_REGISTER_DEFAULT,
 266     AVAHI_DOMAIN_BROWSER_BROWSE,
 267     AVAHI_DOMAIN_BROWSER_BROWSE_DEFAULT
 268 } AvahiDomainBrowserType;
 269
 270 typedef struct AvahiDomainBrowser AvahiDomainBrowser;
 271 typedef void (*AvahiDomainBrowserCallback)(AvahiDomainBrowser *b, gint interface, guchar protocol, AvahiBrowserEvent event, const gchar *domain, gpointer userdata);
 272 AvahiDomainBrowser *avahi_domain_browser_new(AvahiServer *server, gint interface, guchar protocol, const gchar *domain, AvahiDomainBrowserType type, AvahiDomainBrowserCallback callback, gpointer userdata);
 273 void avahi_domain_browser_free(AvahiDomainBrowser *b);
 274
 275 typedef struct AvahiServiceTypeBrowser AvahiServiceTypeBrowser;
 276 typedef void (*AvahiServiceTypeBrowserCallback)(AvahiServiceTypeBrowser *b, gint interface, guchar protocol, AvahiBrowserEvent event, const gchar *type, const gchar *domain, gpointer userdata);
 277 AvahiServiceTypeBrowser *avahi_service_type_browser_new(AvahiServer *server, gint interface, guchar protocol, const gchar *domain, AvahiServiceTypeBrowserCallback callback, gpointer userdata);
 278 void avahi_service_type_browser_free(AvahiServiceTypeBrowser *b);
 279
 280 typedef struct AvahiServiceBrowser AvahiServiceBrowser;
 281 typedef void (*AvahiServiceBrowserCallback)(AvahiServiceBrowser *b, gint interface, guchar protocol, AvahiBrowserEvent event, const gchar *name, const gchar *type, const gchar *domain, gpointer userdata);
 282 AvahiServiceBrowser *avahi_service_browser_new(AvahiServer *server, gint interface, guchar protocol, const gchar *service_type, const gchar *domain, AvahiServiceBrowserCallback callback, gpointer userdata);
 283 void avahi_service_browser_free(AvahiServiceBrowser *b);
 284
 285 typedef struct AvahiServiceResolver AvahiServiceResolver;
 286 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);
 287 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);
 288 void avahi_service_resolver_free(AvahiServiceResolver *r);
 289
 290 #endif