<!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: ExitPolicy.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>ExitPolicy.h</h1><a href="_exit_policy_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 ExitPolicy.h</span> <a name="l00013"></a>00013 <span class="comment">** \version $Id: ExitPolicy.h 3735 2009-04-28 20:28:01Z edmanm $</span> <a name="l00014"></a>00014 <span class="comment">** \brief Collection of Policy objects representing an exit policy</span> <a name="l00015"></a>00015 <span class="comment">*/</span> <a name="l00016"></a>00016 <a name="l00017"></a>00017 <span class="preprocessor">#ifndef _EXITPOLICY_H</span> <a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define _EXITPOLICY_H</span> <a name="l00019"></a>00019 <span class="preprocessor"></span> <a name="l00020"></a>00020 <span class="preprocessor">#include "<a class="code" href="_policy_8h.html">Policy.h</a>"</span> <a name="l00021"></a>00021 <a name="l00022"></a>00022 <span class="preprocessor">#include <QList></span> <a name="l00023"></a>00023 <span class="preprocessor">#include <QString></span> <a name="l00024"></a>00024 <span class="preprocessor">#include <QStringList></span> <a name="l00025"></a>00025 <a name="l00026"></a>00026 <a name="l00027"></a><a class="code" href="class_exit_policy.html">00027</a> <span class="keyword">class </span><a class="code" href="class_exit_policy.html">ExitPolicy</a> <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"> /** Special exit policy types. */</span> <a name="l00031"></a><a class="code" href="class_exit_policy.html#aa76586108b81e24f0bd8dfb51bd77ab8">00031</a> <span class="keyword">enum</span> <a class="code" href="class_exit_policy.html#aa76586108b81e24f0bd8dfb51bd77ab8">SpecialExitPolicy</a> { <a name="l00032"></a><a class="code" href="class_exit_policy.html#aa76586108b81e24f0bd8dfb51bd77ab8a4a36006dbba2412e631cb58c1f9ef1be">00032</a> <a class="code" href="class_exit_policy.html#aa76586108b81e24f0bd8dfb51bd77ab8a4a36006dbba2412e631cb58c1f9ef1be">Default</a>, <span class="comment">/**< Specifies the default exit policy. */</span> <a name="l00033"></a><a class="code" href="class_exit_policy.html#aa76586108b81e24f0bd8dfb51bd77ab8a24858f3513ce54fbe91e759465b16475">00033</a> <a class="code" href="class_exit_policy.html#aa76586108b81e24f0bd8dfb51bd77ab8a24858f3513ce54fbe91e759465b16475">Middleman</a> <span class="comment">/**< Specifies a middleman-only exit policy. */</span> <a name="l00034"></a>00034 }; <a name="l00035"></a>00035 <span class="comment"></span> <a name="l00036"></a>00036 <span class="comment"> /** Default constructor. */</span> <a name="l00037"></a>00037 <a class="code" href="class_exit_policy.html#a40310febcf3741c6bf40f5f70f68cd95">ExitPolicy</a>();<span class="comment"></span> <a name="l00038"></a>00038 <span class="comment"> /** Creates an exit policy of the given special type. */</span> <a name="l00039"></a>00039 <a class="code" href="class_exit_policy.html#a40310febcf3741c6bf40f5f70f68cd95">ExitPolicy</a>(<a class="code" href="class_exit_policy.html#aa76586108b81e24f0bd8dfb51bd77ab8">SpecialExitPolicy</a> exitPolicy);<span class="comment"></span> <a name="l00040"></a>00040 <span class="comment"> /** Creates an exit policy from the given comma-delimited list of policies. */</span> <a name="l00041"></a>00041 <a class="code" href="class_exit_policy.html#a40310febcf3741c6bf40f5f70f68cd95">ExitPolicy</a>(QString exitPolicy); <a name="l00042"></a>00042 <span class="comment"></span> <a name="l00043"></a>00043 <span class="comment"> /** Adds the ports specified in <b>portList</b> to a list of ports accepted</span> <a name="l00044"></a>00044 <span class="comment"> * by this exit policy. Ports may be given either individually or as ranges. */</span> <a name="l00045"></a>00045 <span class="keywordtype">void</span> <a class="code" href="class_exit_policy.html#abb358858e8cf140b930943d15b4d743d">addAcceptedPorts</a>(QStringList portList);<span class="comment"></span> <a name="l00046"></a>00046 <span class="comment"> /** Returns true if this exit policy accepts all ports specified in</span> <a name="l00047"></a>00047 <span class="comment"> * <b>portList</b>. Ports in <b>portList</b> may be given either individually</span> <a name="l00048"></a>00048 <span class="comment"> * or as ranges. */</span> <a name="l00049"></a>00049 <span class="keywordtype">bool</span> <a class="code" href="class_exit_policy.html#a634ccfc40ed6daa9ed7caa1c8c20c56b">acceptsPorts</a>(QStringList portList);<span class="comment"></span> <a name="l00050"></a>00050 <span class="comment"> /** Adds the ports specified in <b>portList</b> to a list of ports rejected</span> <a name="l00051"></a>00051 <span class="comment"> * by this exit policy. Ports may be given either individually or as ranges. */</span> <a name="l00052"></a>00052 <span class="keywordtype">void</span> <a class="code" href="class_exit_policy.html#a14f68328010c547221e43238384e81e4">addRejectedPorts</a>(QStringList portList);<span class="comment"></span> <a name="l00053"></a>00053 <span class="comment"> /** Returns true if this exit policy rejects all ports specified in</span> <a name="l00054"></a>00054 <span class="comment"> * <b>portList</b>. Ports in <b>portList</b> may be given either individually</span> <a name="l00055"></a>00055 <span class="comment"> * or as ranges. */</span> <a name="l00056"></a>00056 <span class="keywordtype">bool</span> <a class="code" href="class_exit_policy.html#a45f5f82dfbef2afe395616cd498cfc42">rejectsPorts</a>(QStringList portList); <a name="l00057"></a>00057 <span class="comment"></span> <a name="l00058"></a>00058 <span class="comment"> /** Adds a rule to the exit policy. */</span> <a name="l00059"></a>00059 <span class="keywordtype">void</span> <a class="code" href="class_exit_policy.html#a33a84b6960ceb03da71a43a31f4230b0">addPolicy</a>(<a class="code" href="class_policy.html">Policy</a> policy);<span class="comment"></span> <a name="l00060"></a>00060 <span class="comment"> /** Removes a rule from the exit policy. */</span> <a name="l00061"></a>00061 <span class="keywordtype">void</span> <a class="code" href="class_exit_policy.html#aeafd48ab4738b84474b14156c925863f">removePolicy</a>(<a class="code" href="class_policy.html">Policy</a> policy);<span class="comment"></span> <a name="l00062"></a>00062 <span class="comment"> /** Checks if the current exit policy contains the given rule. */</span> <a name="l00063"></a>00063 <span class="keywordtype">bool</span> <a class="code" href="class_exit_policy.html#a04f512b4828d51f4d950bae0b90b3258">contains</a>(<a class="code" href="class_policy.html">Policy</a> policy); <a name="l00064"></a>00064 <span class="comment"></span> <a name="l00065"></a>00065 <span class="comment"> /** Returns the list of policies for this exit policy. */</span> <a name="l00066"></a><a class="code" href="class_exit_policy.html#a0ba9d171634d1e1e346eb664ae579b32">00066</a> QList<Policy> <a class="code" href="class_exit_policy.html#a0ba9d171634d1e1e346eb664ae579b32">policyList</a>() { <span class="keywordflow">return</span> <a class="code" href="class_exit_policy.html#a5171cc94377d66e52ec703a9d02cb7fe">_exitPolicy</a>; } <a name="l00067"></a>00067 <span class="comment"></span> <a name="l00068"></a>00068 <span class="comment"> /** Converts the exit policy to a format Tor understands. */</span> <a name="l00069"></a>00069 QString <a class="code" href="class_exit_policy.html#a8178aa3e7eac2aedc6c680a85f1b57f6">toString</a>(); <a name="l00070"></a>00070 <a name="l00071"></a>00071 <span class="keyword">private</span>:<span class="comment"></span> <a name="l00072"></a>00072 <span class="comment"> /** A collection of policies forming the exit policy. */</span> <a name="l00073"></a><a class="code" href="class_exit_policy.html#a5171cc94377d66e52ec703a9d02cb7fe">00073</a> QList<Policy> <a class="code" href="class_exit_policy.html#a5171cc94377d66e52ec703a9d02cb7fe">_exitPolicy</a>; <a name="l00074"></a>00074 }; <a name="l00075"></a>00075 <a name="l00076"></a>00076 <span class="preprocessor">#endif</span> <a name="l00077"></a>00077 <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>