<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>GNU CommonC++: ost::IPV4Host Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.3 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li 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 class="tabs"> <ul> <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 class="navpath"><a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> </div> </div> <div class="contents"> <h1>ost::IPV4Host Class Reference</h1><!-- doxytag: class="ost::IPV4Host" --><!-- doxytag: inherits="ost::IPV4Address" --> <p>This object is used to hold the actual and valid internet address of a specific host machine that will be accessed through a socket. <a href="#_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::IPV4Host:</div> <div class="dynsection"> <div class="center"> <img src="classost_1_1_i_p_v4_host.png" usemap="#ost::IPV4Host_map" alt=""/> <map id="ost::IPV4Host_map" name="ost::IPV4Host_map"> <area href="classost_1_1_i_p_v4_address.html" alt="ost::IPV4Address" shape="rect" coords="0,0,108,24"/> </map> </div> </div> <p><a href="classost_1_1_i_p_v4_host-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_host.html#a7a9d8927679189163fc12c41e8a75b2f">IPV4Host</a> (const char *host=NULL)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new host address for a specific internet host. <a href="#a7a9d8927679189163fc12c41e8a75b2f"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_host.html#a63fc8c49ec06664ddc3215139c658f6d">IPV4Host</a> (struct in_addr addr)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a system socket binary address such as may be returned through the accept() call or getsockpeer() into an internet host address object. <a href="#a63fc8c49ec06664ddc3215139c658f6d"></a><br/></td></tr> <tr><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_host.html#a28be54aa5dd6c5ed9feeeb6c76ab0b27">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="#a28be54aa5dd6c5ed9feeeb6c76ab0b27"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_host.html#a95b5422e9be13225ebf2880c7dddb8fe">operator&=</a> (const <a class="el" href="classost_1_1_i_p_v4_mask.html">IPV4Mask</a> &mask)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Mask the internet host address object with a network mask address. <a href="#a95b5422e9be13225ebf2880c7dddb8fe"></a><br/></td></tr> <tr><td colspan="2"><h2>Friends</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">class __EXPORT </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_host.html#aee7ea6b9d5d5f4bf3de8db73fa8e1f94">IPV4Mask</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">__EXPORT <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_host.html#a20598f0cfda99e7c4bf214084acc1b94">operator&</a> (const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> &addr, const <a class="el" href="classost_1_1_i_p_v4_mask.html">IPV4Mask</a> &mask)</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>This object is used to hold the actual and valid internet address of a specific host machine that will be accessed through a socket. </p> <dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> Address of a specific Internet host machine. </dd></dl> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a7a9d8927679189163fc12c41e8a75b2f"></a><!-- doxytag: member="ost::IPV4Host::IPV4Host" ref="a7a9d8927679189163fc12c41e8a75b2f" args="(const char *host=NULL)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ost::IPV4Host::IPV4Host </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>host</em> = <code>NULL</code></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Create a new host address for a specific internet host. </p> <p>The internet host can be specified in a null terminated ASCII string and include either the physical host address or the DNS name of a host machine. Hence, an <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...">IPV4Host</a> ("www.voxilla.org") can be directly declaired in this manner.</p> <p>Defaults to the IP address that represents the interface matching "gethostname()".</p> <dl><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>dns or physical address of an Internet host. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a63fc8c49ec06664ddc3215139c658f6d"></a><!-- doxytag: member="ost::IPV4Host::IPV4Host" ref="a63fc8c49ec06664ddc3215139c658f6d" args="(struct in_addr addr)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ost::IPV4Host::IPV4Host </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"> <p>Convert a system socket binary address such as may be returned through the accept() call or getsockpeer() into an internet host address object. </p> <dl><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>binary address of internet host. </td></tr> </table> </dd> </dl> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a95b5422e9be13225ebf2880c7dddb8fe"></a><!-- doxytag: member="ost::IPV4Host::operator&=" ref="a95b5422e9be13225ebf2880c7dddb8fe" args="(const IPV4Mask &mask)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a>& ost::IPV4Host::operator&= </td> <td>(</td> <td class="paramtype">const <a class="el" href="classost_1_1_i_p_v4_mask.html">IPV4Mask</a> & </td> <td class="paramname"> <em>mask</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Mask the internet host address object with a network mask address. </p> <p>This is commonly used to coerce an address by subnet. </p> </div> </div> <a class="anchor" id="a28be54aa5dd6c5ed9feeeb6c76ab0b27"></a><!-- doxytag: member="ost::IPV4Host::operator=" ref="a28be54aa5dd6c5ed9feeeb6c76ab0b27" args="(unsigned long addr)" --> <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::IPV4Host::operator= </td> <td>(</td> <td class="paramtype">unsigned long </td> <td class="paramname"> <em>addr</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Allows assignment from the return of functions like inet_addr() or htonl(). </p> <p>Reimplemented from <a class="el" href="classost_1_1_i_p_v4_address.html#ac05d9c4599ad313dec545a9e89e7e2d5">ost::IPV4Address</a>.</p> <p>References <a class="el" href="classost_1_1_i_p_v4_address.html#aaeab0179a7fa73673815e1cc623ab709">ost::IPV4Address::operator=()</a>.</p> </div> </div> <hr/><h2>Friends And Related Function Documentation</h2> <a class="anchor" id="aee7ea6b9d5d5f4bf3de8db73fa8e1f94"></a><!-- doxytag: member="ost::IPV4Host::IPV4Mask" ref="aee7ea6b9d5d5f4bf3de8db73fa8e1f94" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">friend class __EXPORT <a class="el" href="classost_1_1_i_p_v4_mask.html">IPV4Mask</a><code> [friend]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a20598f0cfda99e7c4bf214084acc1b94"></a><!-- doxytag: member="ost::IPV4Host::operator&" ref="a20598f0cfda99e7c4bf214084acc1b94" args="(const IPV4Host &addr, const IPV4Mask &mask)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">__EXPORT <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> operator& </td> <td>(</td> <td class="paramtype">const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> & </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_mask.html">IPV4Mask</a> & </td> <td class="paramname"> <em>mask</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [friend]</code></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> <hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Nov 12 09:55:46 2010 for GNU CommonC++ by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> </body> </html>