<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>DBusTimeout</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.15 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>DBusTimeout<br>
<small>
[<a class="el" href="group__DBus.html">D-BUS message system public API</a>]</small>
</h1>Object representing a timeout.
<a href="#_details">More...</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="a5" doxytag="DBusTimeout::DBusTimeout"></a>
typedef DBusTimeout </td><td valign=bottom><a class="el" href="group__DBusTimeout.html#a5">DBusTimeout</a></td></tr>
<tr><td> </td><td><font size=-1><em>Opaque object representing a timeout.</em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__DBusTimeout.html#a0">dbus_timeout_get_interval</a> (DBusTimeout *timeout)</td></tr>
<tr><td> </td><td><font size=-1><em>Gets the timeout interval.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void * </td><td valign=bottom><a class="el" href="group__DBusTimeout.html#a1">dbus_timeout_get_data</a> (DBusTimeout *timeout)</td></tr>
<tr><td> </td><td><font size=-1><em>Gets data previously set with <a class="el" href="group__DBusTimeout.html#a2">dbus_timeout_set_data</a>() or <a class="el" href="group__DBusMacros.html#a4">NULL</a> if none.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__DBusTimeout.html#a2">dbus_timeout_set_data</a> (DBusTimeout *timeout, void *<a class="el" href="structDBusTimeout.html#m5">data</a>, <a class="el" href="group__DBusMemory.html#a8">DBusFreeFunction</a> <a class="el" href="structDBusTimeout.html#m6">free_data_function</a>)</td></tr>
<tr><td> </td><td><font size=-1><em>Sets data which can be retrieved with <a class="el" href="group__DBusTimeout.html#a1">dbus_timeout_get_data</a>().</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="group__DBusTypes.html#a2">dbus_bool_t</a> </td><td valign=bottom><a class="el" href="group__DBusTimeout.html#a3">dbus_timeout_handle</a> (DBusTimeout *timeout)</td></tr>
<tr><td> </td><td><font size=-1><em>Calls the timeout handler for this timeout.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="group__DBusTypes.html#a2">dbus_bool_t</a> </td><td valign=bottom><a class="el" href="group__DBusTimeout.html#a4">dbus_timeout_get_enabled</a> (DBusTimeout *timeout)</td></tr>
<tr><td> </td><td><font size=-1><em>Returns whether a timeout is enabled or not.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Object representing a timeout.
<p>
<p>
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(). <hr><h2>Function Documentation</h2>
<a name="a1" doxytag="dbus-connection.h::dbus_timeout_get_data"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void* dbus_timeout_get_data </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structDBusTimeout.html">DBusTimeout</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>timeout</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets data previously set with <a class="el" href="group__DBusTimeout.html#a2">dbus_timeout_set_data</a>() or <a class="el" href="group__DBusMacros.html#a4">NULL</a> if none.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>timeout</em> </td><td>
the <a class="el" href="structDBusTimeout.html">DBusTimeout</a> object. </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
previously-set data. </dl>
<p>
Definition at line <a class="el" href="dbus-timeout_8c-source.html#l00425">425</a> of file <a class="el" href="dbus-timeout_8c-source.html">dbus-timeout.c</a>.
<p>
References <a class="el" href="dbus-timeout_8c-source.html#l00048">data</a>. </td>
</tr>
</table>
<a name="a4" doxytag="dbus-connection.h::dbus_timeout_get_enabled"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="group__DBusTypes.html#a2">dbus_bool_t</a> dbus_timeout_get_enabled </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structDBusTimeout.html">DBusTimeout</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>timeout</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns whether a timeout is enabled or not.
<p>
If not enabled, it should not be polled by the main loop.<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>timeout</em> </td><td>
the <a class="el" href="structDBusTimeout.html">DBusTimeout</a> object </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
<a class="el" href="group__DBusMacros.html#a2">TRUE</a> if the timeout is enabled </dl>
<p>
Definition at line <a class="el" href="dbus-timeout_8c-source.html#l00482">482</a> of file <a class="el" href="dbus-timeout_8c-source.html">dbus-timeout.c</a>.
<p>
References <a class="el" href="dbus-timeout_8c-source.html#l00050">enabled</a>. </td>
</tr>
</table>
<a name="a0" doxytag="dbus-connection.h::dbus_timeout_get_interval"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int dbus_timeout_get_interval </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structDBusTimeout.html">DBusTimeout</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>timeout</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the timeout interval.
<p>
The <a class="el" href="group__DBusTimeout.html#a3">dbus_timeout_handle</a>() should be called each time this interval elapses, starting after it elapses once.
<p>
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.<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>timeout</em> </td><td>
the <a class="el" href="structDBusTimeout.html">DBusTimeout</a> object. </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
the interval in milliseconds. </dl>
<p>
Definition at line <a class="el" href="dbus-timeout_8c-source.html#l00412">412</a> of file <a class="el" href="dbus-timeout_8c-source.html">dbus-timeout.c</a>.
<p>
References <a class="el" href="dbus-timeout_8c-source.html#l00042">interval</a>. </td>
</tr>
</table>
<a name="a3" doxytag="dbus-connection.h::dbus_timeout_handle"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="group__DBusTypes.html#a2">dbus_bool_t</a> dbus_timeout_handle </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structDBusTimeout.html">DBusTimeout</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>timeout</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Calls the timeout handler for this timeout.
<p>
This function should be called when the timeout occurs.
<p>
If this function returns <a class="el" href="group__DBusMacros.html#a3">FALSE</a>, 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.<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>timeout</em> </td><td>
the <a class="el" href="structDBusTimeout.html">DBusTimeout</a> object. </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
<a class="el" href="group__DBusMacros.html#a3">FALSE</a> if there wasn't enough memory </dl>
<p>
Definition at line <a class="el" href="dbus-timeout_8c-source.html#l00468">468</a> of file <a class="el" href="dbus-timeout_8c-source.html">dbus-timeout.c</a>.
<p>
References <a class="el" href="dbus-timeout_8c-source.html#l00044">handler</a>, and <a class="el" href="dbus-timeout_8c-source.html#l00045">handler_data</a>. </td>
</tr>
</table>
<a name="a2" doxytag="dbus-connection.h::dbus_timeout_set_data"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void dbus_timeout_set_data </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structDBusTimeout.html">DBusTimeout</a> * </td>
<td class="mdname" nowrap> <em>timeout</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>void * </td>
<td class="mdname" nowrap> <em>data</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="group__DBusMemory.html#a8">DBusFreeFunction</a> </td>
<td class="mdname" nowrap> <em>free_data_function</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets data which can be retrieved with <a class="el" href="group__DBusTimeout.html#a1">dbus_timeout_get_data</a>().
<p>
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.<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>timeout</em> </td><td>
the <a class="el" href="structDBusTimeout.html">DBusTimeout</a> object. </td></tr>
<tr><td valign=top><em>data</em> </td><td>
the data. </td></tr>
<tr><td valign=top><em>free_data_function</em> </td><td>
function to be called to free the data. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="dbus-timeout_8c-source.html#l00442">442</a> of file <a class="el" href="dbus-timeout_8c-source.html">dbus-timeout.c</a>.
<p>
References <a class="el" href="dbus-timeout_8c-source.html#l00048">data</a>, and <a class="el" href="dbus-timeout_8c-source.html#l00049">free_data_function</a>. </td>
</tr>
</table>
<hr><address align="right"><small>Generated on Wed Jun 9 05:01:28 2004 for D-BUS by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.15 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2007.0
>
x86_64
>
media
>
main-release
>
by-pkgid
>
926d2d1e3111287cee1b0a4fad4fb4f6
>
files
>
209
