X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=avahi-core%2Fcore.h;h=c832e0385535adc1f8471e0b8899d8d7bea51fa3;hb=da69334ace7a4620e67fbf0a3eed61835d272ae3;hp=42e6ee09e2b233c9762ede05608265f3f5e41f33;hpb=c526a85bcdb32f84e6ade05ce647a431f6a07c10;p=catta diff --git a/avahi-core/core.h b/avahi-core/core.h index 42e6ee0..c832e03 100644 --- a/avahi-core/core.h +++ b/avahi-core/core.h @@ -25,32 +25,88 @@ #include #include +/** An mDNS responder object */ typedef struct AvahiServer AvahiServer; + +/** A locally registered DNS resource record */ typedef struct AvahiEntry AvahiEntry; + +/** A group of locally registered DNS RRs */ typedef struct AvahiEntryGroup AvahiEntryGroup; #include #include +/** States of a server object */ typedef enum { - AVAHI_ENTRY_NULL = 0, - AVAHI_ENTRY_UNIQUE = 1, - AVAHI_ENTRY_NOPROBE = 2, - AVAHI_ENTRY_NOANNOUNCE = 4 + AVAHI_SERVER_INVALID = -1, /**< Invalid state (initial) */ + AVAHI_SERVER_REGISTERING = 0, /**< Host RRs are being registered */ + AVAHI_SERVER_RUNNING, /**< All host RRs have been established */ + AVAHI_SERVER_COLLISION, /**< There is a collision with a host RR. All host RRs have been withdrawn, the user should set a new host name via avahi_server_set_host_name() */ + AVAHI_SERVER_SLEEPING /**< The host or domain name has changed and the server waits for old entries to be expired */ +} AvahiServerState; + +/** Flags for server entries */ +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 */ } AvahiEntryFlags; +/** States of an entry group object */ typedef enum { - AVAHI_ENTRY_GROUP_UNCOMMITED, - AVAHI_ENTRY_GROUP_REGISTERING, - AVAHI_ENTRY_GROUP_ESTABLISHED, - AVAHI_ENTRY_GROUP_COLLISION + AVAHI_ENTRY_GROUP_UNCOMMITED = -1, /**< The group has not yet been commited, the user must still call avahi_entry_group_commit() */ + AVAHI_ENTRY_GROUP_REGISTERING = 0, /**< The entries of the group are currently being registered */ + AVAHI_ENTRY_GROUP_ESTABLISHED, /**< The entries have successfully been established */ + AVAHI_ENTRY_GROUP_COLLISION /**< A name collision for one of the entries in the group has been detected, the entries have been withdrawn */ } AvahiEntryGroupState; +/** Prototype for callback functions which are called whenever the state of an AvahiServer object changes */ +typedef void (*AvahiServerCallback) (AvahiServer *s, AvahiServerState state, gpointer userdata); + +/** Prototype for callback functions which are called whenever the state of an AvahiEntryGroup object changes */ typedef void (*AvahiEntryGroupCallback) (AvahiServer *s, AvahiEntryGroup *g, AvahiEntryGroupState state, gpointer userdata); -AvahiServer *avahi_server_new(GMainContext *c); +/** Stores configuration options for a server instance */ +typedef struct AvahiServerConfig { + gchar *host_name; /**< Default host name. If left empty defaults to the result of gethostname(2) of the libc */ + 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. */ +} AvahiServerConfig; + +/** Allocate a new mDNS responder object. */ +AvahiServer *avahi_server_new( + GMainContext *c, /**< The GLIB main loop context to attach to */ + const AvahiServerConfig *sc, /**< If non-NULL a pointer to a configuration structure for the server */ + AvahiServerCallback callback, /**< A callback which is called whenever the state of the server changes */ + gpointer userdata /**< An opaque pointer which is passed to the callback function */); + +/** 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); +void avahi_server_config_free(AvahiServerConfig *c); + +const gchar* avahi_server_get_domain_name(AvahiServer *s); +const gchar* avahi_server_get_host_name(AvahiServer *s); +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); + +gpointer avahi_server_get_data(AvahiServer *s); +void avahi_server_set_data(AvahiServer *s, gpointer userdata); + +AvahiServerState avahi_server_get_state(AvahiServer *s); + const AvahiRecord *avahi_server_iterate(AvahiServer *s, AvahiEntryGroup *g, void **state); void avahi_server_dump(AvahiServer *s, FILE *f); @@ -58,6 +114,8 @@ AvahiEntryGroup *avahi_entry_group_new(AvahiServer *s, AvahiEntryGroupCallback c void avahi_entry_group_free(AvahiEntryGroup *g); void avahi_entry_group_commit(AvahiEntryGroup *g); AvahiEntryGroupState avahi_entry_group_get_state(AvahiEntryGroup *g); +void avahi_entry_group_set_data(AvahiEntryGroup *g, gpointer userdata); +gpointer avahi_entry_group_get_data(AvahiEntryGroup *g); void avahi_server_add( AvahiServer *s, @@ -149,16 +207,56 @@ void avahi_server_add_service_strlst( AvahiStringList *strlst); typedef enum { - AVAHI_SUBSCRIPTION_NEW, - AVAHI_SUBSCRIPTION_REMOVE, - AVAHI_SUBSCRIPTION_CHANGE -} AvahiSubscriptionEvent; + AVAHI_BROWSER_NEW = 0, + AVAHI_BROWSER_REMOVE = -1 +} AvahiBrowserEvent; + +typedef enum { + AVAHI_RESOLVER_FOUND = 0, + AVAHI_RESOLVER_TIMEOUT = -1 +} AvahiResolverEvent; + + +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); +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); +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); +void avahi_address_resolver_free(AvahiAddressResolver *r); + +typedef enum { + AVAHI_DOMAIN_BROWSER_REGISTER, + AVAHI_DOMAIN_BROWSER_REGISTER_DEFAULT, + AVAHI_DOMAIN_BROWSER_BROWSE, + AVAHI_DOMAIN_BROWSER_BROWSE_DEFAULT +} 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); +void avahi_domain_browser_free(AvahiDomainBrowser *b); -typedef struct AvahiSubscription AvahiSubscription; +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); +void avahi_service_type_browser_free(AvahiServiceTypeBrowser *b); -typedef void (*AvahiSubscriptionCallback)(AvahiSubscription *s, AvahiRecord *record, gint interface, guchar protocol, AvahiSubscriptionEvent event, gpointer userdata); +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); +void avahi_service_browser_free(AvahiServiceBrowser *b); -AvahiSubscription *avahi_subscription_new(AvahiServer *s, AvahiKey *key, gint interface, guchar protocol, AvahiSubscriptionCallback callback, gpointer userdata); -void avahi_subscription_free(AvahiSubscription *s); +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); +void avahi_service_resolver_free(AvahiServiceResolver *r); #endif