<!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: ControlReply 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>ControlReply Class Reference</h1><!-- doxytag: class="ControlReply" --> <p><code>#include <<a class="el" href="_control_reply_8h_source.html">ControlReply.h</a>></code></p> <p><a href="class_control_reply-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_control_reply.html#a497bbe14336623bb7dec553e4e5e17a2">ControlReply</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_control_reply.html#ab7f593d8a0f921c6d35fa5135676dc40">appendLine</a> (<a class="el" href="class_reply_line.html">ReplyLine</a> line)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_reply_line.html">ReplyLine</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_control_reply.html#a96d433262972ee7815071e60ba03dd38">getLine</a> (int idx=0) const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">QList< <a class="el" href="class_reply_line.html">ReplyLine</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_control_reply.html#a4ff2ea9c2c8035be7c5caf468da744f6">getLines</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_control_reply.html#a8b7a7275546b3ba8f5a3ec6296d971f0">getStatus</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_control_reply.html#a13b0ec6e2d3d97932297cf2002c25578">getMessage</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="class_control_reply.html#a4c14d998eeb24a4e47bbcafc8192d09f">getData</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_control_reply.html#ad03c1cb6d54f7809975b733c4a33d38f">toString</a> () const </td></tr> <tr><td colspan="2"><h2>Private Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">QList< <a class="el" href="class_reply_line.html">ReplyLine</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_control_reply.html#a2450e6812387dda1c6c6504ba791d6de">_lines</a></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Definition at line <a class="el" href="_control_reply_8h_source.html#l00025">25</a> of file <a class="el" href="_control_reply_8h_source.html">ControlReply.h</a>.</p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a497bbe14336623bb7dec553e4e5e17a2"></a><!-- doxytag: member="ControlReply::ControlReply" ref="a497bbe14336623bb7dec553e4e5e17a2" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ControlReply::ControlReply </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Default constructor </p> <p>Definition at line <a class="el" href="_control_reply_8cpp_source.html#l00021">21</a> of file <a class="el" href="_control_reply_8cpp_source.html">ControlReply.cpp</a>.</p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="ab7f593d8a0f921c6d35fa5135676dc40"></a><!-- doxytag: member="ControlReply::appendLine" ref="ab7f593d8a0f921c6d35fa5135676dc40" args="(ReplyLine line)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ControlReply::appendLine </td> <td>(</td> <td class="paramtype"><a class="el" href="class_reply_line.html">ReplyLine</a> </td> <td class="paramname"> <em>line</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Add a line associated with this reply </p> <p>Definition at line <a class="el" href="_control_reply_8cpp_source.html#l00027">27</a> of file <a class="el" href="_control_reply_8cpp_source.html">ControlReply.cpp</a>.</p> <p>References <a class="el" href="_control_reply_8h_source.html#l00049">_lines</a>.</p> <p>Referenced by <a class="el" href="_control_socket_8cpp_source.html#l00138">ControlSocket::readReply()</a>.</p> </div> </div> <a class="anchor" id="a4c14d998eeb24a4e47bbcafc8192d09f"></a><!-- doxytag: member="ControlReply::getData" ref="a4c14d998eeb24a4e47bbcafc8192d09f" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QStringList ControlReply::getData </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns the data for the first line in the reply. </p> <p>Definition at line <a class="el" href="_control_reply_8cpp_source.html#l00062">62</a> of file <a class="el" href="_control_reply_8cpp_source.html">ControlReply.cpp</a>.</p> <p>References <a class="el" href="_reply_line_8cpp_source.html#l00079">ReplyLine::getData()</a>, and <a class="el" href="_control_reply_8cpp_source.html#l00034">getLine()</a>.</p> <p>Referenced by <a class="el" href="_tor_control_8cpp_source.html#l00961">TorControl::getCircuits()</a>, and <a class="el" href="_tor_control_8cpp_source.html#l00993">TorControl::getStreams()</a>.</p> </div> </div> <a class="anchor" id="a96d433262972ee7815071e60ba03dd38"></a><!-- doxytag: member="ControlReply::getLine" ref="a96d433262972ee7815071e60ba03dd38" args="(int idx=0) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_reply_line.html">ReplyLine</a> ControlReply::getLine </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>idx</em> = <code>0</code></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns a single line from this reply</p> <p>Returns the requested line from this reply </p> <p>Definition at line <a class="el" href="_control_reply_8cpp_source.html#l00034">34</a> of file <a class="el" href="_control_reply_8cpp_source.html">ControlReply.cpp</a>.</p> <p>References <a class="el" href="_control_reply_8h_source.html#l00049">_lines</a>.</p> <p>Referenced by <a class="el" href="_control_reply_8cpp_source.html#l00062">getData()</a>, <a class="el" href="_control_reply_8cpp_source.html#l00055">getMessage()</a>, and <a class="el" href="_control_reply_8cpp_source.html#l00048">getStatus()</a>.</p> </div> </div> <a class="anchor" id="a4ff2ea9c2c8035be7c5caf468da744f6"></a><!-- doxytag: member="ControlReply::getLines" ref="a4ff2ea9c2c8035be7c5caf468da744f6" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QList< <a class="el" href="class_reply_line.html">ReplyLine</a> > ControlReply::getLines </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns all lines for this reply </p> <p>Definition at line <a class="el" href="_control_reply_8cpp_source.html#l00041">41</a> of file <a class="el" href="_control_reply_8cpp_source.html">ControlReply.cpp</a>.</p> <p>References <a class="el" href="_control_reply_8h_source.html#l00049">_lines</a>.</p> <p>Referenced by <a class="el" href="_tor_control_8cpp_source.html#l00725">TorControl::getConf()</a>, <a class="el" href="_tor_control_8cpp_source.html#l00409">TorControl::getInfo()</a>, <a class="el" href="_tor_events_8cpp_source.html#l00125">TorEvents::handleEvent()</a>, and <a class="el" href="_tor_control_8cpp_source.html#l00309">TorControl::protocolInfo()</a>.</p> </div> </div> <a class="anchor" id="a13b0ec6e2d3d97932297cf2002c25578"></a><!-- doxytag: member="ControlReply::getMessage" ref="a13b0ec6e2d3d97932297cf2002c25578" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QString ControlReply::getMessage </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns the messasge of the first line in the reply</p> <p>Returns the message of the first line in the reply </p> <p>Definition at line <a class="el" href="_control_reply_8cpp_source.html#l00055">55</a> of file <a class="el" href="_control_reply_8cpp_source.html">ControlReply.cpp</a>.</p> <p>References <a class="el" href="_control_reply_8cpp_source.html#l00034">getLine()</a>, and <a class="el" href="_reply_line_8cpp_source.html#l00065">ReplyLine::getMessage()</a>.</p> <p>Referenced by <a class="el" href="_tor_control_8cpp_source.html#l00993">TorControl::getStreams()</a>, and <a class="el" href="_tor_control_8cpp_source.html#l00233">TorControl::send()</a>.</p> </div> </div> <a class="anchor" id="a8b7a7275546b3ba8f5a3ec6296d971f0"></a><!-- doxytag: member="ControlReply::getStatus" ref="a8b7a7275546b3ba8f5a3ec6296d971f0" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QString ControlReply::getStatus </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns the status of the first line in the reply </p> <p>Definition at line <a class="el" href="_control_reply_8cpp_source.html#l00048">48</a> of file <a class="el" href="_control_reply_8cpp_source.html">ControlReply.cpp</a>.</p> <p>References <a class="el" href="_control_reply_8cpp_source.html#l00034">getLine()</a>, and <a class="el" href="_reply_line_8cpp_source.html#l00051">ReplyLine::getStatus()</a>.</p> <p>Referenced by <a class="el" href="_control_connection_8cpp_source.html#l00251">ControlConnection::onReadyRead()</a>, and <a class="el" href="_tor_control_8cpp_source.html#l00233">TorControl::send()</a>.</p> </div> </div> <a class="anchor" id="ad03c1cb6d54f7809975b733c4a33d38f"></a><!-- doxytag: member="ControlReply::toString" ref="ad03c1cb6d54f7809975b733c4a33d38f" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QString ControlReply::toString </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns the entire contents of the control reply. </p> <p>Definition at line <a class="el" href="_control_reply_8cpp_source.html#l00069">69</a> of file <a class="el" href="_control_reply_8cpp_source.html">ControlReply.cpp</a>.</p> <p>References <a class="el" href="_control_reply_8h_source.html#l00049">_lines</a>, and <a class="el" href="_reply_line_8cpp_source.html#l00100">ReplyLine::toString()</a>.</p> <p>Referenced by <a class="el" href="_tor_control_8cpp_source.html#l00833">TorControl::getHiddenServiceConf()</a>, and <a class="el" href="_control_connection_8cpp_source.html#l00251">ControlConnection::onReadyRead()</a>.</p> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="a2450e6812387dda1c6c6504ba791d6de"></a><!-- doxytag: member="ControlReply::_lines" ref="a2450e6812387dda1c6c6504ba791d6de" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QList<<a class="el" href="class_reply_line.html">ReplyLine</a>> <a class="el" href="class_control_reply.html#a2450e6812387dda1c6c6504ba791d6de">ControlReply::_lines</a><code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="_control_reply_8h_source.html#l00049">49</a> of file <a class="el" href="_control_reply_8h_source.html">ControlReply.h</a>.</p> <p>Referenced by <a class="el" href="_control_reply_8cpp_source.html#l00027">appendLine()</a>, <a class="el" href="_control_reply_8cpp_source.html#l00034">getLine()</a>, <a class="el" href="_control_reply_8cpp_source.html#l00041">getLines()</a>, and <a class="el" href="_control_reply_8cpp_source.html#l00069">toString()</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="_control_reply_8h_source.html">ControlReply.h</a></li> <li><a class="el" href="_control_reply_8cpp_source.html">ControlReply.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>