]> git.meshlink.io Git - catta/blobdiff - avahi-common/defs.h
forgot to pull the publish_no_reverse change to the example.
[catta] / avahi-common / defs.h
index a74fd6ab815666ffb036d0bc0fba649ec37252dd..bb73a9dfdb703104ef65f31a4fa60a19a29f866f 100644 (file)
@@ -1,21 +1,19 @@
 #ifndef foodefshfoo
 #define foodefshfoo
 
-/* $Id$ */
-
 /***
   This file is part of avahi.
+
   avahi is free software; you can redistribute it and/or modify it
   under the terms of the GNU Lesser General Public License as
   published by the Free Software Foundation; either version 2.1 of the
   License, or (at your option) any later version.
+
   avahi is distributed in the hope that it will be useful, but WITHOUT
   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
   or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
   Public License for more details.
+
   You should have received a copy of the GNU Lesser General Public
   License along with avahi; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
@@ -27,7 +25,7 @@
 #include <avahi-common/cdecl.h>
 
 /** \mainpage
- *  
+ *
  * \section choose_api Choosing an API
  *
  * Avahi provides three programming APIs for integration of
@@ -45,7 +43,9 @@
  * \li <b>avahi-client</b>: a simplifying C wrapper around the D-Bus API. We
  * recommend using this API in C or C++ progams. The D-Bus internals
  * are hidden completely.
- * 
+ * \li <b>avahi-gobject</b>: an object-oriented C wrapper based on
+ * GLib's GObject. We recommd using this API for GNOME/Gtk programs.
+ *
  * All three APIs are very similar, however avahi-core is the most powerful.
  *
  * In addition to the three APIs described above Avahi supports two
@@ -86,7 +86,7 @@
  * files for all definitions that are part of the Avahi API. Please
  * note that these hidden definitions are considered part of the Avahi
  * API and will stay available in the API in the future.
- * 
+ *
  * \section error_reporting Error Reporting
  *
  * Some notes on the Avahi error handling:
  * avahi_client_new(). If the client is forced to disconnect from the
  * server it will enter AVAHI_CLIENT_FAILURE state with
  * avahi_client_errno() == AVAHI_ERR_DISCONNECTED. Free the
- * AvahiClient object in that case and reconnect to the server anew -
- * again with passing AVAHI_CLIENT_NO_FAIL to avahi_client_new().
+ * AvahiClient object in that case (and all its associated objects
+ * such as entry groups and browser objects prior to that) and
+ * reconnect to the server anew - again with passing
+ * AVAHI_CLIENT_NO_FAIL to avahi_client_new().
  *
  * We encourage implementing this in all software where service
  * discovery is not an integral part of application. e.g. use it in
- * all kinds of background daemons, but not in software like iChat
- * compatible IM software.
+ * all kinds of background daemons, but not necessarily in software
+ * like iChat compatible IM software.
  *
  * For now AVAHI_CLIENT_NO_FAIL cannot deal with D-Bus daemon restarts.
  *
@@ -217,7 +219,7 @@ AVAHI_C_DECL_BEGIN
 
 /** States of a server object */
 typedef enum {
-    AVAHI_SERVER_INVALID,          /**< Invalid state (initial) */ 
+    AVAHI_SERVER_INVALID,          /**< Invalid state (initial) */
     AVAHI_SERVER_REGISTERING,      /**< Host RRs are being registered */
     AVAHI_SERVER_RUNNING,          /**< All host RRs have been established */
     AVAHI_SERVER_COLLISION,        /**< There is a collision with a host RR. All host RRs have been withdrawn, the user should set a new host name via avahi_server_set_host_name() */