From: Lennart Poettering Date: Fri, 3 Jun 2005 19:38:37 +0000 (+0000) Subject: * make some functions return a gint, for signaling errors to the user X-Git-Url: http://git.meshlink.io/?a=commitdiff_plain;ds=inline;h=3184280a20d54b8f468d0b8d6ff0980b74610ec5;p=catta * make some functions return a gint, for signaling errors to the user * some API documentation updates git-svn-id: file:///home/lennart/svn/public/avahi/trunk@95 941a03a8-eaeb-0310-b9a0-b1bbd8fe43fe --- diff --git a/avahi-core/core.h b/avahi-core/core.h index 0a744f3..961399e 100644 --- a/avahi-core/core.h +++ b/avahi-core/core.h @@ -128,25 +128,63 @@ const gchar* avahi_server_get_host_name(AvahiServer *s); * 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); -void avahi_server_set_domain_name(AvahiServer *s, const gchar *domain_name); - +/** Change the host name of a running mDNS responder. This will drop +all automicatilly generated RRs and readd them with the new +name. Since the responder has to probe for the new RRs this function +takes some time to take effect altough it returns immediately. This +function is intended to be called when a host name conflict is +reported using AvahiServerCallback. The caller should readd all user +defined RRs too since they otherwise continue to point to the outdated +host name..*/ +gint avahi_server_set_host_name(AvahiServer *s, const gchar *host_name); + +/** Change the domain name of a running mDNS responder. The same rules + * as with avahi_server_set_host_name() apply. */ +gint avahi_server_set_domain_name(AvahiServer *s, const gchar *domain_name); + +/** Return the opaque user data pointer attached to a server object */ gpointer avahi_server_get_data(AvahiServer *s); + +/** Change the opaque user data pointer attached to a server object */ void avahi_server_set_data(AvahiServer *s, gpointer userdata); +/** Return the current state of the server object */ AvahiServerState avahi_server_get_state(AvahiServer *s); +/** Iterate through all local entries of the server. (when g is NULL) + * or of a specified entry group. At the first call state should point + * to a NULL initialized void pointer, That pointer is used to track + * the current iteration. It is not safe to call any other + * avahi_server_xxx() function during the iteration. If the last entry + * has been read, NULL is returned. */ const AvahiRecord *avahi_server_iterate(AvahiServer *s, AvahiEntryGroup *g, void **state); + +/** Dump the current server status to the specified FILE object */ void avahi_server_dump(AvahiServer *s, FILE *f); +/** Create a new entry group. The specified callback function is + * called whenever the state of the group changes. Use entry group + * objects to keep track of you RRs. Add new RRs to a group using + * avahi_server_add_xxx(). Make sure to call avahi_entry_group_commit() + * to start the registration process for your RRs */ AvahiEntryGroup *avahi_entry_group_new(AvahiServer *s, AvahiEntryGroupCallback callback, gpointer userdata); + +/** Free an entry group. All RRs assigned to the group are removed from the server */ void avahi_entry_group_free(AvahiEntryGroup *g); -void avahi_entry_group_commit(AvahiEntryGroup *g); + +/** Commit an entry group. This starts the probing and registration process for all RRs in the group */ +gint avahi_entry_group_commit(AvahiEntryGroup *g); + +/** Return the current state of the specified entry group */ AvahiEntryGroupState avahi_entry_group_get_state(AvahiEntryGroup *g); + +/** Change the opaque user data pointer attached to an entry group object */ void avahi_entry_group_set_data(AvahiEntryGroup *g, gpointer userdata); + +/** Return the opaque user data pointer currently set for the entry group object */ gpointer avahi_entry_group_get_data(AvahiEntryGroup *g); -void avahi_server_add( +gint avahi_server_add( AvahiServer *s, AvahiEntryGroup *g, gint interface, @@ -154,7 +192,7 @@ void avahi_server_add( AvahiEntryFlags flags, AvahiRecord *r); -void avahi_server_add_ptr( +gint avahi_server_add_ptr( AvahiServer *s, AvahiEntryGroup *g, gint interface, @@ -163,7 +201,7 @@ void avahi_server_add_ptr( const gchar *name, const gchar *dest); -void avahi_server_add_address( +gint avahi_server_add_address( AvahiServer *s, AvahiEntryGroup *g, gint interface, @@ -172,7 +210,7 @@ void avahi_server_add_address( const gchar *name, AvahiAddress *a); -void avahi_server_add_text( +gint avahi_server_add_text( AvahiServer *s, AvahiEntryGroup *g, gint interface, @@ -181,7 +219,7 @@ void avahi_server_add_text( const gchar *name, ... /* text records, terminated by NULL */); -void avahi_server_add_text_va( +gint avahi_server_add_text_va( AvahiServer *s, AvahiEntryGroup *g, gint interface, @@ -190,7 +228,7 @@ void avahi_server_add_text_va( const gchar *name, va_list va); -void avahi_server_add_text_strlst( +gint avahi_server_add_text_strlst( AvahiServer *s, AvahiEntryGroup *g, gint interface, @@ -199,7 +237,7 @@ void avahi_server_add_text_strlst( const gchar *name, AvahiStringList *strlst); -void avahi_server_add_service( +gint avahi_server_add_service( AvahiServer *s, AvahiEntryGroup *g, gint interface, @@ -211,7 +249,7 @@ void avahi_server_add_service( guint16 port, ... /* text records, terminated by NULL */); -void avahi_server_add_service_va( +gint avahi_server_add_service_va( AvahiServer *s, AvahiEntryGroup *g, gint interface, @@ -223,7 +261,7 @@ void avahi_server_add_service_va( guint16 port, va_list va); -void avahi_server_add_service_strlst( +gint avahi_server_add_service_strlst( AvahiServer *s, AvahiEntryGroup *g, gint interface, @@ -261,11 +299,12 @@ typedef void (*AvahiAddressResolverCallback)(AvahiAddressResolver *r, gint inter 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); +/** The type of domain to browse for */ typedef enum { - AVAHI_DOMAIN_BROWSER_REGISTER, - AVAHI_DOMAIN_BROWSER_REGISTER_DEFAULT, - AVAHI_DOMAIN_BROWSER_BROWSE, - AVAHI_DOMAIN_BROWSER_BROWSE_DEFAULT + AVAHI_DOMAIN_BROWSER_REGISTER, /**< Browse for a list of available registering domains */ + AVAHI_DOMAIN_BROWSER_REGISTER_DEFAULT, /**< Browse for the default registering domain */ + AVAHI_DOMAIN_BROWSER_BROWSE, /**< Browse for a list of available browsing domains */ + AVAHI_DOMAIN_BROWSER_BROWSE_DEFAULT /**< Browse for the default browsing domain */ } AvahiDomainBrowserType; typedef struct AvahiDomainBrowser AvahiDomainBrowser; diff --git a/avahi-core/server.c b/avahi-core/server.c index 7ba2a74..9356fec 100644 --- a/avahi-core/server.c +++ b/avahi-core/server.c @@ -1187,7 +1187,7 @@ static void delayed_register_stuff(AvahiServer *s) { s->register_time_event = avahi_time_event_queue_add(s->time_event_queue, &tv, register_time_event_callback, s); } -void avahi_server_set_host_name(AvahiServer *s, const gchar *host_name) { +gint avahi_server_set_host_name(AvahiServer *s, const gchar *host_name) { g_assert(s); g_assert(host_name); @@ -1200,9 +1200,10 @@ void avahi_server_set_host_name(AvahiServer *s, const gchar *host_name) { update_fqdn(s); delayed_register_stuff(s); + return 0; } -void avahi_server_set_domain_name(AvahiServer *s, const gchar *domain_name) { +gint avahi_server_set_domain_name(AvahiServer *s, const gchar *domain_name) { g_assert(s); g_assert(domain_name); @@ -1214,6 +1215,7 @@ void avahi_server_set_domain_name(AvahiServer *s, const gchar *domain_name) { update_fqdn(s); delayed_register_stuff(s); + return 0; } @@ -1391,7 +1393,7 @@ void avahi_server_free(AvahiServer* s) { g_free(s); } -void avahi_server_add( +gint avahi_server_add( AvahiServer *s, AvahiEntryGroup *g, gint interface, @@ -1428,7 +1430,10 @@ void avahi_server_add( AVAHI_LLIST_PREPEND(AvahiEntry, by_group, g->entries, e); avahi_announce_entry(s, e); + + return 0; } + const AvahiRecord *avahi_server_iterate(AvahiServer *s, AvahiEntryGroup *g, void **state) { AvahiEntry **e = (AvahiEntry**) state; g_assert(s); @@ -1467,7 +1472,7 @@ void avahi_server_dump(AvahiServer *s, FILE *f) { avahi_dump_caches(s->monitor, f); } -void avahi_server_add_ptr( +gint avahi_server_add_ptr( AvahiServer *s, AvahiEntryGroup *g, gint interface, @@ -1484,9 +1489,10 @@ void avahi_server_add_ptr( r->data.ptr.name = avahi_normalize_name(dest); avahi_server_add(s, g, interface, protocol, flags, r); avahi_record_unref(r); + return 0; } -void avahi_server_add_address( +gint avahi_server_add_address( AvahiServer *s, AvahiEntryGroup *g, gint interface, @@ -1533,9 +1539,11 @@ void avahi_server_add_address( } g_free(n); + + return 0; } -void avahi_server_add_text_strlst( +gint avahi_server_add_text_strlst( AvahiServer *s, AvahiEntryGroup *g, gint interface, @@ -1552,9 +1560,11 @@ void avahi_server_add_text_strlst( r->data.txt.string_list = strlst; avahi_server_add(s, g, interface, protocol, flags, r); avahi_record_unref(r); + + return 0; } -void avahi_server_add_text_va( +gint avahi_server_add_text_va( AvahiServer *s, AvahiEntryGroup *g, gint interface, @@ -1566,9 +1576,10 @@ void avahi_server_add_text_va( g_assert(s); avahi_server_add_text_strlst(s, g, interface, protocol, flags, name, avahi_string_list_new_va(va)); + return 0; } -void avahi_server_add_text( +gint avahi_server_add_text( AvahiServer *s, AvahiEntryGroup *g, gint interface, @@ -1584,6 +1595,8 @@ void avahi_server_add_text( va_start(va, name); avahi_server_add_text_va(s, g, interface, protocol, flags, name, va); va_end(va); + + return 0; } static void escape_service_name(gchar *d, guint size, const gchar *s) { @@ -1608,7 +1621,7 @@ static void escape_service_name(gchar *d, guint size, const gchar *s) { *(d++) = 0; } -void avahi_server_add_service_strlst( +gint avahi_server_add_service_strlst( AvahiServer *s, AvahiEntryGroup *g, gint interface, @@ -1655,9 +1668,11 @@ void avahi_server_add_service_strlst( snprintf(enum_ptr, sizeof(enum_ptr), "_services._dns-sd._udp.%s", domain); avahi_server_add_ptr(s, g, interface, protocol, AVAHI_ENTRY_NULL, enum_ptr, ptr_name); + + return 0; } -void avahi_server_add_service_va( +gint avahi_server_add_service_va( AvahiServer *s, AvahiEntryGroup *g, gint interface, @@ -1674,9 +1689,10 @@ void avahi_server_add_service_va( g_assert(name); avahi_server_add_service_strlst(s, g, interface, protocol, type, name, domain, host, port, avahi_string_list_new_va(va)); + return 0; } -void avahi_server_add_service( +gint avahi_server_add_service( AvahiServer *s, AvahiEntryGroup *g, gint interface, @@ -1697,6 +1713,7 @@ void avahi_server_add_service( va_start(va, port); avahi_server_add_service_va(s, g, interface, protocol, type, name, domain, host, port, va); va_end(va); + return 0; } static void post_query_callback(AvahiInterfaceMonitor *m, AvahiInterface *i, gpointer userdata) { @@ -1765,16 +1782,18 @@ void avahi_entry_group_free(AvahiEntryGroup *g) { g->server->need_entry_cleanup = TRUE; } -void avahi_entry_group_commit(AvahiEntryGroup *g) { +gint avahi_entry_group_commit(AvahiEntryGroup *g) { g_assert(g); g_assert(!g->dead); if (g->state != AVAHI_ENTRY_GROUP_UNCOMMITED) - return; + return -1; avahi_entry_group_change_state(g, AVAHI_ENTRY_GROUP_REGISTERING); avahi_announce_group(g->server, g); avahi_entry_group_check_probed(g, FALSE); + + return 0; } gboolean avahi_entry_commited(AvahiEntry *e) { diff --git a/todo b/todo index a24dc54..aa27b96 100644 --- a/todo +++ b/todo @@ -1,13 +1,4 @@ todo: -* reflector: - - handle legacy unicast - - handle unicast reply - - handle known answer - -* debug linux 2.4 spurious packet - -* test against apple test suite - * release! done: @@ -43,3 +34,5 @@ done: * Return to probing state on conflict * response job dependencies * enlarge packet in case a record/query is too large to fit in a normal packet +* reflector +* test against apple test suite