]> git.meshlink.io Git - catta/blobdiff - avahi-core/core.h
minor NEWS updat
[catta] / avahi-core / core.h
index b8ee91a646f9373ae174399953f236211793e8f2..1cf35fc2f2cacea5955143c622eee0e40607d39d 100644 (file)
 
 /** \file core.h The Avahi Multicast DNS and DNS Service Discovery implmentation. */
 
-/** \example publish-service.c Example how to register a DNS-SD
+/** \example core-publish-service.c Example how to register a DNS-SD
  * service using an embedded mDNS stack. It behaves like a network
  * printer registering both an IPP and a BSD LPR service. */
 
-/** \example browse-services.c Example how to browse for DNS-SD
+/** \example core-browse-services.c Example how to browse for DNS-SD
  * services using an embedded mDNS stack. */
 
 #include <avahi-common/cdecl.h>
@@ -49,8 +49,6 @@ AVAHI_C_DECL_END
 
 #include <avahi-core/rr.h>
 #include <avahi-common/address.h>
-#include <avahi-common/alternative.h>
-#include <avahi-common/error.h>
 #include <avahi-common/defs.h>
 #include <avahi-common/watch.h>
 
@@ -228,7 +226,7 @@ int avahi_server_add_txt(
     AvahiEntryFlags flags,
     uint32_t ttl,             /**< DNS TTL for this record */
     const char *name,       /**< TXT record name */
-    ... /**< Text record data, terminated by NULL */);
+    ... /**< Text record data, terminated by NULL */) AVAHI_GCC_SENTINEL;
 
 /** Add a PTR RR to the server. Mostly identical to
  * avahi_server_add_text but takes a va_list instead of a variable
@@ -288,7 +286,7 @@ int avahi_server_add_service(
     const char *domain,       
     const char *host,         /**< Host name where this servcie resides, or NULL if on the local host */
     uint16_t port,              /**< Port number of the service */
-    ...  /**< Text records, terminated by NULL */);
+    ...  /**< Text records, terminated by NULL */) AVAHI_GCC_SENTINEL;
 
 /** Mostly identical to avahi_server_add_service(), but takes an va_list for the TXT records. */
 int avahi_server_add_service_va(
@@ -508,7 +506,7 @@ typedef void (*AvahiSServiceResolverCallback)(
     AvahiSServiceResolver *r,
     AvahiIfIndex interface,
     AvahiProtocol protocol,
-    AvahiResolverEvent event,
+    AvahiResolverEvent event,  /**< Is AVAHI_RESOLVER_FOUND when the service was resolved successfully, and everytime it changes. Is AVAHI_RESOLVER_TIMOUT when the service failed to resolve or disappeared. */
     const char *name,       /**< Service name */
     const char *type,       /**< Service Type */
     const char *domain,
@@ -518,7 +516,7 @@ typedef void (*AvahiSServiceResolverCallback)(
     AvahiStringList *txt,    /**< TXT record data */
     void* userdata);
 
-/** Create a new AvahiSServiceResolver object */
+/** Create a new AvahiSServiceResolver object. The specified callback function will be called with the resolved service data. */
 AvahiSServiceResolver *avahi_s_service_resolver_new(
     AvahiServer *server,
     AvahiIfIndex interface,