1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* expirelist.c List of items that expire
4 * Copyright (C) 2003 Red Hat, Inc.
6 * Licensed under the Academic Free License version 2.1
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 #include "expirelist.h"
26 #include <dbus/dbus-internals.h>
27 #include <dbus/dbus-mainloop.h>
28 #include <dbus/dbus-timeout.h>
32 DBusList *items; /**< List of BusExpireItem */
35 BusExpireFunc expire_func;
37 int expire_after; /**< Expire after milliseconds (thousandths) */
40 static dbus_bool_t expire_timeout_handler (void *data);
43 call_timeout_callback (DBusTimeout *timeout,
46 /* can return FALSE on OOM but we just let it fire again later */
47 dbus_timeout_handle (timeout);
51 bus_expire_list_new (DBusLoop *loop,
53 BusExpireFunc expire_func,
58 list = dbus_new0 (BusExpireList, 1);
62 list->expire_func = expire_func;
65 list->expire_after = expire_after;
67 list->timeout = _dbus_timeout_new (100, /* irrelevant */
68 expire_timeout_handler,
70 if (list->timeout == NULL)
73 _dbus_timeout_set_enabled (list->timeout, FALSE);
75 if (!_dbus_loop_add_timeout (list->loop,
77 call_timeout_callback, NULL, NULL))
84 _dbus_timeout_unref (list->timeout);
92 bus_expire_list_free (BusExpireList *list)
94 _dbus_assert (list->items == NULL);
96 _dbus_loop_remove_timeout (list->loop, list->timeout,
97 call_timeout_callback, NULL);
99 _dbus_timeout_unref (list->timeout);
105 bus_expire_timeout_set_interval (DBusTimeout *timeout,
108 if (next_interval >= 0)
110 _dbus_timeout_set_interval (timeout,
112 _dbus_timeout_set_enabled (timeout, TRUE);
114 _dbus_verbose ("Enabled an expire timeout with interval %d\n",
117 else if (dbus_timeout_get_enabled (timeout))
119 _dbus_timeout_set_enabled (timeout, FALSE);
121 _dbus_verbose ("Disabled an expire timeout\n");
124 _dbus_verbose ("No need to disable this expire timeout\n");
128 bus_expire_list_recheck_immediately (BusExpireList *list)
130 _dbus_verbose ("setting interval on expire list to 0 for immediate recheck\n");
132 bus_expire_timeout_set_interval (list->timeout, 0);
136 do_expiration_with_current_time (BusExpireList *list,
141 int next_interval, min_wait_time, items_to_expire;
144 min_wait_time = 3600 * 1000; /* this is reset anyway if used */
147 link = _dbus_list_get_first_link (&list->items);
150 DBusList *next = _dbus_list_get_next_link (&list->items, link);
156 elapsed = ELAPSED_MILLISECONDS_SINCE (item->added_tv_sec,
160 if (((item->added_tv_sec == 0) && (item->added_tv_usec == 0)) ||
161 ((list->expire_after > 0) && (elapsed >= (double) list->expire_after)))
163 _dbus_verbose ("Expiring an item %p\n", item);
165 /* If the expire function fails, we just end up expiring
166 * this item next time we walk through the list. This would
167 * be an indeterminate time normally, so we set up the
168 * next_interval to be "shortly" (just enough to avoid
171 if (!(* list->expire_func) (list, link, list->data))
173 next_interval = _dbus_get_oom_wait ();
177 else if (list->expire_after > 0)
182 to_wait = (double) list->expire_after - elapsed;
183 if (min_wait_time > to_wait)
184 min_wait_time = to_wait;
190 if (next_interval < 0 && items_to_expire)
191 next_interval = min_wait_time;
193 return next_interval;
197 bus_expirelist_expire (BusExpireList *list)
203 if (list->items != NULL)
205 long tv_sec, tv_usec;
207 _dbus_get_current_time (&tv_sec, &tv_usec);
209 next_interval = do_expiration_with_current_time (list, tv_sec, tv_usec);
212 bus_expire_timeout_set_interval (list->timeout, next_interval);
216 expire_timeout_handler (void *data)
218 BusExpireList *list = data;
220 _dbus_verbose ("Running %s\n", _DBUS_FUNCTION_NAME);
222 /* note that this may remove the timeout */
223 bus_expirelist_expire (list);
229 bus_expire_list_remove_link (BusExpireList *list,
232 _dbus_list_remove_link (&list->items, link);
236 bus_expire_list_remove (BusExpireList *list,
239 return _dbus_list_remove (&list->items, item);
243 bus_expire_list_unlink (BusExpireList *list,
246 _dbus_list_unlink (&list->items, link);
250 bus_expire_list_add (BusExpireList *list,
255 ret = _dbus_list_prepend (&list->items, item);
256 if (ret && !dbus_timeout_get_enabled (list->timeout))
257 bus_expire_timeout_set_interval (list->timeout, 0);
263 bus_expire_list_add_link (BusExpireList *list,
266 _dbus_assert (link->data != NULL);
268 _dbus_list_prepend_link (&list->items, link);
270 if (!dbus_timeout_get_enabled (list->timeout))
271 bus_expire_timeout_set_interval (list->timeout, 0);
275 bus_expire_list_get_first_link (BusExpireList *list)
277 return _dbus_list_get_first_link (&list->items);
281 bus_expire_list_get_next_link (BusExpireList *list,
284 return _dbus_list_get_next_link (&list->items, link);
288 bus_expire_list_contains_item (BusExpireList *list,
291 return _dbus_list_find_last (&list->items, item) != NULL;
294 #ifdef DBUS_BUILD_TESTS
303 test_expire_func (BusExpireList *list,
309 t = (TestExpireItem*) link->data;
311 t->expire_count += 1;
317 time_add_milliseconds (long *tv_sec,
321 *tv_sec = *tv_sec + milliseconds / 1000;
322 *tv_usec = *tv_usec + milliseconds * 1000;
323 if (*tv_usec >= 1000000)
331 bus_expire_list_test (const DBusString *test_data_dir)
335 long tv_sec, tv_usec;
336 long tv_sec_not_expired, tv_usec_not_expired;
337 long tv_sec_expired, tv_usec_expired;
338 long tv_sec_past, tv_usec_past;
339 TestExpireItem *item;
341 dbus_bool_t result = FALSE;
344 loop = _dbus_loop_new ();
345 _dbus_assert (loop != NULL);
347 #define EXPIRE_AFTER 100
349 list = bus_expire_list_new (loop, EXPIRE_AFTER,
350 test_expire_func, NULL);
351 _dbus_assert (list != NULL);
353 _dbus_get_current_time (&tv_sec, &tv_usec);
355 tv_sec_not_expired = tv_sec;
356 tv_usec_not_expired = tv_usec;
357 time_add_milliseconds (&tv_sec_not_expired,
358 &tv_usec_not_expired, EXPIRE_AFTER - 1);
360 tv_sec_expired = tv_sec;
361 tv_usec_expired = tv_usec;
362 time_add_milliseconds (&tv_sec_expired,
363 &tv_usec_expired, EXPIRE_AFTER);
366 tv_sec_past = tv_sec - 1;
367 tv_usec_past = tv_usec;
369 item = dbus_new0 (TestExpireItem, 1);
374 item->item.added_tv_sec = tv_sec;
375 item->item.added_tv_usec = tv_usec;
376 if (!bus_expire_list_add (list, &item->item))
377 _dbus_assert_not_reached ("out of memory");
380 do_expiration_with_current_time (list, tv_sec_not_expired,
381 tv_usec_not_expired);
382 _dbus_assert (item->expire_count == 0);
383 _dbus_verbose ("next_interval = %d\n", next_interval);
384 _dbus_assert (next_interval == 1);
387 do_expiration_with_current_time (list, tv_sec_expired,
389 _dbus_assert (item->expire_count == 1);
390 _dbus_verbose ("next_interval = %d\n", next_interval);
391 _dbus_assert (next_interval == -1);
394 do_expiration_with_current_time (list, tv_sec_past,
396 _dbus_assert (item->expire_count == 1);
397 _dbus_verbose ("next_interval = %d\n", next_interval);
398 _dbus_assert (next_interval == 1000 + EXPIRE_AFTER);
400 bus_expire_list_remove (list, &item->item);
403 bus_expire_list_free (list);
404 _dbus_loop_unref (loop);
412 #endif /* DBUS_BUILD_TESTS */