<!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: ServerSettings.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>ServerSettings.h</h1><a href="_server_settings_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 ServerSettings.h</span>
<a name="l00013"></a>00013 <span class="comment">** \version $Id: ServerSettings.h 4143 2009-10-12 00:59:22Z edmanm $</span>
<a name="l00014"></a>00014 <span class="comment">** \brief Settings for running a Tor server</span>
<a name="l00015"></a>00015 <span class="comment">*/</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef _SERVERSETTINGS_H</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define _SERVERSETTINGS_H</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include "<a class="code" href="_abstract_tor_settings_8h.html">AbstractTorSettings.h</a>"</span>
<a name="l00021"></a>00021 <span class="preprocessor">#include "<a class="code" href="_exit_policy_8h.html">ExitPolicy.h</a>"</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023
<a name="l00024"></a><a class="code" href="class_server_settings.html">00024</a> <span class="keyword">class </span><a class="code" href="class_server_settings.html">ServerSettings</a> : <span class="keyword">public</span> <a class="code" href="class_abstract_tor_settings.html">AbstractTorSettings</a>
<a name="l00025"></a>00025 {
<a name="l00026"></a>00026 Q_OBJECT
<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"> /** Constructor */</span>
<a name="l00030"></a>00030 <a class="code" href="class_server_settings.html#afd3b5060bd7dba76a8ff73f47a5c2081">ServerSettings</a>(<a class="code" href="class_tor_control.html">TorControl</a> *<a class="code" href="class_abstract_tor_settings.html#a1fd0bb636bfa8131f6261b1bc11aeee4">torControl</a>);
<a name="l00031"></a>00031 <span class="comment"></span>
<a name="l00032"></a>00032 <span class="comment"> /** Applies changese to Tor. */</span>
<a name="l00033"></a>00033 <span class="keywordtype">bool</span> <a class="code" href="class_server_settings.html#a030fec2c0433a3106391bb1593382110">apply</a>(QString *errmsg = 0);
<a name="l00034"></a>00034 <span class="comment"></span>
<a name="l00035"></a>00035 <span class="comment"> /** Enables running Tor as a server. */</span>
<a name="l00036"></a>00036 <span class="keywordtype">void</span> <a class="code" href="class_server_settings.html#aa833bc4697c608baf75e69b85ab8c6b6">setServerEnabled</a>(<span class="keywordtype">bool</span> enable);<span class="comment"></span>
<a name="l00037"></a>00037 <span class="comment"> /** Returns true if Tor is running as a server. */</span>
<a name="l00038"></a>00038 <span class="keywordtype">bool</span> <a class="code" href="class_server_settings.html#ad8d3c25facf05765a5379421a5f80da5">isServerEnabled</a>();
<a name="l00039"></a>00039 <span class="comment"></span>
<a name="l00040"></a>00040 <span class="comment"> /** Sets to <b>enabled</b> whether Tor should be a bridge node when acting</span>
<a name="l00041"></a>00041 <span class="comment"> * as a server. */</span>
<a name="l00042"></a>00042 <span class="keywordtype">void</span> <a class="code" href="class_server_settings.html#a0e330c838b330b7d25eeb4c8e7ece126">setBridgeEnabled</a>(<span class="keywordtype">bool</span> enable);<span class="comment"></span>
<a name="l00043"></a>00043 <span class="comment"> /** Returns true if Tor is configured to act as a bridge node. */</span>
<a name="l00044"></a>00044 <span class="keywordtype">bool</span> <a class="code" href="class_server_settings.html#a911acfd3a5ce7227e10e64f251ba44e0">isBridgeEnabled</a>();
<a name="l00045"></a>00045 <span class="comment"></span>
<a name="l00046"></a>00046 <span class="comment"> /** Sets the server's ORPort value. */</span>
<a name="l00047"></a>00047 <span class="keywordtype">void</span> <a class="code" href="class_server_settings.html#a15d7e9f64b3a2799a993819d74f0bcdc">setORPort</a>(quint16 orPort);<span class="comment"></span>
<a name="l00048"></a>00048 <span class="comment"> /** Gets the server's ORPort value. */</span>
<a name="l00049"></a>00049 quint16 <a class="code" href="class_server_settings.html#a6b919ff92a5c43e2163e595c6550ad5a">getORPort</a>();
<a name="l00050"></a>00050 <span class="comment"></span>
<a name="l00051"></a>00051 <span class="comment"> /** Sets the server's DirPort value. */</span>
<a name="l00052"></a>00052 <span class="keywordtype">void</span> <a class="code" href="class_server_settings.html#ac64f885fda7a97a12c2ff1166f7c7c37">setDirPort</a>(quint16 dirPort);<span class="comment"></span>
<a name="l00053"></a>00053 <span class="comment"> /** Gets the server's DirPort value. */</span>
<a name="l00054"></a>00054 quint16 <a class="code" href="class_server_settings.html#a2a3b7a0c5ab09cf6c7436b78addd37a7">getDirPort</a>();
<a name="l00055"></a>00055 <span class="comment"></span>
<a name="l00056"></a>00056 <span class="comment"> /** Sets the server's nickname. */</span>
<a name="l00057"></a>00057 <span class="keywordtype">void</span> <a class="code" href="class_server_settings.html#a6d364baace16bb134cc74e8d675f7cc9">setNickname</a>(QString nickname);<span class="comment"></span>
<a name="l00058"></a>00058 <span class="comment"> /** Gets the server's nickname. */</span>
<a name="l00059"></a>00059 QString <a class="code" href="class_server_settings.html#a6d3899ef930a3de796f4e13d4ab7c534">getNickname</a>();
<a name="l00060"></a>00060 <span class="comment"></span>
<a name="l00061"></a>00061 <span class="comment"> /** Sets the server operator's contact information. */</span>
<a name="l00062"></a>00062 <span class="keywordtype">void</span> <a class="code" href="class_server_settings.html#abb5dffb3adca20bd99e79b0d2b521982">setContactInfo</a>(QString info);<span class="comment"></span>
<a name="l00063"></a>00063 <span class="comment"> /** Gets the server operator's contact information. */</span>
<a name="l00064"></a>00064 QString <a class="code" href="class_server_settings.html#a001a1e0d97c05db09e1de9779b464789">getContactInfo</a>();
<a name="l00065"></a>00065 <span class="comment"></span>
<a name="l00066"></a>00066 <span class="comment"> /** Enables or disables the server to act as a directory mirror. */</span>
<a name="l00067"></a>00067 <span class="keywordtype">void</span> <a class="code" href="class_server_settings.html#a9599baf63fdd49e18155b95987e6755b">setDirectoryMirror</a>(<span class="keywordtype">bool</span> mirror);<span class="comment"></span>
<a name="l00068"></a>00068 <span class="comment"> /** Returns true if the server will mirror the directory. */</span>
<a name="l00069"></a>00069 <span class="keywordtype">bool</span> <a class="code" href="class_server_settings.html#a7779c3509d358077406b4e75cf9c7f7d">isDirectoryMirror</a>();<span class="comment"></span>
<a name="l00070"></a>00070 <span class="comment"> /** Sets the exit policy for this server. */</span>
<a name="l00071"></a>00071 <span class="keywordtype">void</span> <a class="code" href="class_server_settings.html#aad511688b32d4262e64b96ae66c3ae68">setExitPolicy</a>(<a class="code" href="class_exit_policy.html">ExitPolicy</a> &policy);<span class="comment"></span>
<a name="l00072"></a>00072 <span class="comment"> /** Gets the exit policy for this server. */</span>
<a name="l00073"></a>00073 <a class="code" href="class_exit_policy.html">ExitPolicy</a> <a class="code" href="class_server_settings.html#a9d9ec555d9e9fd7c3f608d99a2471186">getExitPolicy</a>();
<a name="l00074"></a>00074 <span class="comment"></span>
<a name="l00075"></a>00075 <span class="comment"> /** Sets the long-term average bandwidth rate (in KB/s) of this server. */</span>
<a name="l00076"></a>00076 <span class="keywordtype">void</span> <a class="code" href="class_server_settings.html#ae007a13970276a36f8c2ff34a465cf73">setBandwidthAvgRate</a>(quint32 rate);<span class="comment"></span>
<a name="l00077"></a>00077 <span class="comment"> /** Gets the long-term average bandwidth rate (in KB/s) of this server. */</span>
<a name="l00078"></a>00078 quint32 <a class="code" href="class_server_settings.html#a68f74454d64896664db22f5671c900c2">getBandwidthAvgRate</a>();
<a name="l00079"></a>00079 <span class="comment"></span>
<a name="l00080"></a>00080 <span class="comment"> /** Sets the maximum burst rate (in B/s) of this server. */</span>
<a name="l00081"></a>00081 <span class="keywordtype">void</span> <a class="code" href="class_server_settings.html#aa1a48f299c7eaa765c5743bded4d0df9">setBandwidthBurstRate</a>(quint32 rate);<span class="comment"></span>
<a name="l00082"></a>00082 <span class="comment"> /** Gets the maximum burst rate (in B/s) of this server. */</span>
<a name="l00083"></a>00083 quint32 <a class="code" href="class_server_settings.html#a4db2fe48b6bcfc400965bf896f96eb7c">getBandwidthBurstRate</a>();
<a name="l00084"></a>00084 <span class="comment"></span>
<a name="l00085"></a>00085 <span class="comment"> /** Sets whether the user's server descriptor will be published or not.</span>
<a name="l00086"></a>00086 <span class="comment"> * Currently this only affects publishing of bridge descriptors. If the</span>
<a name="l00087"></a>00087 <span class="comment"> * user is running a normal relay, its descriptor will always be</span>
<a name="l00088"></a>00088 <span class="comment"> * published regardless of this setting. */</span>
<a name="l00089"></a>00089 <span class="keywordtype">void</span> <a class="code" href="class_server_settings.html#a47644bb280ab9940becc2edb5fb345b5">setPublishServerDescriptor</a>(<span class="keywordtype">bool</span> publish);<span class="comment"></span>
<a name="l00090"></a>00090 <span class="comment"> /** Returns true if the user's server descriptor will be published to</span>
<a name="l00091"></a>00091 <span class="comment"> * the appropriate authorities. */</span>
<a name="l00092"></a>00092 <span class="keywordtype">bool</span> <a class="code" href="class_server_settings.html#afc0daa865e87d83ef9050967ee3f9404">publishServerDescriptor</a>() <span class="keyword">const</span>;
<a name="l00093"></a>00093 <span class="comment"></span>
<a name="l00094"></a>00094 <span class="comment"> /** Configure port forwarding. */</span>
<a name="l00095"></a>00095 <span class="keywordtype">void</span> <a class="code" href="class_server_settings.html#a23f08c9a01e392157a092edefa9fcae0">configurePortForwarding</a>();
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <span class="keywordtype">void</span> <a class="code" href="class_server_settings.html#a7ad953b22dcd629061e11b2a86d1c98f">cleanupPortForwarding</a>();
<a name="l00098"></a>00098 <span class="comment"></span>
<a name="l00099"></a>00099 <span class="comment"> /** Returns true if UPnP support is enabled. */</span>
<a name="l00100"></a>00100 <span class="keywordtype">bool</span> <a class="code" href="class_server_settings.html#a421e1da362a29f7d2a5bda3ba065faf2">isUpnpEnabled</a>();<span class="comment"></span>
<a name="l00101"></a>00101 <span class="comment"> /** Sets whether Vidalia should try to configure port forwarding using UPnP. */</span>
<a name="l00102"></a>00102 <span class="keywordtype">void</span> <a class="code" href="class_server_settings.html#a5d731b4a7a4e08035a631118054b05e6">setUpnpEnabled</a>(<span class="keywordtype">bool</span> enabled);
<a name="l00103"></a>00103
<a name="l00104"></a>00104 <span class="keyword">protected</span>:<span class="comment"></span>
<a name="l00105"></a>00105 <span class="comment"> /** Virtual method called when we retrieve a server-related setting from Tor.</span>
<a name="l00106"></a>00106 <span class="comment"> * Currently this just translates BandwidthFoo to RelayBandwidthFoo when</span>
<a name="l00107"></a>00107 <span class="comment"> * appropriate. */</span>
<a name="l00108"></a>00108 <span class="keyword">virtual</span> QVariant <a class="code" href="class_server_settings.html#a264c9f00c4cd4b1eb2d4b624b1e7633b">torValue</a>(<span class="keyword">const</span> QString &key) <span class="keyword">const</span>;
<a name="l00109"></a>00109
<a name="l00110"></a>00110 <span class="keyword">private</span>:<span class="comment"></span>
<a name="l00111"></a>00111 <span class="comment"> /** Returns Tor-recognizable configuration keys and current values. */</span>
<a name="l00112"></a>00112 QHash<QString,QString> <a class="code" href="class_server_settings.html#a6ca0466032d355a9e90a013b669fda51">confValues</a>();
<a name="l00113"></a>00113 };
<a name="l00114"></a>00114
<a name="l00115"></a>00115 <span class="preprocessor">#endif</span>
<a name="l00116"></a>00116 <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
>
281
