<!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: AddressMap.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>AddressMap.h</h1><a href="_address_map_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 AddressMap.h</span> <a name="l00013"></a>00013 <span class="comment">** \version $Id: bandwidthevent.h 1563 2006-12-26 06:06:04Z edmanm $</span> <a name="l00014"></a>00014 <span class="comment">** \brief Stores a list of address mappings and their expiration times</span> <a name="l00015"></a>00015 <span class="comment">*/</span> <a name="l00016"></a>00016 <a name="l00017"></a>00017 <span class="preprocessor">#ifndef _ADDRESSMAP_H</span> <a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define _ADDRESSMAP_H</span> <a name="l00019"></a>00019 <span class="preprocessor"></span> <a name="l00020"></a>00020 <span class="preprocessor">#include <QHash></span> <a name="l00021"></a>00021 <span class="preprocessor">#include <QDateTime></span> <a name="l00022"></a>00022 <span class="preprocessor">#include <QPair></span> <a name="l00023"></a>00023 <span class="comment"></span> <a name="l00024"></a>00024 <span class="comment">/** Defines a type that pairs a mapping's target address with an expiration</span> <a name="l00025"></a>00025 <span class="comment"> * time for that mapping. */</span> <a name="l00026"></a><a class="code" href="_address_map_8h.html#aea1301cb291459a2b3a61054d3bf3041">00026</a> <span class="keyword">typedef</span> QPair<QString, QDateTime> <a class="code" href="_address_map_8h.html#aea1301cb291459a2b3a61054d3bf3041">AddressMapEntry</a>; <a name="l00027"></a>00027 <a name="l00028"></a>00028 <a name="l00029"></a><a class="code" href="class_address_map.html">00029</a> <span class="keyword">class </span><a class="code" href="class_address_map.html">AddressMap</a> : <span class="keyword">public</span> QHash<QString, AddressMapEntry> <a name="l00030"></a>00030 { <a name="l00031"></a>00031 <span class="keyword">public</span>:<span class="comment"></span> <a name="l00032"></a>00032 <span class="comment"> /** Types of address mappings. */</span> <a name="l00033"></a><a class="code" href="class_address_map.html#a06fbb154318e85e74c8f910bc919c699">00033</a> <span class="keyword">enum</span> <a class="code" href="class_address_map.html#a06fbb154318e85e74c8f910bc919c699">AddressMapType</a> { <a name="l00034"></a><a class="code" href="class_address_map.html#a06fbb154318e85e74c8f910bc919c699a51c09671b349aa01898a627a03932c39">00034</a> <a class="code" href="class_address_map.html#a06fbb154318e85e74c8f910bc919c699a51c09671b349aa01898a627a03932c39">AddressMapAll</a>, <span class="comment">/**< All address mapping types. */</span> <a name="l00035"></a><a class="code" href="class_address_map.html#a06fbb154318e85e74c8f910bc919c699ad7d4a9ef73ce448f61e4722c2f418951">00035</a> <a class="code" href="class_address_map.html#a06fbb154318e85e74c8f910bc919c699ad7d4a9ef73ce448f61e4722c2f418951">AddressMapConfig</a>, <span class="comment">/**< Address mappings set in the torrc. */</span> <a name="l00036"></a><a class="code" href="class_address_map.html#a06fbb154318e85e74c8f910bc919c699a8879352eb46e6b9b030b6dd481ad04ea">00036</a> <a class="code" href="class_address_map.html#a06fbb154318e85e74c8f910bc919c699a8879352eb46e6b9b030b6dd481ad04ea">AddressMapCache</a>, <span class="comment">/**< Address mappings cached by Tor. */</span> <a name="l00037"></a><a class="code" href="class_address_map.html#a06fbb154318e85e74c8f910bc919c699ad5b426af09f0b2f329bea8818045cb64">00037</a> <a class="code" href="class_address_map.html#a06fbb154318e85e74c8f910bc919c699ad5b426af09f0b2f329bea8818045cb64">AddressMapControl</a> <span class="comment">/**< Address mappings set by a controller. */</span> <a name="l00038"></a>00038 }; <a name="l00039"></a>00039 <span class="comment"></span> <a name="l00040"></a>00040 <span class="comment"> /** Constructor. Creates an empty table for storing address mappinsgs. */</span> <a name="l00041"></a><a class="code" href="class_address_map.html#a79c6b2d569b160aca8ea0c41ca6c401f">00041</a> <a class="code" href="class_address_map.html#a79c6b2d569b160aca8ea0c41ca6c401f">AddressMap</a>() <a name="l00042"></a>00042 : QHash<QString, <a class="code" href="_address_map_8h.html#aea1301cb291459a2b3a61054d3bf3041">AddressMapEntry</a>>() {} <a name="l00043"></a>00043 <span class="comment"></span> <a name="l00044"></a>00044 <span class="comment"> /** Adds a new address mapping or updates an existing one for the address</span> <a name="l00045"></a>00045 <span class="comment"> * specified by <b>from</b>. The mapping will remain valid until the date in</span> <a name="l00046"></a>00046 <span class="comment"> * <b>expires</b>. */</span> <a name="l00047"></a>00047 <span class="keywordtype">void</span> <a class="code" href="class_address_map.html#a1bb12511981bfe02622253b514748698">add</a>(<span class="keyword">const</span> QString &from, <span class="keyword">const</span> QString &to, <span class="keyword">const</span> QDateTime &expires);<span class="comment"></span> <a name="l00048"></a>00048 <span class="comment"> /** Adds a new address mapping or updates an existing one based on fields</span> <a name="l00049"></a>00049 <span class="comment"> * parsed from <b>mapping</b>. */</span> <a name="l00050"></a>00050 <span class="keywordtype">void</span> <a class="code" href="class_address_map.html#a1bb12511981bfe02622253b514748698">add</a>(<span class="keyword">const</span> QString &mapping); <a name="l00051"></a>00051 <span class="comment"></span> <a name="l00052"></a>00052 <span class="comment"> /** Returns true if the address map table contains a mapping for <b>addr</b></span> <a name="l00053"></a>00053 <span class="comment"> * that is not expired. */</span> <a name="l00054"></a>00054 <span class="keywordtype">bool</span> <a class="code" href="class_address_map.html#aeab78837799234d133513a819a877979">isMapped</a>(<span class="keyword">const</span> QString &addr) <span class="keyword">const</span>; <a name="l00055"></a>00055 <span class="comment"></span> <a name="l00056"></a>00056 <span class="comment"> /** Returns the address to which <b>addr</b> is currently mapped. If there</span> <a name="l00057"></a>00057 <span class="comment"> * is no mapping for <b>addr</b> (or the mapping is expired), then an</span> <a name="l00058"></a>00058 <span class="comment"> * empty string is returned. */</span> <a name="l00059"></a>00059 QString <a class="code" href="class_address_map.html#a86c87e42aeb13954088468390d15dd9e">mappedTo</a>(<span class="keyword">const</span> QString &addr) <span class="keyword">const</span>; <a name="l00060"></a>00060 <span class="comment"></span> <a name="l00061"></a>00061 <span class="comment"> /** Returns the reverse of this address map. */</span> <a name="l00062"></a>00062 <a class="code" href="class_address_map.html">AddressMap</a> <a class="code" href="class_address_map.html#a9f0b073b8bbb6b5392602bd256f7ac14">reverse</a>() <span class="keyword">const</span>; <a name="l00063"></a>00063 <a name="l00064"></a>00064 <span class="keyword">private</span>:<span class="comment"></span> <a name="l00065"></a>00065 <span class="comment"> /** Returns true if <b>entry</b> is expired; false otherwise. */</span> <a name="l00066"></a>00066 <span class="keywordtype">bool</span> <a class="code" href="class_address_map.html#a3459e8cad420ef5594dafeed50e4b315">isExpired</a>(<span class="keyword">const</span> <a class="code" href="_address_map_8h.html#aea1301cb291459a2b3a61054d3bf3041">AddressMapEntry</a> &entry) <span class="keyword">const</span>; <a name="l00067"></a>00067 }; <a name="l00068"></a>00068 <a name="l00069"></a>00069 <span class="preprocessor">#endif</span> <a name="l00070"></a>00070 <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>