1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* expirelist.c List of items that expire
4 * Copyright (C) 2003 Red Hat, Inc.
6 * Licensed under the Academic Free License version 1.2
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 #include "expirelist.h"
26 #include <dbus/dbus-internals.h>
27 #include <dbus/dbus-mainloop.h>
28 #include <dbus/dbus-timeout.h>
30 static dbus_bool_t expire_timeout_handler (void *data);
33 call_timeout_callback (DBusTimeout *timeout,
36 /* can return FALSE on OOM but we just let it fire again later */
37 dbus_timeout_handle (timeout);
41 bus_expire_list_new (DBusLoop *loop,
43 BusExpireFunc expire_func,
48 list = dbus_new0 (BusExpireList, 1);
52 list->expire_func = expire_func;
55 list->expire_after = expire_after;
57 list->timeout = _dbus_timeout_new (100, /* irrelevant */
58 expire_timeout_handler,
60 if (list->timeout == NULL)
63 _dbus_timeout_set_enabled (list->timeout, FALSE);
65 if (!_dbus_loop_add_timeout (list->loop,
67 call_timeout_callback, NULL, NULL))
74 _dbus_timeout_unref (list->timeout);
82 bus_expire_list_free (BusExpireList *list)
84 _dbus_assert (list->n_items == 0);
85 _dbus_assert (list->items == NULL);
87 _dbus_loop_remove_timeout (list->loop, list->timeout,
88 call_timeout_callback, NULL);
90 _dbus_timeout_unref (list->timeout);
96 bus_expire_timeout_set_interval (DBusTimeout *timeout,
99 if (next_interval >= 0)
101 _dbus_timeout_set_interval (timeout,
103 _dbus_timeout_set_enabled (timeout, TRUE);
105 _dbus_verbose ("Enabled expire timeout with interval %d\n",
108 else if (dbus_timeout_get_enabled (timeout))
110 _dbus_timeout_set_enabled (timeout, FALSE);
112 _dbus_verbose ("Disabled expire timeout\n");
115 _dbus_verbose ("No need to disable expire timeout\n");
119 do_expiration_with_current_time (BusExpireList *list,
128 link = _dbus_list_get_first_link (&list->items);
131 DBusList *next = _dbus_list_get_next_link (&list->items, link);
137 elapsed = ELAPSED_MILLISECONDS_SINCE (item->added_tv_sec,
141 if (elapsed >= (double) list->expire_after)
143 _dbus_verbose ("Expiring an item %p\n", item);
145 /* If the expire function fails, we just end up expiring
146 * this item next time we walk through the list. This would
147 * be an indeterminate time normally, so we set up the
148 * next_interval to be "shortly" (just enough to avoid
151 if (!(* list->expire_func) (list, link, list->data))
153 next_interval = _dbus_get_oom_wait ();
159 /* We can end the loop, since the connections are in oldest-first order */
160 next_interval = ((double)list->expire_after) - elapsed;
161 _dbus_verbose ("Item %p expires in %d milliseconds\n",
162 item, next_interval);
170 return next_interval;
174 bus_expirelist_expire (BusExpireList *list)
180 if (list->items != NULL)
182 long tv_sec, tv_usec;
184 _dbus_get_current_time (&tv_sec, &tv_usec);
186 next_interval = do_expiration_with_current_time (list, tv_sec, tv_usec);
189 bus_expire_timeout_set_interval (list->timeout, next_interval);
193 expire_timeout_handler (void *data)
195 BusExpireList *list = data;
197 _dbus_verbose ("Running %s\n", _DBUS_FUNCTION_NAME);
199 /* note that this may remove the timeout */
200 bus_expirelist_expire (list);
205 #ifdef DBUS_BUILD_TESTS
214 test_expire_func (BusExpireList *list,
220 t = (TestExpireItem*) link->data;
222 t->expire_count += 1;
228 time_add_milliseconds (long *tv_sec,
232 *tv_sec = *tv_sec + milliseconds / 1000;
233 *tv_usec = *tv_usec + milliseconds * 1000;
234 if (*tv_usec >= 1000000)
242 bus_expire_list_test (const DBusString *test_data_dir)
246 long tv_sec, tv_usec;
247 long tv_sec_not_expired, tv_usec_not_expired;
248 long tv_sec_expired, tv_usec_expired;
249 long tv_sec_past, tv_usec_past;
250 TestExpireItem *item;
253 loop = _dbus_loop_new ();
254 _dbus_assert (loop != NULL);
256 #define EXPIRE_AFTER 100
258 list = bus_expire_list_new (loop, EXPIRE_AFTER,
259 test_expire_func, NULL);
260 _dbus_assert (list != NULL);
262 _dbus_get_current_time (&tv_sec, &tv_usec);
264 tv_sec_not_expired = tv_sec;
265 tv_usec_not_expired = tv_usec;
266 time_add_milliseconds (&tv_sec_not_expired,
267 &tv_usec_not_expired, EXPIRE_AFTER - 1);
269 tv_sec_expired = tv_sec;
270 tv_usec_expired = tv_usec;
271 time_add_milliseconds (&tv_sec_expired,
272 &tv_usec_expired, EXPIRE_AFTER);
275 tv_sec_past = tv_sec - 1;
276 tv_usec_past = tv_usec;
278 item = dbus_new0 (TestExpireItem, 1);
280 item->item.added_tv_sec = tv_sec;
281 item->item.added_tv_usec = tv_usec;
282 if (!_dbus_list_append (&list->items, item))
283 _dbus_assert_not_reached ("out of memory");
286 do_expiration_with_current_time (list, tv_sec_not_expired,
287 tv_usec_not_expired);
288 _dbus_assert (item->expire_count == 0);
289 _dbus_verbose ("next_interval = %d\n", next_interval);
290 _dbus_assert (next_interval == 1);
293 do_expiration_with_current_time (list, tv_sec_expired,
295 _dbus_assert (item->expire_count == 1);
296 _dbus_verbose ("next_interval = %d\n", next_interval);
297 _dbus_assert (next_interval == -1);
300 do_expiration_with_current_time (list, tv_sec_past,
302 _dbus_assert (item->expire_count == 1);
303 _dbus_verbose ("next_interval = %d\n", next_interval);
304 _dbus_assert (next_interval == 1000 + EXPIRE_AFTER);
306 _dbus_list_clear (&list->items);
309 bus_expire_list_free (list);
310 _dbus_loop_unref (loop);
315 #endif /* DBUS_BUILD_TESTS */