<!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: dtn::EndpointIDPattern 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.5.8 --> <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 class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</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="namespacedtn.html">dtn</a>::<a class="el" href="classdtn_1_1EndpointIDPattern.html">EndpointIDPattern</a> </div> </div> <div class="contents"> <h1>dtn::EndpointIDPattern Class Reference</h1><!-- doxytag: class="dtn::EndpointIDPattern" --><!-- doxytag: inherits="dtn::EndpointID" -->A Distinct class for endpoint patterns (i.e. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="EndpointID_8h-source.html">EndpointID.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for dtn::EndpointIDPattern:</div> <div class="dynsection"> <p><center><img src="classdtn_1_1EndpointIDPattern.png" usemap="#dtn::EndpointIDPattern_map" border="0" alt=""></center> <map name="dtn::EndpointIDPattern_map"> <area href="classdtn_1_1EndpointID.html" alt="dtn::EndpointID" shape="rect" coords="0,0,136,24"> </map> </div> <p> <a href="classdtn_1_1EndpointIDPattern-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1EndpointIDPattern.html#6fd799ef093d74adf2661c9e519cbfde">EndpointIDPattern</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#6fd799ef093d74adf2661c9e519cbfde"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1EndpointIDPattern.html#048f8e6ed984329cdf463f567f68e905">EndpointIDPattern</a> (const std::string &str)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct the endpoint id pattern from the given string. <a href="#048f8e6ed984329cdf463f567f68e905"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1EndpointIDPattern.html#3a341fd72351a40ff8230ac38dfbceab">EndpointIDPattern</a> (const <a class="el" href="classdtn_1_1EndpointIDPattern.html">EndpointIDPattern</a> &other)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct the endpoint id pattern from another. <a href="#3a341fd72351a40ff8230ac38dfbceab"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1EndpointIDPattern.html#1045b12747fae5632d9e808cf3060021">EndpointIDPattern</a> (const <a class="el" href="classdtn_1_1EndpointID.html">EndpointID</a> &other)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct the endpoint id pattern from another that is not necessarily a pattern. <a href="#1045b12747fae5632d9e808cf3060021"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1EndpointIDPattern.html#551ee984666d2079f9ccdc5514dcbdc6">match</a> (const <a class="el" href="classdtn_1_1EndpointID.html">EndpointID</a> &eid) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Shortcut to the matching functionality implemented by the scheme. <a href="#551ee984666d2079f9ccdc5514dcbdc6"></a><br></td></tr> <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classdtn_1_1EndpointIDPattern.html">EndpointIDPattern</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1EndpointIDPattern.html#9f872c8e701944c46b8989257d3188f2">WILDCARD_EID</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the special wildcard Endpoint ID. <a href="#9f872c8e701944c46b8989257d3188f2"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> A Distinct class for endpoint patterns (i.e. <p> those containing some form of wildcarding) as opposed to basic endpoint IDs to help keep it straight in the code. <p>Definition at line <a class="el" href="EndpointID_8h-source.html#l00290">290</a> of file <a class="el" href="EndpointID_8h-source.html">EndpointID.h</a>.</p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="6fd799ef093d74adf2661c9e519cbfde"></a><!-- doxytag: member="dtn::EndpointIDPattern::EndpointIDPattern" ref="6fd799ef093d74adf2661c9e519cbfde" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">dtn::EndpointIDPattern::EndpointIDPattern </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Default constructor. <p> <p>Definition at line <a class="el" href="EndpointID_8h-source.html#l00295">295</a> of file <a class="el" href="EndpointID_8h-source.html">EndpointID.h</a>.</p> <p>References <a class="el" href="EndpointID_8h-source.html#l00282">dtn::EndpointID::is_pattern_</a>, and <a class="el" href="EndpointID_8h-source.html#l00277">dtn::EndpointID::uri_</a>.</p> </div> </div><p> <a class="anchor" name="048f8e6ed984329cdf463f567f68e905"></a><!-- doxytag: member="dtn::EndpointIDPattern::EndpointIDPattern" ref="048f8e6ed984329cdf463f567f68e905" args="(const std::string &str)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">dtn::EndpointIDPattern::EndpointIDPattern </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>str</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Construct the endpoint id pattern from the given string. <p> <p>Definition at line <a class="el" href="EndpointID_8h-source.html#l00304">304</a> of file <a class="el" href="EndpointID_8h-source.html">EndpointID.h</a>.</p> <p>References <a class="el" href="EndpointID_8h-source.html#l00084">dtn::EndpointID::assign()</a>, <a class="el" href="EndpointID_8h-source.html#l00282">dtn::EndpointID::is_pattern_</a>, and <a class="el" href="EndpointID_8h-source.html#l00277">dtn::EndpointID::uri_</a>.</p> </div> </div><p> <a class="anchor" name="3a341fd72351a40ff8230ac38dfbceab"></a><!-- doxytag: member="dtn::EndpointIDPattern::EndpointIDPattern" ref="3a341fd72351a40ff8230ac38dfbceab" args="(const EndpointIDPattern &other)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">dtn::EndpointIDPattern::EndpointIDPattern </td> <td>(</td> <td class="paramtype">const <a class="el" href="classdtn_1_1EndpointIDPattern.html">EndpointIDPattern</a> & </td> <td class="paramname"> <em>other</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Construct the endpoint id pattern from another. <p> <p>Definition at line <a class="el" href="EndpointID_8h-source.html#l00314">314</a> of file <a class="el" href="EndpointID_8h-source.html">EndpointID.h</a>.</p> </div> </div><p> <a class="anchor" name="1045b12747fae5632d9e808cf3060021"></a><!-- doxytag: member="dtn::EndpointIDPattern::EndpointIDPattern" ref="1045b12747fae5632d9e808cf3060021" args="(const EndpointID &other)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">dtn::EndpointIDPattern::EndpointIDPattern </td> <td>(</td> <td class="paramtype">const <a class="el" href="classdtn_1_1EndpointID.html">EndpointID</a> & </td> <td class="paramname"> <em>other</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Construct the endpoint id pattern from another that is not necessarily a pattern. <p> <p>Definition at line <a class="el" href="EndpointID_8h-source.html#l00321">321</a> of file <a class="el" href="EndpointID_8h-source.html">EndpointID.h</a>.</p> <p>References <a class="el" href="EndpointID_8h-source.html#l00282">dtn::EndpointID::is_pattern_</a>, <a class="el" href="EndpointID_8h-source.html#l00277">dtn::EndpointID::uri_</a>, and <a class="el" href="EndpointID_8cc-source.html#l00044">dtn::EndpointID::validate()</a>.</p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="551ee984666d2079f9ccdc5514dcbdc6"></a><!-- doxytag: member="dtn::EndpointIDPattern::match" ref="551ee984666d2079f9ccdc5514dcbdc6" args="(const EndpointID &eid) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> dtn::EndpointIDPattern::match </td> <td>(</td> <td class="paramtype">const <a class="el" href="classdtn_1_1EndpointID.html">EndpointID</a> & </td> <td class="paramname"> <em>eid</em> </td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p> Shortcut to the matching functionality implemented by the scheme. <p> <p>Definition at line <a class="el" href="EndpointID_8cc-source.html#l00197">197</a> of file <a class="el" href="EndpointID_8cc-source.html">EndpointID.cc</a>.</p> <p>References <a class="el" href="EndpointID_8h-source.html#l00264">dtn::EndpointID::c_str()</a>, <a class="el" href="EndpointID_8h-source.html#l00222">dtn::EndpointID::glob_unknown_schemes_</a>, <a class="el" href="EndpointID_8h-source.html#l00233">dtn::EndpointID::known_scheme()</a>, <a class="el" href="classdtn_1_1Scheme.html#93f324d766daa8cd2755602a7214e4b3">dtn::Scheme::match()</a>, <a class="el" href="EndpointID_8h-source.html#l00261">dtn::EndpointID::scheme()</a>, <a class="el" href="EndpointID_8h-source.html#l00257">dtn::EndpointID::uri()</a>, and <a class="el" href="EndpointID_8h-source.html#l00277">dtn::EndpointID::uri_</a>.</p> <p>Referenced by <a class="el" href="TableBasedRouter_8cc-source.html#l01227">dtn::TableBasedRouter::find_session_upstream()</a>, <a class="el" href="RegistrationTable_8cc-source.html#l00182">dtn::RegistrationTable::get_matching()</a>, <a class="el" href="RouteTable_8cc-source.html#l00126">dtn::RouteTable::get_matching_helper()</a>, <a class="el" href="BundleDaemon_8cc-source.html#l01289">dtn::BundleDaemon::handle_registration_added()</a>, and <a class="el" href="ProphetBundleCore_8cc-source.html#l00116">dtn::ProphetBundleCore::is_route()</a>.</p> </div> </div><p> <a class="anchor" name="9f872c8e701944c46b8989257d3188f2"></a><!-- doxytag: member="dtn::EndpointIDPattern::WILDCARD_EID" ref="9f872c8e701944c46b8989257d3188f2" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const <a class="el" href="classdtn_1_1EndpointIDPattern.html">EndpointIDPattern</a> & dtn::EndpointIDPattern::WILDCARD_EID </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [inline, static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Return the special wildcard Endpoint ID. <p> This functionality is not in the bundle spec, but is used internally to this implementation. <p>Definition at line <a class="el" href="EndpointID_8h-source.html#l00368">368</a> of file <a class="el" href="EndpointID_8h-source.html">EndpointID.h</a>.</p> <p>References <a class="el" href="EndpointID_8h-source.html#l00084">dtn::EndpointID::assign()</a>, <a class="el" href="EndpointID_8h-source.html#l00279">dtn::EndpointID::scheme_</a>, and <a class="el" href="EndpointID_8h-source.html#l00353">dtn::GlobalEndpointIDs::wildcard_eid_</a>.</p> <p>Referenced by <a class="el" href="ForwardingLog_8cc-source.html#l00155">dtn::ForwardingLog::get_count()</a>, <a class="el" href="DTLSRRouter_8cc-source.html#l00720">dtn::DTLSRRouter::handle_lsa()</a>, <a class="el" href="TableBasedRouter_8cc-source.html#l01103">dtn::TableBasedRouter::handle_session_bundle()</a>, <a class="el" href="TableBasedRouter_8cc-source.html#l00728">dtn::TableBasedRouter::route_bundle()</a>, and <a class="el" href="DTLSRRouter_8cc-source.html#l00632">dtn::DTLSRRouter::update_current_lsa()</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="EndpointID_8h-source.html">EndpointID.h</a><li><a class="el" href="EndpointID_8cc-source.html">EndpointID.cc</a></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Fri Jan 30 09:27:04 2009 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.8 </small></address> </body> </html>