<!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: ProtocolInfo 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> <div class="contents"> <h1>ProtocolInfo Class Reference</h1><!-- doxytag: class="ProtocolInfo" --> <p><code>#include <<a class="el" href="_protocol_info_8h_source.html">ProtocolInfo.h</a>></code></p> <p><a href="class_protocol_info-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_protocol_info.html#a557d4f2aaa4cedfc26974b2a4ca0d674">ProtocolInfo</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_protocol_info.html#a354cf24304445c92ee83a35ff6561d3c">isEmpty</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_protocol_info.html#af7e5946d54fdd1855c5625632c45ed3c">setAuthMethods</a> (const QString methods)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="class_protocol_info.html#acd18be6390cb6d5a8bd3e8632e56fffb">authMethods</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_protocol_info.html#ad0733b6d7b047741ac52ccbcbc7ae511">setCookieAuthFile</a> (const QString cookieAuthFile)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_protocol_info.html#aa6316295d55f5b2d82984b2ed1c3ec17">cookieAuthFile</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_protocol_info.html#a4fed1115f41df472f76b4f801b0923de">setTorVersion</a> (const QString torVersion)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_protocol_info.html#afcd218868de436995d5da6da0236395f">torVersionString</a> () const </td></tr> <tr><td colspan="2"><h2>Private Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_protocol_info.html#a488e71b592ed30e026744562a972c497">_torVersion</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_protocol_info.html#aa0792a640a8033fa3f577de945acc8cd">_cookieAuthFile</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="class_protocol_info.html#a049b159c705a232239ccae885b469b45">_authMethods</a></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Definition at line <a class="el" href="_protocol_info_8h_source.html#l00023">23</a> of file <a class="el" href="_protocol_info_8h_source.html">ProtocolInfo.h</a>.</p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a557d4f2aaa4cedfc26974b2a4ca0d674"></a><!-- doxytag: member="ProtocolInfo::ProtocolInfo" ref="a557d4f2aaa4cedfc26974b2a4ca0d674" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ProtocolInfo::ProtocolInfo </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="_protocol_info_8h_source.html#l00027">27</a> of file <a class="el" href="_protocol_info_8h_source.html">ProtocolInfo.h</a>.</p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="acd18be6390cb6d5a8bd3e8632e56fffb"></a><!-- doxytag: member="ProtocolInfo::authMethods" ref="acd18be6390cb6d5a8bd3e8632e56fffb" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QStringList ProtocolInfo::authMethods </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the authentication methods Tor currently accepts. </p> <p>Definition at line <a class="el" href="_protocol_info_8h_source.html#l00036">36</a> of file <a class="el" href="_protocol_info_8h_source.html">ProtocolInfo.h</a>.</p> <p>References <a class="el" href="_protocol_info_8h_source.html#l00052">_authMethods</a>.</p> <p>Referenced by <a class="el" href="_main_window_8cpp_source.html#l01260">MainWindow::authenticate()</a>.</p> </div> </div> <a class="anchor" id="aa6316295d55f5b2d82984b2ed1c3ec17"></a><!-- doxytag: member="ProtocolInfo::cookieAuthFile" ref="aa6316295d55f5b2d82984b2ed1c3ec17" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QString ProtocolInfo::cookieAuthFile </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the file to which Tor has written its authentication cookie. </p> <p>Definition at line <a class="el" href="_protocol_info_8h_source.html#l00042">42</a> of file <a class="el" href="_protocol_info_8h_source.html">ProtocolInfo.h</a>.</p> <p>References <a class="el" href="_protocol_info_8h_source.html#l00051">_cookieAuthFile</a>.</p> <p>Referenced by <a class="el" href="_main_window_8cpp_source.html#l01260">MainWindow::authenticate()</a>.</p> </div> </div> <a class="anchor" id="a354cf24304445c92ee83a35ff6561d3c"></a><!-- doxytag: member="ProtocolInfo::isEmpty" ref="a354cf24304445c92ee83a35ff6561d3c" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool ProtocolInfo::isEmpty </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns true if this <a class="el" href="class_protocol_info.html">ProtocolInfo</a> object contains no data. </p> <p>Definition at line <a class="el" href="_protocol_info_8cpp_source.html#l00022">22</a> of file <a class="el" href="_protocol_info_8cpp_source.html">ProtocolInfo.cpp</a>.</p> <p>References <a class="el" href="_protocol_info_8h_source.html#l00052">_authMethods</a>, <a class="el" href="_protocol_info_8h_source.html#l00051">_cookieAuthFile</a>, and <a class="el" href="_protocol_info_8h_source.html#l00050">_torVersion</a>.</p> <p>Referenced by <a class="el" href="_main_window_8cpp_source.html#l01260">MainWindow::authenticate()</a>.</p> </div> </div> <a class="anchor" id="af7e5946d54fdd1855c5625632c45ed3c"></a><!-- doxytag: member="ProtocolInfo::setAuthMethods" ref="af7e5946d54fdd1855c5625632c45ed3c" args="(const QString methods)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ProtocolInfo::setAuthMethods </td> <td>(</td> <td class="paramtype">const QString </td> <td class="paramname"> <em>authMethods</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Sets the authentication methods Tor currently accepts. <b>methods</b> should be a comma-delimited list of authentication methods. </p> <p>Definition at line <a class="el" href="_protocol_info_8cpp_source.html#l00032">32</a> of file <a class="el" href="_protocol_info_8cpp_source.html">ProtocolInfo.cpp</a>.</p> <p>References <a class="el" href="_protocol_info_8h_source.html#l00052">_authMethods</a>.</p> <p>Referenced by <a class="el" href="_tor_control_8cpp_source.html#l00309">TorControl::protocolInfo()</a>.</p> </div> </div> <a class="anchor" id="ad0733b6d7b047741ac52ccbcbc7ae511"></a><!-- doxytag: member="ProtocolInfo::setCookieAuthFile" ref="ad0733b6d7b047741ac52ccbcbc7ae511" args="(const QString cookieAuthFile)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ProtocolInfo::setCookieAuthFile </td> <td>(</td> <td class="paramtype">const QString </td> <td class="paramname"> <em>cookieAuthFile</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Sets the file to which Tor has written its authentication cookie. </p> <p>Definition at line <a class="el" href="_protocol_info_8h_source.html#l00039">39</a> of file <a class="el" href="_protocol_info_8h_source.html">ProtocolInfo.h</a>.</p> <p>References <a class="el" href="_protocol_info_8h_source.html#l00051">_cookieAuthFile</a>.</p> <p>Referenced by <a class="el" href="_tor_control_8cpp_source.html#l00309">TorControl::protocolInfo()</a>.</p> </div> </div> <a class="anchor" id="a4fed1115f41df472f76b4f801b0923de"></a><!-- doxytag: member="ProtocolInfo::setTorVersion" ref="a4fed1115f41df472f76b4f801b0923de" args="(const QString torVersion)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ProtocolInfo::setTorVersion </td> <td>(</td> <td class="paramtype">const QString </td> <td class="paramname"> <em>torVersion</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Sets the version of Tor to which the controller is connected. </p> <p>Definition at line <a class="el" href="_protocol_info_8h_source.html#l00045">45</a> of file <a class="el" href="_protocol_info_8h_source.html">ProtocolInfo.h</a>.</p> <p>References <a class="el" href="_protocol_info_8h_source.html#l00050">_torVersion</a>.</p> <p>Referenced by <a class="el" href="_tor_control_8cpp_source.html#l00309">TorControl::protocolInfo()</a>.</p> </div> </div> <a class="anchor" id="afcd218868de436995d5da6da0236395f"></a><!-- doxytag: member="ProtocolInfo::torVersionString" ref="afcd218868de436995d5da6da0236395f" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QString ProtocolInfo::torVersionString </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the version of Tor to which the controller is connected. </p> <p>Definition at line <a class="el" href="_protocol_info_8h_source.html#l00047">47</a> of file <a class="el" href="_protocol_info_8h_source.html">ProtocolInfo.h</a>.</p> <p>References <a class="el" href="_protocol_info_8h_source.html#l00050">_torVersion</a>.</p> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="a049b159c705a232239ccae885b469b45"></a><!-- doxytag: member="ProtocolInfo::_authMethods" ref="a049b159c705a232239ccae885b469b45" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QStringList <a class="el" href="class_protocol_info.html#a049b159c705a232239ccae885b469b45">ProtocolInfo::_authMethods</a><code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Tor's ccepted authentication methods. </p> <p>Definition at line <a class="el" href="_protocol_info_8h_source.html#l00052">52</a> of file <a class="el" href="_protocol_info_8h_source.html">ProtocolInfo.h</a>.</p> <p>Referenced by <a class="el" href="_protocol_info_8h_source.html#l00036">authMethods()</a>, <a class="el" href="_protocol_info_8cpp_source.html#l00022">isEmpty()</a>, and <a class="el" href="_protocol_info_8cpp_source.html#l00032">setAuthMethods()</a>.</p> </div> </div> <a class="anchor" id="aa0792a640a8033fa3f577de945acc8cd"></a><!-- doxytag: member="ProtocolInfo::_cookieAuthFile" ref="aa0792a640a8033fa3f577de945acc8cd" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QString <a class="el" href="class_protocol_info.html#aa0792a640a8033fa3f577de945acc8cd">ProtocolInfo::_cookieAuthFile</a><code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Tor's authentication cookie file. </p> <p>Definition at line <a class="el" href="_protocol_info_8h_source.html#l00051">51</a> of file <a class="el" href="_protocol_info_8h_source.html">ProtocolInfo.h</a>.</p> <p>Referenced by <a class="el" href="_protocol_info_8h_source.html#l00042">cookieAuthFile()</a>, <a class="el" href="_protocol_info_8cpp_source.html#l00022">isEmpty()</a>, and <a class="el" href="_protocol_info_8h_source.html#l00039">setCookieAuthFile()</a>.</p> </div> </div> <a class="anchor" id="a488e71b592ed30e026744562a972c497"></a><!-- doxytag: member="ProtocolInfo::_torVersion" ref="a488e71b592ed30e026744562a972c497" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QString <a class="el" href="class_protocol_info.html#a488e71b592ed30e026744562a972c497">ProtocolInfo::_torVersion</a><code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>The Tor version in the PROTOCOLINFO reply. </p> <p>Definition at line <a class="el" href="_protocol_info_8h_source.html#l00050">50</a> of file <a class="el" href="_protocol_info_8h_source.html">ProtocolInfo.h</a>.</p> <p>Referenced by <a class="el" href="_protocol_info_8cpp_source.html#l00022">isEmpty()</a>, <a class="el" href="_protocol_info_8h_source.html#l00045">setTorVersion()</a>, and <a class="el" href="_protocol_info_8h_source.html#l00047">torVersionString()</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="_protocol_info_8h_source.html">ProtocolInfo.h</a></li> <li><a class="el" href="_protocol_info_8cpp_source.html">ProtocolInfo.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 <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> </body> </html>