X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=avahi-client%2Fclient.h;h=1039da57af14b2daed3a809cbf3ed56912aa2415;hb=57905d539abd0d65db3dae745c2a561df5e1943d;hp=56672e3820074a0b0e07df1b47864c6991060c3c;hpb=8edc3488ab846cbbdac5edb698519c3a2405501b;p=catta diff --git a/avahi-client/client.h b/avahi-client/client.h index 56672e3..1039da5 100644 --- a/avahi-client/client.h +++ b/avahi-client/client.h @@ -1,21 +1,19 @@ #ifndef fooclienthfoo #define fooclienthfoo -/* $Id$ */ - /*** This file is part of avahi. - + avahi is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. - + avahi is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. - + You should have received a copy of the GNU Lesser General Public License along with avahi; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 @@ -33,87 +31,59 @@ /** \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. */ - - -#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; - -/** A service resolver object */ -typedef struct AvahiServiceResolver AvahiServiceResolver; - /** 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, - 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 */ + AVAHI_CLIENT_S_REGISTERING = AVAHI_SERVER_REGISTERING, /**< Server state: REGISTERING */ + AVAHI_CLIENT_S_RUNNING = AVAHI_SERVER_RUNNING, /**< Server state: RUNNING */ + AVAHI_CLIENT_S_COLLISION = AVAHI_SERVER_COLLISION, /**< Server state: COLLISION */ + AVAHI_CLIENT_FAILURE = 100, /**< Some kind of error happened on the client side */ + AVAHI_CLIENT_CONNECTING = 101 /**< We're still connecting. This state is only entered when AVAHI_CLIENT_NO_FAIL has been passed to avahi_client_new() and the daemon is not yet available. */ } AvahiClientState; +typedef enum { + AVAHI_CLIENT_IGNORE_USER_CONFIG = 1, /**< Don't read user configuration */ + AVAHI_CLIENT_NO_FAIL = 2 /**< Don't fail if the daemon is not available when avahi_client_new() is called, instead enter AVAHI_CLIENT_CONNECTING state and wait for the daemon to appear */ +} AvahiClientFlags; + /** 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 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); +typedef void (*AvahiClientCallback) ( + AvahiClient *s, + AvahiClientState state /**< The new state of the client */, + void* userdata /**< The user data that was passed to avahi_client_new() */); -/** Creates a new client instance */ -AvahiClient* avahi_client_new (const AvahiPoll *poll_api, AvahiClientCallback callback, void *userdata, int *error); +/** @{ \name Construction and destruction */ -/** Free a client instance */ +/** Creates a new client instance */ +AvahiClient* avahi_client_new ( + const AvahiPoll *poll_api /**< The abstract event loop API to use */, + AvahiClientFlags flags /**< Some flags to modify the behaviour of the client library */, + AvahiClientCallback callback /**< A callback that is called whenever the state of the client changes. This may be NULL. Please note that this function is called for the first time from within the avahi_client_new() context! Thus, in the callback you should not make use of global variables that are initialized only after your call to avahi_client_new(). A common mistake is to store the AvahiClient pointer returned by avahi_client_new() in a global variable and assume that this global variable already contains the valid pointer when the callback is called for the first time. A work-around for this is to always use the AvahiClient pointer passed to the callback function instead of the global pointer. */, + void *userdata /**< Some arbitrary user data pointer that will be passed to the callback function */, + int *error /**< If creation of the client fails, this integer will contain the error cause. May be NULL if you aren't interested in the reason why avahi_client_new() failed. */); + +/** Free a client instance. This will automatically free all + * associated browser, resolve and entry group objects. All pointers + * to such objects become invalid! */ void avahi_client_free(AvahiClient *client); +/** @} */ + +/** @{ \name Properties */ + /** Get the version of the server */ const char* avahi_client_get_version_string (AvahiClient*); /** Get host name */ const char* avahi_client_get_host_name (AvahiClient*); +/** Set host name. \since 0.6.13 */ +int avahi_client_set_host_name(AvahiClient*, const char *name); + /** Get domain name */ const char* avahi_client_get_domain_name (AvahiClient*); @@ -121,137 +91,27 @@ const char* avahi_client_get_domain_name (AvahiClient*); const char* avahi_client_get_host_name_fqdn (AvahiClient*); /** Get state */ -AvahiClientState avahi_client_get_state(AvahiClient *client); +AvahiClientState avahi_client_get_state(AvahiClient *client); + +/** @{ \name Error Handling */ -/** Get the last error number */ +/** Get the last error number. See avahi_strerror() for converting this error code into a human readable string. */ int avahi_client_errno (AvahiClient*); -/** Create a new AvahiEntryGroup object */ -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*); - -/** 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 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_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. */ -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, - const char *domain, - AvahiDomainBrowserType btype, - 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 *); - -/** 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, - const char *domain, - 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 *); - -/** 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 *); - -/* 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); - -/** 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); - -#ifndef DOXYGEN_SHOULD_SKIP_THIS +/** @} */ + +/** \cond fulldocs */ +/** Return the local service cookie. returns AVAHI_SERVICE_COOKIE_INVALID on failure. */ +uint32_t avahi_client_get_local_service_cookie(AvahiClient *client); +/** \endcond */ + +/** @{ \name Libc NSS Support */ + +/** Return 1 if gethostbyname() supports mDNS lookups, 0 otherwise. \since 0.6.5 */ +int avahi_nss_support(void); + +/** @} */ + AVAHI_C_DECL_END -#endif #endif