<!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::BundleEvent Class Reference</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 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_1BundleEvent.html">BundleEvent</a>
</div>
</div>
<div class="contents">
<h1>dtn::BundleEvent Class Reference</h1><!-- doxytag: class="dtn::BundleEvent" --><code>#include <<a class="el" href="BundleEvent_8h-source.html">BundleEvent.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for dtn::BundleEvent:</div>
<div class="dynsection">
<p><center><img src="classdtn_1_1BundleEvent.png" usemap="#dtn::BundleEvent_map" border="0" alt=""></center>
<map name="dtn::BundleEvent_map">
<area href="classdtn_1_1BundleAcceptRequest.html" alt="dtn::BundleAcceptRequest" shape="rect" coords="217,56,424,80">
<area href="classdtn_1_1BundleAttributesQueryRequest.html" alt="dtn::BundleAttributesQueryRequest" shape="rect" coords="217,112,424,136">
<area href="classdtn_1_1BundleAttributesReportEvent.html" alt="dtn::BundleAttributesReportEvent" shape="rect" coords="217,168,424,192">
<area href="classdtn_1_1BundleCancelRequest.html" alt="dtn::BundleCancelRequest" shape="rect" coords="217,224,424,248">
<area href="classdtn_1_1BundleDeleteRequest.html" alt="dtn::BundleDeleteRequest" shape="rect" coords="217,280,424,304">
<area href="classdtn_1_1BundleDeliveredEvent.html" alt="dtn::BundleDeliveredEvent" shape="rect" coords="217,336,424,360">
<area href="classdtn_1_1BundleDeliveryEvent.html" alt="dtn::BundleDeliveryEvent" shape="rect" coords="217,392,424,416">
<area href="classdtn_1_1BundleExpiredEvent.html" alt="dtn::BundleExpiredEvent" shape="rect" coords="217,448,424,472">
<area href="classdtn_1_1BundleFreeEvent.html" alt="dtn::BundleFreeEvent" shape="rect" coords="217,504,424,528">
<area href="classdtn_1_1BundleInjectedEvent.html" alt="dtn::BundleInjectedEvent" shape="rect" coords="217,560,424,584">
<area href="classdtn_1_1BundleInjectRequest.html" alt="dtn::BundleInjectRequest" shape="rect" coords="217,616,424,640">
<area href="classdtn_1_1BundleQueryRequest.html" alt="dtn::BundleQueryRequest" shape="rect" coords="217,672,424,696">
<area href="classdtn_1_1BundleReceivedEvent.html" alt="dtn::BundleReceivedEvent" shape="rect" coords="217,728,424,752">
<area href="classdtn_1_1BundleReportEvent.html" alt="dtn::BundleReportEvent" shape="rect" coords="217,784,424,808">
<area href="classdtn_1_1BundleSendCancelledEvent.html" alt="dtn::BundleSendCancelledEvent" shape="rect" coords="217,840,424,864">
<area href="classdtn_1_1BundleSendRequest.html" alt="dtn::BundleSendRequest" shape="rect" coords="217,896,424,920">
<area href="classdtn_1_1BundleTransmittedEvent.html" alt="dtn::BundleTransmittedEvent" shape="rect" coords="217,952,424,976">
<area href="classdtn_1_1CLAParamsSetEvent.html" alt="dtn::CLAParamsSetEvent" shape="rect" coords="217,1008,424,1032">
<area href="classdtn_1_1CLAQueryReport.html" alt="dtn::CLAQueryReport" shape="rect" coords="217,1064,424,1088">
<area href="classdtn_1_1CLASetParamsRequest.html" alt="dtn::CLASetParamsRequest" shape="rect" coords="217,1120,424,1144">
<area href="classdtn_1_1ContactEvent.html" alt="dtn::ContactEvent" shape="rect" coords="217,1176,424,1200">
<area href="classdtn_1_1ContactQueryRequest.html" alt="dtn::ContactQueryRequest" shape="rect" coords="217,1232,424,1256">
<area href="classdtn_1_1ContactReportEvent.html" alt="dtn::ContactReportEvent" shape="rect" coords="217,1288,424,1312">
<area href="classdtn_1_1CustodySignalEvent.html" alt="dtn::CustodySignalEvent" shape="rect" coords="217,1344,424,1368">
<area href="classdtn_1_1CustodyTimeoutEvent.html" alt="dtn::CustodyTimeoutEvent" shape="rect" coords="217,1400,424,1424">
<area href="classdtn_1_1LinkCreateRequest.html" alt="dtn::LinkCreateRequest" shape="rect" coords="217,1456,424,1480">
<area href="classdtn_1_1LinkDeleteRequest.html" alt="dtn::LinkDeleteRequest" shape="rect" coords="217,1512,424,1536">
<area href="classdtn_1_1LinkQueryRequest.html" alt="dtn::LinkQueryRequest" shape="rect" coords="217,1568,424,1592">
<area href="classdtn_1_1LinkReconfigureRequest.html" alt="dtn::LinkReconfigureRequest" shape="rect" coords="217,1624,424,1648">
<area href="classdtn_1_1LinkReportEvent.html" alt="dtn::LinkReportEvent" shape="rect" coords="217,1680,424,1704">
<area href="classdtn_1_1NewEIDReachableEvent.html" alt="dtn::NewEIDReachableEvent" shape="rect" coords="217,1736,424,1760">
<area href="classdtn_1_1ReassemblyCompletedEvent.html" alt="dtn::ReassemblyCompletedEvent" shape="rect" coords="217,1792,424,1816">
<area href="classdtn_1_1RegistrationAddedEvent.html" alt="dtn::RegistrationAddedEvent" shape="rect" coords="217,1848,424,1872">
<area href="classdtn_1_1RegistrationDeleteRequest.html" alt="dtn::RegistrationDeleteRequest" shape="rect" coords="217,1904,424,1928">
<area href="classdtn_1_1RegistrationExpiredEvent.html" alt="dtn::RegistrationExpiredEvent" shape="rect" coords="217,1960,424,1984">
<area href="classdtn_1_1RegistrationRemovedEvent.html" alt="dtn::RegistrationRemovedEvent" shape="rect" coords="217,2016,424,2040">
<area href="classdtn_1_1RouteAddEvent.html" alt="dtn::RouteAddEvent" shape="rect" coords="217,2072,424,2096">
<area href="classdtn_1_1RouteDelEvent.html" alt="dtn::RouteDelEvent" shape="rect" coords="217,2128,424,2152">
<area href="classdtn_1_1RouteQueryRequest.html" alt="dtn::RouteQueryRequest" shape="rect" coords="217,2184,424,2208">
<area href="classdtn_1_1RouteReportEvent.html" alt="dtn::RouteReportEvent" shape="rect" coords="217,2240,424,2264">
<area href="classdtn_1_1SetLinkDefaultsRequest.html" alt="dtn::SetLinkDefaultsRequest" shape="rect" coords="217,2296,424,2320">
<area href="classdtn_1_1ShutdownRequest.html" alt="dtn::ShutdownRequest" shape="rect" coords="217,2352,424,2376">
<area href="classdtn_1_1StatusRequest.html" alt="dtn::StatusRequest" shape="rect" coords="217,2408,424,2432">
</map>
</div>
<p>
<a href="classdtn_1_1BundleEvent-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Event base class.
<p>Definition at line <a class="el" href="BundleEvent_8h-source.html#l00261">261</a> of file <a class="el" href="BundleEvent_8h-source.html">BundleEvent.h</a>.</p>
<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">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1BundleEvent.html#34ad7fcefe5984584fe304fdecc96d4b">type_str</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used for printing. <a href="#34ad7fcefe5984584fe304fdecc96d4b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1BundleEvent.html#bc4e23173ef6d3e5f9899409a65270b0">~BundleEvent</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Need a virtual destructor to make sure all the right bits are cleaned up. <a href="#bc4e23173ef6d3e5f9899409a65270b0"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="namespacedtn.html#c5c552f91168793347acabfc567715e3">event_type_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1BundleEvent.html#b0087dbde563796221ed76540112708d">type_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The event type code. <a href="#b0087dbde563796221ed76540112708d"></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_1BundleEvent.html#4de9b57df34c041e8b313234d69ae6e9">daemon_only_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Bit indicating whether this event is for the daemon only or if it should be propagated to other components (i.e. <a href="#4de9b57df34c041e8b313234d69ae6e9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">oasys::Notifier * </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1BundleEvent.html#41422f59f627162052747049984b3cf6">processed_notifier_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Slot for a notifier to indicate that the event was processed. <a href="#41422f59f627162052747049984b3cf6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">oasys::Time </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1BundleEvent.html#1b27378270993aa0eb4d90b31fcd7f10">posted_time_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Slot to record the time that the event was put into the queue. <a href="#1b27378270993aa0eb4d90b31fcd7f10"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected 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_1BundleEvent.html#340f9b7653c340af50c8fdfb079b7bdc">BundleEvent</a> (<a class="el" href="namespacedtn.html#c5c552f91168793347acabfc567715e3">event_type_t</a> type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor (protected since one of the subclasses should always be that which is actually initialized. <a href="#340f9b7653c340af50c8fdfb079b7bdc"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="bc4e23173ef6d3e5f9899409a65270b0"></a><!-- doxytag: member="dtn::BundleEvent::~BundleEvent" ref="bc4e23173ef6d3e5f9899409a65270b0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual dtn::BundleEvent::~BundleEvent </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Need a virtual destructor to make sure all the right bits are cleaned up.
<p>
<p>Definition at line <a class="el" href="BundleEvent_8h-source.html#l00296">296</a> of file <a class="el" href="BundleEvent_8h-source.html">BundleEvent.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="340f9b7653c340af50c8fdfb079b7bdc"></a><!-- doxytag: member="dtn::BundleEvent::BundleEvent" ref="340f9b7653c340af50c8fdfb079b7bdc" args="(event_type_t type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dtn::BundleEvent::BundleEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacedtn.html#c5c552f91168793347acabfc567715e3">event_type_t</a> </td>
<td class="paramname"> <em>type</em> </td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor (protected since one of the subclasses should always be that which is actually initialized.
<p>
<p>Definition at line <a class="el" href="BundleEvent_8h-source.html#l00303">303</a> of file <a class="el" href="BundleEvent_8h-source.html">BundleEvent.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="34ad7fcefe5984584fe304fdecc96d4b"></a><!-- doxytag: member="dtn::BundleEvent::type_str" ref="34ad7fcefe5984584fe304fdecc96d4b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* dtn::BundleEvent::type_str </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Used for printing.
<p>
<p>Definition at line <a class="el" href="BundleEvent_8h-source.html#l00288">288</a> of file <a class="el" href="BundleEvent_8h-source.html">BundleEvent.h</a>.</p>
<p>References <a class="el" href="BundleEvent_8h-source.html#l00127">dtn::event_to_str()</a>, and <a class="el" href="BundleEvent_8h-source.html#l00266">type_</a>.</p>
<p>Referenced by <a class="el" href="BundleEventHandler_8cc-source.html#l00030">dtn::BundleEventHandler::dispatch_event()</a>, <a class="el" href="BundleDaemon_8cc-source.html#l02087">dtn::BundleDaemon::event_handlers_completed()</a>, <a class="el" href="sim_2Node_8cc-source.html#l00131">dtnsim::Node::post_event()</a>, <a class="el" href="BundleDaemon_8cc-source.html#l00170">dtn::BundleDaemon::post_event()</a>, <a class="el" href="sim_2Node_8cc-source.html#l00142">dtnsim::Node::process_one_bundle_event()</a>, <a class="el" href="BundleDaemon_8cc-source.html#l02546">dtn::BundleDaemon::run()</a>, and <a class="el" href="sim_2Node_8cc-source.html#l00158">dtnsim::Node::run_one_event_now()</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="b0087dbde563796221ed76540112708d"></a><!-- doxytag: member="dtn::BundleEvent::type_" ref="b0087dbde563796221ed76540112708d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespacedtn.html#c5c552f91168793347acabfc567715e3">event_type_t</a> <a class="el" href="classdtn_1_1BundleEvent.html#b0087dbde563796221ed76540112708d">dtn::BundleEvent::type_</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The event type code.
<p>
<p>Definition at line <a class="el" href="BundleEvent_8h-source.html#l00266">266</a> of file <a class="el" href="BundleEvent_8h-source.html">BundleEvent.h</a>.</p>
<p>Referenced by <a class="el" href="BundleEventHandler_8cc-source.html#l00030">dtn::BundleEventHandler::dispatch_event()</a>, <a class="el" href="BundleDaemon_8cc-source.html#l02087">dtn::BundleDaemon::event_handlers_completed()</a>, and <a class="el" href="BundleEvent_8h-source.html#l00288">type_str()</a>.</p>
</div>
</div><p>
<a class="anchor" name="4de9b57df34c041e8b313234d69ae6e9"></a><!-- doxytag: member="dtn::BundleEvent::daemon_only_" ref="4de9b57df34c041e8b313234d69ae6e9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> <a class="el" href="classdtn_1_1BundleEvent.html#4de9b57df34c041e8b313234d69ae6e9">dtn::BundleEvent::daemon_only_</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Bit indicating whether this event is for the daemon only or if it should be propagated to other components (i.e.
<p>
the various routers).
<p>Definition at line <a class="el" href="BundleEvent_8h-source.html#l00273">273</a> of file <a class="el" href="BundleEvent_8h-source.html">BundleEvent.h</a>.</p>
<p>Referenced by <a class="el" href="BundleEvent_8h-source.html#l00900">dtn::BundleCancelRequest::BundleCancelRequest()</a>, <a class="el" href="BundleEvent_8h-source.html#l00993">dtn::BundleDeleteRequest::BundleDeleteRequest()</a>, <a class="el" href="BundleEvent_8h-source.html#l00475">dtn::BundleFreeEvent::BundleFreeEvent()</a>, <a class="el" href="BundleEvent_8h-source.html#l00944">dtn::BundleInjectRequest::BundleInjectRequest()</a>, <a class="el" href="BundleEvent_8h-source.html#l01069">dtn::BundleQueryRequest::BundleQueryRequest()</a>, <a class="el" href="BundleEvent_8h-source.html#l00867">dtn::BundleSendRequest::BundleSendRequest()</a>, <a class="el" href="BundleEvent_8h-source.html#l01325">dtn::CLAQueryReport::CLAQueryReport()</a>, <a class="el" href="BundleEvent_8h-source.html#l01247">dtn::CLASetParamsRequest::CLASetParamsRequest()</a>, <a class="el" href="BundleEvent_8h-source.html#l00568">dtn::ContactQueryRequest::ContactQueryRequest()</a>, <a class="el" href="BundleDaemon_8cc-source.html#l02393">dtn::BundleDaemon::handle_event()</a>, <a class="el" href="BundleDaemon_8cc-source.html#l01546">dtn::BundleDaemon::handle_link_create()</a>, <a class="el" href="BundleEvent_8h-source.html#l01134">dtn::LinkCreateRequest::LinkCreateRequest()</a>, <a class="el" href="BundleEvent_8h-source.html#l01192">dtn::LinkDeleteRequest::LinkDeleteRequest()</a>, <a class="el" href="BundleEvent_8h-source.html#l01230">dtn::LinkQueryRequest::LinkQueryRequest()</a>, <a class="el" href="BundleEvent_8h-source.html#l01170">dtn::LinkReconfigureRequest::LinkReconfigureRequest()</a>, <a class="el" href="BundleEvent_8h-source.html#l00658">dtn::LinkStateChangeRequest::LinkStateChangeRequest()</a>, <a class="el" href="BundleEvent_8h-source.html#l00737">dtn::RegistrationDeleteRequest::RegistrationDeleteRequest()</a>, <a class="el" href="BundleEvent_8h-source.html#l00777">dtn::RouteQueryRequest::RouteQueryRequest()</a>, <a class="el" href="BundleEvent_8h-source.html#l01281">dtn::SetLinkDefaultsRequest::SetLinkDefaultsRequest()</a>, <a class="el" href="BundleEvent_8h-source.html#l00845">dtn::ShutdownRequest::ShutdownRequest()</a>, and <a class="el" href="BundleEvent_8h-source.html#l00856">dtn::StatusRequest::StatusRequest()</a>.</p>
</div>
</div><p>
<a class="anchor" name="41422f59f627162052747049984b3cf6"></a><!-- doxytag: member="dtn::BundleEvent::processed_notifier_" ref="41422f59f627162052747049984b3cf6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">oasys::Notifier* <a class="el" href="classdtn_1_1BundleEvent.html#41422f59f627162052747049984b3cf6">dtn::BundleEvent::processed_notifier_</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Slot for a notifier to indicate that the event was processed.
<p>
<p>Definition at line <a class="el" href="BundleEvent_8h-source.html#l00278">278</a> of file <a class="el" href="BundleEvent_8h-source.html">BundleEvent.h</a>.</p>
<p>Referenced by <a class="el" href="BundleDaemon_8cc-source.html#l02393">dtn::BundleDaemon::handle_event()</a>, and <a class="el" href="BundleDaemon_8cc-source.html#l00148">dtn::BundleDaemon::post_and_wait()</a>.</p>
</div>
</div><p>
<a class="anchor" name="1b27378270993aa0eb4d90b31fcd7f10"></a><!-- doxytag: member="dtn::BundleEvent::posted_time_" ref="1b27378270993aa0eb4d90b31fcd7f10" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">oasys::Time <a class="el" href="classdtn_1_1BundleEvent.html#1b27378270993aa0eb4d90b31fcd7f10">dtn::BundleEvent::posted_time_</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Slot to record the time that the event was put into the queue.
<p>
<p>Definition at line <a class="el" href="BundleEvent_8h-source.html#l00283">283</a> of file <a class="el" href="BundleEvent_8h-source.html">BundleEvent.h</a>.</p>
<p>Referenced by <a class="el" href="BundleDaemon_8cc-source.html#l02546">dtn::BundleDaemon::run()</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="BundleEvent_8h-source.html">BundleEvent.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jul 21 14:09:51 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>
