index.html
Main Page
|
modules.html
Modules
|
namespaces.html
Namespace List
|
hierarchy.html
Class Hierarchy
|
annotated.html
Data Structures
|
dirs.html
Directories
|
files.html
File List
|
namespacemembers.html
Namespace Members
|
functions.html
Data Fields
|
pages.html
Related Pages
DBusTimeout
[
group__DBus.html
D-BUS low-level public API
]
Object representing a timeout.
#_details
More...
Typedefs
typedef
structDBusTimeout.html
DBusTimeout
group__DBusTimeout.html#ga5
DBusTimeout
Opaque object representing a timeout.
Functions
int
group__DBusTimeout.html#ga0
dbus_timeout_get_interval
(
structDBusTimeout.html
DBusTimeout
*timeout)
Gets the timeout interval.
#ga0
void *
group__DBusTimeout.html#ga1
dbus_timeout_get_data
(
structDBusTimeout.html
DBusTimeout
*timeout)
Gets data previously set with
group__DBusTimeout.html#ga2
dbus_timeout_set_data()
or
group__DBusMacros.html#ga4
NULL
if none.
#ga1
void
group__DBusTimeout.html#ga2
dbus_timeout_set_data
(
structDBusTimeout.html
DBusTimeout
*timeout, void *data,
group__DBusMemory.html#ga8
DBusFreeFunction
free_data_function)
Sets data which can be retrieved with
group__DBusTimeout.html#ga1
dbus_timeout_get_data()
.
#ga2
group__DBusTypes.html#ga2
dbus_bool_t
group__DBusTimeout.html#ga3
dbus_timeout_handle
(
structDBusTimeout.html
DBusTimeout
*timeout)
Calls the timeout handler for this timeout.
#ga3
group__DBusTypes.html#ga2
dbus_bool_t
group__DBusTimeout.html#ga4
dbus_timeout_get_enabled
(
structDBusTimeout.html
DBusTimeout
*timeout)
Returns whether a timeout is enabled or not.
#ga4
Detailed Description
Object representing a timeout.
Types and functions related to
structDBusTimeout.html
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
(
structDBusTimeout.html
DBusTimeout
*
timeout
)
Gets data previously set with
group__DBusTimeout.html#ga2
dbus_timeout_set_data()
or
group__DBusMacros.html#ga4
NULL
if none.
Parameters:
timeout
the
structDBusTimeout.html
DBusTimeout
object.
Returns:
previously-set data.
Definition at line
dbus-timeout_8c-source.html#l00425
425
of file
dbus-timeout_8c-source.html
dbus-timeout.c
.
References
dbus-timeout_8c-source.html#l00048
data
.
group__DBusTypes.html#ga2
dbus_bool_t
dbus_timeout_get_enabled
(
structDBusTimeout.html
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
structDBusTimeout.html
DBusTimeout
object
Returns:
group__DBusMacros.html#ga2
TRUE
if the timeout is enabled
Definition at line
dbus-timeout_8c-source.html#l00482
482
of file
dbus-timeout_8c-source.html
dbus-timeout.c
.
References
dbus-timeout_8c-source.html#l00050
enabled
.
Referenced by
integrator_8cpp-source.html#l00065
DBusQt::Internal::dbusAddTimeout()
, and
integrator_8cpp-source.html#l00081
DBusQt::Internal::dbusToggleTimeout()
.
int dbus_timeout_get_interval
(
structDBusTimeout.html
DBusTimeout
*
timeout
)
Gets the timeout interval.
The
group__DBusTimeout.html#ga3
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
structDBusTimeout.html
DBusTimeout
object.
Returns:
the interval in milliseconds.
Definition at line
dbus-timeout_8c-source.html#l00412
412
of file
dbus-timeout_8c-source.html
dbus-timeout.c
.
References
dbus-timeout_8c-source.html#l00042
interval
.
Referenced by
dbus-connection_8c-source.html#l02571
_dbus_connection_block_pending_call()
, and
integrator_8cpp-source.html#l00117
DBusQt::Internal::Timeout::start()
.
group__DBusTypes.html#ga2
dbus_bool_t
dbus_timeout_handle
(
structDBusTimeout.html
DBusTimeout
*
timeout
)
Calls the timeout handler for this timeout.
This function should be called when the timeout occurs.
If this function returns
group__DBusMacros.html#ga3
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
structDBusTimeout.html
DBusTimeout
object.
Returns:
group__DBusMacros.html#ga3
FALSE
if there wasn't enough memory
Definition at line
dbus-timeout_8c-source.html#l00468
468
of file
dbus-timeout_8c-source.html
dbus-timeout.c
.
References
dbus-timeout_8c-source.html#l00044
handler
, and
dbus-timeout_8c-source.html#l00045
handler_data
.
Referenced by
integrator_8cpp-source.html#l00179
DBusQt::Internal::Integrator::slotTimeout()
.
void dbus_timeout_set_data
(
structDBusTimeout.html
DBusTimeout
*
timeout
,
void *
data
,
group__DBusMemory.html#ga8
DBusFreeFunction
free_data_function
)
Sets data which can be retrieved with
group__DBusTimeout.html#ga1
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
structDBusTimeout.html
DBusTimeout
object.
data
the data.
free_data_function
function to be called to free the data.
Definition at line
dbus-timeout_8c-source.html#l00442
442
of file
dbus-timeout_8c-source.html
dbus-timeout.c
.
References
dbus-timeout_8c-source.html#l00048
data
,
dbus-timeout_8c-source.html#l00049
free_data_function
, and
group__DBusMacros.html#ga4
NULL
.
Referenced by
dbus-timeout_8c-source.html#l00106
_dbus_timeout_unref()
.
Generated on Tue Sep 13 01:28:09 2005 for D-BUS by
http://www.doxygen.org/index.html
doxygen
1.4.4
