Sophie

Sophie

distrib > Mandriva > 2010.2 > i586 > media > contrib-backports > by-pkgid > 9601c7beb4ff23e834bfa171795ed560 > files > 468

vidalia-0.2.9-1mdv2010.1.i586.rpm

<!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: ControlCommand 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&nbsp;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&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>ControlCommand Class Reference</h1><!-- doxytag: class="ControlCommand" -->
<p><code>#include &lt;<a class="el" href="_control_command_8h_source.html">ControlCommand.h</a>&gt;</code></p>

<p><a href="class_control_command-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_control_command.html#a5437f4a8c7534305f55aa9250a34950e">ControlCommand</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_control_command.html#aa40ce5460544613ea23b6f1e9e0c5011">ControlCommand</a> (const QString &amp;keyword)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_control_command.html#a10418997d1632eeaf094ad8b5abc1e6c">ControlCommand</a> (const QString &amp;keyword, const QString &amp;arg)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_control_command.html#adbaaef02b26ac3218722895ff79f0af8">ControlCommand</a> (const QString &amp;keyword, const QStringList &amp;args)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_control_command.html#a42e58dd4d17e94d2434eba19318d4fac">keyword</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_control_command.html#af0e7535f3bfa9c85d5b4d853ddfca2b4">setKeyword</a> (const QString &amp;keyword)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_control_command.html#a4f8c58a007da880191178044ae569ec0">addArgument</a> (const QString &amp;arg)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_control_command.html#ab5981c4f2760b6f23797ab23b7dc491b">addArguments</a> (const QStringList &amp;args)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_control_command.html#a3d8dab8080ef3956ae70a06a7d11fe8e">appendData</a> (const QString &amp;data)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_control_command.html#a57c94909a90bc9ecb301ff3ef3beeb45">toString</a> () const </td></tr>
<tr><td colspan="2"><h2>Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_control_command.html#a38cdbeddf0e8e6b88f4fc474bf2c4a62">escape</a> (const QString &amp;str) const </td></tr>
<tr><td colspan="2"><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_control_command.html#ac9e67b8eb679f0d8d81aba2be87e90ba">_keyword</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QStringList&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_control_command.html#af5c00e7b1b8a5149949befd1b90a0d0a">_arguments</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QStringList&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_control_command.html#a52a26f2b5500737cae3df73f240d763f">_data</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>

<p>Definition at line <a class="el" href="_control_command_8h_source.html#l00023">23</a> of file <a class="el" href="_control_command_8h_source.html">ControlCommand.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a5437f4a8c7534305f55aa9250a34950e"></a><!-- doxytag: member="ControlCommand::ControlCommand" ref="a5437f4a8c7534305f55aa9250a34950e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ControlCommand::ControlCommand </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Default constructor. </p>

<p>Definition at line <a class="el" href="_control_command_8cpp_source.html#l00021">21</a> of file <a class="el" href="_control_command_8cpp_source.html">ControlCommand.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="aa40ce5460544613ea23b6f1e9e0c5011"></a><!-- doxytag: member="ControlCommand::ControlCommand" ref="aa40ce5460544613ea23b6f1e9e0c5011" args="(const QString &amp;keyword)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ControlCommand::ControlCommand </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>keyword</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Creates a command using the specified keyword. </p>

<p>Definition at line <a class="el" href="_control_command_8cpp_source.html#l00026">26</a> of file <a class="el" href="_control_command_8cpp_source.html">ControlCommand.cpp</a>.</p>

<p>References <a class="el" href="_control_command_8h_source.html#l00053">_keyword</a>.</p>

</div>
</div>
<a class="anchor" id="a10418997d1632eeaf094ad8b5abc1e6c"></a><!-- doxytag: member="ControlCommand::ControlCommand" ref="a10418997d1632eeaf094ad8b5abc1e6c" args="(const QString &amp;keyword, const QString &amp;arg)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ControlCommand::ControlCommand </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>keyword</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>arg</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Creates a control command using the specified keyword and argument. </p>

<p>Definition at line <a class="el" href="_control_command_8cpp_source.html#l00032">32</a> of file <a class="el" href="_control_command_8cpp_source.html">ControlCommand.cpp</a>.</p>

<p>References <a class="el" href="_control_command_8h_source.html#l00053">_keyword</a>, and <a class="el" href="_control_command_8cpp_source.html#l00055">addArgument()</a>.</p>

</div>
</div>
<a class="anchor" id="adbaaef02b26ac3218722895ff79f0af8"></a><!-- doxytag: member="ControlCommand::ControlCommand" ref="adbaaef02b26ac3218722895ff79f0af8" args="(const QString &amp;keyword, const QStringList &amp;args)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ControlCommand::ControlCommand </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>keyword</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QStringList &amp;&nbsp;</td>
          <td class="paramname"> <em>args</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Creates a control command using the specified keyword and list of arguments. </p>

