X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=avahi-client%2Fclient.h;h=f102f05934b3d55f32aebb85b7728ae41767b003;hb=e7bcb6b9a448332e34855128b4d496b852dfd2af;hp=8a59ca111c2eb740ecf234d77bd2d97005b9760e;hpb=0c54764cf19428a0c52724a75ddf3368e3899209;p=catta diff --git a/avahi-client/client.h b/avahi-client/client.h index 8a59ca1..f102f05 100644 --- a/avahi-client/client.h +++ b/avahi-client/client.h @@ -33,32 +33,42 @@ /** \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 */ - -#ifndef DOXYGEN_SHOULD_SKIP_THIS AVAHI_C_DECL_BEGIN -#endif /** A connection context */ 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_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); - -/** Free a 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 */, + 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); /** Get the version of the server */ @@ -67,6 +77,9 @@ 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*); @@ -82,11 +95,9 @@ int avahi_client_errno (AvahiClient*); /** 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); +/** Return 1 if gethostbyname() supports mDNS lookups, 0 otherwise. \since 0.6.5 */ +int avahi_nss_support(void); -#ifndef DOXYGEN_SHOULD_SKIP_THIS AVAHI_C_DECL_END -#endif #endif