diff options
| author | Lennart Poettering <lennart@poettering.net> | 2006-01-27 20:33:25 +0000 |
|---|---|---|
| committer | Lennart Poettering <lennart@poettering.net> | 2006-01-27 20:33:25 +0000 |
| commit | 4ecb5cd013710a7871f58b68fa118b7f1a58ac8d (patch) | |
| tree | ef6a51305282d30dc73616efe94fa4769a6155ed /avahi-common | |
| parent | f3d66c3d13ca21275c80d16393d9fadd913c64ae (diff) | |
Update doxygen docs a little to make clearer when to use what API when modifying an existing service
git-svn-id: file:///home/lennart/svn/public/avahi/trunk@1113 941a03a8-eaeb-0310-b9a0-b1bbd8fe43fe
Diffstat (limited to 'avahi-common')
| -rw-r--r-- | avahi-common/defs.h | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/avahi-common/defs.h b/avahi-common/defs.h index 9ad69be..100c9f5 100644 --- a/avahi-common/defs.h +++ b/avahi-common/defs.h @@ -118,9 +118,16 @@ * 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, 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. + * - When you need to modify your services (i.e. change the TXT data + * or the port number), 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. When changing just the + * TXT data avahi_entry_group_update_txt() is a shortcut for + * AVAHI_PUBLISH_UPDATE. Please note that you cannot use + * AVAHI_PUBLISH_UPDATE when changing the service name! Renaming a + * DNS-SD service is identical to deleting and creating a new one, and + * that's exactly what you should do in that case. First call + * avahi_entry_group_reset() to remove it and than readd it normally. * * The linked functions belong to avahi-client. They all have counterparts in the DBUS API and avahi-core. * |