<!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: Stream 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>Stream Class Reference</h1><!-- doxytag: class="Stream" --> <p><code>#include <<a class="el" href="_stream_8h_source.html">Stream.h</a>></code></p> <p><a href="class_stream-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_stream.html#abe342e3ab850c3b79befd8073dd613c2">Status</a> { <br/> <a class="el" href="class_stream.html#abe342e3ab850c3b79befd8073dd613c2aed01de5ee6660abc13d3050573b284bd">Unknown</a>, <a class="el" href="class_stream.html#abe342e3ab850c3b79befd8073dd613c2a71ddfed4a525f68b10d609f5d50fc7ab">New</a>, <a class="el" href="class_stream.html#abe342e3ab850c3b79befd8073dd613c2a0fd9f8a104f93dfb9448b25138dd56d9">NewResolve</a>, <a class="el" href="class_stream.html#abe342e3ab850c3b79befd8073dd613c2ad63c4027dbb4be0bcb07f4fe4fda2c1f">SentConnect</a>, <br/> <a class="el" href="class_stream.html#abe342e3ab850c3b79befd8073dd613c2a171a5190c3d0829d953beebcc2a62144">SentResolve</a>, <a class="el" href="class_stream.html#abe342e3ab850c3b79befd8073dd613c2af02bc26726950e8fcd7a416da3f1159c">Succeeded</a>, <a class="el" href="class_stream.html#abe342e3ab850c3b79befd8073dd613c2a1435e25b3f7e41821a2a32821b4e1f17">Failed</a>, <a class="el" href="class_stream.html#abe342e3ab850c3b79befd8073dd613c2aac96f9b4c5acde5c2c1070f57b8447d4">Closed</a>, <br/> <a class="el" href="class_stream.html#abe342e3ab850c3b79befd8073dd613c2a937bb3762d2e52394d3c985432641349">Detached</a>, <a class="el" href="class_stream.html#abe342e3ab850c3b79befd8073dd613c2ac4a12a9e22e9abf6e2320e62c700b97d">Remap</a> <br/> }</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_stream.html#a8c3f05bd00361ec92627fa41f330a39b">Stream</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#ace77ad18cf50708c6dc27d5c703fe615">Stream</a> (const <a class="el" href="_stream_8h.html#a90d94d8a7b979b4c7e07f5869a431064">StreamId</a> &streamId, <a class="el" href="class_stream.html#abe342e3ab850c3b79befd8073dd613c2">Status</a> status, const <a class="el" href="_circuit_8h.html#a8b7b0182a6d1ff0aab7ab31df9c3f83d">CircuitId</a> &circuitId, const QString &target)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a37656b3fb11c16d9cb693ca33689a036">Stream</a> (const <a class="el" href="_stream_8h.html#a90d94d8a7b979b4c7e07f5869a431064">StreamId</a> &streamId, <a class="el" href="class_stream.html#abe342e3ab850c3b79befd8073dd613c2">Status</a> status, const <a class="el" href="_circuit_8h.html#a8b7b0182a6d1ff0aab7ab31df9c3f83d">CircuitId</a> &circuitId, const QString &address, quint16 port)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a347b15c4c22b5c84145433725c9637e3">isValid</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="_stream_8h.html#a90d94d8a7b979b4c7e07f5869a431064">StreamId</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#ac289e56fcae8e2283e6055d75eb6382d">id</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_stream.html#abe342e3ab850c3b79befd8073dd613c2">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#ae704c6dddc0196b8813de2769426fed6">status</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a7330c007d8ff77ce0a58be66e5c14591">statusString</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="_circuit_8h.html#a8b7b0182a6d1ff0aab7ab31df9c3f83d">CircuitId</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#ab1a8fcb8353bace64d4d56bd5b4d07a2">circuitId</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a81f58b982d1074cf8a5a2d70cbd32bdc">target</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#ab774881d5ef13085ff38fa975ec50edf">targetAddress</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">quint16 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#ab3bfd7479953b545bbf1ed3db0502c10">targetPort</a> () const </td></tr> <tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_stream.html">Stream</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#aeaff90f7abf81399e207c480d1bee8a0">fromString</a> (const QString &stream)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_stream.html#abe342e3ab850c3b79befd8073dd613c2">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a73c71589dc054b2d9fd6180c67c15ba1">toStatus</a> (const QString &strStatus)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a9fa94da8bf9132d9d43a80aebe569393">isValidStreamId</a> (const <a class="el" href="_stream_8h.html#a90d94d8a7b979b4c7e07f5869a431064">StreamId</a> &streamId)</td></tr> <tr><td colspan="2"><h2>Private Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="_stream_8h.html#a90d94d8a7b979b4c7e07f5869a431064">StreamId</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#ab0991ad6af0b5b8938cf0e8b7862689a">_streamId</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="_circuit_8h.html#a8b7b0182a6d1ff0aab7ab31df9c3f83d">CircuitId</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a3d91a042a0c586c8098f2bcd484ecfa6">_circuitId</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#afa6dd3449b2be82e364574a2232e6be1">_address</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_stream.html#abe342e3ab850c3b79befd8073dd613c2">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#aa3b0bd2844ee62354b4416156245f3d3">_status</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">quint16 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#af29712e2c1e1cd5d0b9a40fff0aa2cff">_port</a></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Definition at line <a class="el" href="_stream_8h_source.html#l00032">32</a> of file <a class="el" href="_stream_8h_source.html">Stream.h</a>.</p> <hr/><h2>Member Enumeration Documentation</h2> <a class="anchor" id="abe342e3ab850c3b79befd8073dd613c2"></a><!-- doxytag: member="Stream::Status" ref="abe342e3ab850c3b79befd8073dd613c2" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="class_stream.html#abe342e3ab850c3b79befd8073dd613c2">Stream::Status</a></td> </tr> </table> </div> <div class="memdoc"> <p><a class="el" href="class_stream.html">Stream</a> status values </p> <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"><em><a class="anchor" id="abe342e3ab850c3b79befd8073dd613c2aed01de5ee6660abc13d3050573b284bd"></a><!-- doxytag: member="Unknown" ref="abe342e3ab850c3b79befd8073dd613c2aed01de5ee6660abc13d3050573b284bd" args="" -->Unknown</em> </td><td> <p>Unknown status type given </p> </td></tr> <tr><td valign="top"><em><a class="anchor" id="abe342e3ab850c3b79befd8073dd613c2a71ddfed4a525f68b10d609f5d50fc7ab"></a><!-- doxytag: member="New" ref="abe342e3ab850c3b79befd8073dd613c2a71ddfed4a525f68b10d609f5d50fc7ab" args="" -->New</em> </td><td> <p>New request to connect </p> </td></tr> <tr><td valign="top"><em><a class="anchor" id="abe342e3ab850c3b79befd8073dd613c2a0fd9f8a104f93dfb9448b25138dd56d9"></a><!-- doxytag: member="NewResolve" ref="abe342e3ab850c3b79befd8073dd613c2a0fd9f8a104f93dfb9448b25138dd56d9" args="" -->NewResolve</em> </td><td> <p>New request to resolve an address </p> </td></tr> <tr><td valign="top"><em><a class="anchor" id="abe342e3ab850c3b79befd8073dd613c2ad63c4027dbb4be0bcb07f4fe4fda2c1f"></a><!-- doxytag: member="SentConnect" ref="abe342e3ab850c3b79befd8073dd613c2ad63c4027dbb4be0bcb07f4fe4fda2c1f" args="" -->SentConnect</em> </td><td> <p>Sent a connect cell </p> </td></tr> <tr><td valign="top"><em><a class="anchor" id="abe342e3ab850c3b79befd8073dd613c2a171a5190c3d0829d953beebcc2a62144"></a><!-- doxytag: member="SentResolve" ref="abe342e3ab850c3b79befd8073dd613c2a171a5190c3d0829d953beebcc2a62144" args="" -->SentResolve</em> </td><td> <p>Sent a resolve cell </p> </td></tr> <tr><td valign="top"><em><a class="anchor" id="abe342e3ab850c3b79befd8073dd613c2af02bc26726950e8fcd7a416da3f1159c"></a><!-- doxytag: member="Succeeded" ref="abe342e3ab850c3b79befd8073dd613c2af02bc26726950e8fcd7a416da3f1159c" args="" -->Succeeded</em> </td><td> <p><a class="el" href="class_stream.html">Stream</a> established </p> </td></tr> <tr><td valign="top"><em><a class="anchor" id="abe342e3ab850c3b79befd8073dd613c2a1435e25b3f7e41821a2a32821b4e1f17"></a><!-- doxytag: member="Failed" ref="abe342e3ab850c3b79befd8073dd613c2a1435e25b3f7e41821a2a32821b4e1f17" args="" -->Failed</em> </td><td> <p><a class="el" href="class_stream.html">Stream</a> failed </p> </td></tr> <tr><td valign="top"><em><a class="anchor" id="abe342e3ab850c3b79befd8073dd613c2aac96f9b4c5acde5c2c1070f57b8447d4"></a><!-- doxytag: member="Closed" ref="abe342e3ab850c3b79befd8073dd613c2aac96f9b4c5acde5c2c1070f57b8447d4" args="" -->Closed</em> </td><td> <p><a class="el" href="class_stream.html">Stream</a> closed </p> </td></tr> <tr><td valign="top"><em><a class="anchor" id="abe342e3ab850c3b79befd8073dd613c2a937bb3762d2e52394d3c985432641349"></a><!-- doxytag: member="Detached" ref="abe342e3ab850c3b79befd8073dd613c2a937bb3762d2e52394d3c985432641349" args="" -->Detached</em> </td><td> <p>Detached from circuit </p> </td></tr> <tr><td valign="top"><em><a class="anchor" id="abe342e3ab850c3b79befd8073dd613c2ac4a12a9e22e9abf6e2320e62c700b97d"></a><!-- doxytag: member="Remap" ref="abe342e3ab850c3b79befd8073dd613c2ac4a12a9e22e9abf6e2320e62c700b97d" args="" -->Remap</em> </td><td> <p>Address re-mapped to another </p> </td></tr> </table> </dd> </dl> <p>Definition at line <a class="el" href="_stream_8h_source.html#l00038">38</a> of file <a class="el" href="_stream_8h_source.html">Stream.h</a>.</p> </div> </div> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a8c3f05bd00361ec92627fa41f330a39b"></a><!-- doxytag: member="Stream::Stream" ref="a8c3f05bd00361ec92627fa41f330a39b" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Stream::Stream </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Default constructor</p> <p>Default constructor. </p> <p>Definition at line <a class="el" href="_stream_8cpp_source.html#l00024">24</a> of file <a class="el" href="_stream_8cpp_source.html">Stream.cpp</a>.</p> <p>References <a class="el" href="_stream_8h_source.html#l00092">_port</a>, <a class="el" href="_stream_8h_source.html#l00091">_status</a>, and <a class="el" href="_stream_8h_source.html#l00039">Unknown</a>.</p> <p>Referenced by <a class="el" href="_stream_8cpp_source.html#l00064">fromString()</a>.</p> </div> </div> <a class="anchor" id="ace77ad18cf50708c6dc27d5c703fe615"></a><!-- doxytag: member="Stream::Stream" ref="ace77ad18cf50708c6dc27d5c703fe615" args="(const StreamId &streamId, Status status, const CircuitId &circuitId, const QString &target)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Stream::Stream </td> <td>(</td> <td class="paramtype">const <a class="el" href="_stream_8h.html#a90d94d8a7b979b4c7e07f5869a431064">StreamId</a> & </td> <td class="paramname"> <em>streamId</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="class_stream.html#abe342e3ab850c3b79befd8073dd613c2">Status</a> </td> <td class="paramname"> <em>status</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="_circuit_8h.html#a8b7b0182a6d1ff0aab7ab31df9c3f83d">CircuitId</a> & </td> <td class="paramname"> <em>circuitId</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const QString & </td> <td class="paramname"> <em>target</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Constructor </p> <p>Definition at line <a class="el" href="_stream_8cpp_source.html#l00043">43</a> of file <a class="el" href="_stream_8cpp_source.html">Stream.cpp</a>.</p> <p>References <a class="el" href="_stream_8h_source.html#l00090">_address</a>, <a class="el" href="_stream_8h_source.html#l00089">_circuitId</a>, <a class="el" href="_stream_8h_source.html#l00092">_port</a>, <a class="el" href="_stream_8h_source.html#l00091">_status</a>, <a class="el" href="_stream_8h_source.html#l00088">_streamId</a>, and <a class="el" href="html_8cpp_source.html#l00033">i()</a>.</p> </div> </div> <a class="anchor" id="a37656b3fb11c16d9cb693ca33689a036"></a><!-- doxytag: member="Stream::Stream" ref="a37656b3fb11c16d9cb693ca33689a036" args="(const StreamId &streamId, Status status, const CircuitId &circuitId, const QString &address, quint16 port)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Stream::Stream </td> <td>(</td> <td class="paramtype">const <a class="el" href="_stream_8h.html#a90d94d8a7b979b4c7e07f5869a431064">StreamId</a> & </td> <td class="paramname"> <em>streamId</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="class_stream.html#abe342e3ab850c3b79befd8073dd613c2">Status</a> </td> <td class="paramname"> <em>status</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="_circuit_8h.html#a8b7b0182a6d1ff0aab7ab31df9c3f83d">CircuitId</a> & </td> <td class="paramname"> <em>circuitId</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const QString & </td> <td class="paramname"> <em>address</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">quint16 </td> <td class="paramname"> <em>port</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Constructor </p> <p>Definition at line <a class="el" href="_stream_8cpp_source.html#l00031">31</a> of file <a class="el" href="_stream_8cpp_source.html">Stream.cpp</a>.</p> <p>References <a class="el" href="_stream_8h_source.html#l00090">_address</a>, <a class="el" href="_stream_8h_source.html#l00089">_circuitId</a>, <a class="el" href="_stream_8h_source.html#l00092">_port</a>, <a class="el" href="_stream_8h_source.html#l00091">_status</a>, and <a class="el" href="_stream_8h_source.html#l00088">_streamId</a>.</p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="ab1a8fcb8353bace64d4d56bd5b4d07a2"></a><!-- doxytag: member="Stream::circuitId" ref="ab1a8fcb8353bace64d4d56bd5b4d07a2" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="_circuit_8h.html#a8b7b0182a6d1ff0aab7ab31df9c3f83d">CircuitId</a> Stream::circuitId </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the ID of the circuit to which this stream is assigned. </p> <p>Definition at line <a class="el" href="_stream_8h_source.html#l00075">75</a> of file <a class="el" href="_stream_8h_source.html">Stream.h</a>.</p> <p>References <a class="el" href="_stream_8h_source.html#l00089">_circuitId</a>.</p> <p>Referenced by <a class="el" href="_net_viewer_8cpp_source.html#l00282">NetViewer::addStream()</a>, and <a class="el" href="_circuit_list_widget_8cpp_source.html#l00171">CircuitListWidget::addStream()</a>.</p> </div> </div> <a class="anchor" id="aeaff90f7abf81399e207c480d1bee8a0"></a><!-- doxytag: member="Stream::fromString" ref="aeaff90f7abf81399e207c480d1bee8a0" args="(const QString &stream)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_stream.html">Stream</a> Stream::fromString </td> <td>(</td> <td class="paramtype">const QString & </td> <td class="paramname"> <em>stream</em></td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Parses the given string for a stream, in Tor control protocol format.</p> <p>Parses the given string for stream information, given in Tor control protocol format. The format is:</p> <p>StreamID SP StreamStatus SP CircID SP Target </p> <p>Definition at line <a class="el" href="_stream_8cpp_source.html#l00064">64</a> of file <a class="el" href="_stream_8cpp_source.html">Stream.cpp</a>.</p> <p>References <a class="el" href="_stream_8h_source.html#l00071">status()</a>, <a class="el" href="_stream_8cpp_source.html#l00024">Stream()</a>, <a class="el" href="_stream_8h_source.html#l00077">target()</a>, and <a class="el" href="_stream_8cpp_source.html#l00101">toStatus()</a>.</p> <p>Referenced by <a class="el" href="_tor_control_8cpp_source.html#l00993">TorControl::getStreams()</a>, and <a class="el" href="_tor_events_8cpp_source.html#l00214">TorEvents::handleStreamStatus()</a>.</p> </div> </div> <a class="anchor" id="ac289e56fcae8e2283e6055d75eb6382d"></a><!-- doxytag: member="Stream::id" ref="ac289e56fcae8e2283e6055d75eb6382d" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="_stream_8h.html#a90d94d8a7b979b4c7e07f5869a431064">StreamId</a> Stream::id </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the ID for this stream. </p> <p>Definition at line <a class="el" href="_stream_8h_source.html#l00069">69</a> of file <a class="el" href="_stream_8h_source.html">Stream.h</a>.</p> <p>References <a class="el" href="_stream_8h_source.html#l00088">_streamId</a>.</p> <p>Referenced by <a class="el" href="_net_viewer_8cpp_source.html#l00282">NetViewer::addStream()</a>, <a class="el" href="_circuit_list_widget_8cpp_source.html#l00171">CircuitListWidget::addStream()</a>, and <a class="el" href="_stream_item_8h_source.html#l00035">StreamItem::id()</a>.</p> </div> </div> <a class="anchor" id="a347b15c4c22b5c84145433725c9637e3"></a><!-- doxytag: member="Stream::isValid" ref="a347b15c4c22b5c84145433725c9637e3" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Stream::isValid </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns true iff the <a class="el" href="class_stream.html">Stream</a> object's fields are all valid.</p> <p>Returns true if all fields in this <a class="el" href="class_stream.html">Stream</a> object are valid. </p> <p>Definition at line <a class="el" href="_stream_8cpp_source.html#l00147">147</a> of file <a class="el" href="_stream_8cpp_source.html">Stream.cpp</a>.</p> <p>References <a class="el" href="_stream_8h_source.html#l00090">_address</a>, <a class="el" href="_stream_8h_source.html#l00089">_circuitId</a>, <a class="el" href="_stream_8h_source.html#l00091">_status</a>, <a class="el" href="_stream_8h_source.html#l00088">_streamId</a>, <a class="el" href="_circuit_8cpp_source.html#l00075">Circuit::isValidCircuitId()</a>, <a class="el" href="_stream_8cpp_source.html#l00085">isValidStreamId()</a>, and <a class="el" href="_stream_8h_source.html#l00039">Unknown</a>.</p> <p>Referenced by <a class="el" href="_tor_control_8cpp_source.html#l00993">TorControl::getStreams()</a>, and <a class="el" href="_tor_events_8cpp_source.html#l00214">TorEvents::handleStreamStatus()</a>.</p> </div> </div> <a class="anchor" id="a9fa94da8bf9132d9d43a80aebe569393"></a><!-- doxytag: member="Stream::isValidStreamId" ref="a9fa94da8bf9132d9d43a80aebe569393" args="(const StreamId &streamId)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Stream::isValidStreamId </td> <td>(</td> <td class="paramtype">const <a class="el" href="_stream_8h.html#a90d94d8a7b979b4c7e07f5869a431064">StreamId</a> & </td> <td class="paramname"> <em>streamId</em></td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns true iff <b>streamId</b> consists of only between 1 and 16 (inclusive) ASCII-encoded letters and numbers. </p> <p>Definition at line <a class="el" href="_stream_8cpp_source.html#l00085">85</a> of file <a class="el" href="_stream_8cpp_source.html">Stream.cpp</a>.</p> <p>References <a class="el" href="html_8cpp_source.html#l00033">i()</a>.</p> <p>Referenced by <a class="el" href="_stream_8cpp_source.html#l00147">isValid()</a>.</p> </div> </div> <a class="anchor" id="ae704c6dddc0196b8813de2769426fed6"></a><!-- doxytag: member="Stream::status" ref="ae704c6dddc0196b8813de2769426fed6" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_stream.html#abe342e3ab850c3b79befd8073dd613c2">Status</a> Stream::status </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the status for this stream. </p> <p>Definition at line <a class="el" href="_stream_8h_source.html#l00071">71</a> of file <a class="el" href="_stream_8h_source.html">Stream.h</a>.</p> <p>References <a class="el" href="_stream_8h_source.html#l00091">_status</a>.</p> <p>Referenced by <a class="el" href="_net_viewer_8cpp_source.html#l00282">NetViewer::addStream()</a>, <a class="el" href="_circuit_list_widget_8cpp_source.html#l00171">CircuitListWidget::addStream()</a>, <a class="el" href="_stream_8cpp_source.html#l00064">fromString()</a>, and <a class="el" href="_stream_8cpp_source.html#l00127">statusString()</a>.</p> </div> </div> <a class="anchor" id="a7330c007d8ff77ce0a58be66e5c14591"></a><!-- doxytag: member="Stream::statusString" ref="a7330c007d8ff77ce0a58be66e5c14591" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QString Stream::statusString </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns a string representation of this stream's status.</p> <p>Returns a human-understandable string representation of this stream's status. </p> <p>Definition at line <a class="el" href="_stream_8cpp_source.html#l00127">127</a> of file <a class="el" href="_stream_8cpp_source.html">Stream.cpp</a>.</p> <p>References <a class="el" href="_stream_8h_source.html#l00091">_status</a>, <a class="el" href="_stream_8h_source.html#l00046">Closed</a>, <a class="el" href="_stream_8h_source.html#l00047">Detached</a>, <a class="el" href="_stream_8h_source.html#l00045">Failed</a>, <a class="el" href="_stream_8h_source.html#l00040">New</a>, <a class="el" href="_stream_8h_source.html#l00041">NewResolve</a>, <a class="el" href="_stream_8h_source.html#l00048">Remap</a>, <a class="el" href="_stream_8h_source.html#l00042">SentConnect</a>, <a class="el" href="_stream_8h_source.html#l00043">SentResolve</a>, <a class="el" href="_stream_8h_source.html#l00071">status()</a>, and <a class="el" href="_stream_8h_source.html#l00044">Succeeded</a>.</p> <p>Referenced by <a class="el" href="_stream_item_8cpp_source.html#l00030">StreamItem::update()</a>.</p> </div> </div> <a class="anchor" id="a81f58b982d1074cf8a5a2d70cbd32bdc"></a><!-- doxytag: member="Stream::target" ref="a81f58b982d1074cf8a5a2d70cbd32bdc" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QString Stream::target </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the target address and port for this stream. </p> <p>Definition at line <a class="el" href="_stream_8h_source.html#l00077">77</a> of file <a class="el" href="_stream_8h_source.html">Stream.h</a>.</p> <p>References <a class="el" href="_stream_8h_source.html#l00090">_address</a>, and <a class="el" href="_stream_8h_source.html#l00092">_port</a>.</p> <p>Referenced by <a class="el" href="_stream_8cpp_source.html#l00064">fromString()</a>, and <a class="el" href="_stream_item_8cpp_source.html#l00030">StreamItem::update()</a>.</p> </div> </div> <a class="anchor" id="ab774881d5ef13085ff38fa975ec50edf"></a><!-- doxytag: member="Stream::targetAddress" ref="ab774881d5ef13085ff38fa975ec50edf" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QString Stream::targetAddress </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the target address for this stream. </p> <p>Definition at line <a class="el" href="_stream_8h_source.html#l00079">79</a> of file <a class="el" href="_stream_8h_source.html">Stream.h</a>.</p> <p>References <a class="el" href="_stream_8h_source.html#l00090">_address</a>.</p> <p>Referenced by <a class="el" href="_net_viewer_8cpp_source.html#l00282">NetViewer::addStream()</a>.</p> </div> </div> <a class="anchor" id="ab3bfd7479953b545bbf1ed3db0502c10"></a><!-- doxytag: member="Stream::targetPort" ref="ab3bfd7479953b545bbf1ed3db0502c10" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">quint16 Stream::targetPort </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the target port for this stream. </p> <p>Definition at line <a class="el" href="_stream_8h_source.html#l00081">81</a> of file <a class="el" href="_stream_8h_source.html">Stream.h</a>.</p> <p>References <a class="el" href="_stream_8h_source.html#l00092">_port</a>.</p> <p>Referenced by <a class="el" href="_net_viewer_8cpp_source.html#l00282">NetViewer::addStream()</a>.</p> </div> </div> <a class="anchor" id="a73c71589dc054b2d9fd6180c67c15ba1"></a><!-- doxytag: member="Stream::toStatus" ref="a73c71589dc054b2d9fd6180c67c15ba1" args="(const QString &strStatus)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_stream.html#abe342e3ab850c3b79befd8073dd613c2">Stream::Status</a> Stream::toStatus </td> <td>(</td> <td class="paramtype">const QString & </td> <td class="paramname"> <em>strStatus</em></td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Converts a string description of a stream's status to its enum value </p> <p>Definition at line <a class="el" href="_stream_8cpp_source.html#l00101">101</a> of file <a class="el" href="_stream_8cpp_source.html">Stream.cpp</a>.</p> <p>References <a class="el" href="_stream_8h_source.html#l00046">Closed</a>, <a class="el" href="_stream_8h_source.html#l00047">Detached</a>, <a class="el" href="_stream_8h_source.html#l00045">Failed</a>, <a class="el" href="_stream_8h_source.html#l00040">New</a>, <a class="el" href="_stream_8h_source.html#l00041">NewResolve</a>, <a class="el" href="_stream_8h_source.html#l00048">Remap</a>, <a class="el" href="_stream_8h_source.html#l00042">SentConnect</a>, <a class="el" href="_stream_8h_source.html#l00043">SentResolve</a>, <a class="el" href="_stream_8h_source.html#l00044">Succeeded</a>, and <a class="el" href="_stream_8h_source.html#l00039">Unknown</a>.</p> <p>Referenced by <a class="el" href="_stream_8cpp_source.html#l00064">fromString()</a>.</p> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="afa6dd3449b2be82e364574a2232e6be1"></a><!-- doxytag: member="Stream::_address" ref="afa6dd3449b2be82e364574a2232e6be1" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QString <a class="el" href="class_stream.html#afa6dd3449b2be82e364574a2232e6be1">Stream::_address</a><code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p><a class="el" href="class_stream.html">Stream</a> target address. </p> <p>Definition at line <a class="el" href="_stream_8h_source.html#l00090">90</a> of file <a class="el" href="_stream_8h_source.html">Stream.h</a>.</p> <p>Referenced by <a class="el" href="_stream_8cpp_source.html#l00147">isValid()</a>, <a class="el" href="_stream_8cpp_source.html#l00031">Stream()</a>, <a class="el" href="_stream_8h_source.html#l00077">target()</a>, and <a class="el" href="_stream_8h_source.html#l00079">targetAddress()</a>.</p> </div> </div> <a class="anchor" id="a3d91a042a0c586c8098f2bcd484ecfa6"></a><!-- doxytag: member="Stream::_circuitId" ref="a3d91a042a0c586c8098f2bcd484ecfa6" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="_circuit_8h.html#a8b7b0182a6d1ff0aab7ab31df9c3f83d">CircuitId</a> <a class="el" href="class_stream.html#a3d91a042a0c586c8098f2bcd484ecfa6">Stream::_circuitId</a><code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>ID of the circuit carrying this stream. </p> <p>Definition at line <a class="el" href="_stream_8h_source.html#l00089">89</a> of file <a class="el" href="_stream_8h_source.html">Stream.h</a>.</p> <p>Referenced by <a class="el" href="_stream_8h_source.html#l00075">circuitId()</a>, <a class="el" href="_stream_8cpp_source.html#l00147">isValid()</a>, and <a class="el" href="_stream_8cpp_source.html#l00031">Stream()</a>.</p> </div> </div> <a class="anchor" id="af29712e2c1e1cd5d0b9a40fff0aa2cff"></a><!-- doxytag: member="Stream::_port" ref="af29712e2c1e1cd5d0b9a40fff0aa2cff" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">quint16 <a class="el" href="class_stream.html#af29712e2c1e1cd5d0b9a40fff0aa2cff">Stream::_port</a><code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p><a class="el" href="class_stream.html">Stream</a> target port. </p> <p>Definition at line <a class="el" href="_stream_8h_source.html#l00092">92</a> of file <a class="el" href="_stream_8h_source.html">Stream.h</a>.</p> <p>Referenced by <a class="el" href="_stream_8cpp_source.html#l00024">Stream()</a>, <a class="el" href="_stream_8h_source.html#l00077">target()</a>, and <a class="el" href="_stream_8h_source.html#l00081">targetPort()</a>.</p> </div> </div> <a class="anchor" id="aa3b0bd2844ee62354b4416156245f3d3"></a><!-- doxytag: member="Stream::_status" ref="aa3b0bd2844ee62354b4416156245f3d3" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_stream.html#abe342e3ab850c3b79befd8073dd613c2">Status</a> <a class="el" href="class_stream.html#aa3b0bd2844ee62354b4416156245f3d3">Stream::_status</a><code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p><a class="el" href="class_stream.html">Stream</a> status value. </p> <p>Definition at line <a class="el" href="_stream_8h_source.html#l00091">91</a> of file <a class="el" href="_stream_8h_source.html">Stream.h</a>.</p> <p>Referenced by <a class="el" href="_stream_8cpp_source.html#l00147">isValid()</a>, <a class="el" href="_stream_8h_source.html#l00071">status()</a>, <a class="el" href="_stream_8cpp_source.html#l00127">statusString()</a>, and <a class="el" href="_stream_8cpp_source.html#l00024">Stream()</a>.</p> </div> </div> <a class="anchor" id="ab0991ad6af0b5b8938cf0e8b7862689a"></a><!-- doxytag: member="Stream::_streamId" ref="ab0991ad6af0b5b8938cf0e8b7862689a" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="_stream_8h.html#a90d94d8a7b979b4c7e07f5869a431064">StreamId</a> <a class="el" href="class_stream.html#ab0991ad6af0b5b8938cf0e8b7862689a">Stream::_streamId</a><code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Unique ID associated with this stream. </p> <p>Definition at line <a class="el" href="_stream_8h_source.html#l00088">88</a> of file <a class="el" href="_stream_8h_source.html">Stream.h</a>.</p> <p>Referenced by <a class="el" href="_stream_8h_source.html#l00069">id()</a>, <a class="el" href="_stream_8cpp_source.html#l00147">isValid()</a>, and <a class="el" href="_stream_8cpp_source.html#l00031">Stream()</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="_stream_8h_source.html">Stream.h</a></li> <li><a class="el" href="_stream_8cpp_source.html">Stream.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>