<!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: BridgeDownloader.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_695ba8f8357372e02d38c40b3c6dbe81.html">vidalia</a> » <a class="el" href="dir_738aec08306f4b898e01f7a551299457.html">config</a>
</div>
</div>
<div class="contents">
<h1>BridgeDownloader.h</h1><a href="_bridge_downloader_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 you</span>
<a name="l00004"></a>00004 <span class="comment">** did not receive the LICENSE file with this file, you may obtain it from the</span>
<a name="l00005"></a>00005 <span class="comment">** 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 the</span>
<a name="l00008"></a>00008 <span class="comment">** 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 BridgeDownloader.h</span>
<a name="l00013"></a>00013 <span class="comment">** \version $Id: BridgeDownloader.h 3735 2009-04-28 20:28:01Z edmanm $</span>
<a name="l00014"></a>00014 <span class="comment">** \brief Downloads a list of new bridge addresses via HTTPS</span>
<a name="l00015"></a>00015 <span class="comment">*/</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef _BRIDGEDOWNLOADER_H</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define _BRIDGEDOWNLOADER_H</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include <QHttp></span>
<a name="l00021"></a>00021 <span class="preprocessor">#include <QSslError></span>
<a name="l00022"></a>00022 <span class="preprocessor">#include <QStringList></span>
<a name="l00023"></a>00023
<a name="l00024"></a>00024
<a name="l00025"></a><a class="code" href="class_bridge_downloader.html">00025</a> <span class="keyword">class </span><a class="code" href="class_bridge_downloader.html">BridgeDownloader</a> : <span class="keyword">public</span> QObject
<a name="l00026"></a>00026 {
<a name="l00027"></a>00027 Q_OBJECT
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00030"></a>00030 <span class="comment"> /** Available bridge download methods. */</span>
<a name="l00031"></a><a class="code" href="class_bridge_downloader.html#ab1a059be506eb6f2b16f2d6c77753037">00031</a> <span class="keyword">enum</span> <a class="code" href="class_bridge_downloader.html#ab1a059be506eb6f2b16f2d6c77753037">BridgeDownloadMethod</a> {
<a name="l00032"></a><a class="code" href="class_bridge_downloader.html#ab1a059be506eb6f2b16f2d6c77753037ad0c2f26429d57bef2cd5957387d6eb05">00032</a> <a class="code" href="class_bridge_downloader.html#ab1a059be506eb6f2b16f2d6c77753037ad0c2f26429d57bef2cd5957387d6eb05">DownloadMethodHttps</a>, <span class="comment">/** Download via an HTTPS connection. */</span>
<a name="l00033"></a>00033 };
<a name="l00034"></a>00034 <span class="comment"></span>
<a name="l00035"></a>00035 <span class="comment"> /** Default constructor.</span>
<a name="l00036"></a>00036 <span class="comment"> */</span>
<a name="l00037"></a>00037 <a class="code" href="class_bridge_downloader.html#ad6b806a9ace96c296873704b830923a3">BridgeDownloader</a>(QObject *parent = 0);
<a name="l00038"></a>00038 <span class="comment"></span>
<a name="l00039"></a>00039 <span class="comment"> /** Initiates a request for a set of bridges using the specified</span>
<a name="l00040"></a>00040 <span class="comment"> * download <b>method</b>. Returns true if the request was initiated</span>
<a name="l00041"></a>00041 <span class="comment"> * successfully, or false on error.</span>
<a name="l00042"></a>00042 <span class="comment"> */</span>
<a name="l00043"></a>00043 <span class="keywordtype">bool</span> <a class="code" href="class_bridge_downloader.html#abb849b1ad80522a4809000f110025198">downloadBridges</a>(<a class="code" href="class_bridge_downloader.html#ab1a059be506eb6f2b16f2d6c77753037">BridgeDownloadMethod</a> method);
<a name="l00044"></a>00044 <span class="comment"></span>
<a name="l00045"></a>00045 <span class="comment"> /** Enables HTTPS proxy support, using the proxy server <b>host</b> on</span>
<a name="l00046"></a>00046 <span class="comment"> * port <b>port</b>. A <b>username</b> and <b>password</b> can also</span>
<a name="l00047"></a>00047 <span class="comment"> * optionally be supplied, if required by the proxy.</span>
<a name="l00048"></a>00048 <span class="comment"> */</span>
<a name="l00049"></a>00049 <span class="keywordtype">void</span> <a class="code" href="class_bridge_downloader.html#a3f4e6fb9d6d0d2fa9f180ad69644382b">setProxy</a>(<span class="keyword">const</span> QString &host, <span class="keywordtype">int</span> port,
<a name="l00050"></a>00050 <span class="keyword">const</span> QString &username = QString(),
<a name="l00051"></a>00051 <span class="keyword">const</span> QString &password = QString());
<a name="l00052"></a>00052 <span class="comment"></span>
<a name="l00053"></a>00053 <span class="comment"> /** Returns true if <b>method</b> is supported by the currently</span>
<a name="l00054"></a>00054 <span class="comment"> * available Qt libraries.</span>
<a name="l00055"></a>00055 <span class="comment"> */</span>
<a name="l00056"></a>00056 <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="class_bridge_downloader.html#a37237c2da19e2c8b3699aa971b081079">isMethodSupported</a>(<a class="code" href="class_bridge_downloader.html#ab1a059be506eb6f2b16f2d6c77753037">BridgeDownloadMethod</a> method);
<a name="l00057"></a>00057
<a name="l00058"></a>00058 <span class="keyword">public</span> slots:<span class="comment"></span>
<a name="l00059"></a>00059 <span class="comment"> /** Cancels any pending bridge download requests.</span>
<a name="l00060"></a>00060 <span class="comment"> */</span>
<a name="l00061"></a>00061 <span class="keywordtype">void</span> <a class="code" href="class_bridge_downloader.html#a69259d4eb6ec2715110343f6775b355f">cancelBridgeRequest</a>();
<a name="l00062"></a>00062
<a name="l00063"></a>00063 signals:<span class="comment"></span>
<a name="l00064"></a>00064 <span class="comment"> /** Emitted when the underlying QHttp object reads data from an HTTPS</span>
<a name="l00065"></a>00065 <span class="comment"> * response. <b>done</b> indicates how many bytes out of <b>total</b></span>
<a name="l00066"></a>00066 <span class="comment"> * have been read so far. Note that <b>total</b> may be 0 if the expected</span>
<a name="l00067"></a>00067 <span class="comment"> * total size of the response is not known.</span>
<a name="l00068"></a>00068 <span class="comment"> */</span>
<a name="l00069"></a>00069 <span class="keywordtype">void</span> <a class="code" href="class_bridge_downloader.html#ab4cc058b620e27f3db27ff5394fdb303">downloadProgress</a>(<span class="keywordtype">int</span> done, <span class="keywordtype">int</span> total);
<a name="l00070"></a>00070 <span class="comment"></span>
<a name="l00071"></a>00071 <span class="comment"> /** Emitted when the status of the bridge request changes. <b>status</b></span>
<a name="l00072"></a>00072 <span class="comment"> * describes the new current state of the request.</span>
<a name="l00073"></a>00073 <span class="comment"> */</span>
<a name="l00074"></a>00074 <span class="keywordtype">void</span> <a class="code" href="class_bridge_downloader.html#aeefbf3812b7249dc5a1c3019dd9e5ddc">statusChanged</a>(<span class="keyword">const</span> QString &status);
<a name="l00075"></a>00075 <span class="comment"></span>
<a name="l00076"></a>00076 <span class="comment"> /** Emitted when the previous request for bridge addresses completes</span>
<a name="l00077"></a>00077 <span class="comment"> * successfully. The QStringList <b>bridges</b> contains a (possibly empty)</span>
<a name="l00078"></a>00078 <span class="comment"> * list of bridge addresses parsed from the received response.</span>
<a name="l00079"></a>00079 <span class="comment"> */</span>
<a name="l00080"></a>00080 <span class="keywordtype">void</span> <a class="code" href="class_bridge_downloader.html#aa1fa83631418d786df7ee68606cdd50c">bridgeRequestFinished</a>(<span class="keyword">const</span> QStringList &bridges);
<a name="l00081"></a>00081 <span class="comment"></span>
<a name="l00082"></a>00082 <span class="comment"> /** Emitted when the previous request for bridge addresses fails. The</span>
<a name="l00083"></a>00083 <span class="comment"> * QString <b>error</b> is a human-readable string describing the error</span>
<a name="l00084"></a>00084 <span class="comment"> * encountered.</span>
<a name="l00085"></a>00085 <span class="comment"> */</span>
<a name="l00086"></a>00086 <span class="keywordtype">void</span> <a class="code" href="class_bridge_downloader.html#a6fc4ad4b3abcd6c0c875ea371b327491">bridgeRequestFailed</a>(<span class="keyword">const</span> QString &<a class="code" href="namespacetc.html#aa7353218fd7baef0876bbb422ce818af">error</a>);
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="keyword">private</span> slots:<span class="comment"></span>
<a name="l00089"></a>00089 <span class="comment"> /** Called when the state of the underlying QHttp object changes. A</span>
<a name="l00090"></a>00090 <span class="comment"> * statusChanged() signal is emitted with the appropriate text</span>
<a name="l00091"></a>00091 <span class="comment"> * describing the new state of the request.</span>
<a name="l00092"></a>00092 <span class="comment"> */</span>
<a name="l00093"></a>00093 <span class="keywordtype">void</span> <a class="code" href="class_bridge_downloader.html#adcb64a86c89bee40fd2d35a52debb77a">httpsStateChanged</a>(<span class="keywordtype">int</span> state);
<a name="l00094"></a>00094 <span class="comment"></span>
<a name="l00095"></a>00095 <span class="comment"> /** Called when the underlying QHttp object used to make the bridge</span>
<a name="l00096"></a>00096 <span class="comment"> * request completes. <b>error</b> is set to false if the request was</span>
<a name="l00097"></a>00097 <span class="comment"> * successful, or true if the request failed. If <b>id</b> does not</span>
<a name="l00098"></a>00098 <span class="comment"> * match the request ID previously returned by QHttp::get(), then the</span>
<a name="l00099"></a>00099 <span class="comment"> * signal is ignored since it is the result of a close() or abort()</span>
<a name="l00100"></a>00100 <span class="comment"> * request.</span>
<a name="l00101"></a>00101 <span class="comment"> */</span>
<a name="l00102"></a>00102 <span class="keywordtype">void</span> <a class="code" href="class_bridge_downloader.html#a0f5e1b9188bf8d28a4f4207e3985c65a">httpsRequestFinished</a>(<span class="keywordtype">int</span> <span class="keywordtype">id</span>, <span class="keywordtype">bool</span> <a class="code" href="namespacetc.html#aa7353218fd7baef0876bbb422ce818af">error</a>);
<a name="l00103"></a>00103 <span class="comment"></span>
<a name="l00104"></a>00104 <span class="comment"> /** Called when the HTTPS connection encounters one or more</span>
<a name="l00105"></a>00105 <span class="comment"> * <b>sslErrors</b>. Currently the errors are just logged and</span>
<a name="l00106"></a>00106 <span class="comment"> * bridgeRequestFailed() is <i>not</i> emitted, since QHttp will also</span>
<a name="l00107"></a>00107 <span class="comment"> * emit </span>
<a name="l00108"></a>00108 <span class="comment"> */</span>
<a name="l00109"></a>00109 <span class="keywordtype">void</span> <a class="code" href="class_bridge_downloader.html#a7dc7e9c457cbfdcc6a4251687e972329">sslErrors</a>(<span class="keyword">const</span> QList<QSslError> &<a class="code" href="class_bridge_downloader.html#a7dc7e9c457cbfdcc6a4251687e972329">sslErrors</a>);
<a name="l00110"></a>00110
<a name="l00111"></a>00111 <span class="keyword">private</span>:<span class="comment"></span>
<a name="l00112"></a>00112 <span class="comment"> /** Initiates an HTTPS connection to bridges.torproject.org to start</span>
<a name="l00113"></a>00113 <span class="comment"> * downloading a set of bridges.</span>
<a name="l00114"></a>00114 <span class="comment"> */</span>
<a name="l00115"></a>00115 <span class="keywordtype">void</span> <a class="code" href="class_bridge_downloader.html#aed8a8eef20fe43ab939f4eb9b49b6e43">startHttpsDownload</a>();
<a name="l00116"></a>00116 <span class="comment"></span>
<a name="l00117"></a>00117 <span class="comment"> /** Used to connect to the bridge database, send an HTTPS request for</span>
<a name="l00118"></a>00118 <span class="comment"> * new bridge addresses and then read the response. */</span>
<a name="l00119"></a><a class="code" href="class_bridge_downloader.html#ae44a2677dcde706dc7deb63e5a243eca">00119</a> QHttp* <a class="code" href="class_bridge_downloader.html#ae44a2677dcde706dc7deb63e5a243eca">_https</a>;
<a name="l00120"></a>00120 <span class="comment"></span>
<a name="l00121"></a>00121 <span class="comment"> /** Unique numeric identifier of the current bridge request. */</span>
<a name="l00122"></a><a class="code" href="class_bridge_downloader.html#a38f0166f171285121e7fa17d9b426e7c">00122</a> <span class="keywordtype">int</span> <a class="code" href="class_bridge_downloader.html#a38f0166f171285121e7fa17d9b426e7c">_requestId</a>;
<a name="l00123"></a>00123 };
<a name="l00124"></a>00124
<a name="l00125"></a>00125 <span class="preprocessor">#endif</span>
<a name="l00126"></a>00126 <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
>
41
