<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>GNU CommonC++: ost::IPV4Address Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GNU CommonC++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</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>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceost.html">ost</a></li><li class="navelem"><a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#pro-static-attribs">Static Protected Attributes</a> |
<a href="classost_1_1_i_p_v4_address-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ost::IPV4Address Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The network name and address objects are all derived from a common <a class="el" href="classost_1_1_i_p_v4_address.html" title="The network name and address objects are all derived from a common IPV4Address base class...">IPV4Address</a> base class.
<a href="classost_1_1_i_p_v4_address.html#details">More...</a></p>
<p><code>#include <<a class="el" href="address_8h_source.html">address.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ost::IPV4Address:</div>
<div class="dyncontent">
<div class="center">
<img src="classost_1_1_i_p_v4_address.png" usemap="#ost::IPV4Address_map" alt=""/>
<map id="ost::IPV4Address_map" name="ost::IPV4Address_map">
<area href="classost_1_1_i_p_v4_broadcast.html" title="The broadcast address object is used to store the broadcast address for a specific subnet..." alt="ost::IPV4Broadcast" shape="rect" coords="0,56,118,80"/>
<area href="classost_1_1_i_p_v4_host.html" title="This object is used to hold the actual and valid internet address of a specific host machine that wil..." alt="ost::IPV4Host" shape="rect" coords="128,56,246,80"/>
<area href="classost_1_1_i_p_v4_mask.html" title="Internet addresses used specifically as masking addresses (such as " 255.255.255.0") are held in the ..." alt="ost::IPV4Mask" shape="rect" coords="256,56,374,80"/>
<area href="classost_1_1_i_p_v4_multicast.html" title="A specialization of IPV4Address that provides address validation for multicast addresses. " alt="ost::IPV4Multicast" shape="rect" coords="384,56,502,80"/>
</map>
</div></div>
<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:a05ba4c9d7a44d647ac2b5d443c529cba"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#a05ba4c9d7a44d647ac2b5d443c529cba">IPV4Address</a> (const <a class="el" href="classost_1_1_i_p_v4_validator.html">IPV4Validator</a> *validator=NULL)</td></tr>
<tr class="memdesc:a05ba4c9d7a44d647ac2b5d443c529cba"><td class="mdescLeft"> </td><td class="mdescRight">Create an Internet Address object with an empty (0.0.0.0) address. <a href="#a05ba4c9d7a44d647ac2b5d443c529cba">More...</a><br/></td></tr>
<tr class="separator:a05ba4c9d7a44d647ac2b5d443c529cba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0aef6689f1b3c419cd28add796fde0c8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#a0aef6689f1b3c419cd28add796fde0c8">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 class="memdesc:a0aef6689f1b3c419cd28add796fde0c8"><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" title="The network name and address objects are all derived from a common IPV4Address base class...">IPV4Address</a> object. <a href="#a0aef6689f1b3c419cd28add796fde0c8">More...</a><br/></td></tr>
<tr class="separator:a0aef6689f1b3c419cd28add796fde0c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab77c0c8301677b654cd64c94c8442f6f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#ab77c0c8301677b654cd64c94c8442f6f">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 class="memdesc:ab77c0c8301677b654cd64c94c8442f6f"><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" title="The network name and address objects are all derived from a common IPV4Address base class...">IPV4Address</a> object. <a href="#ab77c0c8301677b654cd64c94c8442f6f">More...</a><br/></td></tr>
<tr class="separator:ab77c0c8301677b654cd64c94c8442f6f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae3fd5fd2919e5934cd7b3ae2d9b752b3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#ae3fd5fd2919e5934cd7b3ae2d9b752b3">IPV4Address</a> (const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> &rhs)</td></tr>
<tr class="memdesc:ae3fd5fd2919e5934cd7b3ae2d9b752b3"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#ae3fd5fd2919e5934cd7b3ae2d9b752b3">More...</a><br/></td></tr>
<tr class="separator:ae3fd5fd2919e5934cd7b3ae2d9b752b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac8c4c826369f4ce356df0392cc595c9d"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#ac8c4c826369f4ce356df0392cc595c9d">~IPV4Address</a> ()</td></tr>
<tr class="memdesc:ac8c4c826369f4ce356df0392cc595c9d"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ac8c4c826369f4ce356df0392cc595c9d">More...</a><br/></td></tr>
<tr class="separator:ac8c4c826369f4ce356df0392cc595c9d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaf68688cd2253cdcd313a12ab6177167"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#aaf68688cd2253cdcd313a12ab6177167">getHostname</a> (void) const </td></tr>
<tr class="memdesc:aaf68688cd2253cdcd313a12ab6177167"><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" title="The network name and address objects are all derived from a common IPV4Address base class...">IPV4Address</a> object. <a href="#aaf68688cd2253cdcd313a12ab6177167">More...</a><br/></td></tr>
<tr class="separator:aaf68688cd2253cdcd313a12ab6177167"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a68aa94e15b9b662ddded4fb3e4810933"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#a68aa94e15b9b662ddded4fb3e4810933">isInetAddress</a> (void) const </td></tr>
<tr class="memdesc:a68aa94e15b9b662ddded4fb3e4810933"><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" title="The network name and address objects are all derived from a common IPV4Address base class...">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" title="The network name and address objects are all derived from a common IPV4Address base class...">IPV4Address</a> values. <a href="#a68aa94e15b9b662ddded4fb3e4810933">More...</a><br/></td></tr>
<tr class="separator:a68aa94e15b9b662ddded4fb3e4810933"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a43a862793e22c0cf16416470490423b1"><td class="memItemLeft" align="right" valign="top">struct in_addr </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#a43a862793e22c0cf16416470490423b1">getAddress</a> (void) const </td></tr>
<tr class="memdesc:a43a862793e22c0cf16416470490423b1"><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" title="The network name and address objects are all derived from a common IPV4Address base class...">IPV4Address</a>. <a href="#a43a862793e22c0cf16416470490423b1">More...</a><br/></td></tr>
<tr class="separator:a43a862793e22c0cf16416470490423b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0e47b365f8d88e343963533ad54ca302"><td class="memItemLeft" align="right" valign="top">struct in_addr </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#a0e47b365f8d88e343963533ad54ca302">getAddress</a> (size_t i) const </td></tr>
<tr class="memdesc:a0e47b365f8d88e343963533ad54ca302"><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" title="The network name and address objects are all derived from a common IPV4Address base class...">IPV4Address</a>. <a href="#a0e47b365f8d88e343963533ad54ca302">More...</a><br/></td></tr>
<tr class="separator:a0e47b365f8d88e343963533ad54ca302"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a90c4bc29684968f09d5cf61f3d7d7524"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#a90c4bc29684968f09d5cf61f3d7d7524">getAddressCount</a> () const </td></tr>
<tr class="memdesc:a90c4bc29684968f09d5cf61f3d7d7524"><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" title="The network name and address objects are all derived from a common IPV4Address base class...">IPV4Address</a> object contains. <a href="#a90c4bc29684968f09d5cf61f3d7d7524">More...</a><br/></td></tr>
<tr class="separator:a90c4bc29684968f09d5cf61f3d7d7524"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaeab0179a7fa73673815e1cc623ab709"><td class="memItemLeft" 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#aaeab0179a7fa73673815e1cc623ab709">operator=</a> (const char *str)</td></tr>
<tr class="separator:aaeab0179a7fa73673815e1cc623ab709"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3d81a8ccf64b8647426e18e534c48e5d"><td class="memItemLeft" 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#a3d81a8ccf64b8647426e18e534c48e5d">operator=</a> (struct in_addr addr)</td></tr>
<tr class="separator:a3d81a8ccf64b8647426e18e534c48e5d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac59145207f75857c414ade190e618290"><td class="memItemLeft" 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#ac59145207f75857c414ade190e618290">operator=</a> (const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> &rhs)</td></tr>
<tr class="separator:ac59145207f75857c414ade190e618290"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac05d9c4599ad313dec545a9e89e7e2d5"><td class="memItemLeft" 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#ac05d9c4599ad313dec545a9e89e7e2d5">operator=</a> (unsigned long addr)</td></tr>
<tr class="memdesc:ac05d9c4599ad313dec545a9e89e7e2d5"><td class="mdescLeft"> </td><td class="mdescRight">Allows assignment from the return of functions like inet_addr() or htonl() <a href="#ac05d9c4599ad313dec545a9e89e7e2d5">More...</a><br/></td></tr>
<tr class="separator:ac05d9c4599ad313dec545a9e89e7e2d5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8198f8d8f9fae2de78194fc26c3b44c6"><td class="memItemLeft" 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#a8198f8d8f9fae2de78194fc26c3b44c6">operator=</a> (unsigned int addr)</td></tr>
<tr class="separator:a8198f8d8f9fae2de78194fc26c3b44c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a028f090c2d60034c3cbc4a23efafd356"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#a028f090c2d60034c3cbc4a23efafd356">operator!</a> () const </td></tr>
<tr class="separator:a028f090c2d60034c3cbc4a23efafd356"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af1ddac78ac54d96dca8462fccd34233d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#af1ddac78ac54d96dca8462fccd34233d">operator==</a> (const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> &a) const </td></tr>
<tr class="memdesc:af1ddac78ac54d96dca8462fccd34233d"><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="#af1ddac78ac54d96dca8462fccd34233d">More...</a><br/></td></tr>
<tr class="separator:af1ddac78ac54d96dca8462fccd34233d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae905a9689c6c05d6c3eb70ebadf8b9ab"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#ae905a9689c6c05d6c3eb70ebadf8b9ab">operator!=</a> (const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> &a) const </td></tr>
<tr class="memdesc:ae905a9689c6c05d6c3eb70ebadf8b9ab"><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="#ae905a9689c6c05d6c3eb70ebadf8b9ab">More...</a><br/></td></tr>
<tr class="separator:ae905a9689c6c05d6c3eb70ebadf8b9ab"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a928ae39893ca3d158505c527610f9a84"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#a928ae39893ca3d158505c527610f9a84">setIPAddress</a> (const char *host)</td></tr>
<tr class="memdesc:a928ae39893ca3d158505c527610f9a84"><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="#a928ae39893ca3d158505c527610f9a84">More...</a><br/></td></tr>
<tr class="separator:a928ae39893ca3d158505c527610f9a84"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a2e12b44eb5455b2c68b1b84bd2a31f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#a3a2e12b44eb5455b2c68b1b84bd2a31f">setAddress</a> (const char *host)</td></tr>
<tr class="memdesc:a3a2e12b44eb5455b2c68b1b84bd2a31f"><td class="mdescLeft"> </td><td class="mdescRight">Used to specify a host name or numeric internet address. <a href="#a3a2e12b44eb5455b2c68b1b84bd2a31f">More...</a><br/></td></tr>
<tr class="separator:a3a2e12b44eb5455b2c68b1b84bd2a31f"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a4437ba1e6bde3e8252df8a1a591ecfe5"><td class="memItemLeft" align="right" valign="top">struct in_addr * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#a4437ba1e6bde3e8252df8a1a591ecfe5">ipaddr</a></td></tr>
<tr class="separator:a4437ba1e6bde3e8252df8a1a591ecfe5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3128cf0e2832071593f940717b484e88"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#a3128cf0e2832071593f940717b484e88">addr_count</a></td></tr>
<tr class="separator:a3128cf0e2832071593f940717b484e88"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9c3cc2812bf79827298211ed4ca4550b"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_address.html#a9c3cc2812bf79827298211ed4ca4550b">hostname</a></td></tr>
<tr class="separator:a9c3cc2812bf79827298211ed4ca4550b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr class="memitem:a5bbe8d3806115e2c4882efb728ba039d"><td class="memItemLeft" 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#a5bbe8d3806115e2c4882efb728ba039d">mutex</a></td></tr>
<tr class="separator:a5bbe8d3806115e2c4882efb728ba039d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The network name and address objects are all derived from a common <a class="el" href="classost_1_1_i_p_v4_address.html" title="The network name and address objects are all derived from a common IPV4Address base class...">IPV4Address</a> base class. </p>
<p>Specific classes, such as <a class="el" href="classost_1_1_i_p_v4_host.html" title="This object is used to hold the actual and valid internet address of a specific host machine that wil...">IPV4Host</a>, <a class="el" href="classost_1_1_i_p_v4_mask.html" title="Internet addresses used specifically as masking addresses (such as " 255.255.255.0") are held in the ...">IPV4Mask</a>, etc, are defined from <a class="el" href="classost_1_1_i_p_v4_address.html" title="The network name and address objects are all derived from a common IPV4Address base class...">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 class="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@os'+'te'+'l.c'+'om'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@ost<span style="display: none;">.nosp@m.</span>el.co<span style="display: none;">.nosp@m.</span>m</a> Internet Address binary data type. </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="tcpthread_8cpp-example.html#_a5">tcpthread.cpp</a>.</dd>
</dl></div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a05ba4c9d7a44d647ac2b5d443c529cba"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::IPV4Address::IPV4Address </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v4_validator.html">IPV4Validator</a> * </td>
<td class="paramname"><em>validator</em> = <code>NULL</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create an Internet Address object with an empty (0.0.0.0) address. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">validator</td><td>optional validator function object, intended for derived classes. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0aef6689f1b3c419cd28add796fde0c8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::IPV4Address::IPV4Address </td>
<td>(</td>
<td class="paramtype">struct in_addr </td>
<td class="paramname"><em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v4_validator.html">IPV4Validator</a> * </td>
<td class="paramname"><em>validator</em> = <code>NULL</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<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" title="The network name and address objects are all derived from a common IPV4Address base class...">IPV4Address</a> object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">addr</td><td>struct of system used binary internet address. </td></tr>
<tr><td class="paramname">validator</td><td>optional validator function object, intended for derived classes. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab77c0c8301677b654cd64c94c8442f6f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::IPV4Address::IPV4Address </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v4_validator.html">IPV4Validator</a> * </td>
<td class="paramname"><em>validator</em> = <code>NULL</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<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" title="The network name and address objects are all derived from a common IPV4Address base class...">IPV4Address</a> object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">address</td><td>null terminated C string. </td></tr>
<tr><td class="paramname">validator</td><td>optional validator function object, intended for derived classes. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae3fd5fd2919e5934cd7b3ae2d9b752b3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::IPV4Address::IPV4Address </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> & </td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy constructor. </p>
</div>
</div>
<a class="anchor" id="ac8c4c826369f4ce356df0392cc595c9d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ost::IPV4Address::~IPV4Address </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a43a862793e22c0cf16416470490423b1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct in_addr ost::IPV4Address::getAddress </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<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" title="The network name and address objects are all derived from a common IPV4Address base class...">IPV4Address</a>. </p>
<p>This is needed for services such as bind() and connect().</p>
<dl class="section return"><dt>Returns</dt><dd>system binary coded internet address. </dd></dl>
</div>
</div>
<a class="anchor" id="a0e47b365f8d88e343963533ad54ca302"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct in_addr ost::IPV4Address::getAddress </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>i</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<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" title="The network name and address objects are all derived from a common IPV4Address base class...">IPV4Address</a>. </p>
<p>This is needed for services such as bind() and connect().</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">i</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#a90c4bc29684968f09d5cf61f3d7d7524" title="Returns the number of internet addresses that an IPV4Address object contains. ">getAddressCount()</a> to determine the number of address the object contains. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>system binary coded internet address. If parameter i is out of range, the first address is returned. </dd></dl>
</div>
</div>
<a class="anchor" id="a90c4bc29684968f09d5cf61f3d7d7524"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t ost::IPV4Address::getAddressCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of internet addresses that an <a class="el" href="classost_1_1_i_p_v4_address.html" title="The network name and address objects are all derived from a common IPV4Address base class...">IPV4Address</a> object contains. </p>
<p>This usually only happens with <a class="el" href="classost_1_1_i_p_v4_host.html" title="This object is used to hold the actual and valid internet address of a specific host machine that wil...">IPV4Host</a> objects where multiple IP addresses are returned for a DNS lookup </p>
</div>
</div>
<a class="anchor" id="aaf68688cd2253cdcd313a12ab6177167"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ost::IPV4Address::getHostname </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<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" title="The network name and address objects are all derived from a common IPV4Address base class...">IPV4Address</a> object. </p>
<dl class="section return"><dt>Returns</dt><dd>string representation of <a class="el" href="classost_1_1_i_p_v4_address.html" title="The network name and address objects are all derived from a common IPV4Address base class...">IPV4Address</a>. </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="tcpthread_8cpp-example.html#a6">tcpthread.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="a68aa94e15b9b662ddded4fb3e4810933"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::IPV4Address::isInetAddress </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>May be used to verify if a given <a class="el" href="classost_1_1_i_p_v4_address.html" title="The network name and address objects are all derived from a common IPV4Address base class...">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" title="The network name and address objects are all derived from a common IPV4Address base class...">IPV4Address</a> values. </p>
<dl class="section return"><dt>Returns</dt><dd>true if address != 0.0.0.0. </dd></dl>
</div>
</div>
<a class="anchor" id="a028f090c2d60034c3cbc4a23efafd356"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ost::IPV4Address::operator! </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ae905a9689c6c05d6c3eb70ebadf8b9ab"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classost_1_1_i_p_v4_address.html#a028f090c2d60034c3cbc4a23efafd356">ost::IPV4Address::operator!</a>= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> & </td>
<td class="paramname"><em>a</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Compare two internet addresses to see if they are not equal (if they each refer to unique and different physical ip addresses). </p>
<p>This is implimented in terms of operator== </p>
</div>
</div>
<a class="anchor" id="aaeab0179a7fa73673815e1cc623ab709"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a>& ost::IPV4Address::operator= </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Referenced by <a class="el" href="classost_1_1_i_p_v4_mask.html#a49ec7fe09dfcc3b9a963e2dc6f1186d4">ost::IPV4Mask::operator=()</a>, and <a class="el" href="classost_1_1_i_p_v4_host.html#a28be54aa5dd6c5ed9feeeb6c76ab0b27">ost::IPV4Host::operator=()</a>.</p>
</div>
</div>
<a class="anchor" id="a3d81a8ccf64b8647426e18e534c48e5d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a>& ost::IPV4Address::operator= </td>
<td>(</td>
<td class="paramtype">struct in_addr </td>
<td class="paramname"><em>addr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ac59145207f75857c414ade190e618290"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a>& ost::IPV4Address::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> & </td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ac05d9c4599ad313dec545a9e89e7e2d5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a>& ost::IPV4Address::operator= </td>
<td>(</td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>addr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Allows assignment from the return of functions like inet_addr() or htonl() </p>
</div>
</div>
<a class="anchor" id="a8198f8d8f9fae2de78194fc26c3b44c6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a>& ost::IPV4Address::operator= </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>addr</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="af1ddac78ac54d96dca8462fccd34233d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::IPV4Address::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> & </td>
<td class="paramname"><em>a</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Compare two internet addresses to see if they are equal (if they specify the physical address of the same internet host). </p>
<p>If there is more than one IP address in either <a class="el" href="classost_1_1_i_p_v4_address.html" title="The network name and address objects are all derived from a common IPV4Address base class...">IPV4Address</a> object, this will return true if all of the IP addresses in the smaller are in the larger in any order. </p>
</div>
</div>
<a class="anchor" id="a3a2e12b44eb5455b2c68b1b84bd2a31f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ost::IPV4Address::setAddress </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>host</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to specify a host name or numeric internet address. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">host</td><td>The string representation of the IP address or a hostname, , if NULL, it will default to INADDR_ANY </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a928ae39893ca3d158505c527610f9a84"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ost::IPV4Address::setIPAddress </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>host</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the IP address from a string representation of the numeric address, ie "127.0.0.1". </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">host</td><td>The string representation of the IP address </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successful </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a3128cf0e2832071593f940717b484e88"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t ost::IPV4Address::addr_count</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a9c3cc2812bf79827298211ed4ca4550b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">char* ost::IPV4Address::hostname</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">mutable</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a4437ba1e6bde3e8252df8a1a591ecfe5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">struct in_addr* ost::IPV4Address::ipaddr</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a5bbe8d3806115e2c4882efb728ba039d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_mutex.html">Mutex</a> ost::IPV4Address::mutex</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<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></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Oct 17 2013 23:24:57 for GNU CommonC++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
