* Implement the HostNameResolver in the avahi-client C api

[catta] / avahi-client / client.h

diff --git a/avahi-client/client.h b/avahi-client/client.h
index 2753f1ba9e3d37ae743fd839e1abd18aa18f27fc..4db2aef882bb9e984ce33417f332345cbea26255 100644 (file)
--- a/avahi-client/client.h
+++ b/avahi-client/client.h
@@ -33,6 +33,17 @@
 
 /** \file client.h Definitions and functions for the client API over D-Bus */
 
+/** \example client-publish-service.c Example how to register a DNS-SD
+ * service using the client interface to avahi-daemon. It behaves like a network
+ * printer registering both an IPP and a BSD LPR service. */
+
+/** \example client-browse-services.c Example how to browse for DNS-SD
+ * services using the client interface to avahi-daemon. */
+
+/** \example glib-integration.c Example of how to integrate
+ * avahi use with GLIB/GTK applications */
+ 
+
 #ifndef DOXYGEN_SHOULD_SKIP_THIS
 AVAHI_C_DECL_BEGIN
 #endif
@@ -55,7 +66,10 @@ typedef struct AvahiServiceTypeBrowser AvahiServiceTypeBrowser;
 /** A service resolver object */
 typedef struct AvahiServiceResolver AvahiServiceResolver;
 
-/** States of a client object, note that AvahiServerStates are also emitted */
+/** A service resolver object */
+typedef struct AvahiHostNameResolver AvahiHostNameResolver;
+
+/** States of a client object, a superset of AvahiServerState */
 typedef enum {
     AVAHI_CLIENT_S_INVALID = AVAHI_SERVER_INVALID,
     AVAHI_CLIENT_S_REGISTERING = AVAHI_SERVER_REGISTERING,
@@ -94,6 +108,16 @@ typedef void (*AvahiServiceResolverCallback) (
     AvahiStringList *txt,
     void *userdata);
 
+/** The function prototype for the callback of an AvahiHostNameResolver */
+typedef void (*AvahiHostNameResolverCallback) (
+    AvahiHostNameResolver *r,
+    AvahiIfIndex interface,
+    AvahiProtocol protocol,
+    AvahiResolverEvent event,
+    const char *name,
+    const AvahiAddress *a,
+    void *userdata);
+
 /** Creates a new client instance */
 AvahiClient* avahi_client_new (const AvahiPoll *poll_api, AvahiClientCallback callback, void *userdata, int *error);
 
@@ -187,6 +211,9 @@ AvahiDomainBrowser* avahi_domain_browser_new (AvahiClient *client,
                                               AvahiDomainBrowserCallback callback,
                                               void *userdata);
 
+/** Get the parent client of an AvahiDomainBrowser object */
+AvahiClient* avahi_domain_browser_get_client (AvahiDomainBrowser *);
+
 /** Get the D-Bus path of an AvahiDomainBrowser object, for debugging purposes only. */
 const char* avahi_domain_browser_get_dbus_path (AvahiDomainBrowser *);
 
@@ -202,6 +229,9 @@ AvahiServiceTypeBrowser* avahi_service_type_browser_new (
                 AvahiServiceTypeBrowserCallback callback,
                 void *userdata);
 
+/** Get the parent client of an AvahiServiceTypeBrowser object */
+AvahiClient* avahi_service_type_browser_get_client (AvahiServiceTypeBrowser *);
+
 /** Get the D-Bus path of an AvahiServiceTypeBrowser object, for debugging purposes only. */
 const char* avahi_service_type_browser_get_dbus_path(AvahiServiceTypeBrowser *);
 
@@ -221,6 +251,9 @@ AvahiServiceBrowser* avahi_service_browser_new (
 /** Get the D-Bus path of an AvahiServiceBrowser object, for debugging purposes only. */
 const char* avahi_service_browser_get_dbus_path (AvahiServiceBrowser *);
 
+/** Get the parent client of an AvahiServiceBrowser object */
+AvahiClient* avahi_service_browser_get_client (AvahiServiceBrowser *);
+
 /* Cleans up and frees an AvahiServiceBrowser object */
 int avahi_service_browser_free (AvahiServiceBrowser *);
 
@@ -236,12 +269,34 @@ AvahiServiceResolver * avahi_service_resolver_new(
     AvahiServiceResolverCallback callback,
     void *userdata);
 
+/** Get the parent client of an AvahiServiceResolver object */
+AvahiClient* avahi_service_resolver_get_client (AvahiServiceResolver *);
+
 /** Free a service resolver object */
 int avahi_service_resolver_free(AvahiServiceResolver *r);
 
 /** Block until the resolving is complete */
 int avahi_service_resolver_block(AvahiServiceResolver *r);
 
+/** Create a new hostname resolver object */
+AvahiHostNameResolver * avahi_host_name_resolver_new(
+    AvahiClient *client,
+    AvahiIfIndex interface,
+    AvahiProtocol protocol,
+    const char *name,
+    AvahiProtocol aprotocol,
+    AvahiHostNameResolverCallback callback,
+    void *userdata);
+
+/** Get the parent client of an AvahiHostNameResolver object */
+AvahiClient* avahi_host_name_resolver_get_client (AvahiHostNameResolver *);
+
+/** Free a hostname resolver object */
+int avahi_host_name_resolver_free(AvahiHostNameResolver *r);
+
+/** Block until the resolving is complete */
+int avahi_host_name_resolver_block(AvahiHostNameResolver *r);
+
 #ifndef DOXYGEN_SHOULD_SKIP_THIS
 AVAHI_C_DECL_END
 #endif