<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GNU CommonC++: ost::IPV4Address Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<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 id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a></div>
<h1>ost::IPV4Address Class Reference</h1><!-- doxytag: class="ost::IPV4Address" -->The network name and address objects are all derived from a common <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> base class.Internet Address binary data type.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="address_8h-source.html">address.h</a>></code>
<p>
<p>Inheritance diagram for ost::IPV4Address:
<p><center><img src="classost_1_1_i_p_v4_address.png" usemap="#ost::IPV4Address_map" border="0" alt=""></center>
<map name="ost::IPV4Address_map">
<area href="classost_1_1_i_p_v4_broadcast.html" alt="ost::IPV4Broadcast" shape="rect" coords="0,56,118,80">
<area href="classost_1_1_i_p_v4_host.html" alt="ost::IPV4Host" shape="rect" coords="128,56,246,80">
<area href="classost_1_1_i_p_v4_mask.html" alt="ost::IPV4Mask" shape="rect" coords="256,56,374,80">
<area href="classost_1_1_i_p_v4_multicast.html" alt="ost::IPV4Multicast" shape="rect" coords="384,56,502,80">
</map>
<a href="classost_1_1_i_p_v4_address-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#05ba4c9d7a44d647ac2b5d443c529cba">IPV4Address</a> (const <a class="el" href="classost_1_1_i_p_v4_validator.html">IPV4Validator</a> *validator=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an Internet Address object with an empty (0.0.0.0) address. <a href="#05ba4c9d7a44d647ac2b5d443c529cba"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#0aef6689f1b3c419cd28add796fde0c8">IPV4Address</a> (struct in_addr addr, const <a class="el" href="classost_1_1_i_p_v4_validator.html">IPV4Validator</a> *validator=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert the system internet address data type (struct in_addr) into a Common C++ <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> object. <a href="#0aef6689f1b3c419cd28add796fde0c8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#b77c0c8301677b654cd64c94c8442f6f">IPV4Address</a> (const char *address, const <a class="el" href="classost_1_1_i_p_v4_validator.html">IPV4Validator</a> *validator=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a null terminated ASCII host address string (example: "127.0.0.1") or host address name (example: "www.voxilla.org") directly into a Common C++ <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> object. <a href="#b77c0c8301677b654cd64c94c8442f6f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#e3fd5fd2919e5934cd7b3ae2d9b752b3">IPV4Address</a> (const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> &rhs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#e3fd5fd2919e5934cd7b3ae2d9b752b3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#c8c4c826369f4ce356df0392cc595c9d">~IPV4Address</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#c8c4c826369f4ce356df0392cc595c9d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#af68688cd2253cdcd313a12ab6177167">getHostname</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provide a string representation of the value (Internet Address) held in the <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> object. <a href="#af68688cd2253cdcd313a12ab6177167"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#68aa94e15b9b662ddded4fb3e4810933">isInetAddress</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">May be used to verify if a given <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> returned by another function contains a "valid" address, or "0.0.0.0" which is often used to mark "invalid" <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> values. <a href="#68aa94e15b9b662ddded4fb3e4810933"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">in_addr </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#43a862793e22c0cf16416470490423b1">getAddress</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provide a low level system usable struct in_addr object from the contents of <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a>. <a href="#43a862793e22c0cf16416470490423b1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">in_addr </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#0e47b365f8d88e343963533ad54ca302">getAddress</a> (size_t i) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provide a low level system usable struct in_addr object from the contents of <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a>. <a href="#0e47b365f8d88e343963533ad54ca302"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#90c4bc29684968f09d5cf61f3d7d7524">getAddressCount</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of internet addresses that an <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> object contains. <a href="#90c4bc29684968f09d5cf61f3d7d7524"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#aeab0179a7fa73673815e1cc623ab709">operator=</a> (const char *str)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#3d81a8ccf64b8647426e18e534c48e5d">operator=</a> (struct in_addr addr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#c59145207f75857c414ade190e618290">operator=</a> (const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> &rhs)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#c05d9c4599ad313dec545a9e89e7e2d5">operator=</a> (unsigned long addr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allows assignment from the return of functions like inet_addr() or htonl(). <a href="#c05d9c4599ad313dec545a9e89e7e2d5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#8198f8d8f9fae2de78194fc26c3b44c6">operator=</a> (unsigned int addr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#028f090c2d60034c3cbc4a23efafd356">operator!</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#f1ddac78ac54d96dca8462fccd34233d">operator==</a> (const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> &a) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compare two internet addresses to see if they are equal (if they specify the physical address of the same internet host). <a href="#f1ddac78ac54d96dca8462fccd34233d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#e905a9689c6c05d6c3eb70ebadf8b9ab">operator!=</a> (const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> &a) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compare two internet addresses to see if they are not equal (if they each refer to unique and different physical ip addresses). <a href="#e905a9689c6c05d6c3eb70ebadf8b9ab"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#928ae39893ca3d158505c527610f9a84">setIPAddress</a> (const char *host)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the IP address from a string representation of the numeric address, ie "127.0.0.1". <a href="#928ae39893ca3d158505c527610f9a84"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#3a2e12b44eb5455b2c68b1b84bd2a31f">setAddress</a> (const char *host)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to specify a host name or numeric internet address. <a href="#3a2e12b44eb5455b2c68b1b84bd2a31f"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">in_addr * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#4437ba1e6bde3e8252df8a1a591ecfe5">ipaddr</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#3128cf0e2832071593f940717b484e88">addr_count</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#9c3cc2812bf79827298211ed4ca4550b">hostname</a></td></tr>
<tr><td colspan="2"><br><h2>Static Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classost_1_1_mutex.html">Mutex</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#5bbe8d3806115e2c4882efb728ba039d">mutex</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The network name and address objects are all derived from a common <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> base class.Internet Address binary data type.
<p>
Specific classes, such as <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a>, <a class="el" href="classost_1_1_i_p_v4_mask.html">IPV4Mask</a>, etc, are defined from <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> entirely so that the manner a network address is being used can easily be documented and understood from the code and to avoid common errors and accidental misuse of the wrong address object. For example, a "connection" to something that is declared as a "IPV4Host" can be kept type-safe from a "connection" accidently being made to something that was declared a "IPV4Broadcast".<p>
<dl compact><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<p>
<a class="el" href="tcpthread_8cpp-example.html#_a81">tcpthread.cpp</a>.</dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="05ba4c9d7a44d647ac2b5d443c529cba"></a><!-- doxytag: member="ost::IPV4Address::IPV4Address" ref="05ba4c9d7a44d647ac2b5d443c529cba" args="(const IPV4Validator *validator=NULL)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::IPV4Address::IPV4Address </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_i_p_v4_validator.html">IPV4Validator</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>validator</em> = <code>NULL</code> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create an Internet Address object with an empty (0.0.0.0) address.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>validator</em> </td><td>optional validator function object, intended for derived classes. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="0aef6689f1b3c419cd28add796fde0c8"></a><!-- doxytag: member="ost::IPV4Address::IPV4Address" ref="0aef6689f1b3c419cd28add796fde0c8" args="(struct in_addr addr, const IPV4Validator *validator=NULL)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::IPV4Address::IPV4Address </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">struct in_addr </td>
<td class="mdname" nowrap> <em>addr</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const <a class="el" href="classost_1_1_i_p_v4_validator.html">IPV4Validator</a> * </td>
<td class="mdname" nowrap> <em>validator</em> = <code>NULL</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Convert the system internet address data type (struct in_addr) into a Common C++ <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>addr</em> </td><td>struct of system used binary internet address. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>validator</em> </td><td>optional validator function object, intended for derived classes. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="b77c0c8301677b654cd64c94c8442f6f"></a><!-- doxytag: member="ost::IPV4Address::IPV4Address" ref="b77c0c8301677b654cd64c94c8442f6f" args="(const char *address, const IPV4Validator *validator=NULL)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::IPV4Address::IPV4Address </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>address</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const <a class="el" href="classost_1_1_i_p_v4_validator.html">IPV4Validator</a> * </td>
<td class="mdname" nowrap> <em>validator</em> = <code>NULL</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Convert a null terminated ASCII host address string (example: "127.0.0.1") or host address name (example: "www.voxilla.org") directly into a Common C++ <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>address</em> </td><td>null terminated C string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>validator</em> </td><td>optional validator function object, intended for derived classes. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="e3fd5fd2919e5934cd7b3ae2d9b752b3"></a><!-- doxytag: member="ost::IPV4Address::IPV4Address" ref="e3fd5fd2919e5934cd7b3ae2d9b752b3" args="(const IPV4Address &rhs)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::IPV4Address::IPV4Address </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>rhs</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Copy constructor.
<p>
</td>
</tr>
</table>
<a class="anchor" name="c8c4c826369f4ce356df0392cc595c9d"></a><!-- doxytag: member="ost::IPV4Address::~IPV4Address" ref="c8c4c826369f4ce356df0392cc595c9d" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual ost::IPV4Address::~IPV4Address </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Destructor.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="0e47b365f8d88e343963533ad54ca302"></a><!-- doxytag: member="ost::IPV4Address::getAddress" ref="0e47b365f8d88e343963533ad54ca302" args="(size_t i) const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">struct in_addr ost::IPV4Address::getAddress </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">size_t </td>
<td class="mdname1" valign="top" nowrap> <em>i</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Provide a low level system usable struct in_addr object from the contents of <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a>.
<p>
This is needed for services such as bind() and connect().<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>i</em> </td><td>for IPV4Addresses with multiple addresses, returns the address at this index. User should call <a class="el" href="classost_1_1_i_p_v4_address.html#90c4bc29684968f09d5cf61f3d7d7524">getAddressCount()</a> to determine the number of address the object contains. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>system binary coded internet address. If parameter i is out of range, the first address is returned. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="43a862793e22c0cf16416470490423b1"></a><!-- doxytag: member="ost::IPV4Address::getAddress" ref="43a862793e22c0cf16416470490423b1" args="(void) const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">struct in_addr ost::IPV4Address::getAddress </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Provide a low level system usable struct in_addr object from the contents of <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a>.
<p>
This is needed for services such as bind() and connect().<p>
<dl compact><dt><b>Returns:</b></dt><dd>system binary coded internet address. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="90c4bc29684968f09d5cf61f3d7d7524"></a><!-- doxytag: member="ost::IPV4Address::getAddressCount" ref="90c4bc29684968f09d5cf61f3d7d7524" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">size_t ost::IPV4Address::getAddressCount </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns the number of internet addresses that an <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> object contains.
<p>
This usually only happens with <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> objects where multiple IP addresses are returned for a DNS lookup </td>
</tr>
</table>
<a class="anchor" name="af68688cd2253cdcd313a12ab6177167"></a><!-- doxytag: member="ost::IPV4Address::getHostname" ref="af68688cd2253cdcd313a12ab6177167" args="(void) const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">const char* ost::IPV4Address::getHostname </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Provide a string representation of the value (Internet Address) held in the <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> object.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>string representation of <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a>. </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="tcpthread_8cpp-example.html#a82">tcpthread.cpp</a>.</dl> </td>
</tr>
</table>
<a class="anchor" name="68aa94e15b9b662ddded4fb3e4810933"></a><!-- doxytag: member="ost::IPV4Address::isInetAddress" ref="68aa94e15b9b662ddded4fb3e4810933" args="(void) const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool ost::IPV4Address::isInetAddress </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
May be used to verify if a given <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> returned by another function contains a "valid" address, or "0.0.0.0" which is often used to mark "invalid" <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> values.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>true if address != 0.0.0.0. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="028f090c2d60034c3cbc4a23efafd356"></a><!-- doxytag: member="ost::IPV4Address::operator!" ref="028f090c2d60034c3cbc4a23efafd356" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool ost::IPV4Address::operator! </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="e905a9689c6c05d6c3eb70ebadf8b9ab"></a><!-- doxytag: member="ost::IPV4Address::operator!=" ref="e905a9689c6c05d6c3eb70ebadf8b9ab" args="(const IPV4Address &a) const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool ost::IPV4Address::operator!= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>a</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Compare two internet addresses to see if they are not equal (if they each refer to unique and different physical ip addresses).
<p>
This is implimented in terms of operator== </td>
</tr>
</table>
<a class="anchor" name="8198f8d8f9fae2de78194fc26c3b44c6"></a><!-- doxytag: member="ost::IPV4Address::operator=" ref="8198f8d8f9fae2de78194fc26c3b44c6" args="(unsigned int addr)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a>& ost::IPV4Address::operator= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned int </td>
<td class="mdname1" valign="top" nowrap> <em>addr</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="c05d9c4599ad313dec545a9e89e7e2d5"></a><!-- doxytag: member="ost::IPV4Address::operator=" ref="c05d9c4599ad313dec545a9e89e7e2d5" args="(unsigned long addr)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a>& ost::IPV4Address::operator= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned long </td>
<td class="mdname1" valign="top" nowrap> <em>addr</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Allows assignment from the return of functions like inet_addr() or htonl().
<p>
<p>
Reimplemented in <a class="el" href="classost_1_1_i_p_v4_mask.html#49ec7fe09dfcc3b9a963e2dc6f1186d4">ost::IPV4Mask</a>, and <a class="el" href="classost_1_1_i_p_v4_host.html#28be54aa5dd6c5ed9feeeb6c76ab0b27">ost::IPV4Host</a>. </td>
</tr>
</table>
<a class="anchor" name="c59145207f75857c414ade190e618290"></a><!-- doxytag: member="ost::IPV4Address::operator=" ref="c59145207f75857c414ade190e618290" args="(const IPV4Address &rhs)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a>& ost::IPV4Address::operator= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>rhs</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="3d81a8ccf64b8647426e18e534c48e5d"></a><!-- doxytag: member="ost::IPV4Address::operator=" ref="3d81a8ccf64b8647426e18e534c48e5d" args="(struct in_addr addr)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a>& ost::IPV4Address::operator= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">struct in_addr </td>
<td class="mdname1" valign="top" nowrap> <em>addr</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="aeab0179a7fa73673815e1cc623ab709"></a><!-- doxytag: member="ost::IPV4Address::operator=" ref="aeab0179a7fa73673815e1cc623ab709" args="(const char *str)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a>& ost::IPV4Address::operator= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>str</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="f1ddac78ac54d96dca8462fccd34233d"></a><!-- doxytag: member="ost::IPV4Address::operator==" ref="f1ddac78ac54d96dca8462fccd34233d" args="(const IPV4Address &a) const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool ost::IPV4Address::operator== </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>a</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Compare two internet addresses to see if they are equal (if they specify the physical address of the same internet host).
<p>
If there is more than one IP address in either <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> object, this will return true if all of the IP addresses in the smaller are in the larger in any order. </td>
</tr>
</table>
<a class="anchor" name="3a2e12b44eb5455b2c68b1b84bd2a31f"></a><!-- doxytag: member="ost::IPV4Address::setAddress" ref="3a2e12b44eb5455b2c68b1b84bd2a31f" args="(const char *host)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::IPV4Address::setAddress </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>host</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Used to specify a host name or numeric internet address.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>host</em> </td><td>The string representation of the IP address or a hostname, , if NULL, it will default to INADDR_ANY </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="928ae39893ca3d158505c527610f9a84"></a><!-- doxytag: member="ost::IPV4Address::setIPAddress" ref="928ae39893ca3d158505c527610f9a84" args="(const char *host)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool ost::IPV4Address::setIPAddress </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>host</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Sets the IP address from a string representation of the numeric address, ie "127.0.0.1".
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>host</em> </td><td>The string representation of the IP address </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>true if successful </dd></dl>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="3128cf0e2832071593f940717b484e88"></a><!-- doxytag: member="ost::IPV4Address::addr_count" ref="3128cf0e2832071593f940717b484e88" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">size_t <a class="el" href="classost_1_1_i_p_v4_address.html#3128cf0e2832071593f940717b484e88">ost::IPV4Address::addr_count</a><code> [protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="9c3cc2812bf79827298211ed4ca4550b"></a><!-- doxytag: member="ost::IPV4Address::hostname" ref="9c3cc2812bf79827298211ed4ca4550b" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">char* <a class="el" href="classost_1_1_i_p_v4_address.html#9c3cc2812bf79827298211ed4ca4550b">ost::IPV4Address::hostname</a><code> [mutable, protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="4437ba1e6bde3e8252df8a1a591ecfe5"></a><!-- doxytag: member="ost::IPV4Address::ipaddr" ref="4437ba1e6bde3e8252df8a1a591ecfe5" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">struct in_addr* <a class="el" href="classost_1_1_i_p_v4_address.html#4437ba1e6bde3e8252df8a1a591ecfe5">ost::IPV4Address::ipaddr</a><code> [protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="5bbe8d3806115e2c4882efb728ba039d"></a><!-- doxytag: member="ost::IPV4Address::mutex" ref="5bbe8d3806115e2c4882efb728ba039d" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_mutex.html">Mutex</a> <a class="el" href="classost_1_1_i_p_v4_address.html#5bbe8d3806115e2c4882efb728ba039d">ost::IPV4Address::mutex</a><code> [static, protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="address_8h-source.html">address.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:55 2006 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>
