X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=avahi-client%2Fclient.h;h=1039da57af14b2daed3a809cbf3ed56912aa2415;hb=7a5b2f69af7d36d6cd4153142f125fa011784e03;hp=4f2250b9bd34d8e6b8a38a7994e9e59b966b607b;hpb=6efe2615e04c6ef664fa9d49b013e261ba1e6e66;p=catta diff --git a/avahi-client/client.h b/avahi-client/client.h index 4f2250b..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,9 +31,6 @@ /** \file client.h Definitions and functions for the client API over D-Bus */ -/** \example glib-integration.c Example of how to integrate - * avahi use with GLIB/GTK applications */ - AVAHI_C_DECL_BEGIN /** A connection context */ @@ -43,29 +38,52 @@ typedef struct AvahiClient AvahiClient; /** 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_S_FAILURE = AVAHI_SERVER_FAILURE, - 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); +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*); @@ -73,13 +91,26 @@ 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*); +/** @} */ + +/** \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