preliminary asynchronous resolver work

[catta] / avahi-client / client.h

diff --git a/avahi-client/client.h b/avahi-client/client.h
index 056adfbe7fe00274f1bdedc702bbbb7bf39b9912..20054ade6d3943e0d3f2482c92b871e5a8191dcf 100644 (file)
--- a/avahi-client/client.h
+++ b/avahi-client/client.h
@@ -33,17 +33,40 @@
 
 /** \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
 
+/** A connection context */
 typedef struct AvahiClient AvahiClient;
+
+/** An entry group object */
 typedef struct AvahiEntryGroup AvahiEntryGroup;
+
+/** A domain browser object */
 typedef struct AvahiDomainBrowser AvahiDomainBrowser;
+
+/** A service browser object */
 typedef struct AvahiServiceBrowser AvahiServiceBrowser;
+
+/** A service type browser object */
 typedef struct AvahiServiceTypeBrowser AvahiServiceTypeBrowser;
 
-/** States of a client object, note that AvahiServerStates are also emitted */
+/** A service resolver object */
+typedef struct AvahiServiceResolver AvahiServiceResolver;
+
+/** 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,
@@ -67,6 +90,21 @@ typedef void (*AvahiServiceBrowserCallback) (AvahiServiceBrowser *b, AvahiIfInde
 /** The function prototype for the callback of an AvahiServiceTypeBrowser */
 typedef void (*AvahiServiceTypeBrowserCallback) (AvahiServiceTypeBrowser *b, AvahiIfIndex interface, AvahiProtocol protocol, AvahiBrowserEvent event, const char *type, const char *domain, void *userdata);
 
+/** The function prototype for the callback of an AvahiServiceResolver */
+typedef void (*AvahiServiceResolverCallback) (
+    AvahiServiceResolver *r,
+    AvahiIfIndex interface,
+    AvahiProtocol protocol,
+    AvahiResolverEvent event,
+    const char *name,
+    const char *type,
+    const char *domain,
+    const char *host_name,
+    const AvahiAddress *a,
+    uint16_t port,
+    AvahiStringList *txt,
+    void *userdata);
+
 /** Creates a new client instance */
 AvahiClient* avahi_client_new (const AvahiPoll *poll_api, AvahiClientCallback callback, void *userdata, int *error);
 
@@ -197,6 +235,24 @@ const char* avahi_service_browser_get_dbus_path (AvahiServiceBrowser *);
 /* Cleans up and frees an AvahiServiceBrowser object */
 int avahi_service_browser_free (AvahiServiceBrowser *);
 
+/** Create a new service resolver object */
+AvahiServiceResolver * avahi_service_resolver_new(
+    AvahiClient *client,
+    AvahiIfIndex interface,
+    AvahiProtocol protocol,
+    const char *name,
+    const char *type,
+    const char *domain,
+    AvahiProtocol aprotocol,
+    AvahiServiceResolverCallback callback,
+    void *userdata);
+
+/** 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);
+
 #ifndef DOXYGEN_SHOULD_SKIP_THIS
 AVAHI_C_DECL_END
 #endif