]> git.meshlink.io Git - catta/blobdiff - avahi-client/client.h
* complete error handling in avahi-client
[catta] / avahi-client / client.h
index f58a7591309b341eb0a6f5b9a438f6842bce04ec..056adfbe7fe00274f1bdedc702bbbb7bf39b9912 100644 (file)
@@ -28,6 +28,8 @@
 #include <avahi-common/address.h>
 #include <avahi-common/strlst.h>
 #include <avahi-common/defs.h>
+#include <avahi-common/watch.h>
+#include <avahi-common/gccmacro.h>
 
 /** \file client.h Definitions and functions for the client API over D-Bus */
 
 AVAHI_C_DECL_BEGIN
 #endif
 
-typedef struct _AvahiClient AvahiClient;
-
-typedef struct _AvahiClientEntryGroup AvahiClientEntryGroup;
-
-typedef struct _AvahiClientDomainBrowser AvahiClientDomainBrowser;
-
-typedef struct _AvahiClientServiceTypeBrowser AvahiClientServiceTypeBrowser;
-
-/* Convenience typedefs for slight name differences */
-typedef AvahiDomainBrowserType AvahiClientDomainBrowserType;
-typedef AvahiEntryGroupState AvahiClientEntryGroupState;
+typedef struct AvahiClient AvahiClient;
+typedef struct AvahiEntryGroup AvahiEntryGroup;
+typedef struct AvahiDomainBrowser AvahiDomainBrowser;
+typedef struct AvahiServiceBrowser AvahiServiceBrowser;
+typedef struct AvahiServiceTypeBrowser AvahiServiceTypeBrowser;
 
 /** States of a client object, note that AvahiServerStates are also emitted */
 typedef enum {
-    AVAHI_CLIENT_DISCONNECTED = 100, /**< Lost DBUS connection to the Avahi daemon */
-    AVAHI_CLIENT_RECONNECTED  = 101  /**< Regained connection to the daemon, all records need to be re-added */
+    AVAHI_CLIENT_S_INVALID = AVAHI_SERVER_INVALID,
+    AVAHI_CLIENT_S_REGISTERING = AVAHI_SERVER_REGISTERING,
+    AVAHI_CLIENT_S_RUNNING = AVAHI_SERVER_RUNNING,
+    AVAHI_CLIENT_S_COLLISION = AVAHI_SERVER_COLLISION,
+    AVAHI_CLIENT_DISCONNECTED = 100 /**< Lost DBUS connection to the Avahi daemon */
 } AvahiClientState;
 
 /** 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);
+typedef void (*AvahiClientCallback) (AvahiClient *s, AvahiClientState state, void* userdata);
+
+/** The function prototype for the callback of an AvahiEntryGroup */
+typedef void (*AvahiEntryGroupCallback) (AvahiEntryGroup *g, AvahiEntryGroupState state, void* userdata);
+
+/** The function prototype for the callback of an AvahiDomainBrowser */
+typedef void (*AvahiDomainBrowserCallback) (AvahiDomainBrowser *b, AvahiIfIndex interface, AvahiProtocol protocol, AvahiBrowserEvent event, const char *domain, void *userdata);
+
+/** The function prototype for the callback of an AvahiServiceBrowser */
+typedef void (*AvahiServiceBrowserCallback) (AvahiServiceBrowser *b, AvahiIfIndex interface, AvahiProtocol protocol, AvahiBrowserEvent event, const char *name, const char *type, const char *domain, void *userdata);
+
+/** 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);
 
 /** Creates a new client instance */
-AvahiClient* avahi_client_new (AvahiClientCallback callback, void *user_data);
+AvahiClient* avahi_client_new (const AvahiPoll *poll_api, AvahiClientCallback callback, void *userdata, int *error);
+
+/** Free a client instance */
+void avahi_client_free(AvahiClient *client);
 
 /** Get the version of the server */
-char* avahi_client_get_version_string (AvahiClient*);
+const char* avahi_client_get_version_string (AvahiClient*);
 
 /** Get host name */
-char* avahi_client_get_host_name (AvahiClient*);
+const char* avahi_client_get_host_name (AvahiClient*);
 
 /** Get domain name */
-char* avahi_client_get_domain_name (AvahiClient*);
+const char* avahi_client_get_domain_name (AvahiClient*);
 
 /** Get FQDN domain name */
-char* avahi_client_get_host_name_fqdn (AvahiClient*);
+const char* avahi_client_get_host_name_fqdn (AvahiClient*);
 
-/** Create a new AvahiClientEntryGroup object */
-AvahiClientEntryGroup* avahi_entry_group_new
-                    (AvahiClient*,
-                     AvahiClientEntryGroupCallback callback,
-                     void *user_data);
+/** Get state */
+AvahiClientState avahi_client_get_state(AvahiClient *client); 
 
