X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=avahi-client%2Fclient.h;h=4db2aef882bb9e984ce33417f332345cbea26255;hb=45bf63f4c05690420fd2d701a6399550160aba02;hp=9654206963c69f7c2a6cdaf179cfdae956098120;hpb=3ec12a8ec9c7a517cda0e9be8c36766ffc7a1029;p=catta diff --git a/avahi-client/client.h b/avahi-client/client.h index 9654206..4db2aef 100644 --- a/avahi-client/client.h +++ b/avahi-client/client.h @@ -22,29 +22,60 @@ USA. ***/ +#include + #include #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; + +/** A service browser object */ +typedef struct AvahiServiceBrowser AvahiServiceBrowser; -typedef struct _AvahiEntryGroup AvahiEntryGroup; +/** A service type browser object */ +typedef struct AvahiServiceTypeBrowser AvahiServiceTypeBrowser; -typedef struct _AvahiDomainBrowser AvahiDomainBrowser; +/** A service resolver object */ +typedef struct AvahiServiceResolver AvahiServiceResolver; -typedef struct _AvahiServiceTypeBrowser AvahiServiceTypeBrowser; +/** A service resolver object */ +typedef struct AvahiHostNameResolver AvahiHostNameResolver; -/** States of a client object, note that AvahiServerStates are also emitted */ +/** 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 */ @@ -54,28 +85,68 @@ typedef void (*AvahiClientCallback) (AvahiClient *s, AvahiClientState state, voi 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, char *domain, void *user_data); +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, char *type, char *domain, void *user_data); +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); /** 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*); + +/** Get state */ +AvahiClientState avahi_client_get_state(AvahiClient *client); + +/** Get the last error number */ +int avahi_client_errno (AvahiClient*); /** Create a new AvahiEntryGroup object */ -AvahiEntryGroup* avahi_entry_group_new (AvahiClient*, AvahiEntryGroupCallback callback, void *user_data); +AvahiEntryGroup* avahi_entry_group_new (AvahiClient*, AvahiEntryGroupCallback callback, void *userdata); + +/** Clean up and free an AvahiEntryGroup object */ +int avahi_entry_group_free (AvahiEntryGroup *); /** Commit an AvahiEntryGroup */ int avahi_entry_group_commit (AvahiEntryGroup*); @@ -89,51 +160,142 @@ int avahi_entry_group_get_state (AvahiEntryGroup*); /** Check if an AvahiEntryGroup is empty */ int avahi_entry_group_is_empty (AvahiEntryGroup*); -/** Get the last error number */ -int avahi_client_errno (AvahiClient*); - /** 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 (AvahiEntryGroup *group, - AvahiIfIndex interface, - AvahiProtocol protocol, - const char *name, - const char *type, - const char *domain, - const char *host, - int port, - AvahiStringList *txt); +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); /** Get the D-Bus path of an AvahiEntryGroup object, for debugging purposes only. */ -char* avahi_entry_group_path (AvahiEntryGroup *); - -/** Get the D-Bus path of an AvahiDomainBrowser object, for debugging purposes only. */ -char* avahi_domain_browser_path (AvahiDomainBrowser *); +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, AvahiProtocol protocol, - char *domain, + const char *domain, AvahiDomainBrowserType btype, AvahiDomainBrowserCallback callback, - void *user_data); + void *userdata); -/** Get the D-Bus path of an AvahiServiceTypeBrowser object, for debugging purposes only. */ -char* avahi_service_type_browser_path (AvahiServiceTypeBrowser *); +/** Get the parent client of an AvahiDomainBrowser object */ +AvahiClient* avahi_domain_browser_get_client (AvahiDomainBrowser *); + +/** Get the D-Bus path of an AvahiDomainBrowser object, for debugging purposes only. */ +const char* avahi_domain_browser_get_dbus_path (AvahiDomainBrowser *); + +/** Cleans up and frees an AvahiDomainBrowser object */ +int avahi_domain_browser_free (AvahiDomainBrowser *); /** Browse for service types on the local network */ AvahiServiceTypeBrowser* avahi_service_type_browser_new ( AvahiClient *client, AvahiIfIndex interface, AvahiProtocol protocol, - char *domain, + const char *domain, AvahiServiceTypeBrowserCallback callback, - void *user_data); + void *userdata); + +/** Get the parent client of an AvahiServiceTypeBrowser object */ +AvahiClient* avahi_service_type_browser_get_client (AvahiServiceTypeBrowser *); + +/** Get the D-Bus path of an AvahiServiceTypeBrowser object, for debugging purposes only. */ +const char* avahi_service_type_browser_get_dbus_path(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 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); + +/** Block until the resolving is complete */ +int avahi_service_resolver_block(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); + +/** Block until the resolving is complete */ +int avahi_host_name_resolver_block(AvahiHostNameResolver *r); #ifndef DOXYGEN_SHOULD_SKIP_THIS AVAHI_C_DECL_END