]> git.meshlink.io Git - catta/blob - avahi-core/browse.c
improve documentation
[catta] / avahi-core / browse.c
1 /* $Id$ */
2
3 /***
4   This file is part of avahi.
5  
6   avahi is free software; you can redistribute it and/or modify it
7   under the terms of the GNU Lesser General Public License as
8   published by the Free Software Foundation; either version 2.1 of the
9   License, or (at your option) any later version.
10  
11   avahi is distributed in the hope that it will be useful, but WITHOUT
12   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13   or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
14   Public License for more details.
15  
16   You should have received a copy of the GNU Lesser General Public
17   License along with avahi; if not, write to the Free Software
18   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
19   USA.
20 ***/
21
22 #ifdef HAVE_CONFIG_H
23 #include <config.h>
24 #endif
25
26 #include "browse.h"
27 #include "util.h"
28
29 struct AvahiRecordBrowser {
30     gboolean dead;
31     
32     AvahiServer *server;
33     AvahiKey *key;
34     gint interface;
35     guchar protocol;
36     guint sec_delay;
37
38     AvahiTimeEvent *time_event;
39
40     AvahiRecordBrowserCallback callback;
41     gpointer userdata;
42     guint scan_idle_source;
43
44     AVAHI_LLIST_FIELDS(AvahiRecordBrowser, browser);
45     AVAHI_LLIST_FIELDS(AvahiRecordBrowser, by_key);
46 };
47
48 static void elapse(AvahiTimeEvent *e, void *userdata) {
49     AvahiRecordBrowser *s = userdata;
50     GTimeVal tv;
51 /*     gchar *t; */
52     
53     g_assert(s);
54
55     avahi_server_post_query(s->server, s->interface, s->protocol, s->key);
56
57     s->sec_delay *= 2;
58     
59     if (s->sec_delay >= 60*60)  /* 1h */
60         s->sec_delay = 60*60;
61
62 /*     avahi_log_debug("%i. Continuous querying for %s", s->n_query, t = avahi_key_to_string(s->key)); */
63 /*     g_free(t); */
64     
65     avahi_elapse_time(&tv, s->sec_delay*1000, 0);
66     avahi_time_event_queue_update(s->server->time_event_queue, s->time_event, &tv);
67 }
68
69 struct cbdata {
70     AvahiRecordBrowser *record_browser;
71     AvahiInterface *interface;
72 };
73
74 static gpointer scan_cache_callback(AvahiCache *c, AvahiKey *pattern, AvahiCacheEntry *e, gpointer userdata) {
75     struct cbdata *cbdata = userdata;
76
77     g_assert(c);
78     g_assert(pattern);
79     g_assert(e);
80     g_assert(cbdata);
81
82     if (cbdata->record_browser->dead)
83         return NULL;
84
85     cbdata->record_browser->callback(
86         cbdata->record_browser,
87         cbdata->interface->hardware->index,
88         cbdata->interface->protocol,
89         AVAHI_BROWSER_NEW,
90         e->record,
91         cbdata->record_browser->userdata);
92
93     return NULL;
94 }
95
96 static void scan_interface_callback(AvahiInterfaceMonitor *m, AvahiInterface *i, gpointer userdata) {
97     AvahiRecordBrowser *s = userdata;
98     struct cbdata cbdata = { s, i };
99
100     g_assert(m);
101     g_assert(i);
102     g_assert(s);
103
104     avahi_cache_walk(i->cache, s->key, scan_cache_callback, &cbdata);
105 }
106
107 gboolean scan_idle_callback(gpointer data) {
108     AvahiRecordBrowser *b = data;
109     g_assert(b);
110
111     /* Scan the caches */
112     avahi_interface_monitor_walk(b->server->monitor, b->interface, b->protocol, scan_interface_callback, b);
113     b->scan_idle_source = (guint) -1;
114
115     return FALSE;
116 }
117
118 AvahiRecordBrowser *avahi_record_browser_new(AvahiServer *server, gint interface, guchar protocol, AvahiKey *key, AvahiRecordBrowserCallback callback, gpointer userdata) {
119     AvahiRecordBrowser *b, *t;
120     GTimeVal tv;
121
122     g_assert(server);
123     g_assert(key);
124     g_assert(callback);
125
126     g_assert(!avahi_key_is_pattern(key));
127     
128     b = g_new(AvahiRecordBrowser, 1);
129     b->dead = FALSE;
130     b->server = server;
131     b->key = avahi_key_ref(key);
132     b->interface = interface;
133     b->protocol = protocol;
134     b->callback = callback;
135     b->userdata = userdata;
136     b->sec_delay = 1;
137
138     avahi_server_post_query(b->server, b->interface, b->protocol, b->key);
139     
140     avahi_elapse_time(&tv, b->sec_delay*1000, 0);
141     b->time_event = avahi_time_event_queue_add(server->time_event_queue, &tv, elapse, b);
142
143     AVAHI_LLIST_PREPEND(AvahiRecordBrowser, browser, server->record_browsers, b);
144
145     /* Add the new entry to the record_browser hash table */
146     t = g_hash_table_lookup(server->record_browser_hashtable, key);
147     AVAHI_LLIST_PREPEND(AvahiRecordBrowser, by_key, t, b);
148     g_hash_table_replace(server->record_browser_hashtable, key, t);
149
150     /* The currenlty cached entries are scanned a bit later */
151     b->scan_idle_source = g_idle_add_full(G_PRIORITY_HIGH, scan_idle_callback, b, NULL);
152     return b;
153 }
154
155 void avahi_record_browser_free(AvahiRecordBrowser *b) {
156     g_assert(b);
157     g_assert(!b->dead);
158
159     b->dead = TRUE;
160     b->server->need_browser_cleanup = TRUE;
161
162     if (b->time_event) {
163         avahi_time_event_queue_remove(b->server->time_event_queue, b->time_event);
164         b->time_event = NULL;
165
166         if (b->scan_idle_source != (guint) -1) {
167             g_source_remove(b->scan_idle_source);
168             b->scan_idle_source = (guint) -1;
169         }
170
171     }
172 }
173
174 void avahi_record_browser_destroy(AvahiRecordBrowser *b) {
175     AvahiRecordBrowser *t;
176     
177     g_assert(b);
178     
179     AVAHI_LLIST_REMOVE(AvahiRecordBrowser, browser, b->server->record_browsers, b);
180
181     t = g_hash_table_lookup(b->server->record_browser_hashtable, b->key);
182     AVAHI_LLIST_REMOVE(AvahiRecordBrowser, by_key, t, b);
183     if (t)
184         g_hash_table_replace(b->server->record_browser_hashtable, t->key, t);
185     else
186         g_hash_table_remove(b->server->record_browser_hashtable, b->key);
187
188     if (b->time_event)
189         avahi_time_event_queue_remove(b->server->time_event_queue, b->time_event);
190     avahi_key_unref(b->key);
191
192     if (b->scan_idle_source != (guint) -1)
193         g_source_remove(b->scan_idle_source);
194     
195     g_free(b);
196 }
197
198 void avahi_browser_cleanup(AvahiServer *server) {
199     AvahiRecordBrowser *b;
200     AvahiRecordBrowser *n;
201     
202     g_assert(server);
203
204     for (b = server->record_browsers; b; b = n) {
205         n = b->browser_next;
206         
207         if (b->dead)
208             avahi_record_browser_destroy(b);
209     }
210
211     server->need_browser_cleanup = FALSE;
212 }
213
214 void avahi_browser_notify(AvahiServer *server, AvahiInterface *i, AvahiRecord *record, AvahiBrowserEvent event) {
215     AvahiRecordBrowser *b;
216     
217     g_assert(server);
218     g_assert(record);
219
220     for (b = g_hash_table_lookup(server->record_browser_hashtable, record->key); b; b = b->by_key_next)
221         if (!b->dead && avahi_interface_match(i, b->interface, b->protocol))
222                 b->callback(b, i->hardware->index, i->protocol, event, record, b->userdata);
223 }
224
225 gboolean avahi_is_subscribed(AvahiServer *server, AvahiInterface *i, AvahiKey *k) {
226     AvahiRecordBrowser *b;
227     g_assert(server);
228     g_assert(k);
229
230     for (b = g_hash_table_lookup(server->record_browser_hashtable, k); b; b = b->by_key_next)
231         if (!b->dead && avahi_interface_match(i, b->interface, b->protocol))
232             return TRUE;
233
234     return FALSE;
235 }
236
237 void avahi_browser_new_interface(AvahiServer*s, AvahiInterface *i) {
238     AvahiRecordBrowser *b;
239     
240     g_assert(s);
241     g_assert(i);
242     
243     for (b = s->record_browsers; b; b = b->browser_next)
244         if (avahi_interface_match(i, b->interface, b->protocol))
245             avahi_interface_post_query(i, b->key, FALSE);
246 }