* Move service/host name/address resolvers to asynchronous interfaces

[catta] / avahi-client / client.h

diff --git a/avahi-client/client.h b/avahi-client/client.h
index 49883d7888f370750d76af29a8ab712c9e5ca943..2d8f41b6058935730ccb111585acfaf820e04e8b 100644 (file)
--- a/avahi-client/client.h
+++ b/avahi-client/client.h
@@ -39,6 +39,9 @@
 
 /** \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
@@ -63,7 +66,13 @@ 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;
+
+/** An address resolver object */
+typedef struct AvahiAddressResolver AvahiAddressResolver;
+
+/** 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,
@@ -102,6 +111,27 @@ 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);
+
+/** The function prototype for the callback of an AvahiAddressResolver */
+typedef void (*AvahiAddressResolverCallback) (
+    AvahiAddressResolver *r,
+    AvahiIfIndex interface,
+    AvahiProtocol protocol,
+    AvahiResolverEvent event,
+    AvahiProtocol aprotocol,
+    const AvahiAddress *a,
+    const char *name,
+    void *userdata);
+
 /** Creates a new client instance */
 AvahiClient* avahi_client_new (const AvahiPoll *poll_api, AvahiClientCallback callback, void *userdata, int *error);
 
@@ -183,9 +213,6 @@ int avahi_entry_group_add_service_va(
     uint16_t port,
     va_list va);
 
-/** Get the D-Bus path of an AvahiEntryGroup object, for debugging purposes only. */
-const char* avahi_entry_group_get_dbus_path (AvahiEntryGroup *);
-
 /** Browse for domains on the local network */
 AvahiDomainBrowser* avahi_domain_browser_new (AvahiClient *client,
                                               AvahiIfIndex interface,
@@ -195,8 +222,8 @@ AvahiDomainBrowser* avahi_domain_browser_new (AvahiClient *client,
                                               AvahiDomainBrowserCallback callback,
                                               void *userdata);
 
-/** Get the D-Bus path of an AvahiDomainBrowser object, for debugging purposes only. */
-const char* avahi_domain_browser_get_dbus_path (AvahiDomainBrowser *);
+/** Get the parent client of an AvahiDomainBrowser object */
+AvahiClient* avahi_domain_browser_get_client (AvahiDomainBrowser *);
 
 /** Cleans up and frees an AvahiDomainBrowser object */
 int avahi_domain_browser_free (AvahiDomainBrowser *);
@@ -210,8 +237,8 @@ AvahiServiceTypeBrowser* avahi_service_type_browser_new (
                 AvahiServiceTypeBrowserCallback callback,
                 void *userdata);
 
-/** Get the D-Bus path of an AvahiServiceTypeBrowser object, for debugging purposes only. */
-const char* avahi_service_type_browser_get_dbus_path(AvahiServiceTypeBrowser *);
+/** Get the parent client of an AvahiServiceTypeBrowser object */
+AvahiClient* avahi_service_type_browser_get_client (AvahiServiceTypeBrowser *);
 
 /** Cleans up and frees an AvahiServiceTypeBrowser object */
 int avahi_service_type_browser_free (AvahiServiceTypeBrowser *);
@@ -226,8 +253,8 @@ AvahiServiceBrowser* avahi_service_browser_new (
                 AvahiServiceBrowserCallback callback,
                 void *userdata);
 
-/** 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 *);
@@ -244,11 +271,51 @@ 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);
+
+/** Create a new address resolver object from an address string.  Set aprotocol to AF_UNSPEC for protocol detection. */
+AvahiAddressResolver * avahi_address_resolver_new(
+    AvahiClient *client,
+    AvahiIfIndex interface,
+    AvahiProtocol protocol,
+    const char *address,
+    AvahiAddressResolverCallback callback,
+    void *userdata);
+
+/** Create a new address resolver object from an AvahiAddress object */
+AvahiAddressResolver* avahi_address_resolver_new_a(
+    AvahiClient *client,
+    AvahiIfIndex interface,
+    AvahiProtocol protocol,
+    const AvahiAddress *a,
+    AvahiAddressResolverCallback callback,
+    void *userdata);
+
+/** Get the parent client of an AvahiAddressResolver object */
+AvahiClient* avahi_address_resolver_get_client (AvahiAddressResolver *);
+
+/** Free a AvahiAddressResolver resolver object */
+int avahi_address_resolver_free(AvahiAddressResolver *r);
 
 #ifndef DOXYGEN_SHOULD_SKIP_THIS
 AVAHI_C_DECL_END