Main Page   Modules   Data Structures   File List   Data Fields   Related Pages  

DBusTimeout
[D-BUS message system public API]

Object representing a timeout. More...

Typedefs

typedef DBusTimeout DBusTimeout
 Opaque object representing a timeout.


Functions

int dbus_timeout_get_interval (DBusTimeout *timeout)
 Gets the timeout interval.

void * dbus_timeout_get_data (DBusTimeout *timeout)
 Gets data previously set with dbus_timeout_set_data() or NULL if none.

void dbus_timeout_set_data (DBusTimeout *timeout, void *data, DBusFreeFunction free_data_function)
 Sets data which can be retrieved with dbus_timeout_get_data().

dbus_bool_t dbus_timeout_handle (DBusTimeout *timeout)
 Calls the timeout handler for this timeout.

dbus_bool_t dbus_timeout_get_enabled (DBusTimeout *timeout)
 Returns whether a timeout is enabled or not.


Detailed Description

Object representing a timeout.

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().


Function Documentation

void* dbus_timeout_get_data DBusTimeout   timeout
 

Gets data previously set with dbus_timeout_set_data() or NULL if none.

Parameters:
timeout the DBusTimeout object.
Returns:
previously-set data.

Definition at line 419 of file dbus-timeout.c.

dbus_bool_t dbus_timeout_get_enabled DBusTimeout   timeout
 

Returns whether a timeout is enabled or not.

If not enabled, it should not be polled by the main loop.

Parameters:
timeout the DBusTimeout object
Returns:
TRUE if the timeout is enabled

Definition at line 476 of file dbus-timeout.c.

int dbus_timeout_get_interval DBusTimeout   timeout
 

Gets the timeout interval.

The dbus_timeout_handle() should be called each time this interval elapses, starting after it elapses once.

The interval may change during the life of the timeout; if so, the timeout will be disabled and re-enabled (calling the "timeout toggled function") to notify you of the change.

Parameters:
timeout the DBusTimeout object.
Returns:
the interval in milliseconds.

Definition at line 406 of file dbus-timeout.c.

dbus_bool_t dbus_timeout_handle DBusTimeout   timeout
 

Calls the timeout handler for this timeout.

This function should be called when the timeout occurs.

If this function returns FALSE, then there wasn't enough memory to handle the timeout. Typically just letting the timeout fire again next time it naturally times out is an adequate response to that problem, but you could try to do more if you wanted.

Parameters:
timeout the DBusTimeout object.
Returns:
FALSE if there wasn't enough memory

Definition at line 462 of file dbus-timeout.c.

void dbus_timeout_set_data DBusTimeout   timeout,
void *    data,
DBusFreeFunction    free_data_function
 

Sets data which can be retrieved with dbus_timeout_get_data().

Intended for use by the DBusAddTimeoutFunction and DBusRemoveTimeoutFunction to store their own data. For example with Qt you might store the QTimer for this timeout and with GLib you might store a g_timeout_add result id.

Parameters:
timeout the DBusTimeout object.
data the data.
free_data_function function to be called to free the data.

Definition at line 436 of file dbus-timeout.c.

References NULL.

Referenced by _dbus_timeout_unref().


Generated on Wed Oct 22 14:05:09 2003 for D-BUS by doxygen1.3-rc3