X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=avahi-client%2Fclient.h;h=0cafed323459607763d99d3be1e3ab3feb7450a1;hb=16db94194059f7ca05813f68c26c59cfcfdcbd7c;hp=056adfbe7fe00274f1bdedc702bbbb7bf39b9912;hpb=d0c6f66e03793c19c034c26c1267f9382167b3ad;p=catta diff --git a/avahi-client/client.h b/avahi-client/client.h index 056adfb..0cafed3 100644 --- a/avahi-client/client.h +++ b/avahi-client/client.h @@ -33,17 +33,46 @@ /** \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 +/** A connection context */ typedef struct AvahiClient AvahiClient; + +/** An entry group object */ typedef struct AvahiEntryGroup AvahiEntryGroup; + +/** A domain browser object */ typedef struct AvahiDomainBrowser AvahiDomainBrowser; + +/** A service browser object */ typedef struct AvahiServiceBrowser AvahiServiceBrowser; + +/** A service type browser object */ typedef struct AvahiServiceTypeBrowser AvahiServiceTypeBrowser; -/** States of a client object, note that AvahiServerStates are also emitted */ +/** A service resolver object */ +typedef struct AvahiServiceResolver AvahiServiceResolver; + +/** A service resolver object */ +typedef struct AvahiHostNameResolver AvahiHostNameResolver; + +/** An address resolver object */ +typedef struct AvahiAddressResolver AvahiAddressResolver; + +/** States of a client object, a superset of AvahiServerState */ typedef enum { AVAHI_CLIENT_S_INVALID = AVAHI_SERVER_INVALID, AVAHI_CLIENT_S_REGISTERING = AVAHI_SERVER_REGISTERING, @@ -67,6 +96,42 @@ typedef void (*AvahiServiceBrowserCallback) (AvahiServiceBrowser *b, AvahiIfInde /** 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 (const AvahiPoll *poll_api, AvahiClientCallback callback, void *userdata, int *error); @@ -148,9 +213,6 @@ int avahi_entry_group_add_service_va( uint16_t port, va_list va); -/** Get the D-Bus path of an AvahiEntryGroup object, for debugging purposes only. */ -const char* avahi_entry_group_get_dbus_path (AvahiEntryGroup *); - /** Browse for domains on the local network */ AvahiDomainBrowser* avahi_domain_browser_new (AvahiClient *client, AvahiIfIndex interface, @@ -160,8 +222,8 @@ AvahiDomainBrowser* avahi_domain_browser_new (AvahiClient *client, AvahiDomainBrowserCallback callback, void *userdata); -/** Get the D-Bus path of an AvahiDomainBrowser object, for debugging purposes only. */ -const char* avahi_domain_browser_get_dbus_path (AvahiDomainBrowser *); +/** 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 *); @@ -175,8 +237,8 @@ AvahiServiceTypeBrowser* avahi_service_type_browser_new ( AvahiServiceTypeBrowserCallback callback, void *userdata); -/** Get the D-Bus path of an AvahiServiceTypeBrowser object, for debugging purposes only. */ -const char* avahi_service_type_browser_get_dbus_path(AvahiServiceTypeBrowser *); +/** 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 *); @@ -191,12 +253,76 @@ AvahiServiceBrowser* avahi_service_browser_new ( AvahiServiceBrowserCallback callback, void *userdata); -/** Get the D-Bus path of an AvahiServiceBrowser object, for debugging purposes only. */ -const char* avahi_service_browser_get_dbus_path (AvahiServiceBrowser *); +/** 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); + +/** Return 1 if the specified service is a registered locally, negative on failure, 0 otherwise. */ +int avahi_client_is_service_local(AvahiClient *client, AvahiIfIndex interface, AvahiProtocol protocol, const char *name, const char *type, const char *domain); + #ifndef DOXYGEN_SHOULD_SKIP_THIS AVAHI_C_DECL_END #endif