<!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: Discovery.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>Discovery.h</h1><a href="Discovery_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 _DISCOVERY_H_</span> <a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define _DISCOVERY_H_</span> <a name="l00019"></a>00019 <span class="preprocessor"></span> <a name="l00020"></a>00020 <span class="preprocessor">#include <oasys/debug/Log.h></span> <a name="l00021"></a>00021 <span class="preprocessor">#include <string></span> <a name="l00022"></a>00022 <span class="preprocessor">#include <list></span> <a name="l00023"></a>00023 <span class="preprocessor">#include "<a class="code" href="EndpointID_8h.html">naming/EndpointID.h</a>"</span> <a name="l00024"></a>00024 <span class="preprocessor">#include "<a class="code" href="Announce_8h.html">Announce.h</a>"</span> <a name="l00025"></a>00025 <a name="l00026"></a>00026 <span class="keyword">namespace </span>dtn { <a name="l00027"></a>00027 <a name="l00043"></a><a class="code" href="classdtn_1_1Discovery.html">00043</a> <span class="keyword">class </span><a class="code" href="classdtn_1_1Discovery.html" title="Abstraction of neighbor discovery agent.">Discovery</a> : <span class="keyword">public</span> oasys::<a class="code" href="classoasys_1_1Logger.html">Logger</a> { <a name="l00044"></a>00044 <span class="keyword">public</span>: <a name="l00045"></a>00045 <a name="l00049"></a><a class="code" href="classdtn_1_1Discovery.html#28f6c94d28520370db8c09c8b5881b8f">00049</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>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classdtn_1_1Discovery.html#d4185c5818cecaa562007ceffe6094be" title="name of discovery agent">name_</a>; } <a name="l00050"></a>00050 <a name="l00054"></a><a class="code" href="classdtn_1_1Discovery.html#d7c9a3ccbbd873c1bdf3ecbcb7c57fb1">00054</a> <span class="keyword">const</span> std::string& <a class="code" href="classdtn_1_1Discovery.html#d7c9a3ccbbd873c1bdf3ecbcb7c57fb1" title="Address family represented by this Discovery instance.">af</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classdtn_1_1Discovery.html#7f8f0dea257fee3d3c6b3518b46c8ac0" title="address family">af_</a>; } <a name="l00055"></a>00055 <a name="l00059"></a><a class="code" href="classdtn_1_1Discovery.html#557dc2728857713d10d32d0acf103fcd">00059</a> <span class="keyword">const</span> std::string& <a class="code" href="classdtn_1_1Discovery.html#557dc2728857713d10d32d0acf103fcd" title="Outbound address of advertisements sent by this Discovery instance.">to_addr</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classdtn_1_1Discovery.html#57590a19bd9c6b2502d336e5d6ac1f2f" title="outbound address of advertisements sent">to_addr_</a>; } <a name="l00060"></a>00060 <a name="l00064"></a><a class="code" href="classdtn_1_1Discovery.html#49013a21df2b9804c1632265fa2fadb0">00064</a> <span class="keyword">const</span> std::string& <a class="code" href="classdtn_1_1Discovery.html#49013a21df2b9804c1632265fa2fadb0" title="Local address on which to listen for advertisements.">local_addr</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classdtn_1_1Discovery.html#f969a96a14aed8cad5b8cf6a8e47f6cd" title="address of beacon listener">local_</a>; } <a name="l00065"></a>00065 <a name="l00070"></a>00070 <span class="keyword">static</span> <a class="code" href="classdtn_1_1Discovery.html" title="Abstraction of neighbor discovery agent.">Discovery</a>* <a class="code" href="classdtn_1_1Discovery.html#a4db7b5f18c029eb30bf5f90a8b872a3" title="Factory method for instantiating objects from the appropriate derived class.">create_discovery</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="l00071"></a>00071 <span class="keyword">const</span> std::string& afname, <a name="l00072"></a>00072 <span class="keywordtype">int</span> argc, <span class="keyword">const</span> <span class="keywordtype">char</span>* argv[], <a name="l00073"></a>00073 <span class="keyword">const</span> <span class="keywordtype">char</span>** error); <a name="l00077"></a>00077 <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1Discovery.html#a380c76912923a5a2f5ead66d92f2259" title="Append snapshot of object state to StringBuffer.">dump</a>(oasys::StringBuffer* <a class="code" href="num2sdnv_8c.html#a81cdcc7ff6987bc85c073253e32715f">buf</a>); <a name="l00078"></a>00078 <a name="l00083"></a>00083 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1Discovery.html#f9d87f0da923ab6ede111146b3348771" title="Close down listening socket and stop the thread.">shutdown</a>() = 0; <a name="l00084"></a>00084 <a name="l00089"></a>00089 <span class="keywordtype">bool</span> <a class="code" href="classdtn_1_1Discovery.html#17302a43a3e0ee32249b9fbc9b58e1f8" title="Register an Announce to advertise a local convergence layer and to respond to advertisements...">announce</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classdtn_1_1Discovery.html#28f6c94d28520370db8c09c8b5881b8f" title="Name of this Discovery instance.">name</a>, <span class="keywordtype">int</span> argc, <span class="keyword">const</span> <span class="keywordtype">char</span>* argv[]); <a name="l00090"></a>00090 <a name="l00094"></a>00094 <span class="keywordtype">bool</span> <span class="keyword">remove</span>(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classdtn_1_1Discovery.html#28f6c94d28520370db8c09c8b5881b8f" title="Name of this Discovery instance.">name</a>); <a name="l00095"></a>00095 <a name="l00099"></a>00099 <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1Discovery.html#6b6da97e92e834b9997b9fc2812fe74b" title="Handle neighbor discovery out to registered DiscoveryInfo objects.">handle_neighbor_discovered</a>(<span class="keyword">const</span> std::string& cl_type, <a name="l00100"></a>00100 <span class="keyword">const</span> std::string& cl_addr, <a name="l00101"></a>00101 <span class="keyword">const</span> <a class="code" href="classdtn_1_1EndpointID.html">EndpointID</a>& remote_eid); <a name="l00102"></a>00102 <a name="l00103"></a>00103 <span class="keyword">virtual</span> <a class="code" href="classdtn_1_1Discovery.html#aaadd0d123505014b40b619f68649f1a">~Discovery</a>(); <a name="l00104"></a>00104 <span class="keyword">protected</span>: <a name="l00105"></a><a class="code" href="classdtn_1_1Discovery.html#409a7b1face715e4b04b811a779d9b69">00105</a> <span class="keyword">typedef</span> std::list<Announce*> <a class="code" href="classdtn_1_1Discovery.html#409a7b1face715e4b04b811a779d9b69">List</a>; <a name="l00106"></a><a class="code" href="classdtn_1_1Discovery.html#e046ec0e0ebde9cf34e14d94e56ea3bf">00106</a> <span class="keyword">typedef</span> std::list<Announce*>::iterator <a class="code" href="classdtn_1_1Discovery.html#e046ec0e0ebde9cf34e14d94e56ea3bf">iterator</a>; <a name="l00107"></a>00107 <a name="l00111"></a>00111 <a class="code" href="classdtn_1_1Discovery.html#aa536748f814cdce863b347d2be9b6c5" title="Constructor.">Discovery</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="l00112"></a>00112 <span class="keyword">const</span> std::string& <a class="code" href="classdtn_1_1Discovery.html#d7c9a3ccbbd873c1bdf3ecbcb7c57fb1" title="Address family represented by this Discovery instance.">af</a>); <a name="l00113"></a>00113 <a name="l00117"></a>00117 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classdtn_1_1Discovery.html#ddea830e6b09b41a73d98deaba7733a1" title="Configure this Discovery instance.">configure</a>(<span class="keywordtype">int</span> argc, <span class="keyword">const</span> <span class="keywordtype">char</span>* argv[]) = 0; <a name="l00118"></a>00118 <a name="l00122"></a><a class="code" href="classdtn_1_1Discovery.html#08dc1eadc966b0cd59ee5fcc11b8d0d8">00122</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1Discovery.html#08dc1eadc966b0cd59ee5fcc11b8d0d8" title="Optional handler for new Announce registration.">handle_announce</a>() {} <a name="l00123"></a>00123 <a name="l00127"></a>00127 <span class="keywordtype">bool</span> <a class="code" href="classdtn_1_1Discovery.html#2194b4baca2e632b1f4335c02ae33344" title="Find a registration by name.">find</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classdtn_1_1Discovery.html#28f6c94d28520370db8c09c8b5881b8f" title="Name of this Discovery instance.">name</a>, <a class="code" href="classdtn_1_1Discovery.html#e046ec0e0ebde9cf34e14d94e56ea3bf">iterator</a>* iter); <a name="l00128"></a>00128 <a name="l00129"></a><a class="code" href="classdtn_1_1Discovery.html#d4185c5818cecaa562007ceffe6094be">00129</a> std::string <a class="code" href="classdtn_1_1Discovery.html#d4185c5818cecaa562007ceffe6094be" title="name of discovery agent">name_</a>; <a name="l00130"></a><a class="code" href="classdtn_1_1Discovery.html#7f8f0dea257fee3d3c6b3518b46c8ac0">00130</a> std::string <a class="code" href="classdtn_1_1Discovery.html#7f8f0dea257fee3d3c6b3518b46c8ac0" title="address family">af_</a>; <a name="l00131"></a><a class="code" href="classdtn_1_1Discovery.html#57590a19bd9c6b2502d336e5d6ac1f2f">00131</a> std::string <a class="code" href="classdtn_1_1Discovery.html#57590a19bd9c6b2502d336e5d6ac1f2f" title="outbound address of advertisements sent">to_addr_</a>; <a name="l00132"></a><a class="code" href="classdtn_1_1Discovery.html#f969a96a14aed8cad5b8cf6a8e47f6cd">00132</a> std::string <a class="code" href="classdtn_1_1Discovery.html#f969a96a14aed8cad5b8cf6a8e47f6cd" title="address of beacon listener">local_</a>; <a name="l00133"></a><a class="code" href="classdtn_1_1Discovery.html#7fb0c15e93e20fccdf1bb439aefa34e3">00133</a> <a class="code" href="classdtn_1_1Discovery.html#409a7b1face715e4b04b811a779d9b69">List</a> <a class="code" href="classdtn_1_1Discovery.html#7fb0c15e93e20fccdf1bb439aefa34e3" title="registered Announce objects">list_</a>; <a name="l00134"></a>00134 <span class="keyword">private</span>: <a name="l00135"></a><a class="code" href="classdtn_1_1Discovery.html#889fcde794689b2156dfeb50c8e61024">00135</a> <a class="code" href="classdtn_1_1Discovery.html#aa536748f814cdce863b347d2be9b6c5" title="Constructor.">Discovery</a>(<span class="keyword">const</span> <a class="code" href="classdtn_1_1Discovery.html" title="Abstraction of neighbor discovery agent.">Discovery</a>&) <a name="l00136"></a>00136 : oasys::<a class="code" href="classoasys_1_1Logger.html">Logger</a>(<span class="stringliteral">"Discovery"</span>,<span class="stringliteral">"/no/loggy/here"</span>) <a name="l00137"></a>00137 {} <a name="l00138"></a>00138 }; <span class="comment">// class Discovery</span> <a name="l00139"></a>00139 <a name="l00140"></a>00140 }; <span class="comment">// namespace dtn</span> <a name="l00141"></a>00141 <a name="l00142"></a>00142 <span class="preprocessor">#endif // _DISCOVERY_H_</span> </pre></div></div> <hr size="1"><address style="text-align: right;"><small>Generated on Mon Jul 21 14:09:39 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>