<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>Vidalia: SendCommandEvent::SendWaiter Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.3 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="dirs.html"><span>Directories</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="class_send_command_event.html">SendCommandEvent</a>::<a class="el" href="class_send_command_event_1_1_send_waiter.html">SendWaiter</a> </div> </div> <div class="contents"> <h1>SendCommandEvent::SendWaiter Class Reference</h1><!-- doxytag: class="SendCommandEvent::SendWaiter" --> <p><code>#include <<a class="el" href="_send_command_event_8h_source.html">SendCommandEvent.h</a>></code></p> <p><a href="class_send_command_event_1_1_send_waiter-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Types</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="class_send_command_event_1_1_send_waiter.html#a39b51b851bab2241ca9117092ca86e50">SenderStatus</a> { <a class="el" href="class_send_command_event_1_1_send_waiter.html#a39b51b851bab2241ca9117092ca86e50ad1e8bf2c2d5b97a6faf5f931e19dac0e">Waiting</a>, <a class="el" href="class_send_command_event_1_1_send_waiter.html#a39b51b851bab2241ca9117092ca86e50a2bfe562dfde794493777562c6b379b5c">Failed</a>, <a class="el" href="class_send_command_event_1_1_send_waiter.html#a39b51b851bab2241ca9117092ca86e50a9065a7784f741bf76f2ab585a656a8b4">Success</a> }</td></tr> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_send_command_event_1_1_send_waiter.html#aeac1f2bf1c84e8e0538f520aaf386380">SendWaiter</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_send_command_event_1_1_send_waiter.html#aa11cdedd453da5ff1aa9a735616dc9ee">setResult</a> (bool success, const QString &errmsg=QString())</td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_send_command_event_1_1_send_waiter.html#a5c403d791740e4b459338880cd7d22ef">getResult</a> (QString *errmsg=0)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_send_command_event_1_1_send_waiter.html#a39b51b851bab2241ca9117092ca86e50">SenderStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_send_command_event_1_1_send_waiter.html#ac0dd97bd93d2c8f50afaa24b7e726bdb">status</a> ()</td></tr> <tr><td colspan="2"><h2>Public Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">enum <br class="typebreak"/> <a class="el" href="class_send_command_event_1_1_send_waiter.html#a39b51b851bab2241ca9117092ca86e50">SendCommandEvent::SendWaiter::SenderStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_send_command_event_1_1_send_waiter.html#a98961dc8a5d8eb5dcc9060cc060e3cb9">_status</a></td></tr> <tr><td colspan="2"><h2>Private Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">QMutex </td><td class="memItemRight" valign="bottom"><a class="el" href="class_send_command_event_1_1_send_waiter.html#adc45c3d449f4460c9b832ca9a5e97d76">_mutex</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">QWaitCondition </td><td class="memItemRight" valign="bottom"><a class="el" href="class_send_command_event_1_1_send_waiter.html#ab7d52247ecfc8048dc2822b8f62d8c84">_waitCond</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_send_command_event_1_1_send_waiter.html#a2b5707c27fdc28725b14be0bce908a49">_errmsg</a></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Object used to wait for the result of a send operation. </p> <p>Definition at line <a class="el" href="_send_command_event_8h_source.html#l00031">31</a> of file <a class="el" href="_send_command_event_8h_source.html">SendCommandEvent.h</a>.</p> <hr/><h2>Member Enumeration Documentation</h2> <a class="anchor" id="a39b51b851bab2241ca9117092ca86e50"></a><!-- doxytag: member="SendCommandEvent::SendWaiter::SenderStatus" ref="a39b51b851bab2241ca9117092ca86e50" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="class_send_command_event_1_1_send_waiter.html#a39b51b851bab2241ca9117092ca86e50">SendCommandEvent::SendWaiter::SenderStatus</a></td> </tr> </table> </div> <div class="memdoc"> <p>Status of the send <a class="el" href="class_send_command_event_1_1_send_waiter.html">SendWaiter</a>. </p> <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"><em><a class="anchor" id="a39b51b851bab2241ca9117092ca86e50ad1e8bf2c2d5b97a6faf5f931e19dac0e"></a><!-- doxytag: member="Waiting" ref="a39b51b851bab2241ca9117092ca86e50ad1e8bf2c2d5b97a6faf5f931e19dac0e" args="" -->Waiting</em> </td><td> </td></tr> <tr><td valign="top"><em><a class="anchor" id="a39b51b851bab2241ca9117092ca86e50a2bfe562dfde794493777562c6b379b5c"></a><!-- doxytag: member="Failed" ref="a39b51b851bab2241ca9117092ca86e50a2bfe562dfde794493777562c6b379b5c" args="" -->Failed</em> </td><td> </td></tr> <tr><td valign="top"><em><a class="anchor" id="a39b51b851bab2241ca9117092ca86e50a9065a7784f741bf76f2ab585a656a8b4"></a><!-- doxytag: member="Success" ref="a39b51b851bab2241ca9117092ca86e50a9065a7784f741bf76f2ab585a656a8b4" args="" -->Success</em> </td><td> </td></tr> </table> </dd> </dl> <p>Definition at line <a class="el" href="_send_command_event_8h_source.html#l00034">34</a> of file <a class="el" href="_send_command_event_8h_source.html">SendCommandEvent.h</a>.</p> </div> </div> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="aeac1f2bf1c84e8e0538f520aaf386380"></a><!-- doxytag: member="SendCommandEvent::SendWaiter::SendWaiter" ref="aeac1f2bf1c84e8e0538f520aaf386380" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">SendCommandEvent::SendWaiter::SendWaiter </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Default constructor. </p> <p>Definition at line <a class="el" href="_send_command_event_8h_source.html#l00036">36</a> of file <a class="el" href="_send_command_event_8h_source.html">SendCommandEvent.h</a>.</p> <p>References <a class="el" href="class_send_command_event_1_1_send_waiter.html#a98961dc8a5d8eb5dcc9060cc060e3cb9">_status</a>, and <a class="el" href="_send_command_event_8h_source.html#l00034">Waiting</a>.</p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a5c403d791740e4b459338880cd7d22ef"></a><!-- doxytag: member="SendCommandEvent::SendWaiter::getResult" ref="a5c403d791740e4b459338880cd7d22ef" args="(QString *errmsg=0)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool SendCommandEvent::SendWaiter::getResult </td> <td>(</td> <td class="paramtype">QString * </td> <td class="paramname"> <em>errmsg</em> = <code>0</code></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Waits for and returns the result of the send operation.</p> <p>Waits for and gets the result of the send operation. </p> <p>Definition at line <a class="el" href="_send_command_event_8cpp_source.html#l00043">43</a> of file <a class="el" href="_send_command_event_8cpp_source.html">SendCommandEvent.cpp</a>.</p> <p>References <a class="el" href="_send_command_event_8h_source.html#l00046">_errmsg</a>, <a class="el" href="_send_command_event_8h_source.html#l00044">_mutex</a>, <a class="el" href="class_send_command_event_1_1_send_waiter.html#a98961dc8a5d8eb5dcc9060cc060e3cb9">_status</a>, <a class="el" href="_send_command_event_8h_source.html#l00045">_waitCond</a>, <a class="el" href="_send_command_event_8h_source.html#l00034">Success</a>, and <a class="el" href="_send_command_event_8h_source.html#l00034">Waiting</a>.</p> <p>Referenced by <a class="el" href="_control_connection_8cpp_source.html#l00236">ControlConnection::send()</a>.</p> </div> </div> <a class="anchor" id="aa11cdedd453da5ff1aa9a735616dc9ee"></a><!-- doxytag: member="SendCommandEvent::SendWaiter::setResult" ref="aa11cdedd453da5ff1aa9a735616dc9ee" args="(bool success, const QString &errmsg=QString())" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void SendCommandEvent::SendWaiter::setResult </td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"> <em>success</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const QString & </td> <td class="paramname"> <em>errmsg</em> = <code>QString()</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Sets the result of the send operation. </p> <p>Definition at line <a class="el" href="_send_command_event_8cpp_source.html#l00032">32</a> of file <a class="el" href="_send_command_event_8cpp_source.html">SendCommandEvent.cpp</a>.</p> <p>References <a class="el" href="_send_command_event_8h_source.html#l00046">_errmsg</a>, <a class="el" href="_send_command_event_8h_source.html#l00044">_mutex</a>, <a class="el" href="class_send_command_event_1_1_send_waiter.html#a98961dc8a5d8eb5dcc9060cc060e3cb9">_status</a>, <a class="el" href="_send_command_event_8h_source.html#l00045">_waitCond</a>, <a class="el" href="_send_command_event_8h_source.html#l00034">Failed</a>, and <a class="el" href="_send_command_event_8h_source.html#l00034">Success</a>.</p> <p>Referenced by <a class="el" href="_control_connection_8cpp_source.html#l00287">ControlConnection::run()</a>.</p> </div> </div> <a class="anchor" id="ac0dd97bd93d2c8f50afaa24b7e726bdb"></a><!-- doxytag: member="SendCommandEvent::SendWaiter::status" ref="ac0dd97bd93d2c8f50afaa24b7e726bdb" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_send_command_event_1_1_send_waiter.html#a39b51b851bab2241ca9117092ca86e50">SendCommandEvent::SendWaiter::SenderStatus</a> SendCommandEvent::SendWaiter::status </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the SendWaiter's current SenderStatus value. </p> <p>Definition at line <a class="el" href="_send_command_event_8cpp_source.html#l00063">63</a> of file <a class="el" href="_send_command_event_8cpp_source.html">SendCommandEvent.cpp</a>.</p> <p>References <a class="el" href="_send_command_event_8h_source.html#l00044">_mutex</a>, and <a class="el" href="class_send_command_event_1_1_send_waiter.html#a98961dc8a5d8eb5dcc9060cc060e3cb9">_status</a>.</p> <p>Referenced by <a class="el" href="_control_connection_8cpp_source.html#l00287">ControlConnection::run()</a>.</p> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="a2b5707c27fdc28725b14be0bce908a49"></a><!-- doxytag: member="SendCommandEvent::SendWaiter::_errmsg" ref="a2b5707c27fdc28725b14be0bce908a49" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QString <a class="el" href="class_send_command_event_1_1_send_waiter.html#a2b5707c27fdc28725b14be0bce908a49">SendCommandEvent::SendWaiter::_errmsg</a><code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Error message if the send fails. </p> <p>Definition at line <a class="el" href="_send_command_event_8h_source.html#l00046">46</a> of file <a class="el" href="_send_command_event_8h_source.html">SendCommandEvent.h</a>.</p> <p>Referenced by <a class="el" href="_send_command_event_8cpp_source.html#l00043">getResult()</a>, and <a class="el" href="_send_command_event_8cpp_source.html#l00032">setResult()</a>.</p> </div> </div> <a class="anchor" id="adc45c3d449f4460c9b832ca9a5e97d76"></a><!-- doxytag: member="SendCommandEvent::SendWaiter::_mutex" ref="adc45c3d449f4460c9b832ca9a5e97d76" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QMutex <a class="el" href="class_send_command_event_1_1_send_waiter.html#adc45c3d449f4460c9b832ca9a5e97d76">SendCommandEvent::SendWaiter::_mutex</a><code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Mutex around the wait condition. </p> <p>Definition at line <a class="el" href="_send_command_event_8h_source.html#l00044">44</a> of file <a class="el" href="_send_command_event_8h_source.html">SendCommandEvent.h</a>.</p> <p>Referenced by <a class="el" href="_send_command_event_8cpp_source.html#l00043">getResult()</a>, <a class="el" href="_send_command_event_8cpp_source.html#l00032">setResult()</a>, and <a class="el" href="_send_command_event_8cpp_source.html#l00063">status()</a>.</p> </div> </div> <a class="anchor" id="a98961dc8a5d8eb5dcc9060cc060e3cb9"></a><!-- doxytag: member="SendCommandEvent::SendWaiter::_status" ref="a98961dc8a5d8eb5dcc9060cc060e3cb9" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="class_send_command_event_1_1_send_waiter.html#a39b51b851bab2241ca9117092ca86e50">SendCommandEvent::SendWaiter::SenderStatus</a> <a class="el" href="class_send_command_event_1_1_send_waiter.html#a98961dc8a5d8eb5dcc9060cc060e3cb9">SendCommandEvent::SendWaiter::_status</a></td> </tr> </table> </div> <div class="memdoc"> <p>Status of the send <a class="el" href="class_send_command_event_1_1_send_waiter.html">SendWaiter</a>. </p> <p>Referenced by <a class="el" href="_send_command_event_8cpp_source.html#l00043">getResult()</a>, <a class="el" href="_send_command_event_8h_source.html#l00036">SendWaiter()</a>, <a class="el" href="_send_command_event_8cpp_source.html#l00032">setResult()</a>, and <a class="el" href="_send_command_event_8cpp_source.html#l00063">status()</a>.</p> </div> </div> <a class="anchor" id="ab7d52247ecfc8048dc2822b8f62d8c84"></a><!-- doxytag: member="SendCommandEvent::SendWaiter::_waitCond" ref="ab7d52247ecfc8048dc2822b8f62d8c84" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QWaitCondition <a class="el" href="class_send_command_event_1_1_send_waiter.html#ab7d52247ecfc8048dc2822b8f62d8c84">SendCommandEvent::SendWaiter::_waitCond</a><code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Waits for the send to complete. </p> <p>Definition at line <a class="el" href="_send_command_event_8h_source.html#l00045">45</a> of file <a class="el" href="_send_command_event_8h_source.html">SendCommandEvent.h</a>.</p> <p>Referenced by <a class="el" href="_send_command_event_8cpp_source.html#l00043">getResult()</a>, and <a class="el" href="_send_command_event_8cpp_source.html#l00032">setResult()</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="_send_command_event_8h_source.html">SendCommandEvent.h</a></li> <li><a class="el" href="_send_command_event_8cpp_source.html">SendCommandEvent.cpp</a></li> </ul> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Aug 30 22:58:57 2010 for Vidalia by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> </body> </html>