X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=avahi-common%2Fdefs.h;h=14a0ba3efce8b3c60ed28d6049ef3a3bd7be7af8;hb=50248a63a26c7bfc959813b834e68e2144182146;hp=67bdddc485dbfe9fed3522b89a174db501ee1907;hpb=6b391bb81f0dce0193a722254016b26c12a17643;p=catta diff --git a/avahi-common/defs.h b/avahi-common/defs.h index 67bdddc..14a0ba3 100644 --- a/avahi-common/defs.h +++ b/avahi-common/defs.h @@ -48,6 +48,20 @@ * * All three APIs are very similar, however avahi-core is the most powerful. * + * In addition to the three APIs described above Avahi supports two + * compatibility libraries: + * + * \li avahi-compat-libdns_sd: the original Bonjour API as documented + * in the header file "dns_sd.h" by Apple Computer, Inc. + * + * \li avahi-compat-howl: the HOWL API as released with HOWL 0.9.8 by + * Porchdog Software. + * + * Please note that these compatibility layers are incomplete and + * generally a waste of resources. We strongly encourage everyone to + * use our native APIs for newly written programs and to port older + * programs to one of them! + * * \section error_reporting Error Reporting * * Some notes on the Avahi error handling: @@ -104,8 +118,7 @@ * avahi_alternative_service_name()) and commit again. Please do not * free the entry group and create a new one. This would inhibit some * traffic limiting algorithms in mDNS. - * - When you need to modify your services, reset the entry group - * (i.e. avahi_entry_group_reset()) and add them back. Please do not + * - When you need to modify your services, use the AVAHI_PUBLISH_UPDATE flag. Please do not * free the entry group and create a new one. This would inhibit some * traffic limiting algorithms in mDNS. * @@ -117,7 +130,7 @@ * for the service type you want to browse for. Use * avahi_client_resolve_service() to acquire service data for a a service * name. - * - You can use avahi_domain_browser() to get a list of announced + * - You can use avahi_domain_browser_new() to get a list of announced * browsing domains. Please note that not all domains whith services * on the LAN are mandatorily announced. * - Network monitor software may use avahi_service_type_browser_new() @@ -130,16 +143,15 @@ * */ -#ifndef DOXYGEN_SHOULD_SKIP_THIS AVAHI_C_DECL_BEGIN -#endif /** States of an entry group object */ typedef enum { AVAHI_ENTRY_GROUP_UNCOMMITED, /**< The group has not yet been commited, the user must still call avahi_entry_group_commit() */ AVAHI_ENTRY_GROUP_REGISTERING, /**< The entries of the group are currently being registered */ AVAHI_ENTRY_GROUP_ESTABLISHED, /**< The entries have successfully been established */ - AVAHI_ENTRY_GROUP_COLLISION /**< A name collision for one of the entries in the group has been detected, the entries have been withdrawn */ + AVAHI_ENTRY_GROUP_COLLISION, /**< A name collision for one of the entries in the group has been detected, the entries have been withdrawn */ + AVAHI_ENTRY_GROUP_FAILURE /**< Some kind of failure happened, the entries have been withdrawn */ } AvahiEntryGroupState; /** The type of domain to browse for */ @@ -154,7 +166,6 @@ typedef enum { /** Some flags for publishing functions */ typedef enum { - AVAHI_PUBLISH_NULL = 0, AVAHI_PUBLISH_UNIQUE = 1, /**< For raw records: The RRset is intended to be unique */ AVAHI_PUBLISH_NO_PROBE = 2, /**< For raw records: Though the RRset is intended to be unique no probes shall be sent */ AVAHI_PUBLISH_NO_ANNOUNCE = 4, /**< For raw records: Do not announce this RR to other hosts */ @@ -166,7 +177,6 @@ typedef enum { /** Some flags for lookup functions */ typedef enum { - AVAHI_LOOKUP_NULL = 0, AVAHI_LOOKUP_USE_WIDE_AREA = 1, /**< Force lookup via wide area DNS */ AVAHI_LOOKUP_USE_MULTICAST = 2, /**< Force lookup via multicast DNS */ AVAHI_LOOKUP_NO_TXT = 4, /**< When doing service resolving, don't lookup TXT record */ @@ -175,7 +185,6 @@ typedef enum { /** Some flags for lookup callback functions */ typedef enum { - AVAHI_LOOKUP_RESULT_NULL = 0, AVAHI_LOOKUP_RESULT_CACHED = 1, /**< This response originates from the cache */ AVAHI_LOOKUP_RESULT_WIDE_AREA = 2, /**< This response originates from wide area DNS */ AVAHI_LOOKUP_RESULT_MULTICAST = 4, /**< This response originates from multicast DNS */ @@ -203,7 +212,8 @@ typedef enum { 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() */ + 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_FAILURE /**< Some fatal failure happened, the server is unable to proceed */ } AvahiServerState; /** For every service a special TXT item is implicitly added, which @@ -215,8 +225,6 @@ typedef enum { /** In invalid cookie as special value */ #define AVAHI_SERVICE_COOKIE_INVALID (0) -#ifndef DOXYGEN_SHOULD_SKIP_THIS AVAHI_C_DECL_END -#endif #endif