]> git.meshlink.io Git - catta/blob - avahi-core/server.h
improve documentation
[catta] / avahi-core / server.h
1 #ifndef fooserverhfoo
2 #define fooserverhfoo
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 #include "core.h"
26 #include "iface.h"
27 #include "prioq.h"
28 #include "llist.h"
29 #include "timeeventq.h"
30 #include "announce.h"
31 #include "browse.h"
32 #include "dns.h"
33 #include "rrlist.h"
34
35 #define AVAHI_MAX_LEGACY_UNICAST_REFLECT_SLOTS 100
36
37 typedef struct AvahiLegacyUnicastReflectSlot AvahiLegacyUnicastReflectSlot;
38
39 struct AvahiLegacyUnicastReflectSlot {
40     AvahiServer *server;
41     
42     guint16 id, original_id;
43     AvahiAddress address;
44     guint16 port;
45     gint interface;
46     GTimeVal elapse_time;
47     AvahiTimeEvent *time_event;
48 };
49
50 struct AvahiEntry {
51     AvahiServer *server;
52     AvahiEntryGroup *group;
53
54     gboolean dead;
55     
56     AvahiEntryFlags flags;
57     AvahiRecord *record;
58     gint interface;
59     guchar protocol;
60
61     AVAHI_LLIST_FIELDS(AvahiEntry, entries);
62     AVAHI_LLIST_FIELDS(AvahiEntry, by_key);
63     AVAHI_LLIST_FIELDS(AvahiEntry, by_group);
64     
65     AVAHI_LLIST_HEAD(AvahiAnnouncement, announcements);
66 };
67
68 struct AvahiEntryGroup {
69     AvahiServer *server;
70     gboolean dead;
71
72     AvahiEntryGroupState state;
73     gpointer userdata;
74     AvahiEntryGroupCallback callback;
75
76     guint n_probing;
77     
78     AVAHI_LLIST_FIELDS(AvahiEntryGroup, groups);
79     AVAHI_LLIST_HEAD(AvahiEntry, entries);
80 };
81
82 struct AvahiServer {
83     GMainContext *context;
84     AvahiInterfaceMonitor *monitor;
85
86     AvahiServerConfig config;
87
88     AVAHI_LLIST_HEAD(AvahiEntry, entries);
89     GHashTable *entries_by_key;
90
91     AVAHI_LLIST_HEAD(AvahiEntryGroup, groups);
92     
93     AVAHI_LLIST_HEAD(AvahiRecordBrowser, record_browsers);
94     GHashTable *record_browser_hashtable;
95     AVAHI_LLIST_HEAD(AvahiHostNameResolver, host_name_resolvers);
96     AVAHI_LLIST_HEAD(AvahiAddressResolver, address_resolvers);
97     AVAHI_LLIST_HEAD(AvahiDomainBrowser, domain_browsers);
98     AVAHI_LLIST_HEAD(AvahiServiceTypeBrowser, service_type_browsers);
99     AVAHI_LLIST_HEAD(AvahiServiceBrowser, service_browsers);
100     AVAHI_LLIST_HEAD(AvahiServiceResolver, service_resolvers);
101     AVAHI_LLIST_HEAD(AvahiDNSServerBrowser, dns_server_browsers);
102
103     gboolean need_entry_cleanup, need_group_cleanup, need_browser_cleanup;
104     
105     AvahiTimeEventQueue *time_event_queue;
106     
107     gchar *host_name, *host_name_fqdn, *domain_name;
108
109     gint fd_ipv4, fd_ipv6,
110         /* The following two sockets two are used for reflection only */
111         fd_legacy_unicast_ipv4, fd_legacy_unicast_ipv6;
112
113     GPollFD pollfd_ipv4, pollfd_ipv6, pollfd_legacy_unicast_ipv4, pollfd_legacy_unicast_ipv6;
114     GSource *source;
115
116     AvahiServerState state;
117     AvahiServerCallback callback;
118     gpointer userdata;
119
120     AvahiEntryGroup *hinfo_entry_group;
121     AvahiEntryGroup *browse_domain_entry_group;
122     guint n_host_rr_pending;
123
124     AvahiTimeEvent *register_time_event;
125     
126     /* Used for assembling responses */
127     AvahiRecordList *record_list;
128
129     /* Used for reflection of legacy unicast packets */
130     AvahiLegacyUnicastReflectSlot **legacy_unicast_reflect_slots;
131     guint16 legacy_unicast_reflect_id;
132 };
133
134 gboolean avahi_server_entry_match_interface(AvahiEntry *e, AvahiInterface *i);
135
136 void avahi_server_post_query(AvahiServer *s, gint interface, guchar protocol, AvahiKey *key);
137
138 void avahi_server_prepare_response(AvahiServer *s, AvahiInterface *i, AvahiEntry *e, gboolean unicast_response, gboolean auxiliary);
139 void avahi_server_prepare_matching_responses(AvahiServer *s, AvahiInterface *i, AvahiKey *k, gboolean unicast_response);
140 void avahi_server_generate_response(AvahiServer *s, AvahiInterface *i, AvahiDnsPacket *p, const AvahiAddress *a, guint16 port, gboolean legacy_unicast, gboolean is_probe);
141
142 void avahi_entry_group_change_state(AvahiEntryGroup *g, AvahiEntryGroupState state);
143
144 gboolean avahi_entry_commited(AvahiEntry *e);
145
146 void avahi_server_enumerate_aux_records(AvahiServer *s, AvahiInterface *i, AvahiRecord *r, void (*callback)(AvahiServer *s, AvahiRecord *r, gboolean flush_cache, gpointer userdata), gpointer userdata);
147
148 void avahi_host_rr_entry_group_callback(AvahiServer *s, AvahiEntryGroup *g, AvahiEntryGroupState state, void *userdata);
149
150 void avahi_server_decrease_host_rr_pending(AvahiServer *s);
151 void avahi_server_increase_host_rr_pending(AvahiServer *s);
152
153 #endif