<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>DTN Reference Implementation: IPDiscovery.h Source File</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.6 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="main.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <h1>IPDiscovery.h</h1><a href="IPDiscovery_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> <a name="l00002"></a>00002 <span class="comment"> * Copyright 2006 Baylor University</span> <a name="l00003"></a>00003 <span class="comment"> * </span> <a name="l00004"></a>00004 <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span> <a name="l00005"></a>00005 <span class="comment"> * you may not use this file except in compliance with the License.</span> <a name="l00006"></a>00006 <span class="comment"> * You may obtain a copy of the License at</span> <a name="l00007"></a>00007 <span class="comment"> * </span> <a name="l00008"></a>00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span> <a name="l00009"></a>00009 <span class="comment"> * </span> <a name="l00010"></a>00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span> <a name="l00011"></a>00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span> <a name="l00012"></a>00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> <a name="l00013"></a>00013 <span class="comment"> * See the License for the specific language governing permissions and</span> <a name="l00014"></a>00014 <span class="comment"> * limitations under the License.</span> <a name="l00015"></a>00015 <span class="comment"> */</span> <a name="l00016"></a>00016 <a name="l00017"></a>00017 <span class="preprocessor">#ifndef _IP_DISCOVERY_H_</span> <a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define _IP_DISCOVERY_H_</span> <a name="l00019"></a>00019 <span class="preprocessor"></span> <a name="l00020"></a>00020 <span class="preprocessor">#include <oasys/thread/Thread.h></span> <a name="l00021"></a>00021 <span class="preprocessor">#include <oasys/thread/Notifier.h></span> <a name="l00022"></a>00022 <span class="preprocessor">#include <oasys/io/NetUtils.h></span> <a name="l00023"></a>00023 <span class="preprocessor">#include <oasys/io/UDPClient.h></span> <a name="l00024"></a>00024 <a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="Discovery_8h.html">discovery/Discovery.h</a>"</span> <a name="l00026"></a>00026 <a name="l00027"></a>00027 <span class="keyword">namespace </span>dtn { <a name="l00028"></a>00028 <a name="l00035"></a><a class="code" href="classdtn_1_1IPDiscovery.html">00035</a> <span class="keyword">class </span><a class="code" href="classdtn_1_1IPDiscovery.html" title="IPDiscovery is the main thread in IP-based neighbor discovery, configured via config...">IPDiscovery</a> : <span class="keyword">public</span> <a class="code" href="classdtn_1_1Discovery.html" title="Abstraction of neighbor discovery agent.">Discovery</a>, <a name="l00036"></a>00036 <span class="keyword">public</span> oasys::Thread <a name="l00037"></a>00037 { <a name="l00038"></a>00038 <span class="keyword">public</span>: <a name="l00039"></a>00039 <a name="l00044"></a><a class="code" href="classdtn_1_1IPDiscovery.html#545fd19e7aaca3eab08b4ff279fc63b4">00044</a> <span class="keyword">static</span> <span class="keyword">const</span> u_int32_t <a class="code" href="classdtn_1_1IPDiscovery.html#545fd19e7aaca3eab08b4ff279fc63b4" title="If no other options are set for destination, default to sending to the IPv4 broadcast...">DEFAULT_DST_ADDR</a>; <a name="l00045"></a>00045 <a name="l00050"></a><a class="code" href="classdtn_1_1IPDiscovery.html#7f1787a9f154ff88952209924f02e273">00050</a> <span class="keyword">static</span> <span class="keyword">const</span> u_int32_t <a class="code" href="classdtn_1_1IPDiscovery.html#7f1787a9f154ff88952209924f02e273" title="If no other options are set for source, use this as default local address.">DEFAULT_SRC_ADDR</a>; <a name="l00051"></a>00051 <a name="l00055"></a><a class="code" href="classdtn_1_1IPDiscovery.html#dacf3f66ee13744990d8cb0c54c37585">00055</a> <span class="keyword">static</span> <span class="keyword">const</span> u_int <a class="code" href="classdtn_1_1IPDiscovery.html#dacf3f66ee13744990d8cb0c54c37585" title="If no other options are set for multicast TTL, set to 1.">DEFAULT_MCAST_TTL</a>; <a name="l00056"></a>00056 <a name="l00061"></a><a class="code" href="structdtn_1_1IPDiscovery_1_1DiscoveryHeader.html">00061</a> <span class="keyword">struct </span><a class="code" href="structdtn_1_1IPDiscovery_1_1DiscoveryHeader.html" title="On-the-wire (radio, whatever) representation of IP address family&#39;s advertisement...">DiscoveryHeader</a> <a name="l00062"></a>00062 { <a name="l00063"></a><a class="code" href="structdtn_1_1IPDiscovery_1_1DiscoveryHeader.html#32a40fc26bb8c14a9dc8ebee32150e12">00063</a> u_int8_t <a class="code" href="structdtn_1_1IPDiscovery_1_1DiscoveryHeader.html#32a40fc26bb8c14a9dc8ebee32150e12">cl_type</a>; <span class="comment">// Type of CL offered</span> <a name="l00064"></a><a class="code" href="structdtn_1_1IPDiscovery_1_1DiscoveryHeader.html#77f320b3585d19dcadcb48f2ec61c8d0">00064</a> u_int8_t <a class="code" href="structdtn_1_1IPDiscovery_1_1DiscoveryHeader.html#77f320b3585d19dcadcb48f2ec61c8d0">interval</a>; <span class="comment">// 100ms units</span> <a name="l00065"></a><a class="code" href="structdtn_1_1IPDiscovery_1_1DiscoveryHeader.html#0f116d9dcd8bda3dc04ef39289472616">00065</a> u_int16_t <a class="code" href="structdtn_1_1IPDiscovery_1_1DiscoveryHeader.html#0f116d9dcd8bda3dc04ef39289472616">length</a>; <span class="comment">// total length of packet</span> <a name="l00066"></a><a class="code" href="structdtn_1_1IPDiscovery_1_1DiscoveryHeader.html#c5a98cccac5ccd9d4643cc1cd93d67f5">00066</a> u_int32_t <a class="code" href="structdtn_1_1IPDiscovery_1_1DiscoveryHeader.html#c5a98cccac5ccd9d4643cc1cd93d67f5">inet_addr</a>; <span class="comment">// IPv4 address of CL</span> <a name="l00067"></a><a class="code" href="structdtn_1_1IPDiscovery_1_1DiscoveryHeader.html#54865d9ae240388f13b78dc74f8ae26f">00067</a> u_int16_t <a class="code" href="structdtn_1_1IPDiscovery_1_1DiscoveryHeader.html#54865d9ae240388f13b78dc74f8ae26f">inet_port</a>; <span class="comment">// IPv4 port of CL</span> <a name="l00068"></a><a class="code" href="structdtn_1_1IPDiscovery_1_1DiscoveryHeader.html#f0b39f36e48f357726218ac7d88e3343">00068</a> u_int16_t <a class="code" href="structdtn_1_1IPDiscovery_1_1DiscoveryHeader.html#f0b39f36e48f357726218ac7d88e3343">name_len</a>; <span class="comment">// length of EID</span> <a name="l00069"></a><a class="code" href="structdtn_1_1IPDiscovery_1_1DiscoveryHeader.html#37420e481d125d89aaef220b3b906e3d">00069</a> <span class="keywordtype">char</span> <a class="code" href="structdtn_1_1IPDiscovery_1_1DiscoveryHeader.html#37420e481d125d89aaef220b3b906e3d">sender_name</a>[0]; <span class="comment">// DTN URI of beacon sender</span> <a name="l00070"></a>00070 } <a name="l00071"></a>00071 __attribute__((<a class="code" href="classdtn_1_1IPDiscovery.html#8f3f429b61a5a093b489aebb5b396cdd" title="On-the-wire (radio, whatever) representation of IP address family&#39;s advertisement...">packed</a>)); <a name="l00072"></a>00072 <a name="l00076"></a><a class="code" href="classdtn_1_1IPDiscovery.html#dba811f3518ddee9d6e16317af505e4d">00076</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> <a name="l00077"></a>00077 { <a name="l00078"></a><a class="code" href="classdtn_1_1IPDiscovery.html#dba811f3518ddee9d6e16317af505e4da1050e8e6503c2c97a1bc73d6a81eef5">00078</a> <a class="code" href="classdtn_1_1IPDiscovery.html#dba811f3518ddee9d6e16317af505e4da1050e8e6503c2c97a1bc73d6a81eef5">UNDEFINED</a> = 0, <a name="l00079"></a><a class="code" href="classdtn_1_1IPDiscovery.html#dba811f3518ddee9d6e16317af505e4d6d63305412b48547e0769f25bb2829c9">00079</a> <a class="code" href="classdtn_1_1IPDiscovery.html#dba811f3518ddee9d6e16317af505e4d6d63305412b48547e0769f25bb2829c9">TCPCL</a> = 1, <span class="comment">// TCP Convergence Layer</span> <a name="l00080"></a><a class="code" href="classdtn_1_1IPDiscovery.html#dba811f3518ddee9d6e16317af505e4dab0183b990af8abb3b948d2c35077ead">00080</a> <a class="code" href="classdtn_1_1IPDiscovery.html#dba811f3518ddee9d6e16317af505e4dab0183b990af8abb3b948d2c35077ead">UDPCL</a> = 2, <span class="comment">// UDP Convergence Layer</span> <a name="l00081"></a>00081 } <a name="l00082"></a>00082 <a class="code" href="classdtn_1_1IPDiscovery.html#dba811f3518ddee9d6e16317af505e4d" title="Enumerate which type of CL is advertised.">cl_type_t</a>; <a name="l00083"></a>00083 <a name="l00084"></a><a class="code" href="classdtn_1_1IPDiscovery.html#b8d11e70af91ec4342bb5be2016de212">00084</a> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classdtn_1_1IPDiscovery.html#b8d11e70af91ec4342bb5be2016de212">type_to_str</a>(<a class="code" href="classdtn_1_1IPDiscovery.html#dba811f3518ddee9d6e16317af505e4d" title="Enumerate which type of CL is advertised.">cl_type_t</a> t) <a name="l00085"></a>00085 { <a name="l00086"></a>00086 <span class="keywordflow">switch</span>(t) { <a name="l00087"></a>00087 <span class="keywordflow">case</span> <a class="code" href="classdtn_1_1IPDiscovery.html#dba811f3518ddee9d6e16317af505e4d6d63305412b48547e0769f25bb2829c9">TCPCL</a>: <span class="keywordflow">return</span> <span class="stringliteral">"tcp"</span>; <a name="l00088"></a>00088 <span class="keywordflow">case</span> <a class="code" href="classdtn_1_1IPDiscovery.html#dba811f3518ddee9d6e16317af505e4dab0183b990af8abb3b948d2c35077ead">UDPCL</a>: <span class="keywordflow">return</span> <span class="stringliteral">"udp"</span>; <a name="l00089"></a>00089 <span class="keywordflow">case</span> <a class="code" href="classdtn_1_1IPDiscovery.html#dba811f3518ddee9d6e16317af505e4da1050e8e6503c2c97a1bc73d6a81eef5">UNDEFINED</a>: <a name="l00090"></a>00090 <span class="keywordflow">default</span>: PANIC(<span class="stringliteral">"Undefined cl_type_t %d"</span>,t); <a name="l00091"></a>00091 } <a name="l00092"></a>00092 NOTREACHED; <a name="l00093"></a>00093 } <a name="l00094"></a>00094 <a name="l00095"></a><a class="code" href="classdtn_1_1IPDiscovery.html#f3bcef2eded36d54a1411992bebc058c">00095</a> <span class="keyword">static</span> <a class="code" href="classdtn_1_1IPDiscovery.html#dba811f3518ddee9d6e16317af505e4d" title="Enumerate which type of CL is advertised.">cl_type_t</a> <a class="code" href="classdtn_1_1IPDiscovery.html#f3bcef2eded36d54a1411992bebc058c">str_to_type</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* cltype) <a name="l00096"></a>00096 { <a name="l00097"></a>00097 <span class="keywordflow">if</span> (strncmp(cltype,<span class="stringliteral">"tcp"</span>,3) == 0) <a name="l00098"></a>00098 <span class="keywordflow">return</span> <a class="code" href="classdtn_1_1IPDiscovery.html#dba811f3518ddee9d6e16317af505e4d6d63305412b48547e0769f25bb2829c9">TCPCL</a>; <a name="l00099"></a>00099 <span class="keywordflow">else</span> <a name="l00100"></a>00100 <span class="keywordflow">if</span> (strncmp(cltype,<span class="stringliteral">"udp"</span>,3) == 0) <a name="l00101"></a>00101 <span class="keywordflow">return</span> <a class="code" href="classdtn_1_1IPDiscovery.html#dba811f3518ddee9d6e16317af505e4dab0183b990af8abb3b948d2c35077ead">UDPCL</a>; <a name="l00102"></a>00102 <span class="keywordflow">else</span> <a name="l00103"></a>00103 PANIC(<span class="stringliteral">"Unsupported CL type %s"</span>,cltype); <a name="l00104"></a>00104 NOTREACHED; <a name="l00105"></a>00105 } <a name="l00106"></a>00106 <a name="l00110"></a><a class="code" href="classdtn_1_1IPDiscovery.html#94633c542ce6d031e5583899e0496f00">00110</a> <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1IPDiscovery.html#94633c542ce6d031e5583899e0496f00" title="Close main socket, causing thread to exit.">shutdown</a>() { <a class="code" href="classdtn_1_1IPDiscovery.html#004f9f774345cd25eb73ea4558b86bd7" title="signal to close down thread">shutdown_</a> = <span class="keyword">true</span>; <a class="code" href="classdtn_1_1IPDiscovery.html#d2d28582fc8830ca107cc07aa9b79a5e" title="the socket for beacons in- and out-bound">socket_</a>.get_notifier()->notify(); } <a name="l00111"></a>00111 <a name="l00112"></a><a class="code" href="classdtn_1_1IPDiscovery.html#79f93179608551c7c8b2bd8310e979cd">00112</a> <span class="keyword">virtual</span> <a class="code" href="classdtn_1_1IPDiscovery.html#79f93179608551c7c8b2bd8310e979cd">~IPDiscovery</a>() {} <a name="l00113"></a>00113 <a name="l00114"></a>00114 <span class="keyword">protected</span>: <a name="l00115"></a><a class="code" href="classdtn_1_1IPDiscovery.html#135e7ff6ba537b610e4d0db2968d9a2a">00115</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classdtn_1_1Discovery.html" title="Abstraction of neighbor discovery agent.">Discovery</a>; <a name="l00116"></a>00116 <a name="l00117"></a>00117 <a class="code" href="classdtn_1_1IPDiscovery.html#ac1eecdacc9c8cc817b1fe781d4b8310">IPDiscovery</a>(<span class="keyword">const</span> std::string& <a class="code" href="classdtn_1_1Discovery.html#28f6c94d28520370db8c09c8b5881b8f" title="Name of this Discovery instance.">name</a>); <a name="l00118"></a>00118 <a name="l00123"></a>00123 <span class="keywordtype">bool</span> <a class="code" href="classdtn_1_1IPDiscovery.html#3705ccea8c5e02f26aa9082a0bcca0c8" title="Set internal state using parameter list; return true on success, else false.">configure</a>(<span class="keywordtype">int</span> argc, <span class="keyword">const</span> <span class="keywordtype">char</span>* argv[]); <a name="l00124"></a>00124 <a name="l00128"></a>00128 <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1IPDiscovery.html#4ba6e7fe4ee9f19945b4c1aaf7d7ab8a" title="virtual from oasys::Thread">run</a>(); <a name="l00129"></a>00129 <a name="l00134"></a>00134 <span class="keywordtype">bool</span> <a class="code" href="classdtn_1_1IPDiscovery.html#ac535bfa53ab2daf771e65c48db9781c" title="Convenience method to pull the relevant items out of the inbound packet.">parse_advertisement</a>(u_char* <a class="code" href="num2sdnv_8c.html#a81cdcc7ff6987bc85c073253e32715f">buf</a>, <span class="keywordtype">size_t</span> <a class="code" href="num2sdnv_8c.html#fed088663f8704004425cdae2120b9b3">len</a>, <a name="l00135"></a>00135 in_addr_t remote_addr, <a name="l00136"></a>00136 u_int8_t& cl_type, <a name="l00137"></a>00137 std::string& nexthop, <a name="l00138"></a>00138 <a class="code" href="classdtn_1_1EndpointID.html">EndpointID</a>& remote_eid); <a name="l00139"></a>00139 <a name="l00143"></a><a class="code" href="classdtn_1_1IPDiscovery.html#f111297820476cf22fc94d9bcd1a0b4b">00143</a> <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1IPDiscovery.html#f111297820476cf22fc94d9bcd1a0b4b" title="Virtual from Discovery.">handle_announce</a>() <a name="l00144"></a>00144 { <a name="l00145"></a>00145 <a class="code" href="classdtn_1_1IPDiscovery.html#d2d28582fc8830ca107cc07aa9b79a5e" title="the socket for beacons in- and out-bound">socket_</a>.get_notifier()->notify(); <a name="l00146"></a>00146 } <a name="l00147"></a>00147 <a name="l00148"></a><a class="code" href="classdtn_1_1IPDiscovery.html#004f9f774345cd25eb73ea4558b86bd7">00148</a> <span class="keyword">volatile</span> <span class="keywordtype">bool</span> <a class="code" href="classdtn_1_1IPDiscovery.html#004f9f774345cd25eb73ea4558b86bd7" title="signal to close down thread">shutdown_</a>; <a name="l00149"></a><a class="code" href="classdtn_1_1IPDiscovery.html#45216229a536034944802a1bf0e3f866">00149</a> in_addr_t <a class="code" href="classdtn_1_1IPDiscovery.html#45216229a536034944802a1bf0e3f866" title="address for bind() to receive beacons">local_addr_</a>; <a name="l00150"></a><a class="code" href="classdtn_1_1IPDiscovery.html#54a253ff502020915fa2521ca9a83e3e">00150</a> u_int16_t <a class="code" href="classdtn_1_1IPDiscovery.html#54a253ff502020915fa2521ca9a83e3e" title="local and remote">port_</a>; <a name="l00151"></a><a class="code" href="classdtn_1_1IPDiscovery.html#92c069ec1b1e15bad6cf52d926442213">00151</a> in_addr_t <a class="code" href="classdtn_1_1IPDiscovery.html#92c069ec1b1e15bad6cf52d926442213" title="whether unicast, multicast, or broadcast">remote_addr_</a>; <a name="l00152"></a><a class="code" href="classdtn_1_1IPDiscovery.html#83213d3cb154802ff76e9b07763b95d3">00152</a> u_int <a class="code" href="classdtn_1_1IPDiscovery.html#83213d3cb154802ff76e9b07763b95d3" title="TTL hop count for multicast option.">mcast_ttl_</a>; <a name="l00153"></a><a class="code" href="classdtn_1_1IPDiscovery.html#d2d28582fc8830ca107cc07aa9b79a5e">00153</a> oasys::UDPClient <a class="code" href="classdtn_1_1IPDiscovery.html#d2d28582fc8830ca107cc07aa9b79a5e" title="the socket for beacons in- and out-bound">socket_</a>; <a name="l00154"></a><a class="code" href="classdtn_1_1IPDiscovery.html#18f8ef2702f024cdc5a87cbc2e676b74">00154</a> <span class="keywordtype">bool</span> <a class="code" href="classdtn_1_1IPDiscovery.html#18f8ef2702f024cdc5a87cbc2e676b74" title="whether to exit thread on send/recv failures">persist_</a>; <a name="l00155"></a>00155 }; <a name="l00156"></a>00156 <a name="l00157"></a>00157 } <span class="comment">// namespace dtn</span> <a name="l00158"></a>00158 <a name="l00159"></a>00159 <span class="preprocessor">#endif </span><span class="comment">/* _IP_DISCOVERY_H_ */</span> </pre></div></div> <hr size="1"><address style="text-align: right;"><small>Generated on Mon Jul 21 14:09:46 2008 for DTN Reference Implementation by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> </body> </html>