<!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>DBusServer implementation details</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>DBusServer implementation details<br> <small> [<a class="el" href="group__DBusInternals.html">D-BUS internal implementation details</a>]</small> </h1>Implementation details of <a class="el" href="structDBusServer.html">DBusServer</a>. <a href="#_details">More...</a><table border=0 cellpadding=0 cellspacing=0> <tr><td colspan=2><br><h2>Functions</h2></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__DBusServerInternals.html#a0">_dbus_server_init_base</a> (<a class="el" href="structDBusServer.html">DBusServer</a> *server, const <a class="el" href="structDBusServerVTable.html">DBusServerVTable</a> *vtable, const <a class="el" href="structDBusString.html">DBusString</a> *address)</td></tr> <tr><td> </td><td><font size=-1><em>Initializes the members of the <a class="el" href="structDBusServer.html">DBusServer</a> base class.</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__DBusServerInternals.html#a1">_dbus_server_finalize_base</a> (<a class="el" href="structDBusServer.html">DBusServer</a> *server)</td></tr> <tr><td> </td><td><font size=-1><em>Finalizes the members of the <a class="el" href="structDBusServer.html">DBusServer</a> base class.</em> <a href="#a1">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__DBusServerInternals.html#a2">_dbus_server_add_watch</a> (<a class="el" href="structDBusServer.html">DBusServer</a> *server, <a class="el" href="structDBusWatch.html">DBusWatch</a> *watch)</td></tr> <tr><td> </td><td><font size=-1><em>Adds a watch for this server, chaining out to application-provided watch handlers.</em> <a href="#a2">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__DBusServerInternals.html#a3">_dbus_server_remove_watch</a> (<a class="el" href="structDBusServer.html">DBusServer</a> *server, <a class="el" href="structDBusWatch.html">DBusWatch</a> *watch)</td></tr> <tr><td> </td><td><font size=-1><em>Removes a watch previously added with <a class="el" href="group__DBusServerInternals.html#a3">_dbus_server_remove_watch</a>().</em> <a href="#a3">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__DBusServerInternals.html#a4">_dbus_server_toggle_watch</a> (<a class="el" href="structDBusServer.html">DBusServer</a> *server, <a class="el" href="structDBusWatch.html">DBusWatch</a> *watch, <a class="el" href="group__DBusTypes.html#a2">dbus_bool_t</a> enabled)</td></tr> <tr><td> </td><td><font size=-1><em>Toggles a watch and notifies app via server's DBusWatchToggledFunction if available.</em> <a href="#a4">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__DBusServerInternals.html#a5">_dbus_server_add_timeout</a> (<a class="el" href="structDBusServer.html">DBusServer</a> *server, <a class="el" href="structDBusTimeout.html">DBusTimeout</a> *timeout)</td></tr> <tr><td> </td><td><font size=-1><em>Adds a timeout for this server, chaining out to application-provided timeout handlers.</em> <a href="#a5">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__DBusServerInternals.html#a6">_dbus_server_remove_timeout</a> (<a class="el" href="structDBusServer.html">DBusServer</a> *server, <a class="el" href="structDBusTimeout.html">DBusTimeout</a> *timeout)</td></tr> <tr><td> </td><td><font size=-1><em>Removes a timeout previously added with <a class="el" href="group__DBusServerInternals.html#a5">_dbus_server_add_timeout</a>().</em> <a href="#a6">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__DBusServerInternals.html#a7">_dbus_server_toggle_timeout</a> (<a class="el" href="structDBusServer.html">DBusServer</a> *server, <a class="el" href="structDBusTimeout.html">DBusTimeout</a> *timeout, <a class="el" href="group__DBusTypes.html#a2">dbus_bool_t</a> enabled)</td></tr> <tr><td> </td><td><font size=-1><em>Toggles a timeout and notifies app via server's DBusTimeoutToggledFunction if available.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Implementation details of <a class="el" href="structDBusServer.html">DBusServer</a>. <p> <p> <hr><h2>Function Documentation</h2> <a name="a5" doxytag="dbus-server-protected.h::_dbus_server_add_timeout"></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_server_add_timeout </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="structDBusServer.html">DBusServer</a> * </td> <td class="mdname" nowrap> <em>server</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="structDBusTimeout.html">DBusTimeout</a> * </td> <td class="mdname" nowrap> <em>timeout</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> Adds a timeout for this server, chaining out to application-provided timeout handlers. <p> The timeout should be repeatedly handled with <a class="el" href="group__DBusTimeout.html#a3">dbus_timeout_handle</a>() at its given interval until it is removed.<dl compact><dt><b> Parameters: </b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>server</em> </td><td> the server. </td></tr> <tr><td valign=top><em>timeout</em> </td><td> the timeout to add. </td></tr> </table> </dl> <p> Definition at line <a class="el" href="dbus-server_8c-source.html#l00193">193</a> of file <a class="el" href="dbus-server_8c-source.html">dbus-server.c</a>. <p> References <a class="el" href="dbus-server-protected_8h-source.html#l00057">DBusServer::timeouts</a>. </td> </tr> </table> <a name="a2" doxytag="dbus-server-protected.h::_dbus_server_add_watch"></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_server_add_watch </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="structDBusServer.html">DBusServer</a> * </td> <td class="mdname" nowrap> <em>server</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="structDBusWatch.html">DBusWatch</a> * </td> <td class="mdname" nowrap> <em>watch</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> Adds a watch for this server, chaining out to application-provided watch handlers. <p> <dl compact><dt><b> Parameters: </b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>server</em> </td><td> the server. </td></tr> <tr><td valign=top><em>watch</em> </td><td> the watch to add. </td></tr> </table> </dl> <p> Definition at line <a class="el" href="dbus-server_8c-source.html#l00145">145</a> of file <a class="el" href="dbus-server_8c-source.html">dbus-server.c</a>. <p> References <a class="el" href="dbus-server-protected_8h-source.html#l00056">DBusServer::watches</a>. </td> </tr> </table> <a name="a1" doxytag="dbus-server-protected.h::_dbus_server_finalize_base"></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_server_finalize_base </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="structDBusServer.html">DBusServer</a> * </td> <td class="mdname1" valign="top" nowrap> <em>server</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> Finalizes the members of the <a class="el" href="structDBusServer.html">DBusServer</a> base class. <p> Chained up to by subclass finalizers.<dl compact><dt><b> Parameters: </b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>server</em> </td><td> the server. </td></tr> </table> </dl> <p> Definition at line <a class="el" href="dbus-server_8c-source.html#l00119">119</a> of file <a class="el" href="dbus-server_8c-source.html">dbus-server.c</a>. <p> References <a class="el" href="dbus-server-protected_8h-source.html#l00059">DBusServer::address</a>, <a class="el" href="dbus-server-protected_8h-source.html#l00074">DBusServer::auth_mechanisms</a>, <a class="el" href="dbus-server-protected_8h-source.html#l00076">DBusServer::disconnected</a>, <a class="el" href="dbus-server-protected_8h-source.html#l00063">DBusServer::slot_list</a>, <a class="el" href="dbus-server-protected_8h-source.html#l00057">DBusServer::timeouts</a>, and <a class="el" href="dbus-server-protected_8h-source.html#l00056">DBusServer::watches</a>. </td> </tr> </table> <a name="a0" doxytag="dbus-server-protected.h::_dbus_server_init_base"></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_server_init_base </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="structDBusServer.html">DBusServer</a> * </td> <td class="mdname" nowrap> <em>server</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const <a class="el" href="structDBusServerVTable.html">DBusServerVTable</a> * </td> <td class="mdname" nowrap> <em>vtable</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const <a class="el" href="structDBusString.html">DBusString</a> * </td> <td class="mdname" nowrap> <em>address</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> Initializes the members of the <a class="el" href="structDBusServer.html">DBusServer</a> base class. <p> Chained up to by subclass constructors.<dl compact><dt><b> Parameters: </b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>server</em> </td><td> the server. </td></tr> <tr><td valign=top><em>vtable</em> </td><td> the vtable for the subclass. </td></tr> <tr><td valign=top><em>address</em> </td><td> the server's address </td></tr> </table> </dl><dl compact><dt><b> Returns: </b><dd> <a class="el" href="group__DBusMacros.html#a2">TRUE</a> on success. </dl> <p> Definition at line <a class="el" href="dbus-server_8c-source.html#l00064">64</a> of file <a class="el" href="dbus-server_8c-source.html">dbus-server.c</a>. <p> References <a class="el" href="dbus-server-protected_8h-source.html#l00059">DBusServer::address</a>, <a class="el" href="dbus-server-protected_8h-source.html#l00054">DBusServer::refcount</a>, <a class="el" href="dbus-server-protected_8h-source.html#l00063">DBusServer::slot_list</a>, <a class="el" href="dbus-server-protected_8h-source.html#l00057">DBusServer::timeouts</a>, <a class="el" href="dbus-server-protected_8h-source.html#l00055">DBusServer::vtable</a>, and <a class="el" href="dbus-server-protected_8h-source.html#l00056">DBusServer::watches</a>. </td> </tr> </table> <a name="a6" doxytag="dbus-server-protected.h::_dbus_server_remove_timeout"></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_server_remove_timeout </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="structDBusServer.html">DBusServer</a> * </td> <td class="mdname" nowrap> <em>server</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="structDBusTimeout.html">DBusTimeout</a> * </td> <td class="mdname" nowrap> <em>timeout</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> Removes a timeout previously added with <a class="el" href="group__DBusServerInternals.html#a5">_dbus_server_add_timeout</a>(). <p> <dl compact><dt><b> Parameters: </b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>server</em> </td><td> the server. </td></tr> <tr><td valign=top><em>timeout</em> </td><td> the timeout to remove. </td></tr> </table> </dl> <p> Definition at line <a class="el" href="dbus-server_8c-source.html#l00206">206</a> of file <a class="el" href="dbus-server_8c-source.html">dbus-server.c</a>. <p> References <a class="el" href="dbus-server-protected_8h-source.html#l00057">DBusServer::timeouts</a>. </td> </tr> </table> <a name="a3" doxytag="dbus-server-protected.h::_dbus_server_remove_watch"></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_server_remove_watch </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="structDBusServer.html">DBusServer</a> * </td> <td class="mdname" nowrap> <em>server</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="structDBusWatch.html">DBusWatch</a> * </td> <td class="mdname" nowrap> <em>watch</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> Removes a watch previously added with <a class="el" href="group__DBusServerInternals.html#a3">_dbus_server_remove_watch</a>(). <p> <dl compact><dt><b> Parameters: </b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>server</em> </td><td> the server. </td></tr> <tr><td valign=top><em>watch</em> </td><td> the watch to remove. </td></tr> </table> </dl> <p> Definition at line <a class="el" href="dbus-server_8c-source.html#l00158">158</a> of file <a class="el" href="dbus-server_8c-source.html">dbus-server.c</a>. <p> References <a class="el" href="dbus-server-protected_8h-source.html#l00056">DBusServer::watches</a>. </td> </tr> </table> <a name="a7" doxytag="dbus-server-protected.h::_dbus_server_toggle_timeout"></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_server_toggle_timeout </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="structDBusServer.html">DBusServer</a> * </td> <td class="mdname" nowrap> <em>server</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><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><a class="el" href="group__DBusTypes.html#a2">dbus_bool_t</a> </td> <td class="mdname" nowrap> <em>enabled</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> Toggles a timeout and notifies app via server's DBusTimeoutToggledFunction if available. <p> It's an error to call this function on a timeout that was not previously added.<dl compact><dt><b> Parameters: </b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>server</em> </td><td> the server. </td></tr> <tr><td valign=top><em>timeout</em> </td><td> the timeout to toggle. </td></tr> <tr><td valign=top><em>enabled</em> </td><td> whether to enable or disable </td></tr> </table> </dl> <p> Definition at line <a class="el" href="dbus-server_8c-source.html#l00222">222</a> of file <a class="el" href="dbus-server_8c-source.html">dbus-server.c</a>. <p> References <a class="el" href="dbus-server-protected_8h-source.html#l00057">DBusServer::timeouts</a>. </td> </tr> </table> <a name="a4" doxytag="dbus-server-protected.h::_dbus_server_toggle_watch"></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_server_toggle_watch </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="structDBusServer.html">DBusServer</a> * </td> <td class="mdname" nowrap> <em>server</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="structDBusWatch.html">DBusWatch</a> * </td> <td class="mdname" nowrap> <em>watch</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="group__DBusTypes.html#a2">dbus_bool_t</a> </td> <td class="mdname" nowrap> <em>enabled</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> Toggles a watch and notifies app via server's DBusWatchToggledFunction if available. <p> It's an error to call this function on a watch that was not previously added.<dl compact><dt><b> Parameters: </b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><em>server</em> </td><td> the server. </td></tr> <tr><td valign=top><em>watch</em> </td><td> the watch to toggle. </td></tr> <tr><td valign=top><em>enabled</em> </td><td> whether to enable or disable </td></tr> </table> </dl> <p> Definition at line <a class="el" href="dbus-server_8c-source.html#l00174">174</a> of file <a class="el" href="dbus-server_8c-source.html">dbus-server.c</a>. <p> References <a class="el" href="dbus-server-protected_8h-source.html#l00056">DBusServer::watches</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>