<!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::IPV6Cidr 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_cidr.html">IPV6Cidr</a> </div> </div> <div class="contents"> <h1>ost::IPV6Cidr Class Reference</h1><!-- doxytag: class="ost::IPV6Cidr" --> <p>The CIDR class is used to support routing tables and validate address policies. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="address_8h_source.html">address.h</a>></code></p> <p><a href="classost_1_1_i_p_v6_cidr-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">struct in6_addr </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v6_cidr.html#a9a3fc6c68055448d300ddee1719002d4">getNetwork</a> (void) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get network address associated with this cidr. <a href="#a9a3fc6c68055448d300ddee1719002d4"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct in6_addr </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v6_cidr.html#aa5dd16ec9107894c8f07165cdecab88b">getNetmask</a> (void) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get network mask associated with this cidr. <a href="#aa5dd16ec9107894c8f07165cdecab88b"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct in6_addr </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v6_cidr.html#a0e1225ba3643486115b8027457d9953d">getBroadcast</a> (void) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Compute the broadcast address associated with this cidr. <a href="#a0e1225ba3643486115b8027457d9953d"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v6_cidr.html#a3609a6cf2825480b8655226a54ce8f95">set</a> (const char *cidr)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the cidr from a full or partial hostname, or from a host/bits specification. <a href="#a3609a6cf2825480b8655226a54ce8f95"></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_v6_cidr.html#aefc4e093e0ebd3bfa7999fe11aac110c">IPV6Cidr</a> (const char *cidr)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a new cidr from a string. <a href="#aefc4e093e0ebd3bfa7999fe11aac110c"></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_v6_cidr.html#a9db6e579b5cb4df0eea945cb3db0c30a">IPV6Cidr</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct an empty cidr. <a href="#a9db6e579b5cb4df0eea945cb3db0c30a"></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_v6_cidr.html#af0d4ac10fe8c90deb0f17bee0ae67a8c">IPV6Cidr</a> (<a class="el" href="classost_1_1_i_p_v6_cidr.html">IPV6Cidr</a> &)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a copy of a cidr. <a href="#af0d4ac10fe8c90deb0f17bee0ae67a8c"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v6_cidr.html#a0584ae737d03024d4d458bc1cbf7d3ea">isMember</a> (const struct sockaddr *saddr) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">See if a socket address is a member of this cidr's network. <a href="#a0584ae737d03024d4d458bc1cbf7d3ea"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v6_cidr.html#a910c00bbe0bfb3af862bd89bb46f0db6">isMember</a> (const struct in6_addr &inaddr) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">See if a low level address object is a member of this cidr's net. <a href="#a910c00bbe0bfb3af862bd89bb46f0db6"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v6_cidr.html#a27dd5cd8d31f250836b0342dbfe01483">operator==</a> (const struct sockaddr *sa) const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v6_cidr.html#a4a1185ddd0accee067006c12f8266569">operator==</a> (const struct in6_addr &a) const </td></tr> <tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v6_cidr.html#acab0094f436e0212d9ce5f948d142d78">getMask</a> (const char *cp) const </td></tr> <tr><td colspan="2"><h2>Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct in6_addr netmask </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v6_cidr.html#afb73fd7948994b257dbce8b830bbf61a">network</a></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>The CIDR class is used to support routing tables and validate address policies. </p> <dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> Classless Internet Domain Routing </dd></dl> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="aefc4e093e0ebd3bfa7999fe11aac110c"></a><!-- doxytag: member="ost::IPV6Cidr::IPV6Cidr" ref="aefc4e093e0ebd3bfa7999fe11aac110c" args="(const char *cidr)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ost::IPV6Cidr::IPV6Cidr </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>cidr</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Construct a new cidr from a string. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>cidr</em> </td><td>string to use. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a9db6e579b5cb4df0eea945cb3db0c30a"></a><!-- doxytag: member="ost::IPV6Cidr::IPV6Cidr" ref="a9db6e579b5cb4df0eea945cb3db0c30a" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ost::IPV6Cidr::IPV6Cidr </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Construct an empty cidr. </p> </div> </div> <a class="anchor" id="af0d4ac10fe8c90deb0f17bee0ae67a8c"></a><!-- doxytag: member="ost::IPV6Cidr::IPV6Cidr" ref="af0d4ac10fe8c90deb0f17bee0ae67a8c" args="(IPV6Cidr &)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ost::IPV6Cidr::IPV6Cidr </td> <td>(</td> <td class="paramtype"><a class="el" href="classost_1_1_i_p_v6_cidr.html">IPV6Cidr</a> & </td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Construct a copy of a cidr. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>cidr</em> </td><td>to copy from. </td></tr> </table> </dd> </dl> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a0e1225ba3643486115b8027457d9953d"></a><!-- doxytag: member="ost::IPV6Cidr::getBroadcast" ref="a0e1225ba3643486115b8027457d9953d" args="(void) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">struct in6_addr ost::IPV6Cidr::getBroadcast </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> <td> const<code> [read]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Compute the broadcast address associated with this cidr. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>system binary coded network address. </dd></dl> </div> </div> <a class="anchor" id="acab0094f436e0212d9ce5f948d142d78"></a><!-- doxytag: member="ost::IPV6Cidr::getMask" ref="acab0094f436e0212d9ce5f948d142d78" args="(const char *cp) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned ost::IPV6Cidr::getMask </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>cp</em></td> <td> ) </td> <td> const<code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="aa5dd16ec9107894c8f07165cdecab88b"></a><!-- doxytag: member="ost::IPV6Cidr::getNetmask" ref="aa5dd16ec9107894c8f07165cdecab88b" args="(void) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">struct in6_addr ost::IPV6Cidr::getNetmask </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline, read]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Get network mask associated with this cidr. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>system binary coded network mask. </dd></dl> </div> </div> <a class="anchor" id="a9a3fc6c68055448d300ddee1719002d4"></a><!-- doxytag: member="ost::IPV6Cidr::getNetwork" ref="a9a3fc6c68055448d300ddee1719002d4" args="(void) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">struct in6_addr ost::IPV6Cidr::getNetwork </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline, read]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Get network address associated with this cidr. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>system binary coded address. </dd></dl> </div> </div> <a class="anchor" id="a910c00bbe0bfb3af862bd89bb46f0db6"></a><!-- doxytag: member="ost::IPV6Cidr::isMember" ref="a910c00bbe0bfb3af862bd89bb46f0db6" args="(const struct in6_addr &inaddr) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool ost::IPV6Cidr::isMember </td> <td>(</td> <td class="paramtype">const struct in6_addr & </td> <td class="paramname"> <em>inaddr</em></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>See if a low level address object is a member of this cidr's net. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>inaddr</em> </td><td>object to test. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>true if member of cidr. </dd></dl> </div> </div> <a class="anchor" id="a0584ae737d03024d4d458bc1cbf7d3ea"></a><!-- doxytag: member="ost::IPV6Cidr::isMember" ref="a0584ae737d03024d4d458bc1cbf7d3ea" args="(const struct sockaddr *saddr) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool ost::IPV6Cidr::isMember </td> <td>(</td> <td class="paramtype">const struct sockaddr * </td> <td class="paramname"> <em>saddr</em></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>See if a socket address is a member of this cidr's network. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>saddr</em> </td><td>pointer to test. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>true if member of cidr. </dd></dl> </div> </div> <a class="anchor" id="a4a1185ddd0accee067006c12f8266569"></a><!-- doxytag: member="ost::IPV6Cidr::operator==" ref="a4a1185ddd0accee067006c12f8266569" args="(const struct in6_addr &a) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool ost::IPV6Cidr::operator== </td> <td>(</td> <td class="paramtype">const struct in6_addr & </td> <td class="paramname"> <em>a</em></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a27dd5cd8d31f250836b0342dbfe01483"></a><!-- doxytag: member="ost::IPV6Cidr::operator==" ref="a27dd5cd8d31f250836b0342dbfe01483" args="(const struct sockaddr *sa) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool ost::IPV6Cidr::operator== </td> <td>(</td> <td class="paramtype">const struct sockaddr * </td> <td class="paramname"> <em>sa</em></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a3609a6cf2825480b8655226a54ce8f95"></a><!-- doxytag: member="ost::IPV6Cidr::set" ref="a3609a6cf2825480b8655226a54ce8f95" args="(const char *cidr)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ost::IPV6Cidr::set </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>cidr</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Set the cidr from a full or partial hostname, or from a host/bits specification. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>cidr</em> </td><td>string to use. </td></tr> </table> </dd> </dl> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="afb73fd7948994b257dbce8b830bbf61a"></a><!-- doxytag: member="ost::IPV6Cidr::network" ref="afb73fd7948994b257dbce8b830bbf61a" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">struct in6_addr netmask <a class="el" href="classost_1_1_i_p_v6_cidr.html#afb73fd7948994b257dbce8b830bbf61a">ost::IPV6Cidr::network</a><code> [protected]</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>