]> git.meshlink.io Git - catta/blobdiff - avahi-client/client.h
* add new flags parameter to avahi_client_new()
[catta] / avahi-client / client.h
index f58a7591309b341eb0a6f5b9a438f6842bce04ec..9d737782958e25765062e3b2557c61b0cc36ce1b 100644 (file)
 #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 */
 
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-AVAHI_C_DECL_BEGIN
-#endif
-
-typedef struct _AvahiClient AvahiClient;
-
-typedef struct _AvahiClientEntryGroup AvahiClientEntryGroup;
+/** \example glib-integration.c Example of how to integrate
+ * avahi use with GLIB/GTK applications */
 
-typedef struct _AvahiClientDomainBrowser AvahiClientDomainBrowser;
-
-typedef struct _AvahiClientServiceTypeBrowser AvahiClientServiceTypeBrowser;
+AVAHI_C_DECL_BEGIN
 
-/* Convenience typedefs for slight name differences */
-typedef AvahiDomainBrowserType AvahiClientDomainBrowserType;
-typedef AvahiEntryGroupState AvahiClientEntryGroupState;
+/** A connection context */
+typedef struct AvahiClient AvahiClient;
 
-/** States of a client object, note that AvahiServerStates are also emitted */
+/** States of a client object, a superset of AvahiServerState */
 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_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);
-
-/** 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);
 
 /** Creates a new client instance */
-AvahiClient* avahi_client_new (AvahiClientCallback callback, void *user_data);
+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);
 
 /** 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*);
-
-/** Create a new AvahiClientEntryGroup object */
-AvahiClientEntryGroup* avahi_entry_group_new
-                    (AvahiClient*,
-                     AvahiClientEntryGroupCallback callback,
-                     void *user_data);
-
-/** Commit an AvahiClientEntryGroup */
-int avahi_entry_group_commit (AvahiClientEntryGroup*);
-
-/** Reset an AvahiClientEntryGroup */
-int avahi_entry_group_reset (AvahiClientEntryGroup*);
+const char* avahi_client_get_host_name_fqdn (AvahiClient*);
 
-/** Get an AvahiClientEntryGroup's state */
-int avahi_entry_group_get_state (AvahiClientEntryGroup*);
-
-/** Check if an AvahiClientEntryGroup is empty */
-int avahi_entry_group_is_empty (AvahiClientEntryGroup*);
+/** Get state */
+AvahiClientState avahi_client_get_state(AvahiClient *client); 
 
 /** Get the last error number */
 int avahi_client_errno (AvahiClient*);
 
-/** Get an AvahiClientEntryGroup's owning client instance */
-AvahiClient* avahi_entry_group_get_client (AvahiClientEntryGroup*);
-
-/** 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 *);
-
-/** 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 *);
-
-/** Browse for service types on the local network */
-AvahiClientServiceTypeBrowser* avahi_service_type_browser_new (
-                AvahiClient *client,
-                AvahiIfIndex interface,
-                AvahiProtocol protocol,
-                char *domain,
-                AvahiClientServiceTypeBrowserCallback callback,
-                void *user_data);
-
-
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
+/** Return the local service cookie. returns AVAHI_SERVICE_COOKIE_INVALID on failure. */
+uint32_t avahi_client_get_local_service_cookie(AvahiClient *client);
+
 AVAHI_C_DECL_END
-#endif
 
 #endif