From 4de3df3db7df43474176533d0b5fac851dd4a9b4 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Fri, 20 May 2005 14:54:00 +0000 Subject: Add support for server state change callbacks git-svn-id: file:///home/lennart/svn/public/avahi/trunk@78 941a03a8-eaeb-0310-b9a0-b1bbd8fe43fe --- avahi-core/core.h | 72 ++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 55 insertions(+), 17 deletions(-) (limited to 'avahi-core/core.h') diff --git a/avahi-core/core.h b/avahi-core/core.h index 49b09b5..d27f02e 100644 --- a/avahi-core/core.h +++ b/avahi-core/core.h @@ -25,48 +25,84 @@ #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() */ +} 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); +/** 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; + 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 */ } AvahiServerConfig; -AvahiServer *avahi_server_new(GMainContext *c, const AvahiServerConfig *sc); +/** 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(AvahiServer *s); +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 avhai_server_get_state(AvahiServer *s); const AvahiRecord *avahi_server_iterate(AvahiServer *s, AvahiEntryGroup *g, void **state); void avahi_server_dump(AvahiServer *s, FILE *f); @@ -75,6 +111,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, -- cgit