]> git.meshlink.io Git - catta/blob - avahi-common/defs.h
Documentation updates
[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 AVAHI_C_DECL_BEGIN
30
31 /** States of an entry group object */
32 typedef enum {
33     AVAHI_ENTRY_GROUP_UNCOMMITED,    /**< The group has not yet been commited, the user must still call avahi_entry_group_commit() */
34     AVAHI_ENTRY_GROUP_REGISTERING,   /**< The entries of the group are currently being registered */
35     AVAHI_ENTRY_GROUP_ESTABLISHED,   /**< The entries have successfully been established */
36     AVAHI_ENTRY_GROUP_COLLISION      /**< A name collision for one of the entries in the group has been detected, the entries have been withdrawn */ 
37 } AvahiEntryGroupState;
38
39 /** The type of domain to browse for */
40 typedef enum {
41     AVAHI_DOMAIN_BROWSER_REGISTER,          /**< Browse for a list of available registering domains */
42     AVAHI_DOMAIN_BROWSER_REGISTER_DEFAULT,  /**< Browse for the default registering domain */
43     AVAHI_DOMAIN_BROWSER_BROWSE,            /**< Browse for a list of available browsing domains */
44     AVAHI_DOMAIN_BROWSER_BROWSE_DEFAULT,    /**< Browse for the default browsing domain */
45     AVAHI_DOMAIN_BROWSER_BROWSE_LEGACY,     /**< Legacy browse domain - see DNS-SD spec for more information */
46     AVAHI_DOMAIN_BROWSER_MAX
47 } AvahiDomainBrowserType;
48
49 /** Type of callback event when browsing */
50 typedef enum {
51     AVAHI_BROWSER_NEW,            /**< The object is new on the network */
52     AVAHI_BROWSER_REMOVE          /**< The object has been removed from the network */
53 } AvahiBrowserEvent;
54
55 /** Type of callback event when resolving */
56 typedef enum {
57     AVAHI_RESOLVER_FOUND,         /**< RR found, resolving successful */
58     AVAHI_RESOLVER_TIMEOUT        /**< Noone responded within the timeout, resolving failed */
59 } AvahiResolverEvent;
60
61 /** States of a server object */
62 typedef enum {
63     AVAHI_SERVER_INVALID,          /**< Invalid state (initial) */ 
64     AVAHI_SERVER_REGISTERING,      /**< Host RRs are being registered */
65     AVAHI_SERVER_RUNNING,          /**< All host RRs have been established */
66     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() */
67 } AvahiServerState;
68
69 AVAHI_C_DECL_END
70
71 #endif