<p>Definition at line <a class="el" href="_control_command_8cpp_source.html#l00040">40</a> of file <a class="el" href="_control_command_8cpp_source.html">ControlCommand.cpp</a>.</p>

<p>References <a class="el" href="_control_command_8h_source.html#l00054">_arguments</a>, and <a class="el" href="_control_command_8h_source.html#l00053">_keyword</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a4f8c58a007da880191178044ae569ec0"></a><!-- doxytag: member="ControlCommand::addArgument" ref="a4f8c58a007da880191178044ae569ec0" args="(const QString &amp;arg)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ControlCommand::addArgument </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>arg</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Add an argument to this control command</p>
<p>Adds an argument to this command's argument list. </p>

<p>Definition at line <a class="el" href="_control_command_8cpp_source.html#l00055">55</a> of file <a class="el" href="_control_command_8cpp_source.html">ControlCommand.cpp</a>.</p>

<p>References <a class="el" href="_control_command_8h_source.html#l00054">_arguments</a>.</p>

<p>Referenced by <a class="el" href="_control_command_8cpp_source.html#l00062">addArguments()</a>, <a class="el" href="_tor_control_8cpp_source.html#l00982">TorControl::closeCircuit()</a>, <a class="el" href="_tor_control_8cpp_source.html#l01019">TorControl::closeStream()</a>, <a class="el" href="_control_command_8cpp_source.html#l00032">ControlCommand()</a>, <a class="el" href="_tor_control_8cpp_source.html#l00725">TorControl::getConf()</a>, <a class="el" href="_tor_control_8cpp_source.html#l00833">TorControl::getHiddenServiceConf()</a>, <a class="el" href="_tor_control_8cpp_source.html#l00409">TorControl::getInfo()</a>, <a class="el" href="_tor_control_8cpp_source.html#l00856">TorControl::resetConf()</a>, <a class="el" href="_tor_control_8cpp_source.html#l00663">TorControl::setConf()</a>, <a class="el" href="_tor_control_8cpp_source.html#l00648">TorControl::setEvents()</a>, and <a class="el" href="_tor_control_8cpp_source.html#l00496">TorControl::signal()</a>.</p>

