X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=avahi-client%2Fclient.h;h=6a12e9a2de12726e14f5563cab239cfd8131090f;hb=c878c09b354196a7814123016676bdaac7b9147a;hp=7cec3b9194cb6143c35a22e1502366c9df45f1d6;hpb=600d2b77c7727da9322557c87afefcbe7553d74d;p=catta

diff --git a/avahi-client/client.h b/avahi-client/client.h
index 7cec3b9..6a12e9a 100644
--- a/avahi-client/client.h
+++ b/avahi-client/client.h
@@ -33,9 +33,6 @@
 
 /** \file client.h Definitions and functions for the client API over D-Bus */
 
-/** \example glib-integration.c Example of how to integrate
- * avahi use with GLIB/GTK applications */
-
 AVAHI_C_DECL_BEGIN
 
 /** A connection context */
@@ -56,12 +53,22 @@ typedef enum {
 } AvahiClientFlags;
 
 /** The function prototype for the callback of an AvahiClient */
-typedef void (*AvahiClientCallback) (AvahiClient *s, AvahiClientState state, void* userdata);
+typedef void (*AvahiClientCallback) (
+    AvahiClient *s,
+    AvahiClientState state /**< The new state of the client */,
+    void* userdata /**< The user data that was passed to avahi_client_new() */);
 
 /** Creates a new client instance */
-AvahiClient* avahi_client_new (const AvahiPoll *poll_api, AvahiClientFlags flags, AvahiClientCallback callback, void *userdata, int *error);
-
-/** Free a client instance */
+AvahiClient* avahi_client_new (
+    const AvahiPoll *poll_api /**< The abstract event loop API to use */,
+    AvahiClientFlags flags /**< Some flags to modify the behaviour of  the client library */,
+    AvahiClientCallback callback /**< A callback that is called whenever the state of the client changes. This may be NULL. Please note that this function is called for the first time from within the avahi_client_new() context! Thus, in the callback you should not make use of global variables that are initialized only after your call to avahi_client_new(). A common mistake is to store the AvahiClient pointer returned by avahi_client_new() in a global variable and assume that this global variable already contains the valid pointer when the callback is called for the first time. A work-around for this is to always use the AvahiClient pointer passed to the callback function instead of the global pointer.  */,
+    void *userdata /**< Some arbitrary user data pointer that will be passed to the callback function */,
+    int *error /**< If creation of the client fails, this integer will contain the error cause. May be NULL if you aren't interested in the reason why avahi_client_new() failed. */);
+
+/** Free a client instance. This will automatically free all
+ * associated browser, resolve and entry group objects. All pointers
+ * to such objects become invalid! */
 void avahi_client_free(AvahiClient *client);
 
 /** Get the version of the server */
@@ -70,6 +77,9 @@ const char* avahi_client_get_version_string (AvahiClient*);
 /** Get host name */
 const char* avahi_client_get_host_name (AvahiClient*);
 
+/** Set host name. \since 0.6.13 */
+int avahi_client_set_host_name(AvahiClient*, const char *name);
+
 /** Get domain name */
 const char* avahi_client_get_domain_name (AvahiClient*);