<!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::IPV6Mask 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_v6_mask.html">IPV6Mask</a> </div> </div> <div class="contents"> <h1>ost::IPV6Mask Class Reference</h1><!-- doxytag: class="ost::IPV6Mask" --><!-- doxytag: inherits="ost::IPV6Address" --> <p>Internet addresses used specifically as masking addresses (such as " 255.255.255.0") are held in the <a class="el" href="classost_1_1_i_p_v6_mask.html" title="Internet addresses used specifically as masking addresses (such as " 255.255...">IPV6Mask</a> derived object. <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::IPV6Mask:</div> <div class="dynsection"> <div class="center"> <img src="classost_1_1_i_p_v6_mask.png" usemap="#ost::IPV6Mask_map" alt=""/> <map id="ost::IPV6Mask_map" name="ost::IPV6Mask_map"> <area href="classost_1_1_i_p_v6_address.html" alt="ost::IPV6Address" shape="rect" coords="0,0,108,24"/> </map> </div> </div> <p><a href="classost_1_1_i_p_v6_mask-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_v6_mask.html#a4c98eded1ed6405a01c5f4caf4afb28a">IPV6Mask</a> (const char *mask)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create the mask from a null terminated ASCII string such as "255.255.255.128". <a href="#a4c98eded1ed6405a01c5f4caf4afb28a"></a><br/></td></tr> <tr><td colspan="2"><h2>Friends</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">__EXPORT <a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v6_mask.html#a6c60e57c1de6ec492d8e415db11eab57">operator&</a> (const <a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> &addr, const <a class="el" href="classost_1_1_i_p_v6_mask.html">IPV6Mask</a> &mask)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Masks are usually used to coerce host addresses into a specific router or class domain. <a href="#a6c60e57c1de6ec492d8e415db11eab57"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Internet addresses used specifically as masking addresses (such as " 255.255.255.0") are held in the <a class="el" href="classost_1_1_i_p_v6_mask.html" title="Internet addresses used specifically as masking addresses (such as " 255.255...">IPV6Mask</a> derived object. </p> <p>The seperate class is used so that C++ type casting can automatically determine when an <a class="el" href="classost_1_1_i_p_v6_address.html" title="The network name and address objects are all derived from a common IPV6Address base...">IPV6Address</a> object is really a mask address object rather than simply using the base class. This also allows manipulative operators for address masking to operate only when presented with a Masked address as well as providing cleaner and safer source.</p> <dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> Internet Address Mask such as subnet masks. </dd></dl> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a4c98eded1ed6405a01c5f4caf4afb28a"></a><!-- doxytag: member="ost::IPV6Mask::IPV6Mask" ref="a4c98eded1ed6405a01c5f4caf4afb28a" args="(const char *mask)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ost::IPV6Mask::IPV6Mask </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>mask</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Create the mask from a null terminated ASCII string such as "255.255.255.128". </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>mask</em> </td><td>null terminated ASCII mask string. </td></tr> </table> </dd> </dl> </div> </div> <hr/><h2>Friends And Related Function Documentation</h2> <a class="anchor" id="a6c60e57c1de6ec492d8e415db11eab57"></a><!-- doxytag: member="ost::IPV6Mask::operator&" ref="a6c60e57c1de6ec492d8e415db11eab57" args="(const IPV6Host &addr, const IPV6Mask &mask)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">__EXPORT <a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> operator& </td> <td>(</td> <td class="paramtype">const <a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</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_v6_mask.html">IPV6Mask</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"> <p>Masks are usually used to coerce host addresses into a specific router or class domain. </p> <p>This can be done by taking the Inet Host Address object and "and"ing it with an address mask. This operation can be directly expressed in C++ through the & operator.</p> <dl class="return"><dt><b>Returns:</b></dt><dd>a internet host address that has been masked. </dd></dl> <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>host address to be masked by subnet. </td></tr> <tr><td valign="top"></td><td valign="top"><em>mask</em> </td><td>inetnet mask address object to mask by. </td></tr> </table> </dd> </dl> </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 Mar 12 10:07:39 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>