<!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: GeoIp.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_3776330d706700e272fa8df738fecea6.html">network</a>
</div>
</div>
<div class="contents">
<h1>GeoIp.h</h1><a href="_geo_ip_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 GeoIp.h</span>
<a name="l00013"></a>00013 <span class="comment">** \version $Id: GeoIp.h 3768 2009-05-13 19:07:26Z edmanm $</span>
<a name="l00014"></a>00014 <span class="comment">** \brief Associates an IP with a geographic location</span>
<a name="l00015"></a>00015 <span class="comment">*/</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef _GEOIP_H</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define _GEOIP_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 <QString></span>
<a name="l00022"></a>00022 <span class="preprocessor">#include <QHostAddress></span>
<a name="l00023"></a>00023
<a name="l00024"></a>00024
<a name="l00025"></a><a class="code" href="class_geo_ip.html">00025</a> <span class="keyword">class </span><a class="code" href="class_geo_ip.html">GeoIp</a>
<a name="l00026"></a>00026 {
<a name="l00027"></a>00027 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00028"></a>00028 <span class="comment"> /** Default constructor. Creates an empty GeoIp object.</span>
<a name="l00029"></a>00029 <span class="comment"> */</span>
<a name="l00030"></a>00030 <a class="code" href="class_geo_ip.html#a57de196f00ca7dacd7036f317c9dfbaa">GeoIp</a>();
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <a class="code" href="class_geo_ip.html#a57de196f00ca7dacd7036f317c9dfbaa">GeoIp</a>(<span class="keyword">const</span> QHostAddress &<a class="code" href="class_geo_ip.html#a054c1b4097bc3cb0bbdd30d4bd8ed6d2">ip</a>, <span class="keywordtype">float</span> <a class="code" href="class_geo_ip.html#adb5de17f48460151e1fb336239f97e4d">latitude</a>, <span class="keywordtype">float</span> <a class="code" href="class_geo_ip.html#af2313a1436e88c21528423d7807c763c">longitude</a>,
<a name="l00033"></a>00033 <span class="keyword">const</span> QString &<a class="code" href="class_geo_ip.html#a0c2bea77a6db423f81ea57a20812aebe">city</a> = QString(),
<a name="l00034"></a>00034 <span class="keyword">const</span> QString &<a class="code" href="class_geo_ip.html#ab99038e02e34edae10d98a1e3b6c82dc">region</a> = QString(),
<a name="l00035"></a>00035 <span class="keyword">const</span> QString &<a class="code" href="class_geo_ip.html#a44cbaa4bd1ced6dea5233ed3cf417679">country</a> = QString(),
<a name="l00036"></a>00036 <span class="keyword">const</span> QString &<a class="code" href="class_geo_ip.html#a3ac50f7bf1046b6368a73c4071622880">countryCode</a> = QString());
<a name="l00037"></a>00037 <span class="comment"></span>
<a name="l00038"></a>00038 <span class="comment"> /** Returns the IP address associated with this GeoIP object.</span>
<a name="l00039"></a>00039 <span class="comment"> */</span>
<a name="l00040"></a><a class="code" href="class_geo_ip.html#a054c1b4097bc3cb0bbdd30d4bd8ed6d2">00040</a> QHostAddress <a class="code" href="class_geo_ip.html#a054c1b4097bc3cb0bbdd30d4bd8ed6d2">ip</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_geo_ip.html#a36d80a5160733468cb19e6fc3e630e8b">_ip</a>; }
<a name="l00041"></a>00041 <span class="comment"></span>
<a name="l00042"></a>00042 <span class="comment"> /** Returns the latitude portion of the geographic coordinates associated</span>
<a name="l00043"></a>00043 <span class="comment"> * with this IP address or range of IP addresses.</span>
<a name="l00044"></a>00044 <span class="comment"> */</span>
<a name="l00045"></a><a class="code" href="class_geo_ip.html#adb5de17f48460151e1fb336239f97e4d">00045</a> <span class="keywordtype">float</span> <a class="code" href="class_geo_ip.html#adb5de17f48460151e1fb336239f97e4d">latitude</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_geo_ip.html#af376e3d3e1b070bb32a5516412b4a262">_latitude</a>; }
<a name="l00046"></a>00046 <span class="comment"></span>
<a name="l00047"></a>00047 <span class="comment"> /** Returns the longitude portion of the geographic coordinates associated</span>
<a name="l00048"></a>00048 <span class="comment"> * with this IP address or range of IP addresses.</span>
<a name="l00049"></a>00049 <span class="comment"> */</span>
<a name="l00050"></a><a class="code" href="class_geo_ip.html#af2313a1436e88c21528423d7807c763c">00050</a> <span class="keywordtype">float</span> <a class="code" href="class_geo_ip.html#af2313a1436e88c21528423d7807c763c">longitude</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_geo_ip.html#a61ff5ae809f38be07f4cf63b529aad67">_longitude</a>; }
<a name="l00051"></a>00051 <span class="comment"></span>
<a name="l00052"></a>00052 <span class="comment"> /** Returns the name of the city associated with this IP address, if known.</span>
<a name="l00053"></a>00053 <span class="comment"> * Otherwise, returns an empty QString.</span>
<a name="l00054"></a>00054 <span class="comment"> */</span>
<a name="l00055"></a><a class="code" href="class_geo_ip.html#a0c2bea77a6db423f81ea57a20812aebe">00055</a> QString <a class="code" href="class_geo_ip.html#a0c2bea77a6db423f81ea57a20812aebe">city</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_geo_ip.html#a35cea7998d8ebe401acc7231da88005e">_city</a>; }
<a name="l00056"></a>00056 <span class="comment"></span>
<a name="l00057"></a>00057 <span class="comment"> /** Returns the full region name (e.g., state) in which this IP address </span>
<a name="l00058"></a>00058 <span class="comment"> * resides, if known. Otherwise, returns an empty QString.</span>
<a name="l00059"></a>00059 <span class="comment"> */</span>
<a name="l00060"></a><a class="code" href="class_geo_ip.html#ab99038e02e34edae10d98a1e3b6c82dc">00060</a> QString <a class="code" href="class_geo_ip.html#ab99038e02e34edae10d98a1e3b6c82dc">region</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_geo_ip.html#a7afdcd5f2dc76074412a563ebae96cfb">_region</a>; }
<a name="l00061"></a>00061 <span class="comment"></span>
<a name="l00062"></a>00062 <span class="comment"> /** Returns the full name of the country associated with this IP address</span>
<a name="l00063"></a>00063 <span class="comment"> * or range of IP addresses, if known. Otherwise, returns an empty QString.</span>
<a name="l00064"></a>00064 <span class="comment"> */</span>
<a name="l00065"></a><a class="code" href="class_geo_ip.html#a44cbaa4bd1ced6dea5233ed3cf417679">00065</a> QString <a class="code" href="class_geo_ip.html#a44cbaa4bd1ced6dea5233ed3cf417679">country</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_geo_ip.html#a97cf375c1eba0f296e153cd851446026">_country</a>; }
<a name="l00066"></a>00066 <span class="comment"></span>
<a name="l00067"></a>00067 <span class="comment"> /** Returns the ISO 3166-1 alpha-2 two-letter country code of the country</span>
<a name="l00068"></a>00068 <span class="comment"> * associated with this IP address or range of IP addresses, if known.</span>
<a name="l00069"></a>00069 <span class="comment"> * Otherwise, returns an empty QString.</span>
<a name="l00070"></a>00070 <span class="comment"> */</span>
<a name="l00071"></a><a class="code" href="class_geo_ip.html#a3ac50f7bf1046b6368a73c4071622880">00071</a> QString <a class="code" href="class_geo_ip.html#a3ac50f7bf1046b6368a73c4071622880">countryCode</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_geo_ip.html#abee9fb603172607877055d70b356dcce">_countryCode</a>; }
<a name="l00072"></a>00072 <span class="comment"></span>
<a name="l00073"></a>00073 <span class="comment"> /** Returns a human-readable string of city, region(state), and country.</span>
<a name="l00074"></a>00074 <span class="comment"> * Some fields may be absent if they are not known. If no fields are known,</span>
<a name="l00075"></a>00075 <span class="comment"> * this will return an empty QString.</span>
<a name="l00076"></a>00076 <span class="comment"> */</span>
<a name="l00077"></a>00077 QString <a class="code" href="class_geo_ip.html#a821197ccf11820d24544f39b6e01296f">toString</a>() <span class="keyword">const</span>;
<a name="l00078"></a>00078 <span class="comment"></span>
<a name="l00079"></a>00079 <span class="comment"> /** Returns true if the GeoIp object is valid. A valid GeoIp object must</span>
<a name="l00080"></a>00080 <span class="comment"> * have valid IP address, valid latitude and longitude coordinates and a </span>
<a name="l00081"></a>00081 <span class="comment"> * two-letter country code.</span>
<a name="l00082"></a>00082 <span class="comment"> */</span>
<a name="l00083"></a>00083 <span class="keywordtype">bool</span> <a class="code" href="class_geo_ip.html#a188bc1ae5f0a4cfa40e808a65647431a">isValid</a>() <span class="keyword">const</span>;
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="keyword">private</span>:
<a name="l00086"></a><a class="code" href="class_geo_ip.html#a36d80a5160733468cb19e6fc3e630e8b">00086</a> QHostAddress <a class="code" href="class_geo_ip.html#a36d80a5160733468cb19e6fc3e630e8b">_ip</a>; <span class="comment">/**< IP address for this location. */</span>
<a name="l00087"></a><a class="code" href="class_geo_ip.html#af376e3d3e1b070bb32a5516412b4a262">00087</a> <span class="keywordtype">float</span> <a class="code" href="class_geo_ip.html#af376e3d3e1b070bb32a5516412b4a262">_latitude</a>; <span class="comment">/**< Latitudinal coordinate for this IP's location. */</span>
<a name="l00088"></a><a class="code" href="class_geo_ip.html#a61ff5ae809f38be07f4cf63b529aad67">00088</a> <span class="keywordtype">float</span> <a class="code" href="class_geo_ip.html#a61ff5ae809f38be07f4cf63b529aad67">_longitude</a>; <span class="comment">/**< Longitudinal coordinate for this IP's location. */</span>
<a name="l00089"></a><a class="code" href="class_geo_ip.html#a35cea7998d8ebe401acc7231da88005e">00089</a> QString <a class="code" href="class_geo_ip.html#a35cea7998d8ebe401acc7231da88005e">_city</a>; <span class="comment">/**< City in which this IP lives. */</span>
<a name="l00090"></a><a class="code" href="class_geo_ip.html#a7afdcd5f2dc76074412a563ebae96cfb">00090</a> QString <a class="code" href="class_geo_ip.html#a7afdcd5f2dc76074412a563ebae96cfb">_region</a>; <span class="comment">/**< State or district in which this IP lives. */</span>
<a name="l00091"></a><a class="code" href="class_geo_ip.html#a97cf375c1eba0f296e153cd851446026">00091</a> QString <a class="code" href="class_geo_ip.html#a97cf375c1eba0f296e153cd851446026">_country</a>; <span class="comment">/**< Country in which this IP lives. */</span>
<a name="l00092"></a><a class="code" href="class_geo_ip.html#abee9fb603172607877055d70b356dcce">00092</a> QString <a class="code" href="class_geo_ip.html#abee9fb603172607877055d70b356dcce">_countryCode</a>; <span class="comment">/**< ISO-3166-1 alpha-2 country code. */</span>
<a name="l00093"></a>00093 };
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="preprocessor">#endif</span>
<a name="l00096"></a>00096 <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>
