* Rename various data structures to prevent a namespace conflict with avahi-core

[catta] / avahi-client / client.h

diff --git a/avahi-client/client.h b/avahi-client/client.h
index c368bb3f2e84746b30117abaac87cacb9b5c51ac..f58a7591309b341eb0a6f5b9a438f6842bce04ec 100644 (file)
--- a/avahi-client/client.h
+++ b/avahi-client/client.h
@@ -22,6 +22,8 @@
   USA.
 ***/
 
+#include <inttypes.h>
+
 #include <avahi-common/cdecl.h>
 #include <avahi-common/address.h>
 #include <avahi-common/strlst.h>
@@ -35,7 +37,15 @@ AVAHI_C_DECL_BEGIN
 
 typedef struct _AvahiClient AvahiClient;
 
-typedef struct _AvahiEntryGroup AvahiEntryGroup;
+typedef struct _AvahiClientEntryGroup AvahiClientEntryGroup;
+
+typedef struct _AvahiClientDomainBrowser AvahiClientDomainBrowser;
+
+typedef struct _AvahiClientServiceTypeBrowser AvahiClientServiceTypeBrowser;
+
+/* Convenience typedefs for slight name differences */
+typedef AvahiDomainBrowserType AvahiClientDomainBrowserType;
+typedef AvahiEntryGroupState AvahiClientEntryGroupState;
 
 /** States of a client object, note that AvahiServerStates are also emitted */
 typedef enum {
@@ -43,9 +53,35 @@ typedef enum {
     AVAHI_CLIENT_RECONNECTED  = 101  /**< Regained connection to the daemon, all records need to be re-added */
 } AvahiClientState;
 
-typedef void (*AvahiClientCallback) (AvahiClient *s, AvahiClientState state, void* userdata);
-
-typedef void (*AvahiEntryGroupCallback) (AvahiClient *s, AvahiEntryGroup *g, AvahiEntryGroupState state, void* userdata);
+/** The function prototype for the callback of an AvahiClient */
+typedef void (*AvahiClientCallback) (AvahiClient *s,
+                                     AvahiClientState state,
+                                     void* userdata);
+
+/** The function prototype for the callback of an AvahiClientEntryGroup */
+typedef void (*AvahiClientEntryGroupCallback)
+                    (AvahiClientEntryGroup *g,
+                     AvahiEntryGroupState state,
+                     void* userdata);
+
+/** The function prototype for the callback of an AvahiClientDomainBrowser */
+typedef void (*AvahiClientDomainBrowserCallback)
+                    (AvahiClientDomainBrowser *b,
+                     AvahiIfIndex interface,
+                     AvahiProtocol protocol,
+                     AvahiBrowserEvent event,
+                     char *domain,
+                     void *user_data);
+
+/** The function prototype for the callback of an AvahiClientServiceTypeBrowser */
+typedef void (*AvahiClientServiceTypeBrowserCallback)
+                    (AvahiClientServiceTypeBrowser *b, 
+                     AvahiIfIndex interface,
+                     AvahiProtocol protocol,
+                     AvahiBrowserEvent event,
+                     char *type,
+                     char *domain,
+                     void *user_data);
 
 /** Creates a new client instance */
 AvahiClient* avahi_client_new (AvahiClientCallback callback, void *user_data);
@@ -62,41 +98,70 @@ char* avahi_client_get_domain_name (AvahiClient*);
 /** Get FQDN domain name */
 char* avahi_client_get_host_name_fqdn (AvahiClient*);
 
-/** Create a new AvahiEntryGroup object */
-AvahiEntryGroup* avahi_entry_group_new (AvahiClient*, AvahiEntryGroupCallback callback, void *user_data);
+/** Create a new AvahiClientEntryGroup object */
+AvahiClientEntryGroup* avahi_entry_group_new
+                    (AvahiClient*,
+                     AvahiClientEntryGroupCallback callback,
+                     void *user_data);
 
-/** Commit an AvahiEntryGroup */
-int avahi_entry_group_commit (AvahiEntryGroup*);
+/** Commit an AvahiClientEntryGroup */
+int avahi_entry_group_commit (AvahiClientEntryGroup*);
 
-/** Reset an AvahiEntryGroup */
-int avahi_entry_group_reset (AvahiEntryGroup*);
+/** Reset an AvahiClientEntryGroup */
+int avahi_entry_group_reset (AvahiClientEntryGroup*);
 
-/** Get an AvahiEntryGroup's state */
-int avahi_entry_group_state (AvahiEntryGroup*);
+/** Get an AvahiClientEntryGroup's state */
+int avahi_entry_group_get_state (AvahiClientEntryGroup*);
 
-/** Check if an AvahiEntryGroup is empty */
-int avahi_entry_group_is_empty (AvahiEntryGroup*);
+/** Check if an AvahiClientEntryGroup is empty */
+int avahi_entry_group_is_empty (AvahiClientEntryGroup*);
 
 /** Get the last error number */
 int avahi_client_errno (AvahiClient*);
 
-/** Get an AvahiEntryGroup's owning client instance */
-AvahiClient* avahi_entry_group_get_client (AvahiEntryGroup*);
+/** Get an AvahiClientEntryGroup's owning client instance */
+AvahiClient* avahi_entry_group_get_client (AvahiClientEntryGroup*);
 
 /** Add a service, takes an AvahiStringList for text records */
 int
-avahi_entry_group_add_service (AvahiEntryGroup *group,
+avahi_entry_group_add_service (AvahiClientEntryGroup *group,
                                AvahiIfIndex interface,
                                AvahiProtocol protocol,
                                const char *name,
                                const char *type,
                                const char *domain,
                                const char *host,
-                               int port,
+                               uint16_t port,
                                AvahiStringList *txt);
 
-/** Get the D-Bus path of an AvahiEntryGroup object, for debugging purposes only. */
-char* avahi_entry_group_get_path (AvahiEntryGroup *);
+/** Get the D-Bus path of an AvahiClientEntryGroup object, for debugging purposes only. */
+char* avahi_entry_group_path (AvahiClientEntryGroup *);
+
+/** Get the D-Bus path of an AvahiClientDomainBrowser object, for debugging purposes only. */
+char* avahi_domain_browser_path (AvahiClientDomainBrowser *);
+
+/** Browse for domains on the local network */
+AvahiClientDomainBrowser* avahi_domain_browser_new
+                                (AvahiClient *client,
+                                AvahiIfIndex interface,
+                                AvahiProtocol protocol,
+                                char *domain,
+                                AvahiDomainBrowserType btype,
+                                AvahiClientDomainBrowserCallback callback,
+                                void *user_data);
+
+/** Get the D-Bus path of an AvahiClientServiceTypeBrowser object, for debugging purposes only. */
+char* avahi_service_type_browser_path (AvahiClientServiceTypeBrowser *);
+
+/** Browse for service types on the local network */
+AvahiClientServiceTypeBrowser* avahi_service_type_browser_new (
+                AvahiClient *client,
+                AvahiIfIndex interface,
+                AvahiProtocol protocol,
+                char *domain,
+                AvahiClientServiceTypeBrowserCallback callback,
+                void *user_data);
+
 
 #ifndef DOXYGEN_SHOULD_SKIP_THIS
 AVAHI_C_DECL_END