]> git.meshlink.io Git - catta/blob - docs/API-CHANGES-0.6
add API-CHANGES-0.6 describing API changes between 0.5.x and 0.6
[catta] / docs / API-CHANGES-0.6
1 -*-text-*-
2
3
4 A terse list of API changes between 0.5.2 and 0.6:
5
6  * Most browsing and registration functions and their callbacks gained
7    new "flags" parameters. Passing 0 results in similar behaviour as
8    in 0.5.2
9
10  * avahi-client/client.h has been split into client.h, publish.h and lookup.h
11  
12  * avahi-core/core.h has been split into core.h publish.h lookup.h
13
14  * avahi_client_is_service_local() has been removed. The special flags
15    AVAHI_LOOKUP_RESULT_LOCAL and AVAHI_LOOKUP_RESULT_OUR_OWN which are
16    set when resolving or browsing for
17    services. AVAHI_LOOKUP_RESULT_OUR_OWN is what most people should
18    use.
19
20  * AVAHI_RESOLVER_TIMEOUT and AVAHI_RESOLVER_NOT_FOUND have been
21    removed. Instead AVAHI_RESOLVER_FAILURE is used and the exact error
22    code is available from avahi_client_errno()/avahi_server_errno()
23
24  * The events AVAHI_BROWSER_CACHE_EXHAUSTED, AVAHI_BROWSER_ALL_FOR_NOW
25    have been introduced. Failures during browsing are now passed as
26    AVAHI_BROWSER_FAILURE and the error code is made available through
27    avahi_client_errno()/avahi_server_errno().
28
29  * The server gained a new state AVAHI_SERVER_FAILURE if some fatal
30    error happens. The reason can be found in
31    avahi_server_errno(). Clients can safely ignore this state.
32
33  * You can now update existing records by setting the
34    AVAHI_PUBLISH_UPDATE flags for add_service() and friends. Consider
35    using avahi_server_update_service_txt_strlst() if you need to
36    update only the TXT record for a service.
37
38  * Proper support for service subtypes is now available. Use
39    avahi_server_add_service_subtype() for that.
40
41  * Entry groups gained the new state AVAHI_ENTRY_GROUP_FAILURE. The
42    reason is available using
43    avahi_server_errno()/avahi_client_errno().
44
45  * Many superfluous functions have been removed from the public API or
46    entirely.
47
48  * avahi_simple_poll_iterate() has been split up into three
49    functions. avahi_simple_poll_loop() has been introduced.
50
51  * Some new limits have been introduced: AVAHI_ADDRESS_STR_MAX,
52    AVAHI_DOMAIN_NAME_MAX, AVAHI_LABEL_MAX
53
54  * The functions avahi_service_name_join() and
55    avahi_service_name_split() have been introduced.
56
57 $Id$