/** A group of locally registered DNS RRs */
typedef struct AvahiEntryGroup AvahiEntryGroup;
-#include <avahi-core/address.h>
-#include <avahi-core/rr.h>
+#include <avahi-common/address.h>
+#include <avahi-common/rr.h>
+#include <avahi-common/alternative.h>
/** States of a server object */
typedef enum {
AVAHI_ENTRY_NULL = 0, /**< No special flags */
AVAHI_ENTRY_UNIQUE = 1, /**< The RRset is intended to be unique */
AVAHI_ENTRY_NOPROBE = 2, /**< Though the RRset is intended to be unique no probes shall be sent */
- AVAHI_ENTRY_NOANNOUNCE = 4 /**< Do not announce this RR to other hosts */
+ AVAHI_ENTRY_NOANNOUNCE = 4, /**< Do not announce this RR to other hosts */
+ AVAHI_ENTRY_ALLOWMUTIPLE = 8 /**< Allow multiple local records of this type, even if they are intended to be unique */
} AvahiEntryFlags;
/** States of an entry group object */
gchar *domain_name; /**< Default domain name. If left empty defaults to .local */
gboolean use_ipv4; /**< Enable IPv4 support */
gboolean use_ipv6; /**< Enable IPv6 support */
- gboolean register_hinfo; /**< Register a HINFO record for the host containing the local OS and CPU type */
- gboolean register_addresses; /**< Register A, AAAA and PTR records for all local IP addresses */
+ gboolean publish_hinfo; /**< Register a HINFO record for the host containing the local OS and CPU type */
+ gboolean publish_addresses; /**< Register A, AAAA and PTR records for all local IP addresses */
+ gboolean publish_workstation; /**< Register a _workstation._tcp service */
+ gboolean publish_domain; /**< Announce the local domain for browsing */
gboolean check_response_ttl; /**< If enabled the server ignores all incoming responses with IP TTL != 255 */
- gboolean announce_domain; /**< Announce the local domain for browsing */
- 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. */
+ 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. */
+ gboolean enable_reflector; /**< Reflect incoming mDNS traffic to all local networks. This allows mDNS based network browsing beyond ethernet borders */
+ gboolean reflect_ipv; /**< if enable_reflector is TRUE, enable/disable reflecting between IPv4 and IPv6 */
} AvahiServerConfig;
/** Allocate a new mDNS responder object. */
AvahiServer *avahi_server_new(
GMainContext *c, /**< The GLIB main loop context to attach to */
- const AvahiServerConfig *sc, /**< If non-NULL a pointer to a configuration structure for the server */
+ 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. */
AvahiServerCallback callback, /**< A callback which is called whenever the state of the server changes */
gpointer userdata /**< An opaque pointer which is passed to the callback function */);
/** Free an mDNS responder object */
void avahi_server_free(AvahiServer* s);
-AvahiServerConfig* avahi_server_config_init(AvahiServerConfig *c);
-AvahiServerConfig* avahi_server_config_copy(AvahiServerConfig *ret, const AvahiServerConfig *c);
+/** Fill in default values for a server configuration structure. If you
+ * make use of an AvahiServerConfig structure be sure to initialize
+ * it with this function for the sake of upwards library
+ * compatibility. This call may allocate strings on the heap. To
+ * release this memory make sure to call
+ * avahi_server_config_done(). If you want to replace any strings in
+ * the structure be sure to free the strings filled in by this
+ * function with g_free() first and allocate the replacements with
+ * g_malloc() (or g_strdup()).*/
+AvahiServerConfig* avahi_server_config_init(
+ AvahiServerConfig *c /**< A structure which shall be filled in */ );
+
+/** Make a deep copy of the configuration structure *c to *ret. */
+AvahiServerConfig* avahi_server_config_copy(
+ AvahiServerConfig *ret /**< destination */,
+ const AvahiServerConfig *c /**< source */);
+
+/** Free the data in a server configuration structure. */
void avahi_server_config_free(AvahiServerConfig *c);
-
+
+/** Return the currently chosen domain name of the server object. The
+ * return value points to an internally allocated string. Be sure to
+ * make a copy of the string before calling any other library
+ * functions. */
const gchar* avahi_server_get_domain_name(AvahiServer *s);
+
+/** Return the currently chosen host name. The return value points to a internally allocated string. */
const gchar* avahi_server_get_host_name(AvahiServer *s);
-const gchar* avahi_server_get_host_name_fqdn(AvahiServer *s);
-void avahi_server_set_host_name(AvahiServer *s, const gchar *host_name);
-void avahi_server_set_domain_name(AvahiServer *s, const gchar *domain_name);
+/** Return the currently chosen host name as a FQDN ("fully qualified
+ * domain name", i.e. the concatenation of the host and domain
+ * name). The return value points to a internally allocated string. */
+const gchar* avahi_server_get_host_name_fqdn(AvahiServer *s);
+/** Change the host name of a running mDNS responder. This will drop
+all automicatilly generated RRs and readd them with the new
+name. Since the responder has to probe for the new RRs this function
+takes some time to take effect altough it returns immediately. This
+function is intended to be called when a host name conflict is
+reported using AvahiServerCallback. The caller should readd all user
+defined RRs too since they otherwise continue to point to the outdated
+host name..*/
+gint avahi_server_set_host_name(AvahiServer *s, const gchar *host_name);
+
+/** Change the domain name of a running mDNS responder. The same rules
+ * as with avahi_server_set_host_name() apply. */
+gint avahi_server_set_domain_name(AvahiServer *s, const gchar *domain_name);
+
+/** Return the opaque user data pointer attached to a server object */
gpointer avahi_server_get_data(AvahiServer *s);
+
+/** Change the opaque user data pointer attached to a server object */
void avahi_server_set_data(AvahiServer *s, gpointer userdata);
+/** Return the current state of the server object */
AvahiServerState avahi_server_get_state(AvahiServer *s);
+/** Iterate through all local entries of the server. (when g is NULL)
+ * or of a specified entry group. At the first call state should point
+ * to a NULL initialized void pointer, That pointer is used to track
+ * the current iteration. It is not safe to call any other
+ * avahi_server_xxx() function during the iteration. If the last entry
+ * has been read, NULL is returned. */
const AvahiRecord *avahi_server_iterate(AvahiServer *s, AvahiEntryGroup *g, void **state);
+
+/** Dump the current server status to the specified FILE object */
void avahi_server_dump(AvahiServer *s, FILE *f);
+/** Create a new entry group. The specified callback function is
+ * called whenever the state of the group changes. Use entry group
+ * objects to keep track of you RRs. Add new RRs to a group using
+ * avahi_server_add_xxx(). Make sure to call avahi_entry_group_commit()
+ * to start the registration process for your RRs */
AvahiEntryGroup *avahi_entry_group_new(AvahiServer *s, AvahiEntryGroupCallback callback, gpointer userdata);
+
+/** Free an entry group. All RRs assigned to the group are removed from the server */
void avahi_entry_group_free(AvahiEntryGroup *g);
-void avahi_entry_group_commit(AvahiEntryGroup *g);
+
+/** Commit an entry group. This starts the probing and registration process for all RRs in the group */
+gint avahi_entry_group_commit(AvahiEntryGroup *g);
+
+/** Return the current state of the specified entry group */
AvahiEntryGroupState avahi_entry_group_get_state(AvahiEntryGroup *g);
+
+/** Change the opaque user data pointer attached to an entry group object */
void avahi_entry_group_set_data(AvahiEntryGroup *g, gpointer userdata);
+
+/** Return the opaque user data pointer currently set for the entry group object */
gpointer avahi_entry_group_get_data(AvahiEntryGroup *g);
-void avahi_server_add(
+gint avahi_server_add(
AvahiServer *s,
AvahiEntryGroup *g,
gint interface,
AvahiEntryFlags flags,
AvahiRecord *r);
-void avahi_server_add_ptr(
+gint avahi_server_add_ptr(
AvahiServer *s,
AvahiEntryGroup *g,
gint interface,
const gchar *name,
const gchar *dest);
-void avahi_server_add_address(
+gint avahi_server_add_address(
AvahiServer *s,
AvahiEntryGroup *g,
gint interface,
const gchar *name,
AvahiAddress *a);
-void avahi_server_add_text(
+gint avahi_server_add_text(
AvahiServer *s,
AvahiEntryGroup *g,
gint interface,
const gchar *name,
... /* text records, terminated by NULL */);
-void avahi_server_add_text_va(
+gint avahi_server_add_text_va(
AvahiServer *s,
AvahiEntryGroup *g,
gint interface,
const gchar *name,
va_list va);
-void avahi_server_add_text_strlst(
+gint avahi_server_add_text_strlst(
AvahiServer *s,
AvahiEntryGroup *g,
gint interface,
const gchar *name,
AvahiStringList *strlst);
-void avahi_server_add_service(
+gint avahi_server_add_service(
AvahiServer *s,
AvahiEntryGroup *g,
gint interface,
guint16 port,
... /* text records, terminated by NULL */);
-void avahi_server_add_service_va(
+gint avahi_server_add_service_va(
AvahiServer *s,
AvahiEntryGroup *g,
gint interface,
guint16 port,
va_list va);
-void avahi_server_add_service_strlst(
+gint avahi_server_add_service_strlst(
AvahiServer *s,
AvahiEntryGroup *g,
gint interface,
guint16 port,
AvahiStringList *strlst);
+/** The type of DNS server */
+typedef enum {
+ AVAHI_DNS_SERVER_RESOLVE, /**< Unicast DNS servers for normal resolves (_domain._udp)*/
+ AVAHI_DNS_SERVER_UPDATE /**< Unicast DNS servers for updates (_dns-update._udp)*/
+} AvahiDNSServerType;
+
+/** Publish the specified unicast DNS server address via mDNS. You may
+ * browse for records create this way wit
+ * avahi_dns_server_browser_new(). */
+gint avahi_server_add_dns_server_address(
+ AvahiServer *s,
+ AvahiEntryGroup *g,
+ gint interface,
+ guchar protocol,
+ const gchar *domain,
+ AvahiDNSServerType type,
+ const AvahiAddress *address,
+ guint16 port /** should be 53 */);
+
+/** Similar to avahi_server_add_dns_server_address(), but specify a
+host name instead of an address. The specified host name should be
+resolvable via mDNS */
+gint avahi_server_add_dns_server_name(
+ AvahiServer *s,
+ AvahiEntryGroup *g,
+ gint interface,
+ guchar protocol,
+ const gchar *domain,
+ AvahiDNSServerType type,
+ const gchar *name,
+ guint16 port /** should be 53 */);
+
typedef enum {
AVAHI_BROWSER_NEW = 0,
AVAHI_BROWSER_REMOVE = -1
AvahiAddressResolver *avahi_address_resolver_new(AvahiServer *server, gint interface, guchar protocol, const AvahiAddress *address, AvahiAddressResolverCallback calback, gpointer userdata);
void avahi_address_resolver_free(AvahiAddressResolver *r);
+/** The type of domain to browse for */
typedef enum {
- AVAHI_DOMAIN_BROWSER_REGISTER,
- AVAHI_DOMAIN_BROWSER_REGISTER_DEFAULT,
- AVAHI_DOMAIN_BROWSER_BROWSE,
- AVAHI_DOMAIN_BROWSER_BROWSE_DEFAULT
+ AVAHI_DOMAIN_BROWSER_REGISTER, /**< Browse for a list of available registering domains */
+ AVAHI_DOMAIN_BROWSER_REGISTER_DEFAULT, /**< Browse for the default registering domain */
+ AVAHI_DOMAIN_BROWSER_BROWSE, /**< Browse for a list of available browsing domains */
+ AVAHI_DOMAIN_BROWSER_BROWSE_DEFAULT, /**< Browse for the default browsing domain */
+ AVAHI_DOMAIN_BROWSER_BROWSE_LEGACY /**< Legacy browse domain - see DNS-SD spec for more information */
} AvahiDomainBrowserType;
typedef struct AvahiDomainBrowser AvahiDomainBrowser;
AvahiDomainBrowser *avahi_domain_browser_new(AvahiServer *server, gint interface, guchar protocol, const gchar *domain, AvahiDomainBrowserType type, AvahiDomainBrowserCallback callback, gpointer userdata);
void avahi_domain_browser_free(AvahiDomainBrowser *b);
-/* not yet implemented */
typedef struct AvahiServiceTypeBrowser AvahiServiceTypeBrowser;
+typedef void (*AvahiServiceTypeBrowserCallback)(AvahiServiceTypeBrowser *b, gint interface, guchar protocol, AvahiBrowserEvent event, const gchar *type, const gchar *domain, gpointer userdata);
+AvahiServiceTypeBrowser *avahi_service_type_browser_new(AvahiServer *server, gint interface, guchar protocol, const gchar *domain, AvahiServiceTypeBrowserCallback callback, gpointer userdata);
+void avahi_service_type_browser_free(AvahiServiceTypeBrowser *b);
+
typedef struct AvahiServiceBrowser AvahiServiceBrowser;
+typedef void (*AvahiServiceBrowserCallback)(AvahiServiceBrowser *b, gint interface, guchar protocol, AvahiBrowserEvent event, const gchar *name, const gchar *type, const gchar *domain, gpointer userdata);
+AvahiServiceBrowser *avahi_service_browser_new(AvahiServer *server, gint interface, guchar protocol, const gchar *service_type, const gchar *domain, AvahiServiceBrowserCallback callback, gpointer userdata);
+void avahi_service_browser_free(AvahiServiceBrowser *b);
+
typedef struct AvahiServiceResolver AvahiServiceResolver;
+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);
+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);
+void avahi_service_resolver_free(AvahiServiceResolver *r);
+
+
+/** A domain service browser object. Use this to browse for
+ * conventional unicast DNS servers which may be used to resolve
+ * conventional domain names */
+typedef struct AvahiDNSServerBrowser AvahiDNSServerBrowser;
+typedef void (*AvahiDNSServerBrowserCallback)(AvahiDNSServerBrowser *b, gint interface, guchar protocol, AvahiBrowserEvent event, const gchar *host_name, const AvahiAddress *a, guint16 port, gpointer userdata);
+AvahiDNSServerBrowser *avahi_dns_server_browser_new(AvahiServer *server, gint interface, guchar protocol, const gchar *domain, AvahiDNSServerType type, guchar aprotocol, AvahiDNSServerBrowserCallback callback, gpointer userdata);
+void avahi_dns_server_browser_free(AvahiDNSServerBrowser *b);
#endif
projects / catta / blobdiff