X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=avahi-core%2Fcore.h;h=0565d23e49ff70215ab0fe9abf4c3599318649c3;hb=219241ab5223b705ade51485ea9227b0a6089c0d;hp=9e2f66b89cb980df7d0e5f03f5d8723a49b3dda2;hpb=4ff0807c04fcc239de52a793bceb88e7f3408f3f;p=catta diff --git a/avahi-core/core.h b/avahi-core/core.h index 9e2f66b..0565d23 100644 --- a/avahi-core/core.h +++ b/avahi-core/core.h @@ -34,8 +34,9 @@ typedef struct AvahiEntry AvahiEntry; /** A group of locally registered DNS RRs */ typedef struct AvahiEntryGroup AvahiEntryGroup; -#include -#include +#include +#include +#include /** States of a server object */ typedef enum { @@ -51,7 +52,8 @@ typedef enum { AVAHI_ENTRY_NULL = 0, /**< No special flags */ AVAHI_ENTRY_UNIQUE = 1, /**< The RRset is intended to be unique */ AVAHI_ENTRY_NOPROBE = 2, /**< Though the RRset is intended to be unique no probes shall be sent */ - AVAHI_ENTRY_NOANNOUNCE = 4 /**< Do not announce this RR to other hosts */ + AVAHI_ENTRY_NOANNOUNCE = 4, /**< Do not announce this RR to other hosts */ + AVAHI_ENTRY_ALLOWMUTIPLE = 8 /**< Allow multiple local records of this type, even if they are intended to be unique */ } AvahiEntryFlags; /** States of an entry group object */ @@ -74,13 +76,14 @@ typedef struct AvahiServerConfig { gchar *domain_name; /**< Default domain name. If left empty defaults to .local */ gboolean use_ipv4; /**< Enable IPv4 support */ gboolean use_ipv6; /**< Enable IPv6 support */ - gboolean register_hinfo; /**< Register a HINFO record for the host containing the local OS and CPU type */ - gboolean register_addresses; /**< Register A, AAAA and PTR records for all local IP addresses */ + gboolean publish_hinfo; /**< Register a HINFO record for the host containing the local OS and CPU type */ + gboolean publish_addresses; /**< Register A, AAAA and PTR records for all local IP addresses */ + gboolean publish_workstation; /**< Register a _workstation._tcp service */ + gboolean publish_domain; /**< Announce the local domain for browsing */ gboolean check_response_ttl; /**< If enabled the server ignores all incoming responses with IP TTL != 255 */ - gboolean announce_domain; /**< Announce the local domain for browsing */ - gboolean use_iff_running; /**< Require IFF_RUNNING on local network interfaces. This is the official way to check for link beat. Unfortunately this doesn't work with all drivers. So bettere leave this off. */ + gboolean use_iff_running; /**< Require IFF_RUNNING on local network interfaces. This is the official way to check for link beat. Unfortunately this doesn't work with all drivers. So bettere leave this off. */ gboolean enable_reflector; /**< Reflect incoming mDNS traffic to all local networks. This allows mDNS based network browsing beyond ethernet borders */ - gboolean ipv_reflect; /**< if enable_reflector is TRUE, enable/disable reflecting between IPv4 and IPv6 */ + gboolean reflect_ipv; /**< if enable_reflector is TRUE, enable/disable reflecting between IPv4 and IPv6 */ } AvahiServerConfig; /** Allocate a new mDNS responder object. */ @@ -127,25 +130,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, @@ -153,7 +194,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, @@ -162,7 +203,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, @@ -171,7 +212,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, @@ -180,7 +221,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, @@ -189,7 +230,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, @@ -198,7 +239,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, @@ -210,7 +251,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, @@ -222,7 +263,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, @@ -260,11 +301,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;