X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=avahi-core%2Fcore.h;h=e0b5b5c100d8d06c521738a87231864da407158e;hb=9962a048634c590db23a00db1d01daada779844c;hp=addfebee1134d82a400c3855755b2c3656cde7c4;hpb=e1f934bbe96fd8e7f3f5212b783c0d3a434d4789;p=catta diff --git a/avahi-core/core.h b/avahi-core/core.h index addfebe..e0b5b5c 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,12 +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 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 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. Newer versions of the RFC do no longer contain this check, so it is disabled by default. */ + 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 reflect_ipv; /**< if enable_reflector is TRUE, enable/disable reflecting between IPv4 and IPv6 */ } AvahiServerConfig; /** Allocate a new mDNS responder object. */ @@ -126,94 +130,133 @@ 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( - AvahiServer *s, - AvahiEntryGroup *g, - gint interface, - guchar protocol, - AvahiEntryFlags flags, - AvahiRecord *r); +/** Add a new resource record to the server. Returns 0 on success, negative otherwise. */ +gint avahi_server_add( + AvahiServer *s, /**< The server object to add this record to */ + AvahiEntryGroup *g, /**< An entry group object if this new record shall be attached to one, or NULL. If you plan to remove the record sometime later you a required to pass an entry group object here. */ + AvahiIfIndex interface, /**< A numeric index of a network interface to attach this record to, or AVAHI_IF_UNSPEC to attach this record to all interfaces */ + AvahiProtocol protocol, /**< A protocol family to attach this record to. One of the AVAHI_PROTO_xxx constants. Use AVAHI_PROTO_UNSPEC to make this record available on all protocols (wich means on both IPv4 and IPv6). */ + AvahiEntryFlags flags, /**< Special flags for this record */ + AvahiRecord *r /**< The record to add. This function increases the reference counter of this object. */ ); -void avahi_server_add_ptr( +gint avahi_server_add_ptr( AvahiServer *s, AvahiEntryGroup *g, - gint interface, - guchar protocol, + AvahiIfIndex interface, + AvahiProtocol protocol, AvahiEntryFlags flags, const gchar *name, const gchar *dest); -void avahi_server_add_address( +gint avahi_server_add_address( AvahiServer *s, AvahiEntryGroup *g, - gint interface, - guchar protocol, + AvahiIfIndex interface, + AvahiProtocol protocol, AvahiEntryFlags flags, const gchar *name, AvahiAddress *a); -void avahi_server_add_text( +gint avahi_server_add_text( AvahiServer *s, AvahiEntryGroup *g, - gint interface, - guchar protocol, + AvahiIfIndex interface, + AvahiProtocol protocol, AvahiEntryFlags flags, 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, - guchar protocol, + AvahiIfIndex interface, + AvahiProtocol protocol, AvahiEntryFlags flags, const gchar *name, va_list va); -void avahi_server_add_text_strlst( +gint avahi_server_add_text_strlst( AvahiServer *s, AvahiEntryGroup *g, - gint interface, - guchar protocol, + AvahiIfIndex interface, + AvahiProtocol protocol, AvahiEntryFlags flags, const gchar *name, AvahiStringList *strlst); -void avahi_server_add_service( +gint avahi_server_add_service( AvahiServer *s, AvahiEntryGroup *g, - gint interface, - guchar protocol, + AvahiIfIndex interface, + AvahiProtocol protocol, const gchar *type, const gchar *name, const gchar *domain, const gchar *host, guint16 port, - ... /* text records, terminated by NULL */); + ... /**< text records, terminated by NULL */); -void avahi_server_add_service_va( +gint avahi_server_add_service_va( AvahiServer *s, AvahiEntryGroup *g, - gint interface, - guchar protocol, + AvahiIfIndex interface, + AvahiProtocol protocol, const gchar *type, const gchar *name, const gchar *domain, @@ -221,11 +264,11 @@ 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, - guchar protocol, + AvahiIfIndex interface, + AvahiProtocol protocol, const gchar *type, const gchar *name, const gchar *domain, @@ -233,6 +276,38 @@ void avahi_server_add_service_strlst( guint16 port, AvahiStringList *strlst); +/** The type of DNS server */ +typedef enum { + AVAHI_DNS_SERVER_RESOLVE, /**< Unicast DNS servers for normal resolves (_domain._udp)*/ + AVAHI_DNS_SERVER_UPDATE /**< Unicast DNS servers for updates (_dns-update._udp)*/ +} AvahiDNSServerType; + +/** Publish the specified unicast DNS server address via mDNS. You may + * browse for records create this way wit + * avahi_dns_server_browser_new(). */ +gint avahi_server_add_dns_server_address( + AvahiServer *s, + AvahiEntryGroup *g, + AvahiIfIndex interface, + AvahiProtocol protocol, + const gchar *domain, + AvahiDNSServerType type, + const AvahiAddress *address, + guint16 port /** should be 53 */); + +/** Similar to avahi_server_add_dns_server_address(), but specify a +host name instead of an address. The specified host name should be +resolvable via mDNS */ +gint avahi_server_add_dns_server_name( + AvahiServer *s, + AvahiEntryGroup *g, + AvahiIfIndex interface, + AvahiProtocol protocol, + const gchar *domain, + AvahiDNSServerType type, + const gchar *name, + guint16 port /** should be 53 */); + typedef enum { AVAHI_BROWSER_NEW = 0, AVAHI_BROWSER_REMOVE = -1 @@ -245,45 +320,56 @@ typedef enum { typedef struct AvahiRecordBrowser AvahiRecordBrowser; -typedef void (*AvahiRecordBrowserCallback)(AvahiRecordBrowser *b, gint interface, guchar protocol, AvahiBrowserEvent event, AvahiRecord *record, gpointer userdata); -AvahiRecordBrowser *avahi_record_browser_new(AvahiServer *server, gint interface, guchar protocol, AvahiKey *key, AvahiRecordBrowserCallback callback, gpointer userdata); +typedef void (*AvahiRecordBrowserCallback)(AvahiRecordBrowser *b, AvahiIfIndex interface, AvahiProtocol protocol, AvahiBrowserEvent event, AvahiRecord *record, gpointer userdata); +AvahiRecordBrowser *avahi_record_browser_new(AvahiServer *server, AvahiIfIndex interface, AvahiProtocol protocol, AvahiKey *key, AvahiRecordBrowserCallback callback, gpointer userdata); void avahi_record_browser_free(AvahiRecordBrowser *b); typedef struct AvahiHostNameResolver AvahiHostNameResolver; -typedef void (*AvahiHostNameResolverCallback)(AvahiHostNameResolver *r, gint interface, guchar protocol, AvahiResolverEvent event, const gchar *host_name, const AvahiAddress *a, gpointer userdata); -AvahiHostNameResolver *avahi_host_name_resolver_new(AvahiServer *server, gint interface, guchar protocol, const gchar *host_name, guchar aprotocol, AvahiHostNameResolverCallback calback, gpointer userdata); +typedef void (*AvahiHostNameResolverCallback)(AvahiHostNameResolver *r, AvahiIfIndex interface, AvahiProtocol protocol, AvahiResolverEvent event, const gchar *host_name, const AvahiAddress *a, gpointer userdata); +AvahiHostNameResolver *avahi_host_name_resolver_new(AvahiServer *server, AvahiIfIndex interface, AvahiProtocol protocol, const gchar *host_name, AvahiProtocol aprotocol, AvahiHostNameResolverCallback calback, gpointer userdata); void avahi_host_name_resolver_free(AvahiHostNameResolver *r); typedef struct AvahiAddressResolver AvahiAddressResolver; -typedef void (*AvahiAddressResolverCallback)(AvahiAddressResolver *r, gint interface, guchar protocol, AvahiResolverEvent event, const AvahiAddress *a, const gchar *host_name, gpointer userdata); -AvahiAddressResolver *avahi_address_resolver_new(AvahiServer *server, gint interface, guchar protocol, const AvahiAddress *address, AvahiAddressResolverCallback calback, gpointer userdata); +typedef void (*AvahiAddressResolverCallback)(AvahiAddressResolver *r, AvahiIfIndex interface, AvahiProtocol protocol, AvahiResolverEvent event, const AvahiAddress *a, const gchar *host_name, gpointer userdata); +AvahiAddressResolver *avahi_address_resolver_new(AvahiServer *server, AvahiIfIndex interface, AvahiProtocol 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 */ + AVAHI_DOMAIN_BROWSER_BROWSE_LEGACY /**< Legacy browse domain - see DNS-SD spec for more information */ } AvahiDomainBrowserType; typedef struct AvahiDomainBrowser AvahiDomainBrowser; -typedef void (*AvahiDomainBrowserCallback)(AvahiDomainBrowser *b, gint interface, guchar protocol, AvahiBrowserEvent event, const gchar *domain, gpointer userdata); -AvahiDomainBrowser *avahi_domain_browser_new(AvahiServer *server, gint interface, guchar protocol, const gchar *domain, AvahiDomainBrowserType type, AvahiDomainBrowserCallback callback, gpointer userdata); +typedef void (*AvahiDomainBrowserCallback)(AvahiDomainBrowser *b, AvahiIfIndex interface, AvahiProtocol protocol, AvahiBrowserEvent event, const gchar *domain, gpointer userdata); +AvahiDomainBrowser *avahi_domain_browser_new(AvahiServer *server, AvahiIfIndex interface, AvahiProtocol protocol, const gchar *domain, AvahiDomainBrowserType type, AvahiDomainBrowserCallback callback, gpointer userdata); void avahi_domain_browser_free(AvahiDomainBrowser *b); typedef struct AvahiServiceTypeBrowser AvahiServiceTypeBrowser; -typedef void (*AvahiServiceTypeBrowserCallback)(AvahiServiceTypeBrowser *b, gint interface, guchar protocol, AvahiBrowserEvent event, const gchar *type, const gchar *domain, gpointer userdata); -AvahiServiceTypeBrowser *avahi_service_type_browser_new(AvahiServer *server, gint interface, guchar protocol, const gchar *domain, AvahiServiceTypeBrowserCallback callback, gpointer userdata); +typedef void (*AvahiServiceTypeBrowserCallback)(AvahiServiceTypeBrowser *b, AvahiIfIndex interface, AvahiProtocol protocol, AvahiBrowserEvent event, const gchar *type, const gchar *domain, gpointer userdata); +AvahiServiceTypeBrowser *avahi_service_type_browser_new(AvahiServer *server, AvahiIfIndex interface, AvahiProtocol protocol, const gchar *domain, AvahiServiceTypeBrowserCallback callback, gpointer userdata); void avahi_service_type_browser_free(AvahiServiceTypeBrowser *b); typedef struct AvahiServiceBrowser AvahiServiceBrowser; -typedef void (*AvahiServiceBrowserCallback)(AvahiServiceBrowser *b, gint interface, guchar protocol, AvahiBrowserEvent event, const gchar *name, const gchar *type, const gchar *domain, gpointer userdata); -AvahiServiceBrowser *avahi_service_browser_new(AvahiServer *server, gint interface, guchar protocol, const gchar *service_type, const gchar *domain, AvahiServiceBrowserCallback callback, gpointer userdata); +typedef void (*AvahiServiceBrowserCallback)(AvahiServiceBrowser *b, AvahiIfIndex interface, AvahiProtocol protocol, AvahiBrowserEvent event, const gchar *name, const gchar *type, const gchar *domain, gpointer userdata); +AvahiServiceBrowser *avahi_service_browser_new(AvahiServer *server, AvahiIfIndex interface, AvahiProtocol protocol, const gchar *service_type, const gchar *domain, AvahiServiceBrowserCallback callback, gpointer userdata); void avahi_service_browser_free(AvahiServiceBrowser *b); typedef struct AvahiServiceResolver AvahiServiceResolver; -typedef void (*AvahiServiceResolverCallback)(AvahiServiceResolver *r, gint interface, guchar protocol, AvahiResolverEvent event, const gchar *name, const gchar *type, const gchar *domain, const gchar *host_name, const AvahiAddress *a, guint16 port, AvahiStringList *txt, gpointer userdata); -AvahiServiceResolver *avahi_service_resolver_new(AvahiServer *server, gint interface, guchar protocol, const gchar *name, const gchar *type, const gchar *domain, guchar aprotocol, AvahiServiceResolverCallback calback, gpointer userdata); +typedef void (*AvahiServiceResolverCallback)(AvahiServiceResolver *r, AvahiIfIndex interface, AvahiProtocol protocol, AvahiResolverEvent event, const gchar *name, const gchar *type, const gchar *domain, const gchar *host_name, const AvahiAddress *a, guint16 port, AvahiStringList *txt, gpointer userdata); +AvahiServiceResolver *avahi_service_resolver_new(AvahiServer *server, AvahiIfIndex interface, AvahiProtocol protocol, const gchar *name, const gchar *type, const gchar *domain, AvahiProtocol aprotocol, AvahiServiceResolverCallback calback, gpointer userdata); void avahi_service_resolver_free(AvahiServiceResolver *r); + +/** A domain service browser object. Use this to browse for + * conventional unicast DNS servers which may be used to resolve + * conventional domain names */ +typedef struct AvahiDNSServerBrowser AvahiDNSServerBrowser; +typedef void (*AvahiDNSServerBrowserCallback)(AvahiDNSServerBrowser *b, AvahiIfIndex interface, AvahiProtocol protocol, AvahiBrowserEvent event, const gchar *host_name, const AvahiAddress *a, guint16 port, gpointer userdata); +AvahiDNSServerBrowser *avahi_dns_server_browser_new(AvahiServer *server, AvahiIfIndex interface, AvahiProtocol protocol, const gchar *domain, AvahiDNSServerType type, AvahiProtocol aprotocol, AvahiDNSServerBrowserCallback callback, gpointer userdata); +void avahi_dns_server_browser_free(AvahiDNSServerBrowser *b); + #endif