nakidai
/
shooter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
shooter/SFML/doc/html/classsf_1_1IpAddress.html

562 lines
34 KiB
HTML
Raw Normal View History

OS Windows support
2021-10-09 13:41:12 +03:00
<!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>
<title>SFML - Simple and Fast Multimedia Library</title>
<meta http-equiv="Content-Type" content="text/html;"/>
<meta charset="utf-8"/>
<!--<link rel='stylesheet' type='text/css' href="https://fonts.googleapis.com/css?family=Ubuntu:400,700,400italic"/>-->
<link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
</head>
<body>
<div id="banner-container">
<div id="banner">
<span id="sfml">SFML 2.5.1</span>
</div>
</div>
<div id="content">
<!-- Generated by Doxygen 1.8.14 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>sf</b></li><li class="navelem"><a class="el" href="classsf_1_1IpAddress.html">IpAddress</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classsf_1_1IpAddress-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">sf::IpAddress Class Reference<div class="ingroups"><a class="el" href="group__network.html">Network module</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Encapsulate an IPv4 network address.
<a href="classsf_1_1IpAddress.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="IpAddress_8hpp_source.html">IpAddress.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af32a0574baa0f46e48deb2d83ca7658b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1IpAddress.html#af32a0574baa0f46e48deb2d83ca7658b">IpAddress</a> ()</td></tr>
<tr class="memdesc:af32a0574baa0f46e48deb2d83ca7658b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <a href="#af32a0574baa0f46e48deb2d83ca7658b">More...</a><br /></td></tr>
<tr class="separator:af32a0574baa0f46e48deb2d83ca7658b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a656b7445ab04cabaa7398685bc09c3f7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1IpAddress.html#a656b7445ab04cabaa7398685bc09c3f7">IpAddress</a> (const std::string &amp;address)</td></tr>
<tr class="memdesc:a656b7445ab04cabaa7398685bc09c3f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct the address from a string. <a href="#a656b7445ab04cabaa7398685bc09c3f7">More...</a><br /></td></tr>
<tr class="separator:a656b7445ab04cabaa7398685bc09c3f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92f2a9be74334a61b96c2fc79fe6eb78"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1IpAddress.html#a92f2a9be74334a61b96c2fc79fe6eb78">IpAddress</a> (const char *address)</td></tr>
<tr class="memdesc:a92f2a9be74334a61b96c2fc79fe6eb78"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct the address from a string. <a href="#a92f2a9be74334a61b96c2fc79fe6eb78">More...</a><br /></td></tr>
<tr class="separator:a92f2a9be74334a61b96c2fc79fe6eb78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d289dcb9ce7a64c600c6f84cba88cc6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1IpAddress.html#a1d289dcb9ce7a64c600c6f84cba88cc6">IpAddress</a> (Uint8 byte0, Uint8 byte1, Uint8 byte2, Uint8 byte3)</td></tr>
<tr class="memdesc:a1d289dcb9ce7a64c600c6f84cba88cc6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct the address from 4 bytes. <a href="#a1d289dcb9ce7a64c600c6f84cba88cc6">More...</a><br /></td></tr>
<tr class="separator:a1d289dcb9ce7a64c600c6f84cba88cc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ed34ba3a40d70eb9f09ac5ae779a162"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1IpAddress.html#a8ed34ba3a40d70eb9f09ac5ae779a162">IpAddress</a> (Uint32 address)</td></tr>
<tr class="memdesc:a8ed34ba3a40d70eb9f09ac5ae779a162"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct the address from a 32-bits integer. <a href="#a8ed34ba3a40d70eb9f09ac5ae779a162">More...</a><br /></td></tr>
<tr class="separator:a8ed34ba3a40d70eb9f09ac5ae779a162"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88507954142d7fc2176cce7f36422340"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1IpAddress.html#a88507954142d7fc2176cce7f36422340">toString</a> () const</td></tr>
<tr class="memdesc:a88507954142d7fc2176cce7f36422340"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a string representation of the address. <a href="#a88507954142d7fc2176cce7f36422340">More...</a><br /></td></tr>
<tr class="separator:a88507954142d7fc2176cce7f36422340"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7911c5ea9562f9602c3e29cd54b15e9"><td class="memItemLeft" align="right" valign="top">Uint32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1IpAddress.html#ae7911c5ea9562f9602c3e29cd54b15e9">toInteger</a> () const</td></tr>
<tr class="memdesc:ae7911c5ea9562f9602c3e29cd54b15e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get an integer representation of the address. <a href="#ae7911c5ea9562f9602c3e29cd54b15e9">More...</a><br /></td></tr>
<tr class="separator:ae7911c5ea9562f9602c3e29cd54b15e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a4c31622ad87edca48adbb8e8ed00ee4a"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classsf_1_1IpAddress.html">IpAddress</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1IpAddress.html#a4c31622ad87edca48adbb8e8ed00ee4a">getLocalAddress</a> ()</td></tr>
<tr class="memdesc:a4c31622ad87edca48adbb8e8ed00ee4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the computer's local address. <a href="#a4c31622ad87edca48adbb8e8ed00ee4a">More...</a><br /></td></tr>
<tr class="separator:a4c31622ad87edca48adbb8e8ed00ee4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c5cbf67e4aacf23c24f2ad991df4c55"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classsf_1_1IpAddress.html">IpAddress</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1IpAddress.html#a5c5cbf67e4aacf23c24f2ad991df4c55">getPublicAddress</a> (<a class="el" href="classsf_1_1Time.html">Time</a> timeout=<a class="el" href="classsf_1_1Time.html#a8db127b632fa8da21550e7282af11fa0">Time::Zero</a>)</td></tr>
<tr class="memdesc:a5c5cbf67e4aacf23c24f2ad991df4c55"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the computer's public address. <a href="#a5c5cbf67e4aacf23c24f2ad991df4c55">More...</a><br /></td></tr>
<tr class="separator:a5c5cbf67e4aacf23c24f2ad991df4c55"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a4619b4abbe3c8fef056e7299db967404"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classsf_1_1IpAddress.html">IpAddress</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1IpAddress.html#a4619b4abbe3c8fef056e7299db967404">None</a></td></tr>
<tr class="memdesc:a4619b4abbe3c8fef056e7299db967404"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value representing an empty/invalid address. <a href="#a4619b4abbe3c8fef056e7299db967404">More...</a><br /></td></tr>
<tr class="separator:a4619b4abbe3c8fef056e7299db967404"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3dbc10b0dc6804cc69e29342f7406907"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classsf_1_1IpAddress.html">IpAddress</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1IpAddress.html#a3dbc10b0dc6804cc69e29342f7406907">Any</a></td></tr>
<tr class="memdesc:a3dbc10b0dc6804cc69e29342f7406907"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value representing any address (0.0.0.0) <a href="#a3dbc10b0dc6804cc69e29342f7406907">More...</a><br /></td></tr>
<tr class="separator:a3dbc10b0dc6804cc69e29342f7406907"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a594d3a8e2559f8fa8ab0a96fa597333b"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classsf_1_1IpAddress.html">IpAddress</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1IpAddress.html#a594d3a8e2559f8fa8ab0a96fa597333b">LocalHost</a></td></tr>
<tr class="memdesc:a594d3a8e2559f8fa8ab0a96fa597333b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The "localhost" address (for connecting a computer to itself locally) <a href="#a594d3a8e2559f8fa8ab0a96fa597333b">More...</a><br /></td></tr>
<tr class="separator:a594d3a8e2559f8fa8ab0a96fa597333b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa93d1d57b65d243f2baf804b6035465c"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classsf_1_1IpAddress.html">IpAddress</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1IpAddress.html#aa93d1d57b65d243f2baf804b6035465c">Broadcast</a></td></tr>
<tr class="memdesc:aa93d1d57b65d243f2baf804b6035465c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The "broadcast" address (for sending UDP messages to everyone on a local network) <a href="#aa93d1d57b65d243f2baf804b6035465c">More...</a><br /></td></tr>
<tr class="separator:aa93d1d57b65d243f2baf804b6035465c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a4886da3f195b8c30d415a94a7009fdd7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1IpAddress.html#a4886da3f195b8c30d415a94a7009fdd7">operator&lt;</a> (const <a class="el" href="classsf_1_1IpAddress.html">IpAddress</a> &amp;left, const <a class="el" href="classsf_1_1IpAddress.html">IpAddress</a> &amp;right)</td></tr>
<tr class="memdesc:a4886da3f195b8c30d415a94a7009fdd7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload of &lt; operator to compare two IP addresses. <a href="#a4886da3f195b8c30d415a94a7009fdd7">More...</a><br /></td></tr>
<tr class="separator:a4886da3f195b8c30d415a94a7009fdd7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Encapsulate an IPv4 network address. </p>
<p><a class="el" href="classsf_1_1IpAddress.html" title="Encapsulate an IPv4 network address. ">sf::IpAddress</a> is a utility class for manipulating network addresses.</p>
<p>It provides a set a implicit constructors and conversion functions to easily build or transform an IP address from/to various representations.</p>
<p>Usage example: </p><div class="fragment"><div class="line"><a class="code" href="classsf_1_1IpAddress.html">sf::IpAddress</a> a0; <span class="comment">// an invalid address</span></div><div class="line"><a class="code" href="classsf_1_1IpAddress.html">sf::IpAddress</a> a1 = <a class="code" href="classsf_1_1IpAddress.html#a4619b4abbe3c8fef056e7299db967404">sf::IpAddress::None</a>; <span class="comment">// an invalid address (same as a0)</span></div><div class="line"><a class="code" href="classsf_1_1IpAddress.html">sf::IpAddress</a> a2(<span class="stringliteral">&quot;127.0.0.1&quot;</span>); <span class="comment">// the local host address</span></div><div class="line"><a class="code" href="classsf_1_1IpAddress.html">sf::IpAddress</a> a3 = <a class="code" href="classsf_1_1IpAddress.html#aa93d1d57b65d243f2baf804b6035465c">sf::IpAddress::Broadcast</a>; <span class="comment">// the broadcast address</span></div><div class="line"><a class="code" href="classsf_1_1IpAddress.html">sf::IpAddress</a> a4(192, 168, 1, 56); <span class="comment">// a local address</span></div><div class="line"><a class="code" href="classsf_1_1IpAddress.html">sf::IpAddress</a> a5(<span class="stringliteral">&quot;my_computer&quot;</span>); <span class="comment">// a local address created from a network name</span></div><div class="line"><a class="code" href="classsf_1_1IpAddress.html">sf::IpAddress</a> a6(<span class="stringliteral">&quot;89.54.1.169&quot;</span>); <span class="comment">// a distant address</span></div><div class="line"><a class="code" href="classsf_1_1IpAddress.html">sf::IpAddress</a> a7(<span class="stringliteral">&quot;www.google.com&quot;</span>); <span class="comment">// a distant address created from a network name</span></div><div class="line"><a class="code" href="classsf_1_1IpAddress.html">sf::IpAddress</a> a8 = <a class="code" href="classsf_1_1IpAddress.html#a4c31622ad87edca48adbb8e8ed00ee4a">sf::IpAddress::getLocalAddress</a>(); <span class="comment">// my address on the local network</span></div><div class="line"><a class="code" href="classsf_1_1IpAddress.html">sf::IpAddress</a> a9 = <a class="code" href="classsf_1_1IpAddress.html#a5c5cbf67e4aacf23c24f2ad991df4c55">sf::IpAddress::getPublicAddress</a>(); <span class="comment">// my address on the internet</span></div></div><!-- fragment --><p>Note that <a class="el" href="classsf_1_1IpAddress.html" title="Encapsulate an IPv4 network address. ">sf::IpAddress</a> currently doesn't support IPv6 nor other types of network addresses. </p>
<p class="definition">Definition at line <a class="el" href="IpAddress_8hpp_source.html#l00044">44</a> of file <a class="el" href="IpAddress_8hpp_source.html">IpAddress.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af32a0574baa0f46e48deb2d83ca7658b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af32a0574baa0f46e48deb2d83ca7658b">&#9670;&nbsp;</a></span>IpAddress() <span class="overload">[1/5]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sf::IpAddress::IpAddress </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor. </p>
<p>This constructor creates an empty (invalid) address </p>
</div>
</div>
<a id="a656b7445ab04cabaa7398685bc09c3f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a656b7445ab04cabaa7398685bc09c3f7">&#9670;&nbsp;</a></span>IpAddress() <span class="overload">[2/5]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sf::IpAddress::IpAddress </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>address</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct the address from a string. </p>
<p>Here <em>address</em> can be either a decimal address (ex: "192.168.1.56") or a network name (ex: "localhost").</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">address</td><td>IP address or network name </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a92f2a9be74334a61b96c2fc79fe6eb78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a92f2a9be74334a61b96c2fc79fe6eb78">&#9670;&nbsp;</a></span>IpAddress() <span class="overload">[3/5]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sf::IpAddress::IpAddress </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>address</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct the address from a string. </p>
<p>Here <em>address</em> can be either a decimal address (ex: "192.168.1.56") or a network name (ex: "localhost"). This is equivalent to the constructor taking a std::string parameter, it is defined for convenience so that the implicit conversions from literal strings to <a class="el" href="classsf_1_1IpAddress.html" title="Encapsulate an IPv4 network address. ">IpAddress</a> work.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">address</td><td>IP address or network name </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a1d289dcb9ce7a64c600c6f84cba88cc6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d289dcb9ce7a64c600c6f84cba88cc6">&#9670;&nbsp;</a></span>IpAddress() <span class="overload">[4/5]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sf::IpAddress::IpAddress </td>
<td>(</td>
<td class="paramtype">Uint8&#160;</td>
<td class="paramname"><em>byte0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Uint8&#160;</td>
<td class="paramname"><em>byte1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Uint8&#160;</td>
<td class="paramname"><em>byte2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Uint8&#160;</td>
<td class="paramname"><em>byte3</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct the address from 4 bytes. </p>
<p>Calling IpAddress(a, b, c, d) is equivalent to calling <a class="el" href="classsf_1_1IpAddress.html" title="Encapsulate an IPv4 network address. ">IpAddress</a>("a.b.c.d"), but safer as it doesn't have to parse a string to get the address components.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">byte0</td><td>First byte of the address </td></tr>
<tr><td class="paramname">byte1</td><td>Second byte of the address </td></tr>
<tr><td class="paramname">byte2</td><td>Third byte of the address </td></tr>
<tr><td class="paramname">byte3</td><td>Fourth byte of the address </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8ed34ba3a40d70eb9f09ac5ae779a162"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ed34ba3a40d70eb9f09ac5ae779a162">&#9670;&nbsp;</a></span>IpAddress() <span class="overload">[5/5]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">sf::IpAddress::IpAddress </td>
<td>(</td>
<td class="paramtype">Uint32&#160;</td>
<td class="paramname"><em>address</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct the address from a 32-bits integer. </p>
<p>This constructor uses the internal representation of the address directly. It should be used for optimization purposes, and only if you got that representation from <a class="el" href="classsf_1_1IpAddress.html#ae7911c5ea9562f9602c3e29cd54b15e9" title="Get an integer representation of the address. ">IpAddress::toInteger()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">address</td><td>4 bytes of the address packed into a 32-bits integer</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1IpAddress.html#ae7911c5ea9562f9602c3e29cd54b15e9" title="Get an integer representation of the address. ">toInteger</a> </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a4c31622ad87edca48adbb8e8ed00ee4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c31622ad87edca48adbb8e8ed00ee4a">&#9670;&nbsp;</a></span>getLocalAddress()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classsf_1_1IpAddress.html">IpAddress</a> sf::IpAddress::getLocalAddress </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the computer's local address. </p>
<p>The local address is the address of the computer from the LAN point of view, i.e. something like 192.168.1.56. It is meaningful only for communications over the local network. Unlike getPublicAddress, this function is fast and may be used safely anywhere.</p>
<dl class="section return"><dt>Returns</dt><dd>Local IP address of the computer</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1IpAddress.html#a5c5cbf67e4aacf23c24f2ad991df4c55" title="Get the computer&#39;s public address. ">getPublicAddress</a> </dd></dl>
</div>
</div>
<a id="a5c5cbf67e4aacf23c24f2ad991df4c55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c5cbf67e4aacf23c24f2ad991df4c55">&#9670;&nbsp;</a></span>getPublicAddress()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classsf_1_1IpAddress.html">IpAddress</a> sf::IpAddress::getPublicAddress </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classsf_1_1Time.html">Time</a>&#160;</td>
<td class="paramname"><em>timeout</em> = <code><a class="el" href="classsf_1_1Time.html#a8db127b632fa8da21550e7282af11fa0">Time::Zero</a></code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the computer's public address. </p>
<p>The public address is the address of the computer from the internet point of view, i.e. something like 89.54.1.169. It is necessary for communications over the world wide web. The only way to get a public address is to ask it to a distant website; as a consequence, this function depends on both your network connection and the server, and may be very slow. You should use it as few as possible. Because this function depends on the network connection and on a distant server, you may use a time limit if you don't want your program to be possibly stuck waiting in case there is a problem; this limit is deactivated by default.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">timeout</td><td>Maximum time to wait</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Public IP address of the computer</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1IpAddress.html#a4c31622ad87edca48adbb8e8ed00ee4a" title="Get the computer&#39;s local address. ">getLocalAddress</a> </dd></dl>
</div>
</div>
<a id="ae7911c5ea9562f9602c3e29cd54b15e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7911c5ea9562f9602c3e29cd54b15e9">&#9670;&nbsp;</a></span>toInteger()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Uint32 sf::IpAddress::toInteger </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get an integer representation of the address. </p>
<p>The returned number is the internal representation of the address, and should be used for optimization purposes only (like sending the address through a socket). The integer produced by this function can then be converted back to a <a class="el" href="classsf_1_1IpAddress.html" title="Encapsulate an IPv4 network address. ">sf::IpAddress</a> with the proper constructor.</p>
<dl class="section return"><dt>Returns</dt><dd>32-bits unsigned integer representation of the address</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1IpAddress.html#a88507954142d7fc2176cce7f36422340" title="Get a string representation of the address. ">toString</a> </dd></dl>
</div>
</div>
<a id="a88507954142d7fc2176cce7f36422340"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88507954142d7fc2176cce7f36422340">&#9670;&nbsp;</a></span>toString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string sf::IpAddress::toString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a string representation of the address. </p>
<p>The returned string is the decimal representation of the IP address (like "192.168.1.56"), even if it was constructed from a host name.</p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings. ">String</a> representation of the address</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1IpAddress.html#ae7911c5ea9562f9602c3e29cd54b15e9" title="Get an integer representation of the address. ">toInteger</a> </dd></dl>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a4886da3f195b8c30d415a94a7009fdd7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4886da3f195b8c30d415a94a7009fdd7">&#9670;&nbsp;</a></span>operator&lt;</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool operator&lt; </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1IpAddress.html">IpAddress</a> &amp;&#160;</td>
<td class="paramname"><em>left</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classsf_1_1IpAddress.html">IpAddress</a> &amp;&#160;</td>
<td class="paramname"><em>right</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Overload of &lt; operator to compare two IP addresses. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">left</td><td>Left operand (a IP address) </td></tr>
<tr><td class="paramname">right</td><td>Right operand (a IP address)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if <em>left</em> is lesser than <em>right</em> </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a3dbc10b0dc6804cc69e29342f7406907"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3dbc10b0dc6804cc69e29342f7406907">&#9670;&nbsp;</a></span>Any</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classsf_1_1IpAddress.html">IpAddress</a> sf::IpAddress::Any</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Value representing any address (0.0.0.0) </p>
<p class="definition">Definition at line <a class="el" href="IpAddress_8hpp_source.html#l00185">185</a> of file <a class="el" href="IpAddress_8hpp_source.html">IpAddress.hpp</a>.</p>
</div>
</div>
<a id="aa93d1d57b65d243f2baf804b6035465c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa93d1d57b65d243f2baf804b6035465c">&#9670;&nbsp;</a></span>Broadcast</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classsf_1_1IpAddress.html">IpAddress</a> sf::IpAddress::Broadcast</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The "broadcast" address (for sending UDP messages to everyone on a local network) </p>
<p class="definition">Definition at line <a class="el" href="IpAddress_8hpp_source.html#l00187">187</a> of file <a class="el" href="IpAddress_8hpp_source.html">IpAddress.hpp</a>.</p>
</div>
</div>
<a id="a594d3a8e2559f8fa8ab0a96fa597333b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a594d3a8e2559f8fa8ab0a96fa597333b">&#9670;&nbsp;</a></span>LocalHost</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classsf_1_1IpAddress.html">IpAddress</a> sf::IpAddress::LocalHost</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The "localhost" address (for connecting a computer to itself locally) </p>
<p class="definition">Definition at line <a class="el" href="IpAddress_8hpp_source.html#l00186">186</a> of file <a class="el" href="IpAddress_8hpp_source.html">IpAddress.hpp</a>.</p>
</div>
</div>
<a id="a4619b4abbe3c8fef056e7299db967404"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4619b4abbe3c8fef056e7299db967404">&#9670;&nbsp;</a></span>None</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classsf_1_1IpAddress.html">IpAddress</a> sf::IpAddress::None</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Value representing an empty/invalid address. </p>
<p class="definition">Definition at line <a class="el" href="IpAddress_8hpp_source.html#l00184">184</a> of file <a class="el" href="IpAddress_8hpp_source.html">IpAddress.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="IpAddress_8hpp_source.html">IpAddress.hpp</a></li>
</ul>
</div><!-- contents -->
</div>
<div id="footer-container">
<div id="footer">
SFML is licensed under the terms and conditions of the <a href="https://www.sfml-dev.org/license.php">zlib/png license</a>.<br>
Copyright &copy; Laurent Gomila &nbsp;::&nbsp;
Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen</a> &nbsp;::&nbsp;
</div>
</div>
</body>
</html>