]> git.meshlink.io Git - catta/blob - avahi-common/defs.h
documentation update
[catta] / avahi-common / defs.h
1 #ifndef foodefshfoo
2 #define foodefshfoo
3
4 /* $Id$ */
5
6 /***
7   This file is part of avahi.
8  
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.
13  
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.
18  
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
22   USA.
23 ***/
24
25 /** \file defs.h Some common definitions */
26
27 #include <avahi-common/cdecl.h>
28
29 /** \mainpage
30  *  
31  * \section choose_api Choosing an API
32  *
33  * Avahi provides three programming APIs for integration of
34  * mDNS/DNS-SD features into your progams:
35  *
36  * \li <b>avahi-core</b>: an API for embedding a complete mDNS/DNS-SD stack
37  * into your software. This is intended for developers of embedded
38  * ampliances only. We dissuade from using this API in normal desktop
39  * applications since it is not a good idea to run multiple mDNS
40  * stacks simultaneously on the same host.
41  * \li <b>the D-Bus API</b>: an extensive D-Bus interface for browsing and
42  * registering mDNS/DNS-SD services using avahi-daemon. We recommend
43  * to use this API for software written in any language but
44  * C. (i.e. Python)
45  * \li <b>avahi-client</b>: a simplifying C wrapper around the D-Bus API. We
46  * recommend to use this API in C or C++ progams. The D-Bus internals
47  * are hidden completely.
48  * 
49  * All three APIs are very similar, however avahi-core is the most powerful.
50  *
51  * In addition to the three APIs described above Avahi supports two
52  * compatibility libraries:
53  *
54  * \li avahi-compat-libdns_sd: the original Bonjour API as documented
55  * in the header file "dns_sd.h" by Apple Computer, Inc.
56  *
57  * \li avahi-compat-howl: the HOWL API as released with HOWL 0.9.8 by
58  * Porchdog Software.
59  *
60  * Please note that these compatibility layers are incomplete and
61  * generally a waste of resources. We strongly encourage everyone to
62  * use our native APIs for newly written programs and to port older
63  * programs to avahi-client!
64  * 
65  * \section error_reporting Error Reporting
66  *
67  * Some notes on the Avahi error handling:
68  *
69  * - Error codes are negative integers and defined as AVAHI_ERR_xx
70  * - If a function returns some kind of non-negative integer value on
71  * success, a failure is indicated by returning the error code
72  * directly.
73  * - If a function returns a pointer of some kind on success, a
74  * failure is indicated by returning NULL
75  * - The last error number may be retrieved by calling
76  * avahi_client_errno()
77  * - Just like the libc errno variable the Avahi errno is NOT reset to
78  * AVAHI_OK if a function call succeeds.
79  * - You may convert a numeric error code into a human readable string
80  * using avahi_strerror()
81  * - The constructor function avahi_client_new() returns the error
82  * code in a call-by-reference argument
83  *
84  * \section event_loop Event Loop Abstraction
85  *
86  * Avahi uses a simple event loop abstraction laye. A table AvahiPoll
87  * which contains function pointers for user defined timeout and I/O
88  * condition event source implementations needs to be passed to
89  * avahi_client_new(). An adapter for this abstraction layer is
90  * available for the GLib main loop in the object AvahiGLibPoll. A
91  * simple stand-alone implementation is available under the name
92  * AvahiSimplePoll. An adpater for the Qt main loop is available from
93  * avahi_qt_poll_get().
94  *
95  * \section good_publish How to Register Services
96  *
97  * - Subscribe to server state changes. Pass a callback function
98  * pointer to avahi_client_new(). It will be called
99  * whenever the server state changes.
100  * - Only register your services when the server is in state
101  * AVAHI_SERVER_RUNNING. If you register your services in other server
102  * states they might not be accessible since the local host name is
103  * not established.
104  * - Remove your services when the server enters
105  * AVAHI_SERVER_COLLISION or AVAHI_SERVER_REGISTERING state. Your
106  * services may no be reachable anymore since the local host name is
107  * no longer established or is currently in the process of being
108  * established.
109  * - When registering services, use the following algorithm:
110  *   - Create a new entry group (i.e. avahi_entry_group_new())
111  *   - Add your service(s)/additional host names (i.e. avahi_entry_group_add_service())
112  *   - Commit the entry group (i.e. avahi_entry_group_commit())
113  * - Subscribe to entry group state changes.
114  * - If the entry group enters AVAHI_ENTRY_GROUP_COLLISION state the
115  * services of the entry group are automatically removed from the
116  * server. You may immediately add your services back to the entry
117  * group (but with new names, perhaps using
118  * avahi_alternative_service_name()) and commit again. Please do not
119  * free the entry group and create a new one. This would inhibit some
120  * traffic limiting algorithms in mDNS.
121  * - When you need to modify your services (i.e. change the TXT data
122  * or the port number), use the AVAHI_PUBLISH_UPDATE flag. Please do
123  * not free the entry group and create a new one. This would inhibit
124  * some traffic limiting algorithms in mDNS. When changing just the
125  * TXT data avahi_entry_group_update_txt() is a shortcut for
126  * AVAHI_PUBLISH_UPDATE. Please note that you cannot use
127  * AVAHI_PUBLISH_UPDATE when changing the service name! Renaming a
128  * DNS-SD service is identical to deleting and creating a new one, and
129  * that's exactly what you should do in that case. First call
130  * avahi_entry_group_reset() to remove it and than readd it normally.
131  *
132  * \section good_browse How to Browse for Services
133  *
134  * - For normal applications you need to call avahi_service_browser_new()
135  * for the service type you want to browse for. Use
136  * avahi_client_resolve_service() to acquire service data for a a service
137  * name.
138  * - You can use avahi_domain_browser_new() to get a list of announced
139  * browsing domains. Please note that not all domains whith services
140  * on the LAN are mandatorily announced.
141  * - Network monitor software may use avahi_service_type_browser_new()
142  * to browse for the list of available service types on the LAN. This
143  * API should NOT be used in normal software since it increases
144  * traffic immensly. In addition not all DNS-SD implementations
145  * announce their services in away that they can be found with
146  * avahi_server_type_browser_new().
147  * - There is no need to subscribe to server state changes.
148  *
149  * \section daemon_dies How to Write a Client That Can Deal with Daemon Restarts
150  *
151  * With Avahi it is possible to write client applications that can
152  * deal with Avahi daemon restarts. To accomplish that make sure to
153  * pass AVAHI_CLIENT_NO_FAIL to avahi_client_new()'s flags
154  * parameter. That way avahi_client_new() will succeed even when the
155  * daemon is not running. In that case the object will enter
156  * AVAHI_CLIENT_CONNECTING state. As soon as the daemon becomes
157  * available the object will enter one of the AVAHI_CLIENT_S_xxx
158  * states. Make sure to not create browsers or entry groups before the
159  * client object has entered one of those states. As usual you will be
160  * informed about state changes with the callback function supplied to
161  * avahi_client_new(). If the client is forced to disconnect from the
162  * server it will enter AVAHI_CLIENT_FAILURE state with
163  * avahi_client_errno() == AVAHI_ERR_DISCONNECTED. Free the
164  * AvahiClient object in that case and reconnect to the server anew -
165  * again with passing AVAHI_CLIENT_NO_FAIL to avahi_client_new().
166  *
167  * We encourage to implement this in all software where service
168  * discovery is not an integral part of application. e.g. use it in
169  * all kinds of background daemons, but not in software like iChat
170  * compatible IM software.
171  *
172  * For now AVAHI_CLIENT_NO_FAIL cannot deal with D-Bus daemon restarts.
173  *
174  * \section domains How to Deal Properly with Browsing Domains
175  *
176  * Due to the introduction of wide-area DNS-SD the correct handling of
177  * domains becomes more important for Avahi enabled applications. All
178  * applications that offer the user a list of services discovered with
179  * Avahi should offer some kind of editable drop down box where the
180  * user can either enter his own domain or select one of those offered
181  * by AvahiDomainBrowser. The default domain to browse should be the
182  * one returned by avahi_client_get_domain_name(). The list of domains
183  * returned by AvahiDomainBrowser is assembled by the browsing domains
184  * configured in the daemon's configuration file, the domains
185  * announced inside the default domain, the domains set with the
186  * environment variable $AVAHI_BROWSE_DOMAINS (colon-seperated) on the
187  * client side and the domains set in the XDG configuration file
188  * ~/.config/avahi/browse-domains on the client side (seperated by
189  * newlines). File managers offering some kind of "Network
190  * Neighborhood" folder should show the entries of the default domain
191  * right inside that and offer subfolders for the browsing domains
192  * returned by AvahiDomainBrowser.
193  */
194
195 AVAHI_C_DECL_BEGIN
196
197 /** States of an entry group object */
198 typedef enum {
199     AVAHI_ENTRY_GROUP_UNCOMMITED,    /**< The group has not yet been commited, the user must still call avahi_entry_group_commit() */
200     AVAHI_ENTRY_GROUP_REGISTERING,   /**< The entries of the group are currently being registered */
201     AVAHI_ENTRY_GROUP_ESTABLISHED,   /**< The entries have successfully been established */
202     AVAHI_ENTRY_GROUP_COLLISION,     /**< A name collision for one of the entries in the group has been detected, the entries have been withdrawn */
203     AVAHI_ENTRY_GROUP_FAILURE        /**< Some kind of failure happened, the entries have been withdrawn */
204 } AvahiEntryGroupState;
205
206 /** The type of domain to browse for */
207 typedef enum {
208     AVAHI_DOMAIN_BROWSER_BROWSE,            /**< Browse for a list of available browsing domains */
209     AVAHI_DOMAIN_BROWSER_BROWSE_DEFAULT,    /**< Browse for the default browsing domain */
210     AVAHI_DOMAIN_BROWSER_REGISTER,          /**< Browse for a list of available registering domains */
211     AVAHI_DOMAIN_BROWSER_REGISTER_DEFAULT,  /**< Browse for the default registering domain */
212     AVAHI_DOMAIN_BROWSER_BROWSE_LEGACY,     /**< Legacy browse domain - see DNS-SD spec for more information */
213     AVAHI_DOMAIN_BROWSER_MAX
214 } AvahiDomainBrowserType;
215
216 /** Some flags for publishing functions */
217 typedef enum {
218     AVAHI_PUBLISH_UNIQUE = 1,           /**< For raw records: The RRset is intended to be unique */
219     AVAHI_PUBLISH_NO_PROBE = 2,         /**< For raw records: Though the RRset is intended to be unique no probes shall be sent */
220     AVAHI_PUBLISH_NO_ANNOUNCE = 4,      /**< For raw records: Do not announce this RR to other hosts */
221     AVAHI_PUBLISH_ALLOW_MULTIPLE = 8,   /**< For raw records: Allow multiple local records of this type, even if they are intended to be unique */
222     AVAHI_PUBLISH_NO_REVERSE = 16,      /**< For address records: don't create a reverse (PTR) entry */
223     AVAHI_PUBLISH_NO_COOKIE = 32,       /**< For service records: do not implicitly add the local service cookie to TXT data */
224     AVAHI_PUBLISH_UPDATE = 64,          /**< Update existing records instead of adding new ones */
225     AVAHI_PUBLISH_USE_WIDE_AREA = 128,  /**< Register the record using wide area DNS (i.e. unicast DNS update) */
226     AVAHI_PUBLISH_USE_MULTICAST = 256   /**< Register the record using multicast DNS */
227 } AvahiPublishFlags;
228
229 /** Some flags for lookup functions */
230 typedef enum {
231     AVAHI_LOOKUP_USE_WIDE_AREA = 1,    /**< Force lookup via wide area DNS */
232     AVAHI_LOOKUP_USE_MULTICAST = 2,    /**< Force lookup via multicast DNS */
233     AVAHI_LOOKUP_NO_TXT = 4,           /**< When doing service resolving, don't lookup TXT record */
234     AVAHI_LOOKUP_NO_ADDRESS = 8        /**< When doing service resolving, don't lookup A/AAAA record */
235 } AvahiLookupFlags;
236
237 /** Some flags for lookup callback functions */
238 typedef enum {
239     AVAHI_LOOKUP_RESULT_CACHED = 1,         /**< This response originates from the cache */
240     AVAHI_LOOKUP_RESULT_WIDE_AREA = 2,      /**< This response originates from wide area DNS */
241     AVAHI_LOOKUP_RESULT_MULTICAST = 4,      /**< This response originates from multicast DNS */
242     AVAHI_LOOKUP_RESULT_LOCAL = 8,          /**< This record/service resides on and was announced by the local host. Only available in service and record browsers and only on AVAHI_BROWSER_NEW. */
243     AVAHI_LOOKUP_RESULT_OUR_OWN = 16,       /**< This service belongs to the same local client as the browser object. Only available in avahi-client, and only for service browsers and only on AVAHI_BROWSER_NEW. */
244     AVAHI_LOOKUP_RESULT_STATIC = 32         /**< The returned data has been defined statically by some configuration option */
245 } AvahiLookupResultFlags;
246
247 /** Type of callback event when browsing */
248 typedef enum {
249     AVAHI_BROWSER_NEW,               /**< The object is new on the network */
250     AVAHI_BROWSER_REMOVE,            /**< The object has been removed from the network */
251     AVAHI_BROWSER_CACHE_EXHAUSTED,   /**< One-time event, to notify the user that all entries from the caches have been send */
252     AVAHI_BROWSER_ALL_FOR_NOW,       /**< One-time event, to notify the user that more records will probably not show up in the near future, i.e. all cache entries have been read and all static servers been queried */
253     AVAHI_BROWSER_FAILURE            /**< Browsing failed due to some reason which can be retrieved using avahi_server_errno()/avahi_client_errno() */
254 } AvahiBrowserEvent;
255
256 /** Type of callback event when resolving */
257 typedef enum {
258     AVAHI_RESOLVER_FOUND,          /**< RR found, resolving successful */
259     AVAHI_RESOLVER_FAILURE         /**< Resolving failed due to some reason which can be retrieved using avahi_server_errno()/avahi_client_errno() */
260 } AvahiResolverEvent;
261
262 /** States of a server object */
263 typedef enum {
264     AVAHI_SERVER_INVALID,          /**< Invalid state (initial) */ 
265     AVAHI_SERVER_REGISTERING,      /**< Host RRs are being registered */
266     AVAHI_SERVER_RUNNING,          /**< All host RRs have been established */
267     AVAHI_SERVER_COLLISION,        /**< There is a collision with a host RR. All host RRs have been withdrawn, the user should set a new host name via avahi_server_set_host_name() */
268     AVAHI_SERVER_FAILURE           /**< Some fatal failure happened, the server is unable to proceed */
269 } AvahiServerState;
270
271 /** For every service a special TXT item is implicitly added, which
272  * contains a random cookie which is private to the local daemon. This
273  * can be used by clients to determine if two services on two
274  * different subnets are effectively the same. */
275 #define AVAHI_SERVICE_COOKIE "org.freedesktop.Avahi.cookie"
276
277 /** In invalid cookie as special value */
278 #define AVAHI_SERVICE_COOKIE_INVALID (0)
279
280 /** DNS record types, see RFC 1035 */
281 enum {
282     AVAHI_DNS_TYPE_A = 0x01,
283     AVAHI_DNS_TYPE_NS = 0x02,
284     AVAHI_DNS_TYPE_CNAME = 0x05,
285     AVAHI_DNS_TYPE_SOA = 0x06,
286     AVAHI_DNS_TYPE_PTR = 0x0C,
287     AVAHI_DNS_TYPE_HINFO = 0x0D,
288     AVAHI_DNS_TYPE_MX = 0x0F,
289     AVAHI_DNS_TYPE_TXT = 0x10,
290     AVAHI_DNS_TYPE_AAAA = 0x1C,
291     AVAHI_DNS_TYPE_SRV = 0x21,
292 };
293
294 /** DNS record classes, see RFC 1035 */
295 enum {
296     AVAHI_DNS_CLASS_IN = 0x01,          /**< Probably the only class we will ever use */
297 };
298
299 /** The default TTL for RRs which contain a host name of some kind. */
300 #define AVAHI_DEFAULT_TTL_HOST_NAME (120)
301
302 /** The default TTL for all other records. */
303 #define AVAHI_DEFAULT_TTL (75*60)
304
305 AVAHI_C_DECL_END
306
307 #endif