<!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.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_b47abd1aad201a152869566145babb61.html">src</a> » <a class="el" href="dir_67a2ce25601334632bdc5ef4a72c0f17.html">torcontrol</a>
</div>
</div>
<div class="contents">
<h1>SendCommandEvent.h</h1><a href="_send_command_event_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">** This file is part of Vidalia, and is subject to the license terms in the</span>
<a name="l00003"></a>00003 <span class="comment">** LICENSE file, found in the top level directory of this distribution. If </span>
<a name="l00004"></a>00004 <span class="comment">** you did not receive the LICENSE file with this file, you may obtain it</span>
<a name="l00005"></a>00005 <span class="comment">** from the Vidalia source package distributed by the Vidalia Project at</span>
<a name="l00006"></a>00006 <span class="comment">** http://www.vidalia-project.net/. No part of Vidalia, including this file,</span>
<a name="l00007"></a>00007 <span class="comment">** may be copied, modified, propagated, or distributed except according to</span>
<a name="l00008"></a>00008 <span class="comment">** the terms described in the LICENSE file.</span>
<a name="l00009"></a>00009 <span class="comment">*/</span>
<a name="l00010"></a>00010
<a name="l00011"></a>00011 <span class="comment">/*</span>
<a name="l00012"></a>00012 <span class="comment">** \file SendCommandEvent.h</span>
<a name="l00013"></a>00013 <span class="comment">** \version $Id: SendCommandEvent.h 4054 2009-08-17 02:25:08Z edmanm $</span>
<a name="l00014"></a>00014 <span class="comment">** \brief An event posted to a socket living in another thread, indicating</span>
<a name="l00015"></a>00015 <span class="comment">** that it should send the given control command.</span>
<a name="l00016"></a>00016 <span class="comment">*/</span>
<a name="l00017"></a>00017
<a name="l00018"></a>00018 <span class="preprocessor">#ifndef _SENDCOMMANDEVENT_H</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define _SENDCOMMANDEVENT_H</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span>
<a name="l00021"></a>00021 <span class="preprocessor">#include "<a class="code" href="_control_command_8h.html">ControlCommand.h</a>"</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#include <QEvent></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include <QMutex></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include <QWaitCondition></span>
<a name="l00026"></a>00026
<a name="l00027"></a>00027
<a name="l00028"></a><a class="code" href="class_send_command_event.html">00028</a> <span class="keyword">class </span><a class="code" href="class_send_command_event.html">SendCommandEvent</a> : <span class="keyword">public</span> QEvent {
<a name="l00029"></a>00029 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00030"></a>00030 <span class="comment"> /** Object used to wait for the result of a send operation. */</span>
<a name="l00031"></a><a class="code" href="class_send_command_event_1_1_send_waiter.html">00031</a> <span class="keyword">class </span><a class="code" href="class_send_command_event_1_1_send_waiter.html">SendWaiter</a> {
<a name="l00032"></a>00032 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00033"></a>00033 <span class="comment"> /** Status of the send SendWaiter. */</span>
<a name="l00034"></a><a class="code" href="class_send_command_event_1_1_send_waiter.html#a39b51b851bab2241ca9117092ca86e50ad1e8bf2c2d5b97a6faf5f931e19dac0e">00034</a> <span class="keyword">enum</span> <a class="code" href="class_send_command_event_1_1_send_waiter.html#a39b51b851bab2241ca9117092ca86e50">SenderStatus</a> { <a class="code" href="class_send_command_event_1_1_send_waiter.html#a39b51b851bab2241ca9117092ca86e50ad1e8bf2c2d5b97a6faf5f931e19dac0e">Waiting</a>, <a class="code" href="class_send_command_event_1_1_send_waiter.html#a39b51b851bab2241ca9117092ca86e50a2bfe562dfde794493777562c6b379b5c">Failed</a>, <a class="code" href="class_send_command_event_1_1_send_waiter.html#a39b51b851bab2241ca9117092ca86e50a9065a7784f741bf76f2ab585a656a8b4">Success</a> } <a class="code" href="class_send_command_event_1_1_send_waiter.html#a98961dc8a5d8eb5dcc9060cc060e3cb9">_status</a>;<span class="comment"></span>
<a name="l00035"></a>00035 <span class="comment"> /** Default constructor. */</span>
<a name="l00036"></a><a class="code" href="class_send_command_event_1_1_send_waiter.html#aeac1f2bf1c84e8e0538f520aaf386380">00036</a> <a class="code" href="class_send_command_event_1_1_send_waiter.html#aeac1f2bf1c84e8e0538f520aaf386380">SendWaiter</a>() { <a class="code" href="class_send_command_event_1_1_send_waiter.html#a98961dc8a5d8eb5dcc9060cc060e3cb9">_status</a> = <a class="code" href="class_send_command_event_1_1_send_waiter.html#a39b51b851bab2241ca9117092ca86e50ad1e8bf2c2d5b97a6faf5f931e19dac0e">Waiting</a>; }<span class="comment"></span>
<a name="l00037"></a>00037 <span class="comment"> /** Sets the result of the send operation. */</span>
<a name="l00038"></a>00038 <span class="keywordtype">void</span> <a class="code" href="class_send_command_event_1_1_send_waiter.html#aa11cdedd453da5ff1aa9a735616dc9ee">setResult</a>(<span class="keywordtype">bool</span> success, <span class="keyword">const</span> QString &errmsg = QString());<span class="comment"></span>
<a name="l00039"></a>00039 <span class="comment"> /** Waits for and returns the result of the send operation. */</span>
<a name="l00040"></a>00040 <span class="keywordtype">bool</span> <a class="code" href="class_send_command_event_1_1_send_waiter.html#a5c403d791740e4b459338880cd7d22ef">getResult</a>(QString *errmsg = 0);<span class="comment"></span>
<a name="l00041"></a>00041 <span class="comment"> /** Returns the SendWaiter's current SenderStatus value. */</span>
<a name="l00042"></a>00042 <a class="code" href="class_send_command_event_1_1_send_waiter.html#a39b51b851bab2241ca9117092ca86e50">SenderStatus</a> <a class="code" href="class_send_command_event_1_1_send_waiter.html#ac0dd97bd93d2c8f50afaa24b7e726bdb">status</a>();
<a name="l00043"></a>00043 <span class="keyword">private</span>:
<a name="l00044"></a><a class="code" href="class_send_command_event_1_1_send_waiter.html#adc45c3d449f4460c9b832ca9a5e97d76">00044</a> QMutex <a class="code" href="class_send_command_event_1_1_send_waiter.html#adc45c3d449f4460c9b832ca9a5e97d76">_mutex</a>; <span class="comment">/**< Mutex around the wait condition. */</span>
<a name="l00045"></a><a class="code" href="class_send_command_event_1_1_send_waiter.html#ab7d52247ecfc8048dc2822b8f62d8c84">00045</a> QWaitCondition <a class="code" href="class_send_command_event_1_1_send_waiter.html#ab7d52247ecfc8048dc2822b8f62d8c84">_waitCond</a>; <span class="comment">/**< Waits for the send to complete. */</span>
<a name="l00046"></a><a class="code" href="class_send_command_event_1_1_send_waiter.html#a2b5707c27fdc28725b14be0bce908a49">00046</a> QString <a class="code" href="class_send_command_event_1_1_send_waiter.html#a2b5707c27fdc28725b14be0bce908a49">_errmsg</a>; <span class="comment">/**< Error message if the send fails. */</span>
<a name="l00047"></a>00047 };
<a name="l00048"></a>00048 <span class="comment"></span>
<a name="l00049"></a>00049 <span class="comment"> /** Constructor. */</span>
<a name="l00050"></a>00050 <a class="code" href="class_send_command_event.html#a95dc8cc68269aa9ce87c4b145b1da0ac">SendCommandEvent</a>(<span class="keyword">const</span> <a class="code" href="class_control_command.html">ControlCommand</a> &cmd, <a class="code" href="class_send_command_event_1_1_send_waiter.html">SendWaiter</a> *w = 0);<span class="comment"></span>
<a name="l00051"></a>00051 <span class="comment"> /** Returns the control command to send to Tor. */</span>
<a name="l00052"></a><a class="code" href="class_send_command_event.html#a8b1d46a93a456b83b45d8c5eda1ca9e7">00052</a> <a class="code" href="class_control_command.html">ControlCommand</a> <a class="code" href="class_send_command_event.html#a8b1d46a93a456b83b45d8c5eda1ca9e7">command</a>() { <span class="keywordflow">return</span> <a class="code" href="class_send_command_event.html#a412410de9fe9fcc659af1f1a5e8c8267">_cmd</a>; }<span class="comment"></span>
<a name="l00053"></a>00053 <span class="comment"> /** Returns a SendWaiter (if any) for the result of this send. */</span>
<a name="l00054"></a><a class="code" href="class_send_command_event.html#ac80735b768437082f63fc718d20fa1cd">00054</a> <a class="code" href="class_send_command_event_1_1_send_waiter.html">SendWaiter</a>* <a class="code" href="class_send_command_event.html#ac80735b768437082f63fc718d20fa1cd">waiter</a>() { <span class="keywordflow">return</span> <a class="code" href="class_send_command_event.html#a7eed7cdbc7355517f2392242d242390e">_waiter</a>; }
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="keyword">private</span>:
<a name="l00057"></a><a class="code" href="class_send_command_event.html#a412410de9fe9fcc659af1f1a5e8c8267">00057</a> <a class="code" href="class_control_command.html">ControlCommand</a> <a class="code" href="class_send_command_event.html#a412410de9fe9fcc659af1f1a5e8c8267">_cmd</a>; <span class="comment">/**< Command to send to Tor. */</span>
<a name="l00058"></a><a class="code" href="class_send_command_event.html#a7eed7cdbc7355517f2392242d242390e">00058</a> <a class="code" href="class_send_command_event_1_1_send_waiter.html">SendWaiter</a>* <a class="code" href="class_send_command_event.html#a7eed7cdbc7355517f2392242d242390e">_waiter</a>; <span class="comment">/**< SendWaiter for the result of this event. */</span>
<a name="l00059"></a>00059 };
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <span class="preprocessor">#endif</span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Aug 30 22:58:54 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>