-/** Commit an AvahiClientEntryGroup */
-int avahi_entry_group_commit (AvahiClientEntryGroup*);
+/** Get the last error number */
+int avahi_client_errno (AvahiClient*);
 
-/** Reset an AvahiClientEntryGroup */
-int avahi_entry_group_reset (AvahiClientEntryGroup*);
+/** Create a new AvahiEntryGroup object */
+AvahiEntryGroup* avahi_entry_group_new (AvahiClient*, AvahiEntryGroupCallback callback, void *userdata);
 
-/** Get an AvahiClientEntryGroup's state */
-int avahi_entry_group_get_state (AvahiClientEntryGroup*);
+/** Clean up and free an AvahiEntryGroup object */
+int avahi_entry_group_free (AvahiEntryGroup *);
 
-/** Check if an AvahiClientEntryGroup is empty */
-int avahi_entry_group_is_empty (AvahiClientEntryGroup*);
+/** Commit an AvahiEntryGroup */
+int avahi_entry_group_commit (AvahiEntryGroup*);
 
-/** Get the last error number */
-int avahi_client_errno (AvahiClient*);
+/** Reset an AvahiEntryGroup */
+int avahi_entry_group_reset (AvahiEntryGroup*);
 
-/** Get an AvahiClientEntryGroup's owning client instance */
-AvahiClient* avahi_entry_group_get_client (AvahiClientEntryGroup*);
+/** Get an AvahiEntryGroup's state */
+int avahi_entry_group_get_state (AvahiEntryGroup*);
+
+/** Check if an AvahiEntryGroup is empty */
+int avahi_entry_group_is_empty (AvahiEntryGroup*);
+
+/** Get an AvahiEntryGroup's owning client instance */
+AvahiClient* avahi_entry_group_get_client (AvahiEntryGroup*);
+
+/** Add a service, takes a variable NULL terminated list of text records */
+int avahi_entry_group_add_service(
+    AvahiEntryGroup *group,
+    AvahiIfIndex interface,
+    AvahiProtocol protocol,
+    const char *name,
+    const char *type,
+    const char *domain,
+    const char *host,
+    uint16_t port,
+    ...) AVAHI_GCC_SENTINEL;
 
 /** Add a service, takes an AvahiStringList for text records */
-int
-avahi_entry_group_add_service (AvahiClientEntryGroup *group,
-                               AvahiIfIndex interface,
-                               AvahiProtocol protocol,
-                               const char *name,
-                               const char *type,
-                               const char *domain,
-                               const char *host,
-                               uint16_t port,
-                               AvahiStringList *txt);
-
-/** 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 *);
+int avahi_entry_group_add_service_strlst(
+    AvahiEntryGroup *group,
+    AvahiIfIndex interface,
+    AvahiProtocol protocol,
+    const char *name,
+    const char *type,
+    const char *domain,
+    const char *host,
+    uint16_t port,
+    AvahiStringList *txt);
+
+/** Add a service, takes a NULL terminated va_list for text records */
+int avahi_entry_group_add_service_va(
+    AvahiEntryGroup *group,
+    AvahiIfIndex interface,
+    AvahiProtocol protocol,
+    const char *name,
+    const char *type,
+    const char *domain,
+    const char *host,
+    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 */
-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 *);
+AvahiDomainBrowser* avahi_domain_browser_new (AvahiClient *client,
+                                              AvahiIfIndex interface,
+                                              AvahiProtocol protocol,
+                                              const char *domain,
+                                              AvahiDomainBrowserType btype,
+                                              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 *);
+
+/** Cleans up and frees an AvahiDomainBrowser object */
+int avahi_domain_browser_free (AvahiDomainBrowser *);
 
 /** Browse for service types on the local network */
-AvahiClientServiceTypeBrowser* avahi_service_type_browser_new (
+AvahiServiceTypeBrowser* avahi_service_type_browser_new (
+                AvahiClient *client,
+                AvahiIfIndex interface,
+                AvahiProtocol protocol,
+                const char *domain,
+                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 *);
+
+/** Cleans up and frees an AvahiServiceTypeBrowser object */
+int avahi_service_type_browser_free (AvahiServiceTypeBrowser *);
+
+/** Browse for services of a type on the local network */
+AvahiServiceBrowser* avahi_service_browser_new (
                 AvahiClient *client,
                 AvahiIfIndex interface,
                 AvahiProtocol protocol,
-                char *domain,
-                AvahiClientServiceTypeBrowserCallback callback,
-                void *user_data);
+                const char *type,
+                const char *domain,
+                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 *);
 
+/* Cleans up and frees an AvahiServiceBrowser object */
+int avahi_service_browser_free (AvahiServiceBrowser *);
 
 #ifndef DOXYGEN_SHOULD_SKIP_THIS
 AVAHI_C_DECL_END