</div>
</div>
<a class="anchor" id="ab5981c4f2760b6f23797ab23b7dc491b"></a><!-- doxytag: member="ControlCommand::addArguments" ref="ab5981c4f2760b6f23797ab23b7dc491b" args="(const QStringList &amp;args)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ControlCommand::addArguments </td>
          <td>(</td>
          <td class="paramtype">const QStringList &amp;&nbsp;</td>
          <td class="paramname"> <em>args</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Adds all arguments in <b>args</b> to this control command. </p>

<p>Definition at line <a class="el" href="_control_command_8cpp_source.html#l00062">62</a> of file <a class="el" href="_control_command_8cpp_source.html">ControlCommand.cpp</a>.</p>

<p>References <a class="el" href="_control_command_8cpp_source.html#l00055">addArgument()</a>.</p>

<p>Referenced by <a class="el" href="_tor_control_8cpp_source.html#l00790">TorControl::getConf()</a>, and <a class="el" href="_tor_control_8cpp_source.html#l00438">TorControl::getInfo()</a>.</p>

</div>
</div>
<a class="anchor" id="a3d8dab8080ef3956ae70a06a7d11fe8e"></a><!-- doxytag: member="ControlCommand::appendData" ref="a3d8dab8080ef3956ae70a06a7d11fe8e" args="(const QString &amp;data)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ControlCommand::appendData </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>data</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Append a data line for this control command</p>
<p>Adds data to the end of this command. </p>

<p>Definition at line <a class="el" href="_control_command_8cpp_source.html#l00071">71</a> of file <a class="el" href="_control_command_8cpp_source.html">ControlCommand.cpp</a>.</p>

<p>References <a class="el" href="_control_command_8h_source.html#l00055">_data</a>.</p>

</div>
</div>
<a class="anchor" id="a38cdbeddf0e8e6b88f4fc474bf2c4a62"></a><!-- doxytag: member="ControlCommand::escape" ref="a38cdbeddf0e8e6b88f4fc474bf2c4a62" args="(const QString &amp;str) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QString ControlCommand::escape </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>unescaped</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Escape special characters in the supplied string</p>
<p>Escapes any special characters in this command. </p>

<p>Definition at line <a class="el" href="_control_command_8cpp_source.html#l00078">78</a> of file <a class="el" href="_control_command_8cpp_source.html">ControlCommand.cpp</a>.</p>

<p>Referenced by <a class="el" href="_control_command_8cpp_source.html#l00100">toString()</a>.</p>

</div>
</div>
<a class="anchor" id="a42e58dd4d17e94d2434eba19318d4fac"></a><!-- doxytag: member="ControlCommand::keyword" ref="a42e58dd4d17e94d2434eba19318d4fac" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QString ControlCommand::keyword </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the keyword for this control command. </p>

<p>Definition at line <a class="el" href="_control_command_8h_source.html#l00032">32</a> of file <a class="el" href="_control_command_8h_source.html">ControlCommand.h</a>.</p>

<p>References <a class="el" href="_control_command_8h_source.html#l00053">_keyword</a>.</p>

<p>Referenced by <a class="el" href="_control_connection_8cpp_source.html#l00203">ControlConnection::send()</a>.</p>

</div>
</div>
<a class="anchor" id="af0e7535f3bfa9c85d5b4d853ddfca2b4"></a><!-- doxytag: member="ControlCommand::setKeyword" ref="af0e7535f3bfa9c85d5b4d853ddfca2b4" args="(const QString &amp;keyword)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ControlCommand::setKeyword </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>keyword</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Set the keyword for this control command</p>
<p>Sets the keyword for this command. </p>

<p>Definition at line <a class="el" href="_control_command_8cpp_source.html#l00048">48</a> of file <a class="el" href="_control_command_8cpp_source.html">ControlCommand.cpp</a>.</p>

<p>References <a class="el" href="_control_command_8h_source.html#l00053">_keyword</a>.</p>

</div>
</div>
<a class="anchor" id="a57c94909a90bc9ecb301ff3ef3beeb45"></a><!-- doxytag: member="ControlCommand::toString" ref="a57c94909a90bc9ecb301ff3ef3beeb45" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QString ControlCommand::toString </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Format this control command into a format conforming to Tor's v1 protocol specification.</p>
<p>Formats a command according to Tor's Control Protocol V1. The proper format of a command is as follows:</p>
<p>Command = Keyword Arguments CRLF / "+" Keyword Arguments CRLF Data Keyword = 1*ALPHA Arguments = *(SP / VCHAR) </p>

<p>Definition at line <a class="el" href="_control_command_8cpp_source.html#l00100">100</a> of file <a class="el" href="_control_command_8cpp_source.html">ControlCommand.cpp</a>.</p>

<p>References <a class="el" href="_control_command_8h_source.html#l00054">_arguments</a>, <a class="el" href="_control_command_8h_source.html#l00055">_data</a>, <a class="el" href="_control_command_8h_source.html#l00053">_keyword</a>, <a class="el" href="_control_command_8cpp_source.html#l00078">escape()</a>, and <a class="el" href="html_8cpp_source.html#l00033">i()</a>.</p>

<p>Referenced by <a class="el" href="_control_socket_8cpp_source.html#l00067">ControlSocket::sendCommand()</a>.</p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="af5c00e7b1b8a5149949befd1b90a0d0a"></a><!-- doxytag: member="ControlCommand::_arguments" ref="af5c00e7b1b8a5149949befd1b90a0d0a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QStringList <a class="el" href="class_control_command.html#af5c00e7b1b8a5149949befd1b90a0d0a">ControlCommand::_arguments</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_control_command_8h_source.html#l00054">54</a> of file <a class="el" href="_control_command_8h_source.html">ControlCommand.h</a>.</p>

<p>Referenced by <a class="el" href="_control_command_8cpp_source.html#l00055">addArgument()</a>, <a class="el" href="_control_command_8cpp_source.html#l00040">ControlCommand()</a>, and <a class="el" href="_control_command_8cpp_source.html#l00100">toString()</a>.</p>

</div>
</div>
<a class="anchor" id="a52a26f2b5500737cae3df73f240d763f"></a><!-- doxytag: member="ControlCommand::_data" ref="a52a26f2b5500737cae3df73f240d763f" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QStringList <a class="el" href="class_control_command.html#a52a26f2b5500737cae3df73f240d763f">ControlCommand::_data</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_control_command_8h_source.html#l00055">55</a> of file <a class="el" href="_control_command_8h_source.html">ControlCommand.h</a>.</p>

<p>Referenced by <a class="el" href="_control_command_8cpp_source.html#l00071">appendData()</a>, and <a class="el" href="_control_command_8cpp_source.html#l00100">toString()</a>.</p>

</div>
</div>
<a class="anchor" id="ac9e67b8eb679f0d8d81aba2be87e90ba"></a><!-- doxytag: member="ControlCommand::_keyword" ref="ac9e67b8eb679f0d8d81aba2be87e90ba" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QString <a class="el" href="class_control_command.html#ac9e67b8eb679f0d8d81aba2be87e90ba">ControlCommand::_keyword</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_control_command_8h_source.html#l00053">53</a> of file <a class="el" href="_control_command_8h_source.html">ControlCommand.h</a>.</p>

<p>Referenced by <a class="el" href="_control_command_8cpp_source.html#l00026">ControlCommand()</a>, <a class="el" href="_control_command_8h_source.html#l00032">keyword()</a>, <a class="el" href="_control_command_8cpp_source.html#l00048">setKeyword()</a>, and <a class="el" href="_control_command_8cpp_source.html#l00100">toString()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_control_command_8h_source.html">ControlCommand.h</a></li>
<li><a class="el" href="_control_command_8cpp_source.html">ControlCommand.cpp</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Aug 30 22:58:56 2010 for Vidalia by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional