diff options
Diffstat (limited to 'avahi-client/client.h')
| -rw-r--r-- | avahi-client/client.h | 18 |
1 files changed, 17 insertions, 1 deletions
diff --git a/avahi-client/client.h b/avahi-client/client.h index 6a12e9a..2f86d02 100644 --- a/avahi-client/client.h +++ b/avahi-client/client.h @@ -58,6 +58,8 @@ typedef void (*AvahiClientCallback) ( AvahiClientState state /**< The new state of the client */, void* userdata /**< The user data that was passed to avahi_client_new() */); +/** @{ \name Construction and destruction */ + /** Creates a new client instance */ AvahiClient* avahi_client_new ( const AvahiPoll *poll_api /**< The abstract event loop API to use */, @@ -71,6 +73,10 @@ AvahiClient* avahi_client_new ( * 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*); @@ -89,15 +95,25 @@ const char* avahi_client_get_host_name_fqdn (AvahiClient*); /** Get state */ AvahiClientState avahi_client_get_state(AvahiClient *client); -/** Get the last error number */ +/** @{ \name Error Handling */ + +/** 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 #endif |