X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=avahi-core%2Fcore.h;h=705fa317983ff3afe4774a86a087c34a4751a9e8;hb=c75a6b480b047abc73ee7afd912aef249e9da8e3;hp=49b09b5aa0f2cb78c74608e66ff0bdbc65e08c95;hpb=40cd1f60e9d84610401db992003a3b282de5fcae;p=catta diff --git a/avahi-core/core.h b/avahi-core/core.h index 49b09b5..705fa31 100644 --- a/avahi-core/core.h +++ b/avahi-core/core.h @@ -22,159 +22,154 @@ USA. ***/ -#include -#include +/** \file core.h The Avahi Multicast DNS and DNS Service Discovery implementation. */ + +#include + +#ifndef DOXYGEN_SHOULD_SKIP_THIS +AVAHI_C_DECL_BEGIN +#endif + +/** An mDNS responder object */ typedef struct AvahiServer AvahiServer; -typedef struct AvahiEntry AvahiEntry; -typedef struct AvahiEntryGroup AvahiEntryGroup; -#include +#ifndef DOXYGEN_SHOULD_SKIP_THIS +AVAHI_C_DECL_END +#endif + #include +#include +#include +#include -typedef enum { - AVAHI_ENTRY_NULL = 0, - AVAHI_ENTRY_UNIQUE = 1, - AVAHI_ENTRY_NOPROBE = 2, - AVAHI_ENTRY_NOANNOUNCE = 4 -} AvahiEntryFlags; +#ifndef DOXYGEN_SHOULD_SKIP_THIS +AVAHI_C_DECL_BEGIN +#endif + +/** Maximum number of defined DNS servers for wide area DNS */ +#define AVAHI_MAX_WIDE_AREA_SERVERS 4 +/** Flags for server entries */ typedef enum { - AVAHI_ENTRY_GROUP_UNCOMMITED, - AVAHI_ENTRY_GROUP_REGISTERING, - AVAHI_ENTRY_GROUP_ESTABLISHED, - AVAHI_ENTRY_GROUP_COLLISION -} AvahiEntryGroupState; + 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_ALLOWMUTIPLE = 8 /**< Allow multiple local records of this type, even if they are intended to be unique */ +} AvahiEntryFlags; -typedef void (*AvahiEntryGroupCallback) (AvahiServer *s, AvahiEntryGroup *g, AvahiEntryGroupState state, gpointer userdata); +/** Prototype for callback functions which are called whenever the state of an AvahiServer object changes */ +typedef void (*AvahiServerCallback) (AvahiServer *s, AvahiServerState state, void* userdata); +/** Stores configuration options for a server instance */ typedef struct AvahiServerConfig { - gboolean register_hinfo; - gboolean register_addresses; - gboolean use_ipv4; - gboolean use_ipv6; - gchar *host_name; - gchar *domain_name; - gboolean check_response_ttl; + char *host_name; /**< Default host name. If left empty defaults to the result of gethostname(2) of the libc */ + char *domain_name; /**< Default domain name. If left empty defaults to .local */ + int use_ipv4; /**< Enable IPv4 support */ + int use_ipv6; /**< Enable IPv6 support */ + int publish_hinfo; /**< Register a HINFO record for the host containing the local OS and CPU type */ + int publish_addresses; /**< Register A, AAAA and PTR records for all local IP addresses */ + int publish_workstation; /**< Register a _workstation._tcp service */ + int publish_domain; /**< Announce the local domain for browsing */ + int 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. */ + int 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. */ + int enable_reflector; /**< Reflect incoming mDNS traffic to all local networks. This allows mDNS based network browsing beyond ethernet borders */ + int reflect_ipv; /**< if enable_reflector is 1, enable/disable reflecting between IPv4 and IPv6 */ + int add_service_cookie; /**< Add magic service cookie to all locally generated records implicitly */ + int enable_wide_area; /**< Enable wide area support */ + AvahiAddress wide_area_servers[AVAHI_MAX_WIDE_AREA_SERVERS]; /** Unicast DNS server to use for wide area lookup */ + unsigned n_wide_area_servers; /**< Number of servers in wide_area_servers[] */ } AvahiServerConfig; -AvahiServer *avahi_server_new(GMainContext *c, const AvahiServerConfig *sc); +/** Allocate a new mDNS responder object. */ +AvahiServer *avahi_server_new( + const AvahiPoll *api, /**< The main loop adapter */ + const AvahiServerConfig *sc, /**< If non-NULL a pointer to a configuration structure for the server. The server makes an internal deep copy of this structure, so you may free it using avahi_server_config_done() immediately after calling this function. */ + AvahiServerCallback callback, /**< A callback which is called whenever the state of the server changes */ + void* userdata, /**< An opaque pointer which is passed to the callback function */ + int *error); + +/** Free an mDNS responder object */ void avahi_server_free(AvahiServer* s); -AvahiServerConfig* avahi_server_config_init(AvahiServerConfig *c); -AvahiServerConfig* avahi_server_config_copy(AvahiServerConfig *ret, const AvahiServerConfig *c); +/** Fill in default values for a server configuration structure. If you + * make use of an AvahiServerConfig structure be sure to initialize + * it with this function for the sake of upwards library + * compatibility. This call may allocate strings on the heap. To + * release this memory make sure to call + * avahi_server_config_done(). If you want to replace any strings in + * the structure be sure to free the strings filled in by this + * function with avahi_free() first and allocate the replacements with + * g_malloc() (or g_strdup()).*/ +AvahiServerConfig* avahi_server_config_init( + AvahiServerConfig *c /**< A structure which shall be filled in */ ); + +/** Make a deep copy of the configuration structure *c to *ret. */ +AvahiServerConfig* avahi_server_config_copy( + AvahiServerConfig *ret /**< destination */, + const AvahiServerConfig *c /**< source */); + +/** Free the data in a server configuration structure. */ void avahi_server_config_free(AvahiServerConfig *c); - -const gchar* avahi_server_get_domain(AvahiServer *s); -const gchar* avahi_server_get_host_name(AvahiServer *s); - -const AvahiRecord *avahi_server_iterate(AvahiServer *s, AvahiEntryGroup *g, void **state); -void avahi_server_dump(AvahiServer *s, FILE *f); - -AvahiEntryGroup *avahi_entry_group_new(AvahiServer *s, AvahiEntryGroupCallback callback, gpointer userdata); -void avahi_entry_group_free(AvahiEntryGroup *g); -void avahi_entry_group_commit(AvahiEntryGroup *g); -AvahiEntryGroupState avahi_entry_group_get_state(AvahiEntryGroup *g); - -void avahi_server_add( - AvahiServer *s, - AvahiEntryGroup *g, - gint interface, - guchar protocol, - AvahiEntryFlags flags, - AvahiRecord *r); - -void avahi_server_add_ptr( - AvahiServer *s, - AvahiEntryGroup *g, - gint interface, - guchar protocol, - AvahiEntryFlags flags, - const gchar *name, - const gchar *dest); - -void avahi_server_add_address( - AvahiServer *s, - AvahiEntryGroup *g, - gint interface, - guchar protocol, - AvahiEntryFlags flags, - const gchar *name, - AvahiAddress *a); - -void avahi_server_add_text( - AvahiServer *s, - AvahiEntryGroup *g, - gint interface, - guchar protocol, - AvahiEntryFlags flags, - const gchar *name, - ... /* text records, terminated by NULL */); - -void avahi_server_add_text_va( - AvahiServer *s, - AvahiEntryGroup *g, - gint interface, - guchar protocol, - AvahiEntryFlags flags, - const gchar *name, - va_list va); - -void avahi_server_add_text_strlst( - AvahiServer *s, - AvahiEntryGroup *g, - gint interface, - guchar protocol, - AvahiEntryFlags flags, - const gchar *name, - AvahiStringList *strlst); - -void avahi_server_add_service( - AvahiServer *s, - AvahiEntryGroup *g, - gint interface, - guchar protocol, - const gchar *type, - const gchar *name, - const gchar *domain, - const gchar *host, - guint16 port, - ... /* text records, terminated by NULL */); - -void avahi_server_add_service_va( - AvahiServer *s, - AvahiEntryGroup *g, - gint interface, - guchar protocol, - const gchar *type, - const gchar *name, - const gchar *domain, - const gchar *host, - guint16 port, - va_list va); - -void avahi_server_add_service_strlst( - AvahiServer *s, - AvahiEntryGroup *g, - gint interface, - guchar protocol, - const gchar *type, - const gchar *name, - const gchar *domain, - const gchar *host, - guint16 port, - AvahiStringList *strlst); -typedef enum { - AVAHI_SUBSCRIPTION_NEW, - AVAHI_SUBSCRIPTION_REMOVE, -} AvahiSubscriptionEvent; +/** Return the currently chosen domain name of the server object. The + * return value points to an internally allocated string. Be sure to + * make a copy of the string before calling any other library + * functions. */ +const char* avahi_server_get_domain_name(AvahiServer *s); -typedef struct AvahiSubscription AvahiSubscription; +/** Return the currently chosen host name. The return value points to a internally allocated string. */ +const char* avahi_server_get_host_name(AvahiServer *s); -typedef void (*AvahiSubscriptionCallback)(AvahiSubscription *s, AvahiRecord *record, gint interface, guchar protocol, AvahiSubscriptionEvent event, gpointer userdata); +/** Return the currently chosen host name as a FQDN ("fully qualified + * domain name", i.e. the concatenation of the host and domain + * name). The return value points to a internally allocated string. */ +const char* avahi_server_get_host_name_fqdn(AvahiServer *s); -AvahiSubscription *avahi_subscription_new(AvahiServer *s, AvahiKey *key, gint interface, guchar protocol, AvahiSubscriptionCallback callback, gpointer userdata); -void avahi_subscription_free(AvahiSubscription *s); +/** 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..*/ +int avahi_server_set_host_name(AvahiServer *s, const char *host_name); + +/** Change the domain name of a running mDNS responder. The same rules + * as with avahi_server_set_host_name() apply. */ +int avahi_server_set_domain_name(AvahiServer *s, const char *domain_name); + +/** Return the opaque user data pointer attached to a server object */ +void* avahi_server_get_data(AvahiServer *s); + +/** Change the opaque user data pointer attached to a server object */ +void avahi_server_set_data(AvahiServer *s, void* userdata); + +/** Return the current state of the server object */ +AvahiServerState avahi_server_get_state(AvahiServer *s); + +/** Callback prototype for avahi_server_dump() */ +typedef void (*AvahiDumpCallback)(const char *text, void* userdata); + +/** Dump the current server status by calling "callback" for each line. */ +int avahi_server_dump(AvahiServer *s, AvahiDumpCallback callback, void* userdata); + +/** Return the last error code */ +int avahi_server_errno(AvahiServer *s); + +/** Return the local service cookie */ +uint32_t avahi_server_get_local_service_cookie(AvahiServer *s); + +/** Return 1 if there is a local service with the specified credentials registeresd. Return 0 if not, negative on failure */ +int avahi_server_is_service_local(AvahiServer *s, AvahiIfIndex, AvahiProtocol protocol, const char *name, const char *type, const char*domain); + +/** Set the wide area DNS servers */ +int avahi_server_set_wide_area_servers(AvahiServer *s, const AvahiAddress *a, unsigned n); + +#ifndef DOXYGEN_SHOULD_SKIP_THIS +AVAHI_C_DECL_END +#endif #endif