* add new flags parameter to avahi_client_new()

[catta] / avahi-client / client.h

diff --git a/avahi-client/client.h b/avahi-client/client.h
index ffcc8d747ad5c71088f00fbbc5ff3acd0e97f43f..9d737782958e25765062e3b2557c61b0cc36ce1b 100644 (file)
--- a/avahi-client/client.h
+++ b/avahi-client/client.h
@@ -36,28 +36,30 @@
 /** \example glib-integration.c Example of how to integrate
  * avahi use with GLIB/GTK applications */
 
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
 AVAHI_C_DECL_BEGIN
-#endif
 
 /** A connection context */
 typedef struct AvahiClient AvahiClient;
 
 /** States of a client object, a superset of AvahiServerState */
 typedef enum {
-    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_S_FAILURE = AVAHI_SERVER_FAILURE,
-    AVAHI_CLIENT_DISCONNECTED = 100 /**< Lost DBUS connection to the Avahi daemon */
+    AVAHI_CLIENT_S_REGISTERING = AVAHI_SERVER_REGISTERING,  /**< Server state: REGISTERING */
+    AVAHI_CLIENT_S_RUNNING = AVAHI_SERVER_RUNNING,          /**< Server state: RUNNING */
+    AVAHI_CLIENT_S_COLLISION = AVAHI_SERVER_COLLISION,      /**< Server state: COLLISION */
+    AVAHI_CLIENT_FAILURE = 100,                             /**< Some kind of error happened on the client side */
+    AVAHI_CLIENT_CONNECTING = 101                           /**< We're still connecting. This state is only entered when AVAHI_CLIENT_NO_FAIL has been passed to avahi_client_new() and the daemon is not yet available. */  
 } AvahiClientState;
 
+typedef enum {
+    AVAHI_CLIENT_IGNORE_USER_CONFIG = 1, /**< Don't read user configuration */
+    AVAHI_CLIENT_NO_FAIL = 2        /**< Don't fail if the daemon is not available when avahi_client_new() is called, instead enter AVAHI_CLIENT_CONNECTING state and wait for the daemon to appear */
+} AvahiClientFlags;
+
 /** The function prototype for the callback of an AvahiClient */
 typedef void (*AvahiClientCallback) (AvahiClient *s, AvahiClientState state, void* userdata);
 
 /** Creates a new client instance */
-AvahiClient* avahi_client_new (const AvahiPoll *poll_api, AvahiClientCallback callback, void *userdata, int *error);
+AvahiClient* avahi_client_new (const AvahiPoll *poll_api, AvahiClientFlags flags, AvahiClientCallback callback, void *userdata, int *error);
 
 /** Free a client instance */
 void avahi_client_free(AvahiClient *client);
@@ -83,8 +85,6 @@ int avahi_client_errno (AvahiClient*);
 /** Return the local service cookie. returns AVAHI_SERVICE_COOKIE_INVALID on failure. */
 uint32_t avahi_client_get_local_service_cookie(AvahiClient *client);
 
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
 AVAHI_C_DECL_END
-#endif
 
 #endif