]> git.meshlink.io Git - catta/blobdiff - avahi-core/core.h
* improve avahi-discover GUI
[catta] / avahi-core / core.h
index d27f02ed6cc014b04f8511b2b27dad973cd476d7..0a744f349c7950b953587b8fda59ad2cbcb8a08d 100644 (file)
@@ -42,7 +42,8 @@ typedef enum {
     AVAHI_SERVER_INVALID = -1,     /**< Invalid state (initial) */ 
     AVAHI_SERVER_REGISTERING = 0,  /**< 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() */
+    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() */
+    AVAHI_SERVER_SLEEPING          /**< The host or domain name has changed and the server waits for old entries to be expired */
 } AvahiServerState;
 
 /** Flags for server entries */
@@ -75,25 +76,56 @@ typedef struct AvahiServerConfig {
     gboolean use_ipv6;                     /**< Enable IPv6 support */
     gboolean register_hinfo;               /**< Register a HINFO record for the host containing the local OS and CPU type */
     gboolean register_addresses;           /**< Register A, AAAA and PTR records for all local IP addresses */
+    gboolean register_workstation;         /**< Register a _workstation._tcp service */
     gboolean check_response_ttl;           /**< If enabled the server ignores all incoming responses with IP TTL != 255 */
+    gboolean announce_domain;              /**< Announce the local domain for browsing */
+    gboolean use_iff_running;              /**< Require IFF_RUNNING on local network interfaces. This is the official way to check for link beat. Unfortunately this doesn't work with all drivers. So bettere leave this off. */
+    gboolean enable_reflector;             /**< Reflect incoming mDNS traffic to all local networks. This allows mDNS based network browsing beyond ethernet borders */
+    gboolean ipv_reflect;                  /**< if enable_reflector is TRUE, enable/disable reflecting between IPv4 and IPv6 */
 } AvahiServerConfig;
 
 /** Allocate a new mDNS responder object. */
 AvahiServer *avahi_server_new(
     GMainContext *c,               /**< The GLIB main loop context to attach to */
-    const AvahiServerConfig *sc,   /**< If non-NULL a pointer to a configuration structure for the server */
+    const AvahiServerConfig *sc,   /**< If non-NULL a pointer to a configuration structure for the server. The server makes an internal deep copy of this structure, so you may free it using avahi_server_config_done() immediately after calling this function. */
     AvahiServerCallback callback,  /**< A callback which is called whenever the state of the server changes */
     gpointer userdata              /**< An opaque pointer which is passed to the callback function */);
 
 /** Free an mDNS responder object */
 void avahi_server_free(AvahiServer* s);
 
-AvahiServerConfig* avahi_server_config_init(AvahiServerConfig *c);
-AvahiServerConfig* avahi_server_config_copy(AvahiServerConfig *ret, const AvahiServerConfig *c);
+/** Fill in default values for a server configuration structure. If you
+ * make use of an AvahiServerConfig structure be sure to initialize
+ * it with this function for the sake of upwards library
+ * compatibility. This call may allocate strings on the heap. To
+ * release this memory make sure to call
+ * avahi_server_config_done(). If you want to replace any strings in
+ * the structure be sure to free the strings filled in by this
+ * function with g_free() first and allocate the replacements with
+ * g_malloc() (or g_strdup()).*/
+AvahiServerConfig* avahi_server_config_init(
+   AvahiServerConfig *c /**< A structure which shall be filled in */ );
+
+/** Make a deep copy of the configuration structure *c to *ret. */
+AvahiServerConfig* avahi_server_config_copy(
+    AvahiServerConfig *ret /**< destination */,
+    const AvahiServerConfig *c /**< source */);
+
+/** Free the data in a server configuration structure. */
 void avahi_server_config_free(AvahiServerConfig *c);
-    
+
+/** Return the currently chosen domain name of the server object. The
+ * return value points to an internally allocated string. Be sure to
+ * make a copy of the string before calling any other library
+ * functions. */
 const gchar* avahi_server_get_domain_name(AvahiServer *s);
+
+/** Return the currently chosen host name. The return value points to a internally allocated string. */
 const gchar* avahi_server_get_host_name(AvahiServer *s);
+
+/** Return the currently chosen host name as a FQDN ("fully qualified
+ * domain name", i.e. the concatenation of the host and domain
+ * name). The return value points to a internally allocated string. */
 const gchar* avahi_server_get_host_name_fqdn(AvahiServer *s);
 
 void avahi_server_set_host_name(AvahiServer *s, const gchar *host_name);
@@ -102,7 +134,7 @@ void avahi_server_set_domain_name(AvahiServer *s, const gchar *domain_name);
 gpointer avahi_server_get_data(AvahiServer *s);
 void avahi_server_set_data(AvahiServer *s, gpointer userdata);
 
-AvahiServerState avhai_server_get_state(AvahiServer *s);
+AvahiServerState avahi_server_get_state(AvahiServer *s);
 
 const AvahiRecord *avahi_server_iterate(AvahiServer *s, AvahiEntryGroup *g, void **state);
 void avahi_server_dump(AvahiServer *s, FILE *f);
@@ -204,15 +236,56 @@ void avahi_server_add_service_strlst(
     AvahiStringList *strlst);
 
 typedef enum {
-    AVAHI_SUBSCRIPTION_NEW,
-    AVAHI_SUBSCRIPTION_REMOVE,
-} AvahiSubscriptionEvent;
+    AVAHI_BROWSER_NEW = 0,
+    AVAHI_BROWSER_REMOVE = -1
+} AvahiBrowserEvent;
+
+typedef enum {
+    AVAHI_RESOLVER_FOUND = 0,
+    AVAHI_RESOLVER_TIMEOUT = -1
+} AvahiResolverEvent;
+
 
