<html> <head><title>ClanLib Reference: CL_IPAddress</title></head> <body text=black link=blue vlink=#800080 bgcolor=white topmargin=0 leftmargin=0> <table border=0 cellspacing=0 cellpadding=0 width=100%><tr><td><img border=0 src="../images/eyeheader-main-purple-a.gif" alt="ClanSoft logo" width=525 height=96></td></tr> <tr bgcolor=#dadada><td align=left valign=top><img border=0 src="../images/eyeheader-main-purple-b.gif" alt="ClanSoft logo" width=190 height=14></td><td align=right valign=top><img border=0 src="../images/clanlib_light.gif" width=42 height=14></td></tr></table> <table align=center border=0 cellspacing=10> <tr> <td><a href="entire_class_index.html">Entire Class Index</a></td> <td><a href="class_index.html">Main Class Index</a></td> <td><a href="cross_index.html">Cross Index</a></td> <td><a href="global_index.html">Global Index</a></td> </table><h1 align=center>Class CL_IPAddress</h1><p> <b> Socket name; container class for an IP address and port.</b><br> Contained in: <a href="global_index.html">global</a><br> Derived from: <i>none</i> <br> Derived by: <i>none</i> <br>Group: Network (Sockets) <p> #include <ClanLib/network.h> <p> <hr noshade> <table border=0> <tr><td colspan=3><h3>public function member index:</h3></td> <tr valign=top><td align=left><h3>Construction:</h3></td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_IPAddress.html#1294"><tt><font color=blue><b>CL_IPAddress</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_IPAddress.html#1295"><tt><font color=blue><b>CL_IPAddress</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>port</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_IPAddress.html#1296"><tt><font color=blue><b>CL_IPAddress</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>hostname</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>port</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_IPAddress.html#1297"><tt><font color=blue><b>CL_IPAddress</b></font></tt></a></td><td><tt>(<tt>const</tt> <a href="CL_IPAddress.html#1297"><tt><font color=blue><b>CL_IPAddress</b></font></tt></a>& <tt><font color=blue>copy</font></tt>)</tt>;</td> <tr valign=top><td align=left><h3>Attributes:</h3></td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_IPAddress.html#1298"><tt><font color=blue><b>get_addrinfo</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>type</font></tt>, <tt><font color=navy>struct</font></tt> <tt><font color=blue>sockaddr</font></tt>& <tt><font color=blue>addr</font></tt>, <tt><font color=purple>int</font></tt>& <tt><font color=blue>len</font></tt>) <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt><font color=navy>std::string</font></tt></tt> </td><td align=right><a href="CL_IPAddress.html#1299"><tt><font color=blue><b>get_address</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt><font color=navy>std::string</font></tt></tt> </td><td align=right><a href="CL_IPAddress.html#1300"><tt><font color=blue><b>get_port</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_IPAddress.html#1301"><tt><font color=black><b>operator</b></font></tt><tt> == </tt></a></td><td><tt>(<tt>const</tt> <a href="CL_IPAddress.html#1297"><tt><font color=blue><b>CL_IPAddress</b></font></tt></a>& <tt><font color=blue>other_instance</font></tt>) <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_IPAddress.html#1302"><tt><font color=black><b>operator</b></font></tt><tt> < </tt></a></td><td><tt>(<tt>const</tt> <a href="CL_IPAddress.html#1297"><tt><font color=blue><b>CL_IPAddress</b></font></tt></a>& <tt><font color=blue>other_instance</font></tt>) <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_IPAddress.html#1303"><tt><font color=black><b>operator</b></font></tt><tt> > </tt></a></td><td><tt>(<tt>const</tt> <a href="CL_IPAddress.html#1297"><tt><font color=blue><b>CL_IPAddress</b></font></tt></a>& <tt><font color=blue>other_instance</font></tt>) <tt>const</tt></tt>;</td> <tr valign=top><td align=left><h3>Operations:</h3></td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_IPAddress.html#1304"><tt><font color=blue><b>set_address</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>hostname</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_IPAddress.html#1305"><tt><font color=blue><b>set_address</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>hostname</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>port</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_IPAddress.html#1306"><tt><font color=blue><b>set_port</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>port</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=navy>std::string</font></tt></tt> </td><td align=right><a href="CL_IPAddress.html#1307"><tt><font color=blue><b>dns_lookup</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> <p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="1294"><font size=+1><b>CL_IPAddress::CL_IPAddress</b></font></a> - Constructs an IP address using INADDR_ANY and port 0.<br><tt></tt> <a href="CL_IPAddress.html#1294"><tt><font color=blue><b>CL_IPAddress</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1295"><font size=+1><b>CL_IPAddress::CL_IPAddress</b></font></a> - Constructs an IP address using INADDR_ANY and the specified port.<br><tt></tt> <a href="CL_IPAddress.html#1295"><tt><font color=blue><b>CL_IPAddress</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>port</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1296"><font size=+1><b>CL_IPAddress::CL_IPAddress</b></font></a> - Construct an IP address using the hostname and the port.<br><tt></tt> <a href="CL_IPAddress.html#1296"><tt><font color=blue><b>CL_IPAddress</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>hostname</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>port</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1297"><font size=+1><b>CL_IPAddress::CL_IPAddress</b></font></a> - Copy constructor.<br><tt></tt> <a href="CL_IPAddress.html#1297"><tt><font color=blue><b>CL_IPAddress</b></font></tt></a><tt>(<tt>const</tt> <a href="CL_IPAddress.html#1297"><tt><font color=blue><b>CL_IPAddress</b></font></tt></a>& <tt><font color=blue>copy</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1307"><font size=+1><b>CL_IPAddress::dns_lookup</b></font></a> - Do a DNS lookup on the IP address.<br><tt><tt><font color=navy>std::string</font></tt></tt> <a href="CL_IPAddress.html#1307"><tt><font color=blue><b>dns_lookup</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1299"><font size=+1><b>CL_IPAddress::get_address</b></font></a> - Returns the IP address as a string.<br><tt><tt><font color=navy>std::string</font></tt></tt> <a href="CL_IPAddress.html#1299"><tt><font color=blue><b>get_address</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1298"><font size=+1><b>CL_IPAddress::get_addrinfo</b></font></a> - Returns the internal addrinfo struct<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_IPAddress.html#1298"><tt><font color=blue><b>get_addrinfo</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>type</font></tt>, <tt><font color=navy>struct</font></tt> <tt><font color=blue>sockaddr</font></tt>& <tt><font color=blue>addr</font></tt>, <tt><font color=purple>int</font></tt>& <tt><font color=blue>len</font></tt>) <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1300"><font size=+1><b>CL_IPAddress::get_port</b></font></a> - Returns the IP port as a string.<br><tt><tt><font color=navy>std::string</font></tt></tt> <a href="CL_IPAddress.html#1300"><tt><font color=blue><b>get_port</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1302"><font size=+1><b>CL_IPAddress::operator < </b></font></a> - Returns true if the other address is less.<br><tt><tt><font color=purple>bool</font></tt></tt> <a href="CL_IPAddress.html#1302"><tt><font color=black><b>operator</b></font></tt><tt> < </tt></a><tt>(<tt>const</tt> <a href="CL_IPAddress.html#1297"><tt><font color=blue><b>CL_IPAddress</b></font></tt></a>& <tt><font color=blue>other_instance</font></tt>) <tt>const</tt></tt>;<br><blockquote> <p>This is used for sorting<br> purposes (eg. if you use a std::map<CL_IPAddress, CL_Socket>), and sorts<br> the address based on lowest IP number address.</p></blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1301"><font size=+1><b>CL_IPAddress::operator == </b></font></a> - Returns true if objects are the same.<br><tt><tt><font color=purple>bool</font></tt></tt> <a href="CL_IPAddress.html#1301"><tt><font color=black><b>operator</b></font></tt><tt> == </tt></a><tt>(<tt>const</tt> <a href="CL_IPAddress.html#1297"><tt><font color=blue><b>CL_IPAddress</b></font></tt></a>& <tt><font color=blue>other_instance</font></tt>) <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1303"><font size=+1><b>CL_IPAddress::operator > </b></font></a> - Returns true if the other address is greater.<br><tt><tt><font color=purple>bool</font></tt></tt> <a href="CL_IPAddress.html#1303"><tt><font color=black><b>operator</b></font></tt><tt> > </tt></a><tt>(<tt>const</tt> <a href="CL_IPAddress.html#1297"><tt><font color=blue><b>CL_IPAddress</b></font></tt></a>& <tt><font color=blue>other_instance</font></tt>) <tt>const</tt></tt>;<br><blockquote> <p>This is used for sorting<br> purposes (eg. if you use a std::map<CL_IPAddress, CL_Socket>), and sorts<br> the address based on lowest IP number address.</p></blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1304"><font size=+1><b>CL_IPAddress::set_address</b></font></a> - Set the IP address using a hostname.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_IPAddress.html#1304"><tt><font color=blue><b>set_address</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>hostname</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1305"><font size=+1><b>CL_IPAddress::set_address</b></font></a> - Set the IP address using a hostname and port.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_IPAddress.html#1305"><tt><font color=blue><b>set_address</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>hostname</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>port</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1306"><font size=+1><b>CL_IPAddress::set_port</b></font></a> - Set the IP port.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_IPAddress.html#1306"><tt><font color=blue><b>set_port</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>port</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <hr noshade> <h2>Variable Member Descriptions:</h2> <hr noshade> </body> </html>
