dbus/dbus-timeout.c

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-timeout.c DBusTimeout implementation
   3  *
   4  * Copyright (C) 2003  CodeFactory AB
   5  *
   6  * Licensed under the Academic Free License version 1.2
   7  *
   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.
  12  *
  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.
  17  *
  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
  21  *
  22  */
  23
  24 #include "dbus-internals.h"
  25 #include "dbus-timeout.h"
  26 #include "dbus-list.h"
  27
  28 /**
  29  * @defgroup DBusTimeoutInternals DBusTimeout implementation details
  30  * @ingroup  DBusInternals
  31  * @brief implementation details for DBusTimeout
  32  *
  33  * @{
  34  */
  35
  36 struct DBusTimeout
  37 {
  38   int refcount;                                /**< Reference count */
  39   int interval;                                /**< Timeout interval in milliseconds. */
  40
  41   DBusTimeoutHandler handler;                  /**< Timeout handler. */
  42   void *handler_data;                          /**< Timeout handler data. */
  43   DBusFreeFunction free_handler_data_function; /**< Free the timeout handler data. */
  44
  45   void *data;                                  /**< Application data. */
  46   DBusFreeFunction free_data_function;         /**< Free the application data. */
  47   unsigned int enabled : 1;                    /**< True if timeout is active. */
  48 };
  49
  50 /**
  51  * Creates a new DBusTimeout, enabled by default.
  52  * @param interval the timeout interval in milliseconds.
  53  * @param handler function to call when the timeout occurs.
  54  * @param data data to pass to the handler
  55  * @param free_data_function function to be called to free the data.
  56  * @returns the new DBusTimeout object,
  57  */
  58 DBusTimeout*
  59 _dbus_timeout_new (int                 interval,
  60                    DBusTimeoutHandler  handler,
  61                    void               *data,
  62                    DBusFreeFunction    free_data_function)
  63 {
  64   DBusTimeout *timeout;
  65
  66   timeout = dbus_new0 (DBusTimeout, 1);
  67   timeout->refcount = 1;
  68   timeout->interval = interval;
  69
  70   timeout->handler = handler;
  71   timeout->handler_data = data;
  72   timeout->free_handler_data_function = free_data_function;
  73
  74   timeout->enabled = TRUE;
  75
  76   return timeout;
  77 }
  78
  79 /**
  80  * Increments the reference count of a DBusTimeout object.
  81  *
  82  * @param timeout the timeout object.
  83  */
  84 void
  85 _dbus_timeout_ref (DBusTimeout *timeout)
  86 {
  87   timeout->refcount += 1;
  88 }
  89
  90 /**
  91  * Decrements the reference count of a DBusTimeout object
  92  * and finalizes the object if the count reaches zero.
  93  *
  94  * @param timeout the timeout object.
  95  */
  96 void
  97 _dbus_timeout_unref (DBusTimeout *timeout)
  98 {
  99   _dbus_assert (timeout != NULL);
 100   _dbus_assert (timeout->refcount > 0);
 101
 102   timeout->refcount -= 1;
 103   if (timeout->refcount == 0)
 104     {
 105       dbus_timeout_set_data (timeout, NULL, NULL); /* call free_data_function */
 106
 107       if (timeout->free_handler_data_function)
 108         (* timeout->free_handler_data_function) (timeout->handler_data);
 109
 110       dbus_free (timeout);
 111     }
 112 }
 113
 114 /**
 115  * Changes the timeout interval. Note that you have to disable and
 116  * re-enable the timeout using the timeout toggle function
 117  * (_dbus_connection_toggle_timeout() etc.) to notify the application
 118  * of this change.
 119  *
 120  * @param timeout the timeout
 121  * @param interval the new interval
 122  */
 123 void
 124 _dbus_timeout_set_interval (DBusTimeout *timeout,
 125                             int          interval)
 126 {
 127   timeout->interval = interval;
 128 }
 129
 130 /**
 131  * Changes the timeout's enabled-ness. Note that you should use
 132  * _dbus_connection_toggle_timeout() etc. instead, if
 133  * the timeout is passed out to an application main loop.
 134  * i.e. you can't use this function in the D-BUS library, it's
 135  * only used in the message bus daemon implementation.
 136  *
 137  * @param timeout the timeout
 138  * @param interval the new interval
 139  */
 140 void
 141 _dbus_timeout_set_enabled (DBusTimeout  *timeout,
 142                            dbus_bool_t   enabled)
 143 {
 144   timeout->enabled = enabled != FALSE;
 145 }
 146
 147
 148 /**
 149  * @typedef DBusTimeoutList
 150  *
 151  * Opaque data type representing a list of timeouts
 152  * and a set of DBusAddTimeoutFunction/DBusRemoveTimeoutFunction.
 153  * Automatically handles removing/re-adding timeouts
 154  * when the DBusAddTimeoutFunction is updated or changed.
 155  * Holds a reference count to each timeout.
 156  *
 157  */
 158
 159 /**
 160  * DBusTimeoutList implementation details. All fields
 161  * are private.
 162  *
 163  */
 164 struct DBusTimeoutList
 165 {
 166   DBusList *timeouts; /**< Timeout objects. */
 167
 168   DBusAddTimeoutFunction add_timeout_function;       /**< Callback for adding a timeout. */
 169   DBusRemoveTimeoutFunction remove_timeout_function; /**< Callback for removing a timeout. */
 170   DBusTimeoutToggledFunction timeout_toggled_function; /**< Callback when timeout is enabled/disabled or changes interval */
 171   void *timeout_data;                                /**< Data for timeout callbacks */
 172   DBusFreeFunction timeout_free_data_function;       /**< Free function for timeout callback data */
 173 };
 174
 175 /**
 176  * Creates a new timeout list. Returns #NULL if insufficient
 177  * memory exists.
 178  *
 179  * @returns the new timeout list, or #NULL on failure.
 180  */
 181 DBusTimeoutList*
 182 _dbus_timeout_list_new (void)
 183 {
 184   DBusTimeoutList *timeout_list;
 185
 186   timeout_list = dbus_new0 (DBusTimeoutList, 1);
 187   if (timeout_list == NULL)
 188     return NULL;
 189
 190   return timeout_list;
 191 }
 192
 193 /**
 194  * Frees a DBusTimeoutList.
 195  *
 196  * @param timeout_list the timeout list.
 197  */
 198 void
 199 _dbus_timeout_list_free (DBusTimeoutList *timeout_list)
 200 {
 201   /* free timeout_data and remove timeouts as a side effect */
 202   _dbus_timeout_list_set_functions (timeout_list,
 203                                     NULL, NULL, NULL, NULL, NULL);
 204
 205   _dbus_list_foreach (&timeout_list->timeouts,
 206                       (DBusForeachFunction) _dbus_timeout_unref,
 207                       NULL);
 208   _dbus_list_clear (&timeout_list->timeouts);
 209
 210   dbus_free (timeout_list);
 211 }
 212
 213 /**
 214  * Sets the timeout functions. This function is the "backend"
 215  * for dbus_connection_set_timeout_functions().
 216  *
 217  * @param timeout_list the timeout list
 218  * @param add_function the add timeout function.
 219  * @param remove_function the remove timeout function.
 220  * @param toggled_function toggle notify function, or #NULL
 221  * @param data the data for those functions.
 222  * @param free_data_function the function to free the data.
 223  * @returns #FALSE if no memory
 224  *
 225  */
 226 dbus_bool_t
 227 _dbus_timeout_list_set_functions (DBusTimeoutList           *timeout_list,
 228                                   DBusAddTimeoutFunction     add_function,
 229                                   DBusRemoveTimeoutFunction  remove_function,
 230                                   DBusTimeoutToggledFunction toggled_function,
 231                                   void                      *data,
 232                                   DBusFreeFunction           free_data_function)
 233 {
 234   /* Add timeouts with the new function, failing on OOM */
 235   if (add_function != NULL)
 236     {
 237       DBusList *link;
 238
 239       link = _dbus_list_get_first_link (&timeout_list->timeouts);
 240       while (link != NULL)
 241         {
 242           DBusList *next = _dbus_list_get_next_link (&timeout_list->timeouts,
 243                                                      link);
 244
 245           if (!(* add_function) (link->data, data))
 246             {
 247               /* remove it all again and return FALSE */
 248               DBusList *link2;
 249
 250               link2 = _dbus_list_get_first_link (&timeout_list->timeouts);
 251               while (link2 != link)
 252                 {
 253                   DBusList *next = _dbus_list_get_next_link (&timeout_list->timeouts,
 254                                                              link2);
 255
 256                   (* remove_function) (link2->data, data);
 257
 258                   link2 = next;
 259                 }
 260
 261               return FALSE;
 262             }
 263
 264           link = next;
 265         }
 266     }
 267
 268   /* Remove all current timeouts from previous timeout handlers */
 269
 270   if (timeout_list->remove_timeout_function != NULL)
 271     {
 272       _dbus_list_foreach (&timeout_list->timeouts,
 273                           (DBusForeachFunction) timeout_list->remove_timeout_function,
 274                           timeout_list->timeout_data);
 275     }
 276
 277   if (timeout_list->timeout_free_data_function != NULL)
 278     (* timeout_list->timeout_free_data_function) (timeout_list->timeout_data);
 279
 280   timeout_list->add_timeout_function = add_function;
 281   timeout_list->remove_timeout_function = remove_function;
 282   timeout_list->timeout_toggled_function = toggled_function;
 283   timeout_list->timeout_data = data;
 284   timeout_list->timeout_free_data_function = free_data_function;
 285
 286   return TRUE;
 287 }
 288
 289 /**
 290  * Adds a new timeout to the timeout list, invoking the
 291  * application DBusAddTimeoutFunction if appropriate.
 292  *
 293  * @param timeout_list the timeout list.
 294  * @param timeout the timeout to add.
 295  * @returns #TRUE on success, #FALSE If no memory.
 296  */
 297 dbus_bool_t
 298 _dbus_timeout_list_add_timeout (DBusTimeoutList *timeout_list,
 299                                 DBusTimeout     *timeout)
 300 {
 301   if (!_dbus_list_append (&timeout_list->timeouts, timeout))
 302     return FALSE;
 303
 304   _dbus_timeout_ref (timeout);
 305
 306   if (timeout_list->add_timeout_function != NULL)
 307     {
 308       if (!(* timeout_list->add_timeout_function) (timeout,
 309                                                    timeout_list->timeout_data))
 310         {
 311           _dbus_list_remove_last (&timeout_list->timeouts, timeout);
 312           _dbus_timeout_unref (timeout);
 313           return FALSE;
 314         }
 315     }
 316
 317   return TRUE;
 318 }
 319
 320 /**
 321  * Removes a timeout from the timeout list, invoking the
 322  * application's DBusRemoveTimeoutFunction if appropriate.
 323  *
 324  * @param timeout_list the timeout list.
 325  * @param timeout the timeout to remove.
 326  */
 327 void
 328 _dbus_timeout_list_remove_timeout (DBusTimeoutList *timeout_list,
 329                                    DBusTimeout     *timeout)
 330 {
 331   if (!_dbus_list_remove (&timeout_list->timeouts, timeout))
 332     _dbus_assert_not_reached ("Nonexistent timeout was removed");
 333
 334   if (timeout_list->remove_timeout_function != NULL)
 335     (* timeout_list->remove_timeout_function) (timeout,
 336                                                timeout_list->timeout_data);
 337
 338   _dbus_timeout_unref (timeout);
 339 }
 340
 341 /**
 342  * Sets a timeout to the given enabled state, invoking the
 343  * application's DBusTimeoutToggledFunction if appropriate.
 344  *
 345  * @param timeout_list the timeout list.
 346  * @param timeout the timeout to toggle.
 347  * @param enabled #TRUE to enable
 348  */
 349 void
 350 _dbus_timeout_list_toggle_timeout (DBusTimeoutList           *timeout_list,
 351                                    DBusTimeout               *timeout,
 352                                    dbus_bool_t                enabled)
 353 {
 354   enabled = !!enabled;
 355
 356   if (enabled == timeout->enabled)
 357     return;
 358
 359   timeout->enabled = enabled;
 360
 361   if (timeout_list->timeout_toggled_function != NULL)
 362     (* timeout_list->timeout_toggled_function) (timeout,
 363                                                 timeout_list->timeout_data);
 364 }
 365
 366 /** @} */
 367
 368 /**
 369  * @defgroup DBusTimeout DBusTimeout
 370  * @ingroup  DBus
 371  * @brief Object representing a timeout
 372  *
 373  * Types and functions related to DBusTimeout. A timeout
 374  * represents a timeout that the main loop needs to monitor,
 375  * as in Qt's QTimer or GLib's g_timeout_add().
 376  *
 377  * @{
 378  */
 379
 380
 381 /**
 382  * @typedef DBusTimeout
 383  *
 384  * Opaque object representing a timeout.
 385  */
 386
 387 /**
 388  * Gets the timeout interval. The dbus_timeout_handle()
 389  * should be called each time this interval elapses,
 390  * starting after it elapses once.
 391  *
 392  * The interval may change during the life of the
 393  * timeout; if so, the timeout will be disabled and
 394  * re-enabled (calling the "timeout toggled function")
 395  * to notify you of the change.
 396  *
 397  * @param timeout the DBusTimeout object.
 398  * @returns the interval in milliseconds.
 399  */
 400 int
 401 dbus_timeout_get_interval (DBusTimeout *timeout)
 402 {
 403   return timeout->interval;
 404 }
 405
 406 /**
 407  * Gets data previously set with dbus_timeout_set_data()
 408  * or #NULL if none.
 409  *
 410  * @param timeout the DBusTimeout object.
 411  * @returns previously-set data.
 412  */
 413 void*
 414 dbus_timeout_get_data (DBusTimeout *timeout)
 415 {
 416   return timeout->data;
 417 }
 418
 419 /**
 420  * Sets data which can be retrieved with dbus_timeout_get_data().
 421  * Intended for use by the DBusAddTimeoutFunction and
 422  * DBusRemoveTimeoutFunction to store their own data.  For example with
 423  * Qt you might store the QTimer for this timeout and with GLib
 424  * you might store a g_timeout_add result id.
 425  *
 426  * @param timeout the DBusTimeout object.
 427  * @param data the data.
 428  * @param free_data_function function to be called to free the data.
 429  */
 430 void
 431 dbus_timeout_set_data (DBusTimeout      *timeout,
 432                        void             *data,
 433                        DBusFreeFunction  free_data_function)
 434 {
 435   if (timeout->free_data_function != NULL)
 436     (* timeout->free_data_function) (timeout->data);
 437
 438   timeout->data = data;
 439   timeout->free_data_function = free_data_function;
 440 }
 441
 442 /**
 443  * Calls the timeout handler for this timeout.
 444  * This function should be called when the timeout
 445  * occurs.
 446  *
 447  * If this function returns #FALSE, then there wasn't
 448  * enough memory to handle the timeout. Typically just
 449  * letting the timeout fire again next time it naturally
 450  * times out is an adequate response to that problem,
 451  * but you could try to do more if you wanted.
 452  *
 453  * @param timeout the DBusTimeout object.
 454  * @returns #FALSE if there wasn't enough memory
 455  */
 456 dbus_bool_t
 457 dbus_timeout_handle (DBusTimeout *timeout)
 458 {
 459   return (* timeout->handler) (timeout->handler_data);
 460 }
 461
 462
 463 /**
 464  * Returns whether a timeout is enabled or not. If not
 465  * enabled, it should not be polled by the main loop.
 466  *
 467  * @param timeout the DBusTimeout object
 468  * @returns #TRUE if the timeout is enabled
 469  */
 470 dbus_bool_t
 471 dbus_timeout_get_enabled (DBusTimeout *timeout)
 472 {
 473   return timeout->enabled;
 474 }
 475
 476 /** @} end public API docs */