<!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: RouterStatus.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>RouterStatus.h</h1><a href="_router_status_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 RouterStatus.h</span>
<a name="l00013"></a>00013 <span class="comment">** \version $Id: RouterStatus.h 3735 2009-04-28 20:28:01Z edmanm $</span>
<a name="l00014"></a>00014 <span class="comment">** \brief Parses a blob of router status text from Tor</span>
<a name="l00015"></a>00015 <span class="comment">*/</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef _ROUTERSTATUS_H</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define _ROUTERSTATUS_H</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include <QFlags></span>
<a name="l00021"></a>00021 <span class="preprocessor">#include <QStringList></span>
<a name="l00022"></a>00022 <span class="preprocessor">#include <QHostAddress></span>
<a name="l00023"></a>00023 <span class="preprocessor">#include <QDateTime></span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025
<a name="l00026"></a><a class="code" href="class_router_status.html">00026</a> <span class="keyword">class </span><a class="code" href="class_router_status.html">RouterStatus</a>
<a name="l00027"></a>00027 {
<a name="l00028"></a>00028 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00029"></a>00029 <span class="comment"> /** Possible router status flags. */</span>
<a name="l00030"></a><a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3">00030</a> <span class="keyword">enum</span> <a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3">Flag</a> {
<a name="l00031"></a><a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3a2bcc404adfb53cc5abc85950d8909b56">00031</a> <a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3a2bcc404adfb53cc5abc85950d8909b56">Unknown</a> = 0x0000,
<a name="l00032"></a><a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3aa97c30cea7fc633292dd1c11c2fa2ed5">00032</a> <a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3aa97c30cea7fc633292dd1c11c2fa2ed5">Authority</a> = 0x0001,
<a name="l00033"></a><a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3a7026fb54bbe440ab0fa49e750bf7be4a">00033</a> <a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3a7026fb54bbe440ab0fa49e750bf7be4a">BadExit</a> = 0x0002,
<a name="l00034"></a><a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3ae34fd7fe102b4143bba19e7b49d5a6b1">00034</a> <a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3ae34fd7fe102b4143bba19e7b49d5a6b1">BadDirectory</a> = 0x0004,
<a name="l00035"></a><a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3a011d7cd436e3805332fbaa604dc6f98f">00035</a> <a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3a011d7cd436e3805332fbaa604dc6f98f">Exit</a> = 0x0008,
<a name="l00036"></a><a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3a8893a77dbdac75e2747a8c91e00eaedc">00036</a> <a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3a8893a77dbdac75e2747a8c91e00eaedc">Fast</a> = 0x0010,
<a name="l00037"></a><a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3aa046a81d28c897a447f1af554908dd32">00037</a> <a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3aa046a81d28c897a447f1af554908dd32">Guard</a> = 0x0020,
<a name="l00038"></a><a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3a349ef87f35c1c6b4bba59a2d94d79b34">00038</a> <a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3a349ef87f35c1c6b4bba59a2d94d79b34">HSDir</a> = 0x0040,
<a name="l00039"></a><a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3add86b1dbc8c86cd49408cfff58006e8f">00039</a> <a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3add86b1dbc8c86cd49408cfff58006e8f">Named</a> = 0x0080,
<a name="l00040"></a><a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3a02628199a8269948276355844100121b">00040</a> <a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3a02628199a8269948276355844100121b">Stable</a> = 0x0100,
<a name="l00041"></a><a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3a4ee0f3f3b0ee6bdfc23b672ca588e56b">00041</a> <a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3a4ee0f3f3b0ee6bdfc23b672ca588e56b">Running</a> = 0x0200,
<a name="l00042"></a><a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3afd85078743ff4bc361bed3e7c22eee3f">00042</a> <a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3afd85078743ff4bc361bed3e7c22eee3f">Valid</a> = 0x0400,
<a name="l00043"></a><a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3a12c76bacab2734f4b36588426cbfc7b6">00043</a> <a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3a12c76bacab2734f4b36588426cbfc7b6">V2Dir</a> = 0x0800,
<a name="l00044"></a><a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3a5c5d214c77d06a72a4624eaaadeec5e5">00044</a> <a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3a5c5d214c77d06a72a4624eaaadeec5e5">V3Dir</a> = 0x1000
<a name="l00045"></a>00045 };
<a name="l00046"></a>00046 Q_DECLARE_FLAGS(Flags, <a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3">Flag</a>)
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="comment">/** Constructor. */</span>
<a name="l00049"></a>00049 <a class="code" href="class_router_status.html">RouterStatus</a>(const QStringList &status);
<a name="l00050"></a>00050 <span class="comment"></span>
<a name="l00051"></a>00051 <span class="comment"> /** Returns the router's hexadecimal-encoded router identity key digest. */</span>
<a name="l00052"></a><a class="code" href="class_router_status.html#ad064c0ddddf64b32eb084eb5e90972d3">00052</a> QString <span class="keywordtype">id</span>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_router_status.html#ad82dc178650da28c3b43b678604a1659">_id</a>; }<span class="comment"></span>
<a name="l00053"></a>00053 <span class="comment"> /** Returns the router's nickname. */</span>
<a name="l00054"></a><a class="code" href="class_router_status.html#a0ec8ac211fe411dd5dd641b1fd92e399">00054</a> QString <a class="code" href="class_router_status.html#a0ec8ac211fe411dd5dd641b1fd92e399">name</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_router_status.html#a9fd12f7b8e676e2e233d708c5630d793">_name</a>; }<span class="comment"></span>
<a name="l00055"></a>00055 <span class="comment"> /** Returns the hexadecimal-encoded digest of the router's most recent</span>
<a name="l00056"></a>00056 <span class="comment"> * descriptor. */</span>
<a name="l00057"></a><a class="code" href="class_router_status.html#a5f368af1ae936973e5a39a708f0456d8">00057</a> QString <a class="code" href="class_router_status.html#a5f368af1ae936973e5a39a708f0456d8">descriptorDigest</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_router_status.html#a49c80243fa12157cc50c1dd735a50f41">_digest</a>; }<span class="comment"></span>
<a name="l00058"></a>00058 <span class="comment"> /** Returns the router's most recent IP address. */</span>
<a name="l00059"></a><a class="code" href="class_router_status.html#a9c8027b53f81154e2ce6603ff3b79cc1">00059</a> QHostAddress <a class="code" href="class_router_status.html#a9c8027b53f81154e2ce6603ff3b79cc1">ipAddress</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_router_status.html#ad38bb5dbeefd9e39d95d14862ecce342">_ipAddress</a>; }<span class="comment"></span>
<a name="l00060"></a>00060 <span class="comment"> /** Returns the publication time of the router's most recent descriptor. */</span>
<a name="l00061"></a><a class="code" href="class_router_status.html#abae764c97588316bd49e8be198eba318">00061</a> QDateTime <a class="code" href="class_router_status.html#abae764c97588316bd49e8be198eba318">published</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_router_status.html#ad056d26a710668e1c4e2543b2f1821e2">_published</a>; }<span class="comment"></span>
<a name="l00062"></a>00062 <span class="comment"> /** Returns the router's OR port number. */</span>
<a name="l00063"></a><a class="code" href="class_router_status.html#a3529add63ea8de46ab09360dfecf4f3b">00063</a> quint16 <a class="code" href="class_router_status.html#a3529add63ea8de46ab09360dfecf4f3b">orPort</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_router_status.html#a6188114d0a7f97d338f068b87700960e">_orPort</a>; }<span class="comment"></span>
<a name="l00064"></a>00064 <span class="comment"> /** Returns the router's directory port number. */</span>
<a name="l00065"></a><a class="code" href="class_router_status.html#ae41abe695dc4cf2a31bb9c1c17b46913">00065</a> quint16 <a class="code" href="class_router_status.html#ae41abe695dc4cf2a31bb9c1c17b46913">dirPort</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_router_status.html#af55cc179563a96140e0eb305f7735b12">_dirPort</a>; }
<a name="l00066"></a>00066 <span class="comment"></span>
<a name="l00067"></a>00067 <span class="comment"> /** Returns an OR-ed field of the router's current status flags. */</span>
<a name="l00068"></a><a class="code" href="class_router_status.html#a7ae44fcf11fdfcc684cf317bf3306d95">00068</a> Flags <a class="code" href="class_router_status.html#a7ae44fcf11fdfcc684cf317bf3306d95">flags</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_router_status.html#a4654bbeb6b695f2591fd001a76810206">_flags</a>; }<span class="comment"></span>
<a name="l00069"></a>00069 <span class="comment"> /** Returns true if this router is currently listed as Running. */</span>
<a name="l00070"></a><a class="code" href="class_router_status.html#a23881113b6731e90685d15f9b753634a">00070</a> <span class="keywordtype">bool</span> <a class="code" href="class_router_status.html#a23881113b6731e90685d15f9b753634a">isRunning</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (<a class="code" href="class_router_status.html#a7ae44fcf11fdfcc684cf317bf3306d95">flags</a>() & <a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3a4ee0f3f3b0ee6bdfc23b672ca588e56b">Running</a>); }
<a name="l00071"></a>00071 <span class="comment"></span>
<a name="l00072"></a>00072 <span class="comment"> /** Returns true if this router status object is valid. This method should</span>
<a name="l00073"></a>00073 <span class="comment"> * be called to verify that the QStringList given in this object's</span>
<a name="l00074"></a>00074 <span class="comment"> * constructor contained properly formatted router status lines. */</span>
<a name="l00075"></a><a class="code" href="class_router_status.html#a81f921247025b634a9b9b0a3ee185d99">00075</a> <span class="keywordtype">bool</span> <a class="code" href="class_router_status.html#a81f921247025b634a9b9b0a3ee185d99">isValid</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_router_status.html#abdac24aa747ee4b38d8bb158b1baceb4">_valid</a>; }
<a name="l00076"></a>00076
<a name="l00077"></a>00077 <span class="keyword">private</span>:<span class="comment"></span>
<a name="l00078"></a>00078 <span class="comment"> /** Returns a Flags enum value for the given router status <b>flag</b>. If</span>
<a name="l00079"></a>00079 <span class="comment"> * <b>flag</b> is not recognized, then <i>Unknown</i> is returned. */</span>
<a name="l00080"></a>00080 <a class="code" href="class_router_status.html#a79bbd308f257cf7b6d221ec1d63488f3">Flag</a> <a class="code" href="class_router_status.html#a9286bc89d3131ee09a6e64bf543eecca">flagValue</a>(<span class="keyword">const</span> QString &flag);
<a name="l00081"></a>00081
<a name="l00082"></a><a class="code" href="class_router_status.html#abdac24aa747ee4b38d8bb158b1baceb4">00082</a> <span class="keywordtype">bool</span> <a class="code" href="class_router_status.html#abdac24aa747ee4b38d8bb158b1baceb4">_valid</a>; <span class="comment">/**< True if this object is a valid RouterStatus. */</span>
<a name="l00083"></a><a class="code" href="class_router_status.html#a9fd12f7b8e676e2e233d708c5630d793">00083</a> QString <a class="code" href="class_router_status.html#a9fd12f7b8e676e2e233d708c5630d793">_name</a>; <span class="comment">/**< Router nickname. */</span>
<a name="l00084"></a><a class="code" href="class_router_status.html#ad82dc178650da28c3b43b678604a1659">00084</a> QString <a class="code" href="class_router_status.html#ad82dc178650da28c3b43b678604a1659">_id</a>; <span class="comment">/**< Hexadecimal-encoded router identity digest. */</span>
<a name="l00085"></a><a class="code" href="class_router_status.html#a49c80243fa12157cc50c1dd735a50f41">00085</a> QString <a class="code" href="class_router_status.html#a49c80243fa12157cc50c1dd735a50f41">_digest</a>; <span class="comment">/**< Hexadecimal-encoded hash of the router's most recent</span>
<a name="l00086"></a>00086 <span class="comment"> descriptor. */</span>
<a name="l00087"></a><a class="code" href="class_router_status.html#ad056d26a710668e1c4e2543b2f1821e2">00087</a> QDateTime <a class="code" href="class_router_status.html#ad056d26a710668e1c4e2543b2f1821e2">_published</a>; <span class="comment">/**< The publication time of the router's most recent</span>
<a name="l00088"></a>00088 <span class="comment"> descriptor. */</span>
<a name="l00089"></a><a class="code" href="class_router_status.html#ad38bb5dbeefd9e39d95d14862ecce342">00089</a> QHostAddress <a class="code" href="class_router_status.html#ad38bb5dbeefd9e39d95d14862ecce342">_ipAddress</a>; <span class="comment">/**< Current IP address. */</span>
<a name="l00090"></a><a class="code" href="class_router_status.html#a6188114d0a7f97d338f068b87700960e">00090</a> quint16 <a class="code" href="class_router_status.html#a6188114d0a7f97d338f068b87700960e">_orPort</a>; <span class="comment">/**< Current OR port. */</span>
<a name="l00091"></a><a class="code" href="class_router_status.html#af55cc179563a96140e0eb305f7735b12">00091</a> quint16 <a class="code" href="class_router_status.html#af55cc179563a96140e0eb305f7735b12">_dirPort</a>; <span class="comment">/**< Current directory port. */</span>
<a name="l00092"></a><a class="code" href="class_router_status.html#a4654bbeb6b695f2591fd001a76810206">00092</a> Flags <a class="code" href="class_router_status.html#a4654bbeb6b695f2591fd001a76810206">_flags</a>; <span class="comment">/**< OR-ed field of the router's current status flags. */</span>
<a name="l00093"></a>00093 };
<a name="l00094"></a>00094
<a name="l00095"></a>00095 Q_DECLARE_OPERATORS_FOR_FLAGS(RouterStatus::Flags)
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <span class="comment">/** A collection of RouterStatus objects. */</span>
<a name="l00098"></a><a class="code" href="_router_status_8h.html#a0043af5f764cd62f178e35cbd74f494b">00098</a> typedef QList<<a class="code" href="class_router_status.html">RouterStatus</a>> <a class="code" href="_router_status_8h.html#a0043af5f764cd62f178e35cbd74f494b">NetworkStatus</a>;
<a name="l00099"></a>00099
<a name="l00100"></a>00100 <span class="preprocessor">#endif</span>
<a name="l00101"></a>00101 <span class="preprocessor"></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>
distrib
>
Mandriva
>
2010.2
>
i586
>
media
>
contrib-backports
>
by-pkgid
>
9601c7beb4ff23e834bfa171795ed560
>
files
>
269