-typedef struct AvahiSubscription AvahiSubscription;
+typedef struct AvahiRecordBrowser AvahiRecordBrowser;
+typedef void (*AvahiRecordBrowserCallback)(AvahiRecordBrowser *b, gint interface, guchar protocol, AvahiBrowserEvent event, AvahiRecord *record, gpointer userdata);
+AvahiRecordBrowser *avahi_record_browser_new(AvahiServer *server, gint interface, guchar protocol, AvahiKey *key, AvahiRecordBrowserCallback callback, gpointer userdata);
+void avahi_record_browser_free(AvahiRecordBrowser *b);
 
-typedef void (*AvahiSubscriptionCallback)(AvahiSubscription *s, AvahiRecord *record, gint interface, guchar protocol, AvahiSubscriptionEvent event, gpointer userdata);
+typedef struct AvahiHostNameResolver AvahiHostNameResolver;
+typedef void (*AvahiHostNameResolverCallback)(AvahiHostNameResolver *r, gint interface, guchar protocol, AvahiResolverEvent event, const gchar *host_name, const AvahiAddress *a, gpointer userdata);
+AvahiHostNameResolver *avahi_host_name_resolver_new(AvahiServer *server, gint interface, guchar protocol, const gchar *host_name, guchar aprotocol, AvahiHostNameResolverCallback calback, gpointer userdata);
+void avahi_host_name_resolver_free(AvahiHostNameResolver *r);
 
-AvahiSubscription *avahi_subscription_new(AvahiServer *s, AvahiKey *key, gint interface, guchar protocol, AvahiSubscriptionCallback callback, gpointer userdata);
-void avahi_subscription_free(AvahiSubscription *s);
+typedef struct AvahiAddressResolver AvahiAddressResolver;
+typedef void (*AvahiAddressResolverCallback)(AvahiAddressResolver *r, gint interface, guchar protocol, AvahiResolverEvent event, const AvahiAddress *a, const gchar *host_name, gpointer userdata);
+AvahiAddressResolver *avahi_address_resolver_new(AvahiServer *server, gint interface, guchar protocol, const AvahiAddress *address, AvahiAddressResolverCallback calback, gpointer userdata);
+void avahi_address_resolver_free(AvahiAddressResolver *r);
+
+typedef enum {
+    AVAHI_DOMAIN_BROWSER_REGISTER,
+    AVAHI_DOMAIN_BROWSER_REGISTER_DEFAULT,
+    AVAHI_DOMAIN_BROWSER_BROWSE,
+    AVAHI_DOMAIN_BROWSER_BROWSE_DEFAULT
+} AvahiDomainBrowserType;
+
+typedef struct AvahiDomainBrowser AvahiDomainBrowser;
+typedef void (*AvahiDomainBrowserCallback)(AvahiDomainBrowser *b, gint interface, guchar protocol, AvahiBrowserEvent event, const gchar *domain, gpointer userdata);
+AvahiDomainBrowser *avahi_domain_browser_new(AvahiServer *server, gint interface, guchar protocol, const gchar *domain, AvahiDomainBrowserType type, AvahiDomainBrowserCallback callback, gpointer userdata);
+void avahi_domain_browser_free(AvahiDomainBrowser *b);
+
+typedef struct AvahiServiceTypeBrowser AvahiServiceTypeBrowser;
+typedef void (*AvahiServiceTypeBrowserCallback)(AvahiServiceTypeBrowser *b, gint interface, guchar protocol, AvahiBrowserEvent event, const gchar *type, const gchar *domain, gpointer userdata);
+AvahiServiceTypeBrowser *avahi_service_type_browser_new(AvahiServer *server, gint interface, guchar protocol, const gchar *domain, AvahiServiceTypeBrowserCallback callback, gpointer userdata);
+void avahi_service_type_browser_free(AvahiServiceTypeBrowser *b);
+
+typedef struct AvahiServiceBrowser AvahiServiceBrowser;
+typedef void (*AvahiServiceBrowserCallback)(AvahiServiceBrowser *b, gint interface, guchar protocol, AvahiBrowserEvent event, const gchar *name, const gchar *type, const gchar *domain, gpointer userdata);
+AvahiServiceBrowser *avahi_service_browser_new(AvahiServer *server, gint interface, guchar protocol, const gchar *service_type, const gchar *domain, AvahiServiceBrowserCallback callback, gpointer userdata);
+void avahi_service_browser_free(AvahiServiceBrowser *b);
+
+typedef struct AvahiServiceResolver AvahiServiceResolver;
+typedef void (*AvahiServiceResolverCallback)(AvahiServiceResolver *r, gint interface, guchar protocol, AvahiResolverEvent event, const gchar *name, const gchar *type, const gchar *domain, const gchar *host_name, const AvahiAddress *a, guint16 port, AvahiStringList *txt, gpointer userdata);
+AvahiServiceResolver *avahi_service_resolver_new(AvahiServer *server, gint interface, guchar protocol, const gchar *name, const gchar *type, const gchar *domain, guchar aprotocol, AvahiServiceResolverCallback calback, gpointer userdata);
+void avahi_service_resolver_free(AvahiServiceResolver *r);
 
 #endif