<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>My Project: hal/architecture/Linux/drivers/core/IPAddress.h Source File</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">My Project
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_52c912f73dac9c4c0e442232e1b2bd80.html">hal</a></li><li class="navelem"><a class="el" href="dir_f2b50fdf5983ac8db5dbb1f1d585f6a3.html">architecture</a></li><li class="navelem"><a class="el" href="dir_14e8f5cb68fb87a2830d32ad3850b550.html">Linux</a></li><li class="navelem"><a class="el" href="dir_68a77b0bc8673001e7a269f14784e305.html">drivers</a></li><li class="navelem"><a class="el" href="dir_0a272b5cc5deeb53553d5784b8e7c3ce.html">core</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">IPAddress.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * IPAddress.h - Base class that provides IPAddress</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright (c) 2011 Adrian McEwen. All right reserved.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This library is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * License as published by the Free Software Foundation; either</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * This library is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * Lesser General Public License for more details.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * License along with this library; if not, write to the Free Software</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * Modified by Marcelo Aquino <marceloaqno@gmail.org> for MySensors use</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#ifndef IPAddress_h</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#define IPAddress_h</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <stdint.h></span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <string></span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="class_i_p_address.html"> 32</a></span> <span class="keyword">class </span><a class="code" href="class_i_p_address.html">IPAddress</a></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> {</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">union </span>{</div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="class_i_p_address.html#a3a731bf8c0e7cb974a204c4fcca80127"> 36</a></span>  uint8_t <a class="code" href="class_i_p_address.html#a3a731bf8c0e7cb974a204c4fcca80127">bytes</a>[4]; </div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="class_i_p_address.html#aaae6d8c02dfbf3241e2586d3cc10197d"> 37</a></span>  uint32_t <a class="code" href="class_i_p_address.html#aaae6d8c02dfbf3241e2586d3cc10197d">dword</a>; </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  } _address;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  uint8_t* raw_address()</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  {</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordflow">return</span> _address.bytes;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  }</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <a class="code" href="class_i_p_address.html#a6089825af3b03060f80282d0dcca1582">IPAddress</a>();</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <a class="code" href="class_i_p_address.html#a6089825af3b03060f80282d0dcca1582">IPAddress</a>(uint8_t first_octet, uint8_t second_octet, uint8_t third_octet, uint8_t fourth_octet);</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">explicit</span> <a class="code" href="class_i_p_address.html#a6089825af3b03060f80282d0dcca1582">IPAddress</a>(uint32_t address);</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">explicit</span> <a class="code" href="class_i_p_address.html#a6089825af3b03060f80282d0dcca1582">IPAddress</a>(<span class="keyword">const</span> uint8_t *address);</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">bool</span> <a class="code" href="class_i_p_address.html#ad74ee82b3ceb7144b6b1af47b0664cce">fromString</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *address);</div>
<div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="class_i_p_address.html#a4bb5061e381c254c888373f007542fd0"> 91</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_i_p_address.html#a4bb5061e381c254c888373f007542fd0">fromString</a>(<span class="keyword">const</span> std::string &address)</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  {</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordflow">return</span> <a class="code" href="class_i_p_address.html#ad74ee82b3ceb7144b6b1af47b0664cce">fromString</a>(address.c_str());</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  }</div>
<div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="class_i_p_address.html#af0e86276959426f4675e526825e8c03d"> 100</a></span>  <span class="keyword">operator</span> uint32_t()<span class="keyword"> const</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordflow">return</span> _address.dword;</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  }</div>
<div class="line"><a name="l00108"></a><span class="lineno"><a class="line" href="class_i_p_address.html#a1ba9feba1032a8b93ed473eb19d424c5"> 108</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_i_p_address.html#a1ba9feba1032a8b93ed473eb19d424c5">operator==</a>(<span class="keyword">const</span> <a class="code" href="class_i_p_address.html">IPAddress</a>& addr)<span class="keyword"> const</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordflow">return</span> _address.dword == addr._address.<a class="code" href="class_i_p_address.html#aaae6d8c02dfbf3241e2586d3cc10197d">dword</a>;</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  }</div>
<div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="class_i_p_address.html#ae779b6561c618144470c31da8d268ea0"> 116</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_i_p_address.html#ae779b6561c618144470c31da8d268ea0">operator==</a>(uint32_t addr)<span class="keyword"> const</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordflow">return</span> _address.dword == addr;</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  }</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keywordtype">bool</span> <a class="code" href="class_i_p_address.html#a1ba9feba1032a8b93ed473eb19d424c5">operator==</a>(<span class="keyword">const</span> uint8_t* addr) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00131"></a><span class="lineno"><a class="line" href="class_i_p_address.html#a8d5391a43fa8b71f21927574b565eafb"> 131</a></span>  uint8_t <a class="code" href="class_i_p_address.html#a8d5391a43fa8b71f21927574b565eafb">operator[]</a>(<span class="keywordtype">int</span> index)<span class="keyword"> const</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keywordflow">return</span> _address.bytes[index];</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  }</div>
<div class="line"><a name="l00139"></a><span class="lineno"><a class="line" href="class_i_p_address.html#ab7c569a71648e9235ebb63d7a6d58143"> 139</a></span>  uint8_t& <a class="code" href="class_i_p_address.html#ab7c569a71648e9235ebb63d7a6d58143">operator[]</a>(<span class="keywordtype">int</span> index)</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  {</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keywordflow">return</span> _address.bytes[index];</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  }</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <a class="code" href="class_i_p_address.html">IPAddress</a>& <a class="code" href="class_i_p_address.html#a0dc5d0937fec535ef61daa5d05f30d3a">operator=</a>(<span class="keyword">const</span> uint8_t *address);</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <a class="code" href="class_i_p_address.html">IPAddress</a>& <a class="code" href="class_i_p_address.html#a0dc5d0937fec535ef61daa5d05f30d3a">operator=</a>(uint32_t address);</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  std::string <a class="code" href="class_i_p_address.html#a8061191810bb4dea09b846fb20790bf6">toString</a>();</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  </div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_client.html">Client</a>;</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> };</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  </div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclass_i_p_address_html_a1ba9feba1032a8b93ed473eb19d424c5"><div class="ttname"><a href="class_i_p_address.html#a1ba9feba1032a8b93ed473eb19d424c5">IPAddress::operator==</a></div><div class="ttdeci">bool operator==(const IPAddress &addr) const</div><div class="ttdoc">Overloaded cast operator.</div><div class="ttdef"><b>Definition:</b> IPAddress.h:108</div></div>
<div class="ttc" id="aclass_i_p_address_html_a0dc5d0937fec535ef61daa5d05f30d3a"><div class="ttname"><a href="class_i_p_address.html#a0dc5d0937fec535ef61daa5d05f30d3a">IPAddress::operator=</a></div><div class="ttdeci">IPAddress & operator=(const uint8_t *address)</div><div class="ttdoc">Overloaded copy operators.</div><div class="ttdef"><b>Definition:</b> IPAddress.cpp:87</div></div>
<div class="ttc" id="aclass_i_p_address_html"><div class="ttname"><a href="class_i_p_address.html">IPAddress</a></div><div class="ttdoc">A class to make it easier to handle and pass around IP addresses.</div><div class="ttdef"><b>Definition:</b> IPAddress.h:32</div></div>
<div class="ttc" id="aclass_i_p_address_html_ad74ee82b3ceb7144b6b1af47b0664cce"><div class="ttname"><a href="class_i_p_address.html#ad74ee82b3ceb7144b6b1af47b0664cce">IPAddress::fromString</a></div><div class="ttdeci">bool fromString(const char *address)</div><div class="ttdoc">Set the IP from a array of characters.</div><div class="ttdef"><b>Definition:</b> IPAddress.cpp:51</div></div>
<div class="ttc" id="aclass_i_p_address_html_a8061191810bb4dea09b846fb20790bf6"><div class="ttname"><a href="class_i_p_address.html#a8061191810bb4dea09b846fb20790bf6">IPAddress::toString</a></div><div class="ttdeci">std::string toString()</div><div class="ttdoc">Convert the IP address to a string.</div><div class="ttdef"><b>Definition:</b> IPAddress.cpp:104</div></div>
<div class="ttc" id="aclass_i_p_address_html_ae779b6561c618144470c31da8d268ea0"><div class="ttname"><a href="class_i_p_address.html#ae779b6561c618144470c31da8d268ea0">IPAddress::operator==</a></div><div class="ttdeci">bool operator==(uint32_t addr) const</div><div class="ttdoc">Overloaded cast operator.</div><div class="ttdef"><b>Definition:</b> IPAddress.h:116</div></div>
<div class="ttc" id="aclass_i_p_address_html_a4bb5061e381c254c888373f007542fd0"><div class="ttname"><a href="class_i_p_address.html#a4bb5061e381c254c888373f007542fd0">IPAddress::fromString</a></div><div class="ttdeci">bool fromString(const std::string &address)</div><div class="ttdoc">Set the IP from a string class type.</div><div class="ttdef"><b>Definition:</b> IPAddress.h:91</div></div>
<div class="ttc" id="aclass_i_p_address_html_ab7c569a71648e9235ebb63d7a6d58143"><div class="ttname"><a href="class_i_p_address.html#ab7c569a71648e9235ebb63d7a6d58143">IPAddress::operator[]</a></div><div class="ttdeci">uint8_t & operator[](int index)</div><div class="ttdoc">Overloaded index operator.</div><div class="ttdef"><b>Definition:</b> IPAddress.h:139</div></div>
<div class="ttc" id="aclass_i_p_address_html_a8d5391a43fa8b71f21927574b565eafb"><div class="ttname"><a href="class_i_p_address.html#a8d5391a43fa8b71f21927574b565eafb">IPAddress::operator[]</a></div><div class="ttdeci">uint8_t operator[](int index) const</div><div class="ttdoc">Overloaded index operator.</div><div class="ttdef"><b>Definition:</b> IPAddress.h:131</div></div>
<div class="ttc" id="aclass_i_p_address_html_a3a731bf8c0e7cb974a204c4fcca80127"><div class="ttname"><a href="class_i_p_address.html#a3a731bf8c0e7cb974a204c4fcca80127">IPAddress::bytes</a></div><div class="ttdeci">uint8_t bytes[4]</div><div class="ttdoc">IPv4 address as an array.</div><div class="ttdef"><b>Definition:</b> IPAddress.h:36</div></div>
<div class="ttc" id="aclass_i_p_address_html_aaae6d8c02dfbf3241e2586d3cc10197d"><div class="ttname"><a href="class_i_p_address.html#aaae6d8c02dfbf3241e2586d3cc10197d">IPAddress::dword</a></div><div class="ttdeci">uint32_t dword</div><div class="ttdoc">IPv4 address in 32 bits format.</div><div class="ttdef"><b>Definition:</b> IPAddress.h:37</div></div>
<div class="ttc" id="aclass_client_html"><div class="ttname"><a href="class_client.html">Client</a></div><div class="ttdef"><b>Definition:</b> Client.h:29</div></div>
<div class="ttc" id="aclass_i_p_address_html_a6089825af3b03060f80282d0dcca1582"><div class="ttname"><a href="class_i_p_address.html#a6089825af3b03060f80282d0dcca1582">IPAddress::IPAddress</a></div><div class="ttdeci">IPAddress()</div><div class="ttdoc">IPAddress constructor.</div><div class="ttdef"><b>Definition:</b> IPAddress.cpp:27</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>