]> git.meshlink.io Git - catta/blobdiff - avahi-glib/glib-watch.h
Apply fedora init script fix from http://cvs.fedora.redhat.com/viewcvs/devel/avahi...
[catta] / avahi-glib / glib-watch.h
index 9e6bd68b9dff6c331f8a2dba46672f9602e137cc..78f77428d892135fe4252bceab737221f41dde88 100644 (file)
   USA.
 ***/
 
+/** \file glib-watch.h GLib main loop adapter */
+
+/** \example glib-integration.c Example of how to integrate
+ * avahi use with GLIB/GTK applications */
+
 #include <glib.h>
 
 #include <avahi-common/cdecl.h>
 
 AVAHI_C_DECL_BEGIN
 
+/** GLib main loop adapter. You can safely cast this into a GSource */
 typedef struct AvahiGLibPoll AvahiGLibPoll;
 
-AvahiGLibPoll *avahi_glib_poll_new(GMainContext *context);
+/** Create a new GLib main loop adapter attached to the specified
+ context. If context is NULL, the default main loop context is
+ used. You can attach as many AvahiGLibPoll objects to the same context
+ as you want. priority takes one of GLib's G_PRIORITY constants. */
+AvahiGLibPoll *avahi_glib_poll_new(GMainContext *context, gint priority);
+
+/** Free  GLib main loop adapter */
 void avahi_glib_poll_free(AvahiGLibPoll *g);
-AvahiPoll* avahi_glib_poll_get(AvahiGLibPoll *g);
+
+/** Return the abstract poll API structure for this object. This will
+ * return the same pointer to a internally allocated structure on each
+ * call */
+const AvahiPoll *avahi_glib_poll_get(AvahiGLibPoll *g);
 
 AVAHI_C_DECL_END