X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=avahi-client%2Fclient.h;h=f92f4bff53df5afdf2f81f97362377da184a0e90;hb=e8edcf439d2ce1593af11c357893681b6b3c0bb4;hp=f58a7591309b341eb0a6f5b9a438f6842bce04ec;hpb=f8c479234af6b676027df4fb6b38ce8e22949049;p=catta diff --git a/avahi-client/client.h b/avahi-client/client.h index f58a759..f92f4bf 100644 --- a/avahi-client/client.h +++ b/avahi-client/client.h @@ -28,140 +28,297 @@ #include #include #include +#include +#include /** \file client.h Definitions and functions for the client API over D-Bus */ +/** \example client-publish-service.c Example how to register a DNS-SD + * service using the client interface to avahi-daemon. It behaves like a network + * printer registering both an IPP and a BSD LPR service. */ + +/** \example client-browse-services.c Example how to browse for DNS-SD + * services using the client interface to avahi-daemon. */ + +/** \example glib-integration.c Example of how to integrate + * avahi use with GLIB/GTK applications */ + + #ifndef DOXYGEN_SHOULD_SKIP_THIS AVAHI_C_DECL_BEGIN #endif -typedef struct _AvahiClient AvahiClient; +/** A connection context */ +typedef struct AvahiClient AvahiClient; + +/** An entry group object */ +typedef struct AvahiEntryGroup AvahiEntryGroup; + +/** A domain browser object */ +typedef struct AvahiDomainBrowser AvahiDomainBrowser; -typedef struct _AvahiClientEntryGroup AvahiClientEntryGroup; +/** A service browser object */ +typedef struct AvahiServiceBrowser AvahiServiceBrowser; -typedef struct _AvahiClientDomainBrowser AvahiClientDomainBrowser; +/** A service type browser object */ +typedef struct AvahiServiceTypeBrowser AvahiServiceTypeBrowser; -typedef struct _AvahiClientServiceTypeBrowser AvahiClientServiceTypeBrowser; +/** A service resolver object */ +typedef struct AvahiServiceResolver AvahiServiceResolver; -/* Convenience typedefs for slight name differences */ -typedef AvahiDomainBrowserType AvahiClientDomainBrowserType; -typedef AvahiEntryGroupState AvahiClientEntryGroupState; +/** A service resolver object */ +typedef struct AvahiHostNameResolver AvahiHostNameResolver; -/** States of a client object, note that AvahiServerStates are also emitted */ +/** An address resolver object */ +typedef struct AvahiAddressResolver AvahiAddressResolver; + +/** States of a client object, a superset of AvahiServerState */ typedef enum { - AVAHI_CLIENT_DISCONNECTED = 100, /**< Lost DBUS connection to the Avahi daemon */ - AVAHI_CLIENT_RECONNECTED = 101 /**< Regained connection to the daemon, all records need to be re-added */ + AVAHI_CLIENT_S_INVALID = AVAHI_SERVER_INVALID, + AVAHI_CLIENT_S_REGISTERING = AVAHI_SERVER_REGISTERING, + AVAHI_CLIENT_S_RUNNING = AVAHI_SERVER_RUNNING, + AVAHI_CLIENT_S_COLLISION = AVAHI_SERVER_COLLISION, + AVAHI_CLIENT_DISCONNECTED = 100 /**< Lost DBUS connection to the Avahi daemon */ } AvahiClientState; /** The function prototype for the callback of an AvahiClient */ -typedef void (*AvahiClientCallback) (AvahiClient *s, - AvahiClientState state, - void* userdata); - -/** The function prototype for the callback of an AvahiClientEntryGroup */ -typedef void (*AvahiClientEntryGroupCallback) - (AvahiClientEntryGroup *g, - AvahiEntryGroupState state, - void* userdata); - -/** The function prototype for the callback of an AvahiClientDomainBrowser */ -typedef void (*AvahiClientDomainBrowserCallback) - (AvahiClientDomainBrowser *b, - AvahiIfIndex interface, - AvahiProtocol protocol, - AvahiBrowserEvent event, - char *domain, - void *user_data); - -/** The function prototype for the callback of an AvahiClientServiceTypeBrowser */ -typedef void (*AvahiClientServiceTypeBrowserCallback) - (AvahiClientServiceTypeBrowser *b, - AvahiIfIndex interface, - AvahiProtocol protocol, - AvahiBrowserEvent event, - char *type, - char *domain, - void *user_data); +typedef void (*AvahiClientCallback) (AvahiClient *s, AvahiClientState state, void* userdata); + +/** The function prototype for the callback of an AvahiEntryGroup */ +typedef void (*AvahiEntryGroupCallback) (AvahiEntryGroup *g, AvahiEntryGroupState state, void* userdata); + +/** The function prototype for the callback of an AvahiDomainBrowser */ +typedef void (*AvahiDomainBrowserCallback) (AvahiDomainBrowser *b, AvahiIfIndex interface, AvahiProtocol protocol, AvahiBrowserEvent event, const char *domain, void *userdata); + +/** The function prototype for the callback of an AvahiServiceBrowser */ +typedef void (*AvahiServiceBrowserCallback) (AvahiServiceBrowser *b, AvahiIfIndex interface, AvahiProtocol protocol, AvahiBrowserEvent event, const char *name, const char *type, const char *domain, void *userdata); + +/** The function prototype for the callback of an AvahiServiceTypeBrowser */ +typedef void (*AvahiServiceTypeBrowserCallback) (AvahiServiceTypeBrowser *b, AvahiIfIndex interface, AvahiProtocol protocol, AvahiBrowserEvent event, const char *type, const char *domain, void *userdata); + +/** The function prototype for the callback of an AvahiServiceResolver */ +typedef void (*AvahiServiceResolverCallback) ( + AvahiServiceResolver *r, + AvahiIfIndex interface, + AvahiProtocol protocol, + AvahiResolverEvent event, + const char *name, + const char *type, + const char *domain, + const char *host_name, + const AvahiAddress *a, + uint16_t port, + AvahiStringList *txt, + void *userdata); + +/** The function prototype for the callback of an AvahiHostNameResolver */ +typedef void (*AvahiHostNameResolverCallback) ( + AvahiHostNameResolver *r, + AvahiIfIndex interface, + AvahiProtocol protocol, + AvahiResolverEvent event, + const char *name, + const AvahiAddress *a, + void *userdata); + +/** The function prototype for the callback of an AvahiAddressResolver */ +typedef void (*AvahiAddressResolverCallback) ( + AvahiAddressResolver *r, + AvahiIfIndex interface, + AvahiProtocol protocol, + AvahiResolverEvent event, + AvahiProtocol aprotocol, + const AvahiAddress *a, + const char *name, + void *userdata); /** Creates a new client instance */ -AvahiClient* avahi_client_new (AvahiClientCallback callback, void *user_data); +AvahiClient* avahi_client_new (const AvahiPoll *poll_api, AvahiClientCallback callback, void *userdata, int *error); + +/** Free a client instance */ +void avahi_client_free(AvahiClient *client); /** Get the version of the server */ -char* avahi_client_get_version_string (AvahiClient*); +const char* avahi_client_get_version_string (AvahiClient*); /** Get host name */ -char* avahi_client_get_host_name (AvahiClient*); +const char* avahi_client_get_host_name (AvahiClient*); /** Get domain name */ -char* avahi_client_get_domain_name (AvahiClient*); +const char* avahi_client_get_domain_name (AvahiClient*); /** Get FQDN domain name */ -char* avahi_client_get_host_name_fqdn (AvahiClient*); +const char* avahi_client_get_host_name_fqdn (AvahiClient*); -/** Create a new AvahiClientEntryGroup object */ -AvahiClientEntryGroup* avahi_entry_group_new - (AvahiClient*, - AvahiClientEntryGroupCallback callback, - void *user_data); +/** Get state */ +AvahiClientState avahi_client_get_state(AvahiClient *client); -/** Commit an AvahiClientEntryGroup */ -int avahi_entry_group_commit (AvahiClientEntryGroup*); +/** Get the last error number */ +int avahi_client_errno (AvahiClient*); -/** Reset an AvahiClientEntryGroup */ -int avahi_entry_group_reset (AvahiClientEntryGroup*); +/** Create a new AvahiEntryGroup object */ +AvahiEntryGroup* avahi_entry_group_new (AvahiClient*, AvahiEntryGroupCallback callback, void *userdata); -/** Get an AvahiClientEntryGroup's state */ -int avahi_entry_group_get_state (AvahiClientEntryGroup*); +/** Clean up and free an AvahiEntryGroup object */ +int avahi_entry_group_free (AvahiEntryGroup *); -/** Check if an AvahiClientEntryGroup is empty */ -int avahi_entry_group_is_empty (AvahiClientEntryGroup*); +/** Commit an AvahiEntryGroup */ +int avahi_entry_group_commit (AvahiEntryGroup*); -/** Get the last error number */ -int avahi_client_errno (AvahiClient*); +/** Reset an AvahiEntryGroup */ +int avahi_entry_group_reset (AvahiEntryGroup*); + +/** Get an AvahiEntryGroup's state */ +int avahi_entry_group_get_state (AvahiEntryGroup*); + +/** Check if an AvahiEntryGroup is empty */ +int avahi_entry_group_is_empty (AvahiEntryGroup*); -/** Get an AvahiClientEntryGroup's owning client instance */ -AvahiClient* avahi_entry_group_get_client (AvahiClientEntryGroup*); +/** Get an AvahiEntryGroup's owning client instance */ +AvahiClient* avahi_entry_group_get_client (AvahiEntryGroup*); + +/** Add a service, takes a variable NULL terminated list of text records */ +int avahi_entry_group_add_service( + AvahiEntryGroup *group, + AvahiIfIndex interface, + AvahiProtocol protocol, + const char *name, + const char *type, + const char *domain, + const char *host, + uint16_t port, + ...) AVAHI_GCC_SENTINEL; /** Add a service, takes an AvahiStringList for text records */ -int -avahi_entry_group_add_service (AvahiClientEntryGroup *group, - AvahiIfIndex interface, - AvahiProtocol protocol, - const char *name, - const char *type, - const char *domain, - const char *host, - uint16_t port, - AvahiStringList *txt); - -/** Get the D-Bus path of an AvahiClientEntryGroup object, for debugging purposes only. */ -char* avahi_entry_group_path (AvahiClientEntryGroup *); - -/** Get the D-Bus path of an AvahiClientDomainBrowser object, for debugging purposes only. */ -char* avahi_domain_browser_path (AvahiClientDomainBrowser *); +int avahi_entry_group_add_service_strlst( + AvahiEntryGroup *group, + AvahiIfIndex interface, + AvahiProtocol protocol, + const char *name, + const char *type, + const char *domain, + const char *host, + uint16_t port, + AvahiStringList *txt); + +/** Add a service, takes a NULL terminated va_list for text records */ +int avahi_entry_group_add_service_va( + AvahiEntryGroup *group, + AvahiIfIndex interface, + AvahiProtocol protocol, + const char *name, + const char *type, + const char *domain, + const char *host, + uint16_t port, + va_list va); /** Browse for domains on the local network */ -AvahiClientDomainBrowser* avahi_domain_browser_new - (AvahiClient *client, - AvahiIfIndex interface, - AvahiProtocol protocol, - char *domain, - AvahiDomainBrowserType btype, - AvahiClientDomainBrowserCallback callback, - void *user_data); - -/** Get the D-Bus path of an AvahiClientServiceTypeBrowser object, for debugging purposes only. */ -char* avahi_service_type_browser_path (AvahiClientServiceTypeBrowser *); +AvahiDomainBrowser* avahi_domain_browser_new (AvahiClient *client, + AvahiIfIndex interface, + AvahiProtocol protocol, + const char *domain, + AvahiDomainBrowserType btype, + AvahiDomainBrowserCallback callback, + void *userdata); + +/** Get the parent client of an AvahiDomainBrowser object */ +AvahiClient* avahi_domain_browser_get_client (AvahiDomainBrowser *); + +/** Cleans up and frees an AvahiDomainBrowser object */ +int avahi_domain_browser_free (AvahiDomainBrowser *); /** Browse for service types on the local network */ -AvahiClientServiceTypeBrowser* avahi_service_type_browser_new ( +AvahiServiceTypeBrowser* avahi_service_type_browser_new ( AvahiClient *client, AvahiIfIndex interface, AvahiProtocol protocol, - char *domain, - AvahiClientServiceTypeBrowserCallback callback, - void *user_data); + const char *domain, + AvahiServiceTypeBrowserCallback callback, + void *userdata); +/** Get the parent client of an AvahiServiceTypeBrowser object */ +AvahiClient* avahi_service_type_browser_get_client (AvahiServiceTypeBrowser *); + +/** Cleans up and frees an AvahiServiceTypeBrowser object */ +int avahi_service_type_browser_free (AvahiServiceTypeBrowser *); + +/** Browse for services of a type on the local network */ +AvahiServiceBrowser* avahi_service_browser_new ( + AvahiClient *client, + AvahiIfIndex interface, + AvahiProtocol protocol, + const char *type, + const char *domain, + AvahiServiceBrowserCallback callback, + void *userdata); + +/** Get the parent client of an AvahiServiceBrowser object */ +AvahiClient* avahi_service_browser_get_client (AvahiServiceBrowser *); + +/* Cleans up and frees an AvahiServiceBrowser object */ +int avahi_service_browser_free (AvahiServiceBrowser *); + +/** Create a new service resolver object */ +AvahiServiceResolver * avahi_service_resolver_new( + AvahiClient *client, + AvahiIfIndex interface, + AvahiProtocol protocol, + const char *name, + const char *type, + const char *domain, + AvahiProtocol aprotocol, + AvahiServiceResolverCallback callback, + void *userdata); + +/** Get the parent client of an AvahiServiceResolver object */ +AvahiClient* avahi_service_resolver_get_client (AvahiServiceResolver *); + +/** Free a service resolver object */ +int avahi_service_resolver_free(AvahiServiceResolver *r); + +/** Create a new hostname resolver object */ +AvahiHostNameResolver * avahi_host_name_resolver_new( + AvahiClient *client, + AvahiIfIndex interface, + AvahiProtocol protocol, + const char *name, + AvahiProtocol aprotocol, + AvahiHostNameResolverCallback callback, + void *userdata); + +/** Get the parent client of an AvahiHostNameResolver object */ +AvahiClient* avahi_host_name_resolver_get_client (AvahiHostNameResolver *); + +/** Free a hostname resolver object */ +int avahi_host_name_resolver_free(AvahiHostNameResolver *r); + +/** Create a new address resolver object from an address string. Set aprotocol to AF_UNSPEC for protocol detection. */ +AvahiAddressResolver * avahi_address_resolver_new( + AvahiClient *client, + AvahiIfIndex interface, + AvahiProtocol protocol, + const char *address, + AvahiAddressResolverCallback callback, + void *userdata); + +/** Create a new address resolver object from an AvahiAddress object */ +AvahiAddressResolver* avahi_address_resolver_new_a( + AvahiClient *client, + AvahiIfIndex interface, + AvahiProtocol protocol, + const AvahiAddress *a, + AvahiAddressResolverCallback callback, + void *userdata); + +/** Get the parent client of an AvahiAddressResolver object */ +AvahiClient* avahi_address_resolver_get_client (AvahiAddressResolver *); + +/** Free a AvahiAddressResolver resolver object */ +int avahi_address_resolver_free(AvahiAddressResolver *r); + +/** Return the local service cookie. returns AVAHI_SERVICE_COOKIE_INVALID on failure. */ +uint32_t avahi_client_get_local_service_cookie(AvahiClient *client); #ifndef DOXYGEN_SHOULD_SKIP_THIS AVAHI_C_DECL_END