<!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::IPV4Cidr 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_cidr.html">IPV4Cidr</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="classost_1_1_i_p_v4_cidr-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ost::IPV4Cidr Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The CIDR class is used to support routing tables and validate address policies.
<a href="classost_1_1_i_p_v4_cidr.html#details">More...</a></p>
<p><code>#include <<a class="el" href="address_8h_source.html">address.h</a>></code></p>
<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:ae4990e1f58a6c871c22774944f8c5921"><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 class="memdesc:ae4990e1f58a6c871c22774944f8c5921"><td class="mdescLeft"> </td><td class="mdescRight">Get network address associated with this cidr. <a href="#ae4990e1f58a6c871c22774944f8c5921">More...</a><br/></td></tr>
<tr class="separator:ae4990e1f58a6c871c22774944f8c5921"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a36e0337c68d14d2c67be12ec6a9eefba"><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 class="memdesc:a36e0337c68d14d2c67be12ec6a9eefba"><td class="mdescLeft"> </td><td class="mdescRight">Get network mask associated with this cidr. <a href="#a36e0337c68d14d2c67be12ec6a9eefba">More...</a><br/></td></tr>
<tr class="separator:a36e0337c68d14d2c67be12ec6a9eefba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4130ffc92326bee037dd5eb325673c0b"><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 class="memdesc:a4130ffc92326bee037dd5eb325673c0b"><td class="mdescLeft"> </td><td class="mdescRight">Compute the broadcast address associated with this cidr. <a href="#a4130ffc92326bee037dd5eb325673c0b">More...</a><br/></td></tr>
<tr class="separator:a4130ffc92326bee037dd5eb325673c0b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4df8371ed56cbe7b89c72fb7883e23b1"><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 class="memdesc:a4df8371ed56cbe7b89c72fb7883e23b1"><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">More...</a><br/></td></tr>
<tr class="separator:a4df8371ed56cbe7b89c72fb7883e23b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac2b3fbe6dbc80c9d24c791bb9cac6702"><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 class="memdesc:ac2b3fbe6dbc80c9d24c791bb9cac6702"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new cidr from a string. <a href="#ac2b3fbe6dbc80c9d24c791bb9cac6702">More...</a><br/></td></tr>
<tr class="separator:ac2b3fbe6dbc80c9d24c791bb9cac6702"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6819857311e46b549b1193db9f2f22b9"><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 class="memdesc:a6819857311e46b549b1193db9f2f22b9"><td class="mdescLeft"> </td><td class="mdescRight">Construct an empty cidr. <a href="#a6819857311e46b549b1193db9f2f22b9">More...</a><br/></td></tr>
<tr class="separator:a6819857311e46b549b1193db9f2f22b9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a34b0ec6f4cb196a60346068decc436e8"><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 class="memdesc:a34b0ec6f4cb196a60346068decc436e8"><td class="mdescLeft"> </td><td class="mdescRight">Construct a copy of a cidr. <a href="#a34b0ec6f4cb196a60346068decc436e8">More...</a><br/></td></tr>
<tr class="separator:a34b0ec6f4cb196a60346068decc436e8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae75b6711cf86479609f5c285edddf16d"><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 class="memdesc:ae75b6711cf86479609f5c285edddf16d"><td class="mdescLeft"> </td><td class="mdescRight">See if a socket address is a member of this cidr's network. <a href="#ae75b6711cf86479609f5c285edddf16d">More...</a><br/></td></tr>
<tr class="separator:ae75b6711cf86479609f5c285edddf16d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7d3941f08c67c23da4a88944e3835520"><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 class="memdesc:a7d3941f08c67c23da4a88944e3835520"><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">More...</a><br/></td></tr>
<tr class="separator:a7d3941f08c67c23da4a88944e3835520"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a119f377cfa2fba3b7b28cf0a71f03ad5"><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 class="separator:a119f377cfa2fba3b7b28cf0a71f03ad5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a23d8115b00be38c2f17a2b7b7a40860c"><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 class="separator:a23d8115b00be38c2f17a2b7b7a40860c"><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:ab574f35204147a447785adbee0f714cb"><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 class="separator:ab574f35204147a447785adbee0f714cb"><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:a1e521394346937df3ea4b79d10c3cc49"><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>
<tr class="separator:a1e521394346937df3ea4b79d10c3cc49"><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 CIDR class is used to support routing tables and validate address policies. </p>
<dl class="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@gn'+'ut'+'ele'+'ph'+'ony'+'.o'+'rg'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@gnu<span style="display: none;">.nosp@m.</span>telep<span style="display: none;">.nosp@m.</span>hony<span style="display: none;">.nosp@m.</span>.org</a> Classless Internet Domain Routing </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="ac2b3fbe6dbc80c9d24c791bb9cac6702"></a>
<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 class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cidr</td><td>string to use. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6819857311e46b549b1193db9f2f22b9"></a>
<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>
<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 class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cidr</td><td>to copy from. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a4130ffc92326bee037dd5eb325673c0b"></a>
<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</td>
</tr>
</table>
</div><div class="memdoc">
<p>Compute the broadcast address associated with this cidr. </p>
<dl class="section return"><dt>Returns</dt><dd>system binary coded network address. </dd></dl>
</div>
</div>
<a class="anchor" id="ab574f35204147a447785adbee0f714cb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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</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="a36e0337c68d14d2c67be12ec6a9eefba"></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::IPV4Cidr::getNetmask </td>
<td>(</td>
<td class="paramtype">void </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>Get network mask associated with this cidr. </p>
<dl class="section return"><dt>Returns</dt><dd>system binary coded network mask. </dd></dl>
</div>
</div>
<a class="anchor" id="ae4990e1f58a6c871c22774944f8c5921"></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::IPV4Cidr::getNetwork </td>
<td>(</td>
<td class="paramtype">void </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>Get network address associated with this cidr. </p>
<dl class="section return"><dt>Returns</dt><dd>system binary coded address. </dd></dl>
</div>
</div>
<a class="anchor" id="ae75b6711cf86479609f5c285edddf16d"></a>
<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 class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">saddr</td><td>pointer to test. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if member of cidr. </dd></dl>
</div>
</div>
<a class="anchor" id="a7d3941f08c67c23da4a88944e3835520"></a>
<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 class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">inaddr</td><td>object to test. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if member of cidr. </dd></dl>
</div>
</div>
<a class="anchor" id="a119f377cfa2fba3b7b28cf0a71f03ad5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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</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="a23d8115b00be38c2f17a2b7b7a40860c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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</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="a4df8371ed56cbe7b89c72fb7883e23b1"></a>
<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 class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cidr</td><td>string to use. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a1e521394346937df3ea4b79d10c3cc49"></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 netmask ost::IPV4Cidr::network</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>
<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>
