Merge "Optional autogen.sh flag --enable-kdbus-transport added allowing to compile...

[platform/upstream/dbus.git] / dbus / dbus-timeout.c

diff --git a/dbus/dbus-timeout.c b/dbus/dbus-timeout.c
index 74210f9..a1d6ce5 100644 (file)
--- a/dbus/dbus-timeout.c
+++ b/dbus/dbus-timeout.c
@@ -1,9 +1,9 @@
-/* -*- mode: C; c-file-style: "gnu" -*- */
+/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
 /* dbus-timeout.c DBusTimeout implementation
  *
  * Copyright (C) 2003  CodeFactory AB
  *
- * Licensed under the Academic Free License version 1.2
+ * Licensed under the Academic Free License version 2.1
  * 
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -17,10 +17,11 @@
  * 
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  *
  */
 
+#include <config.h>
 #include "dbus-internals.h"
 #include "dbus-timeout.h"
 #include "dbus-list.h"
@@ -33,6 +34,9 @@
  * @{
  */
 
+/**
+ * Internals of DBusTimeout
+ */
 struct DBusTimeout
 {
   int refcount;                                /**< Reference count */
@@ -64,6 +68,9 @@ _dbus_timeout_new (int                 interval,
   DBusTimeout *timeout;
 
   timeout = dbus_new0 (DBusTimeout, 1);
+  if (timeout == NULL)
+    return NULL;
+  
   timeout->refcount = 1;
   timeout->interval = interval;
 
@@ -80,11 +87,14 @@ _dbus_timeout_new (int                 interval,
  * Increments the reference count of a DBusTimeout object.
  *
  * @param timeout the timeout object.
+ * @returns the timeout object.
  */
-void
+DBusTimeout *
 _dbus_timeout_ref (DBusTimeout *timeout)
 {
   timeout->refcount += 1;
+
+  return timeout;
 }
 
 /**
@@ -114,8 +124,8 @@ _dbus_timeout_unref (DBusTimeout *timeout)
 /**
  * Changes the timeout interval. Note that you have to disable and
  * re-enable the timeout using the timeout toggle function
- * (_dbus_connection_toggle_timeout() etc.) to notify the application
- * of this change.
+ * (_dbus_connection_toggle_timeout_unlocked() etc.) to notify the
+ * application of this change.
  *
  * @param timeout the timeout
  * @param interval the new interval
@@ -124,18 +134,20 @@ void
 _dbus_timeout_set_interval (DBusTimeout *timeout,
                             int          interval)
 {
+  _dbus_assert (interval >= 0);
+  
   timeout->interval = interval;
 }
 
 /**
  * Changes the timeout's enabled-ness. Note that you should use
- * _dbus_connection_toggle_timeout() etc. instead, if
+ * _dbus_connection_toggle_timeout_unlocked() etc. instead, if
  * the timeout is passed out to an application main loop.
- * i.e. you can't use this function in the D-BUS library, it's
+ * i.e. you can't use this function in the D-Bus library, it's
  * only used in the message bus daemon implementation.
  *
  * @param timeout the timeout
- * @param interval the new interval
+ * @param enabled #TRUE if timeout should be enabled.
  */
 void
 _dbus_timeout_set_enabled (DBusTimeout  *timeout,
@@ -373,6 +385,9 @@ _dbus_timeout_list_toggle_timeout (DBusTimeoutList           *timeout_list,
  * Types and functions related to DBusTimeout. A timeout
  * represents a timeout that the main loop needs to monitor,
  * as in Qt's QTimer or GLib's g_timeout_add().
+ *
+ * Use dbus_connection_set_timeout_functions() or dbus_server_set_timeout_functions()
+ * to be notified when libdbus needs to add or remove timeouts.
  * 
  * @{
  */