<!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::IPV4Cidr 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_cidr.html">IPV4Cidr</a> </div> </div> <div class="contents"> <h1>ost::IPV4Cidr Class Reference</h1><!-- doxytag: class="ost::IPV4Cidr" --> <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_v4_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 in_addr </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_cidr.html#ae4990e1f58a6c871c22774944f8c5921">getNetwork</a> (void) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get network address associated with this cidr. <a href="#ae4990e1f58a6c871c22774944f8c5921"></a><br/></td></tr> <tr><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_cidr.html#a36e0337c68d14d2c67be12ec6a9eefba">getNetmask</a> (void) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get network mask associated with this cidr. <a href="#a36e0337c68d14d2c67be12ec6a9eefba"></a><br/></td></tr> <tr><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_cidr.html#a4130ffc92326bee037dd5eb325673c0b">getBroadcast</a> (void) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Compute the broadcast address associated with this cidr. <a href="#a4130ffc92326bee037dd5eb325673c0b"></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_v4_cidr.html#a4df8371ed56cbe7b89c72fb7883e23b1">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 an address/mask, or a host/bits specification. <a href="#a4df8371ed56cbe7b89c72fb7883e23b1"></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_cidr.html#ac2b3fbe6dbc80c9d24c791bb9cac6702">IPV4Cidr</a> (const char *cidr)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a new cidr from a string. <a href="#ac2b3fbe6dbc80c9d24c791bb9cac6702"></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_cidr.html#a6819857311e46b549b1193db9f2f22b9">IPV4Cidr</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct an empty cidr. <a href="#a6819857311e46b549b1193db9f2f22b9"></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_cidr.html#a34b0ec6f4cb196a60346068decc436e8">IPV4Cidr</a> (<a class="el" href="classost_1_1_i_p_v4_cidr.html">IPV4Cidr</a> &)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a copy of a cidr. <a href="#a34b0ec6f4cb196a60346068decc436e8"></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_v4_cidr.html#ae75b6711cf86479609f5c285edddf16d">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="#ae75b6711cf86479609f5c285edddf16d"></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_v4_cidr.html#a7d3941f08c67c23da4a88944e3835520">isMember</a> (const struct in_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="#a7d3941f08c67c23da4a88944e3835520"></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_v4_cidr.html#a119f377cfa2fba3b7b28cf0a71f03ad5">operator==</a> (const struct sockaddr *a) 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_v4_cidr.html#a23d8115b00be38c2f17a2b7b7a40860c">operator==</a> (const struct in_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_v4_cidr.html#ab574f35204147a447785adbee0f714cb">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 in_addr netmask </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_i_p_v4_cidr.html#a1e521394346937df3ea4b79d10c3cc49">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="ac2b3fbe6dbc80c9d24c791bb9cac6702"></a><!-- doxytag: member="ost::IPV4Cidr::IPV4Cidr" ref="ac2b3fbe6dbc80c9d24c791bb9cac6702" args="(const char *cidr)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ost::IPV4Cidr::IPV4Cidr </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="a6819857311e46b549b1193db9f2f22b9"></a><!-- doxytag: member="ost::IPV4Cidr::IPV4Cidr" ref="a6819857311e46b549b1193db9f2f22b9" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ost::IPV4Cidr::IPV4Cidr </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="a34b0ec6f4cb196a60346068decc436e8"></a><!-- doxytag: member="ost::IPV4Cidr::IPV4Cidr" ref="a34b0ec6f4cb196a60346068decc436e8" args="(IPV4Cidr &)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ost::IPV4Cidr::IPV4Cidr </td> <td>(</td> <td class="paramtype"><a class="el" href="classost_1_1_i_p_v4_cidr.html">IPV4Cidr</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="a4130ffc92326bee037dd5eb325673c0b"></a><!-- doxytag: member="ost::IPV4Cidr::getBroadcast" ref="a4130ffc92326bee037dd5eb325673c0b" args="(void) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">struct in_addr ost::IPV4Cidr::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="ab574f35204147a447785adbee0f714cb"></a><!-- doxytag: member="ost::IPV4Cidr::getMask" ref="ab574f35204147a447785adbee0f714cb" args="(const char *cp) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned ost::IPV4Cidr::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="a36e0337c68d14d2c67be12ec6a9eefba"></a><!-- doxytag: member="ost::IPV4Cidr::getNetmask" ref="a36e0337c68d14d2c67be12ec6a9eefba" args="(void) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">struct in_addr ost::IPV4Cidr::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="ae4990e1f58a6c871c22774944f8c5921"></a><!-- doxytag: member="ost::IPV4Cidr::getNetwork" ref="ae4990e1f58a6c871c22774944f8c5921" args="(void) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">struct in_addr ost::IPV4Cidr::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="a7d3941f08c67c23da4a88944e3835520"></a><!-- doxytag: member="ost::IPV4Cidr::isMember" ref="a7d3941f08c67c23da4a88944e3835520" args="(const struct in_addr &inaddr) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool ost::IPV4Cidr::isMember </td> <td>(</td> <td class="paramtype">const struct in_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="ae75b6711cf86479609f5c285edddf16d"></a><!-- doxytag: member="ost::IPV4Cidr::isMember" ref="ae75b6711cf86479609f5c285edddf16d" args="(const struct sockaddr *saddr) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool ost::IPV4Cidr::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="a23d8115b00be38c2f17a2b7b7a40860c"></a><!-- doxytag: member="ost::IPV4Cidr::operator==" ref="a23d8115b00be38c2f17a2b7b7a40860c" args="(const struct in_addr &a) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool ost::IPV4Cidr::operator== </td> <td>(</td> <td class="paramtype">const struct in_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="a119f377cfa2fba3b7b28cf0a71f03ad5"></a><!-- doxytag: member="ost::IPV4Cidr::operator==" ref="a119f377cfa2fba3b7b28cf0a71f03ad5" args="(const struct sockaddr *a) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool ost::IPV4Cidr::operator== </td> <td>(</td> <td class="paramtype">const struct sockaddr * </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="a4df8371ed56cbe7b89c72fb7883e23b1"></a><!-- doxytag: member="ost::IPV4Cidr::set" ref="a4df8371ed56cbe7b89c72fb7883e23b1" args="(const char *cidr)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ost::IPV4Cidr::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 an address/mask, or 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="a1e521394346937df3ea4b79d10c3cc49"></a><!-- doxytag: member="ost::IPV4Cidr::network" ref="a1e521394346937df3ea4b79d10c3cc49" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">struct in_addr netmask <a class="el" href="classost_1_1_i_p_v4_cidr.html#a1e521394346937df3ea4b79d10c3cc49">ost::IPV4Cidr::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>