7 This file is part of avahi.
9 avahi is free software; you can redistribute it and/or modify it
10 under the terms of the GNU Lesser General Public License as
11 published by the Free Software Foundation; either version 2.1 of the
12 License, or (at your option) any later version.
14 avahi is distributed in the hope that it will be useful, but WITHOUT
15 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
16 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
17 Public License for more details.
19 You should have received a copy of the GNU Lesser General Public
20 License along with avahi; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
27 #include <avahi-common/cdecl.h>
28 #include <avahi-common/address.h>
29 #include <avahi-common/strlst.h>
30 #include <avahi-common/defs.h>
31 #include <avahi-common/watch.h>
32 #include <avahi-common/gccmacro.h>
34 /** \file client.h Definitions and functions for the client API over D-Bus */
36 /** \example client-publish-service.c Example how to register a DNS-SD
37 * service using the client interface to avahi-daemon. It behaves like a network
38 * printer registering both an IPP and a BSD LPR service. */
40 /** \example client-browse-services.c Example how to browse for DNS-SD
41 * services using the client interface to avahi-daemon. */
43 /** \example glib-integration.c Example of how to integrate
44 * avahi use with GLIB/GTK applications */
47 #ifndef DOXYGEN_SHOULD_SKIP_THIS
51 /** A connection context */
52 typedef struct AvahiClient AvahiClient;
54 /** An entry group object */
55 typedef struct AvahiEntryGroup AvahiEntryGroup;
57 /** A domain browser object */
58 typedef struct AvahiDomainBrowser AvahiDomainBrowser;
60 /** A service browser object */
61 typedef struct AvahiServiceBrowser AvahiServiceBrowser;
63 /** A service type browser object */
64 typedef struct AvahiServiceTypeBrowser AvahiServiceTypeBrowser;
66 /** A service resolver object */
67 typedef struct AvahiServiceResolver AvahiServiceResolver;
69 /** A service resolver object */
70 typedef struct AvahiHostNameResolver AvahiHostNameResolver;
72 /** An address resolver object */
73 typedef struct AvahiAddressResolver AvahiAddressResolver;
75 /** States of a client object, a superset of AvahiServerState */
77 AVAHI_CLIENT_S_INVALID = AVAHI_SERVER_INVALID,
78 AVAHI_CLIENT_S_REGISTERING = AVAHI_SERVER_REGISTERING,
79 AVAHI_CLIENT_S_RUNNING = AVAHI_SERVER_RUNNING,
80 AVAHI_CLIENT_S_COLLISION = AVAHI_SERVER_COLLISION,
81 AVAHI_CLIENT_DISCONNECTED = 100 /**< Lost DBUS connection to the Avahi daemon */
84 /** The function prototype for the callback of an AvahiClient */
85 typedef void (*AvahiClientCallback) (AvahiClient *s, AvahiClientState state, void* userdata);
87 /** The function prototype for the callback of an AvahiEntryGroup */
88 typedef void (*AvahiEntryGroupCallback) (AvahiEntryGroup *g, AvahiEntryGroupState state, void* userdata);
90 /** The function prototype for the callback of an AvahiDomainBrowser */
91 typedef void (*AvahiDomainBrowserCallback) (AvahiDomainBrowser *b, AvahiIfIndex interface, AvahiProtocol protocol, AvahiBrowserEvent event, const char *domain, AvahiLookupResultFlags flags, void *userdata);
93 /** The function prototype for the callback of an AvahiServiceBrowser */
94 typedef void (*AvahiServiceBrowserCallback) (AvahiServiceBrowser *b, AvahiIfIndex interface, AvahiProtocol protocol, AvahiBrowserEvent event, const char *name, const char *type, const char *domain, AvahiLookupResultFlags flags, void *userdata);
96 /** The function prototype for the callback of an AvahiServiceTypeBrowser */
97 typedef void (*AvahiServiceTypeBrowserCallback) (AvahiServiceTypeBrowser *b, AvahiIfIndex interface, AvahiProtocol protocol, AvahiBrowserEvent event, const char *type, const char *domain, AvahiLookupResultFlags flags, void *userdata);
99 /** The function prototype for the callback of an AvahiServiceResolver */
100 typedef void (*AvahiServiceResolverCallback) (
101 AvahiServiceResolver *r,
102 AvahiIfIndex interface,
103 AvahiProtocol protocol,
104 AvahiResolverEvent event,
108 const char *host_name,
109 const AvahiAddress *a,
111 AvahiStringList *txt,
112 AvahiLookupResultFlags flags,
115 /** The function prototype for the callback of an AvahiHostNameResolver */
116 typedef void (*AvahiHostNameResolverCallback) (
117 AvahiHostNameResolver *r,
118 AvahiIfIndex interface,
119 AvahiProtocol protocol,
120 AvahiResolverEvent event,
122 const AvahiAddress *a,
123 AvahiLookupResultFlags flags,
126 /** The function prototype for the callback of an AvahiAddressResolver */
127 typedef void (*AvahiAddressResolverCallback) (
128 AvahiAddressResolver *r,
129 AvahiIfIndex interface,
130 AvahiProtocol protocol,
131 AvahiResolverEvent event,
132 AvahiProtocol aprotocol,
133 const AvahiAddress *a,
135 AvahiLookupResultFlags flags,
138 /** Creates a new client instance */
139 AvahiClient* avahi_client_new (const AvahiPoll *poll_api, AvahiClientCallback callback, void *userdata, int *error);
141 /** Free a client instance */
142 void avahi_client_free(AvahiClient *client);
144 /** Get the version of the server */
145 const char* avahi_client_get_version_string (AvahiClient*);
148 const char* avahi_client_get_host_name (AvahiClient*);
150 /** Get domain name */
151 const char* avahi_client_get_domain_name (AvahiClient*);
153 /** Get FQDN domain name */
154 const char* avahi_client_get_host_name_fqdn (AvahiClient*);
157 AvahiClientState avahi_client_get_state(AvahiClient *client);
159 /** Get the last error number */
160 int avahi_client_errno (AvahiClient*);
162 /** Create a new AvahiEntryGroup object */
163 AvahiEntryGroup* avahi_entry_group_new (AvahiClient*, AvahiEntryGroupCallback callback, void *userdata);
165 /** Clean up and free an AvahiEntryGroup object */
166 int avahi_entry_group_free (AvahiEntryGroup *);
168 /** Commit an AvahiEntryGroup */
169 int avahi_entry_group_commit (AvahiEntryGroup*);
171 /** Reset an AvahiEntryGroup */
172 int avahi_entry_group_reset (AvahiEntryGroup*);
174 /** Get an AvahiEntryGroup's state */
175 int avahi_entry_group_get_state (AvahiEntryGroup*);
177 /** Check if an AvahiEntryGroup is empty */
178 int avahi_entry_group_is_empty (AvahiEntryGroup*);
180 /** Get an AvahiEntryGroup's owning client instance */
181 AvahiClient* avahi_entry_group_get_client (AvahiEntryGroup*);
183 /** Add a service, takes a variable NULL terminated list of text records */
184 int avahi_entry_group_add_service(
185 AvahiEntryGroup *group,
186 AvahiIfIndex interface,
187 AvahiProtocol protocol,
193 ...) AVAHI_GCC_SENTINEL;
195 /** Add a service, takes an AvahiStringList for text records */
196 int avahi_entry_group_add_service_strlst(
197 AvahiEntryGroup *group,
198 AvahiIfIndex interface,
199 AvahiProtocol protocol,
205 AvahiStringList *txt);
207 /** Add a service, takes a NULL terminated va_list for text records */
208 int avahi_entry_group_add_service_va(
209 AvahiEntryGroup *group,
210 AvahiIfIndex interface,
211 AvahiProtocol protocol,
219 /** Browse for domains on the local network */
220 AvahiDomainBrowser* avahi_domain_browser_new (
222 AvahiIfIndex interface,
223 AvahiProtocol protocol,
225 AvahiDomainBrowserType btype,
226 AvahiLookupFlags flags,
227 AvahiDomainBrowserCallback callback,
230 /** Get the parent client of an AvahiDomainBrowser object */
231 AvahiClient* avahi_domain_browser_get_client (AvahiDomainBrowser *);
233 /** Cleans up and frees an AvahiDomainBrowser object */
234 int avahi_domain_browser_free (AvahiDomainBrowser *);
236 /** Browse for service types on the local network */
237 AvahiServiceTypeBrowser* avahi_service_type_browser_new (
239 AvahiIfIndex interface,
240 AvahiProtocol protocol,
242 AvahiLookupFlags flags,
243 AvahiServiceTypeBrowserCallback callback,
246 /** Get the parent client of an AvahiServiceTypeBrowser object */
247 AvahiClient* avahi_service_type_browser_get_client (AvahiServiceTypeBrowser *);
249 /** Cleans up and frees an AvahiServiceTypeBrowser object */
250 int avahi_service_type_browser_free (AvahiServiceTypeBrowser *);
252 /** Browse for services of a type on the local network */
253 AvahiServiceBrowser* avahi_service_browser_new (
255 AvahiIfIndex interface,
256 AvahiProtocol protocol,
259 AvahiLookupFlags flags,
260 AvahiServiceBrowserCallback callback,
263 /** Get the parent client of an AvahiServiceBrowser object */
264 AvahiClient* avahi_service_browser_get_client (AvahiServiceBrowser *);
266 /* Cleans up and frees an AvahiServiceBrowser object */
267 int avahi_service_browser_free (AvahiServiceBrowser *);
269 /** Create a new service resolver object */
270 AvahiServiceResolver * avahi_service_resolver_new(
272 AvahiIfIndex interface,
273 AvahiProtocol protocol,
277 AvahiProtocol aprotocol,
278 AvahiLookupFlags flags,
279 AvahiServiceResolverCallback callback,
282 /** Get the parent client of an AvahiServiceResolver object */
283 AvahiClient* avahi_service_resolver_get_client (AvahiServiceResolver *);
285 /** Free a service resolver object */
286 int avahi_service_resolver_free(AvahiServiceResolver *r);
288 /** Create a new hostname resolver object */
289 AvahiHostNameResolver * avahi_host_name_resolver_new(
291 AvahiIfIndex interface,
292 AvahiProtocol protocol,
294 AvahiProtocol aprotocol,
295 AvahiLookupFlags flags,
296 AvahiHostNameResolverCallback callback,
299 /** Get the parent client of an AvahiHostNameResolver object */
300 AvahiClient* avahi_host_name_resolver_get_client (AvahiHostNameResolver *);
302 /** Free a hostname resolver object */
303 int avahi_host_name_resolver_free(AvahiHostNameResolver *r);
305 /** Create a new address resolver object from an address string. Set aprotocol to AF_UNSPEC for protocol detection. */
306 AvahiAddressResolver * avahi_address_resolver_new(
308 AvahiIfIndex interface,
309 AvahiProtocol protocol,
311 AvahiLookupFlags flags,
312 AvahiAddressResolverCallback callback,
315 /** Create a new address resolver object from an AvahiAddress object */
316 AvahiAddressResolver* avahi_address_resolver_new_a(
318 AvahiIfIndex interface,
319 AvahiProtocol protocol,
320 const AvahiAddress *a,
321 AvahiLookupFlags flags,
322 AvahiAddressResolverCallback callback,
325 /** Get the parent client of an AvahiAddressResolver object */
326 AvahiClient* avahi_address_resolver_get_client (AvahiAddressResolver *);
328 /** Free a AvahiAddressResolver resolver object */
329 int avahi_address_resolver_free(AvahiAddressResolver *r);
331 /** Return the local service cookie. returns AVAHI_SERVICE_COOKIE_INVALID on failure. */
332 uint32_t avahi_client_get_local_service_cookie(AvahiClient *client);
334 /** Return 1 if the specified service is a registered locally, negative on failure, 0 otherwise. */
335 int avahi_client_is_service_local(AvahiClient *client, AvahiIfIndex interface, AvahiProtocol protocol, const char *name, const char *type, const char *domain);
337 #ifndef DOXYGEN_SHOULD_SKIP_THIS