<!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::ContactEvent 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_1ContactEvent.html">ContactEvent</a>
</div>
</div>
<div class="contents">
<h1>dtn::ContactEvent Class Reference</h1><!-- doxytag: class="dtn::ContactEvent" --><!-- doxytag: inherits="dtn::BundleEvent" -->Abstract class for the subset of events related to contacts and links that defines a reason code enumerated type.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="BundleEvent_8h-source.html">BundleEvent.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for dtn::ContactEvent:</div>
<div class="dynsection">
<p><center><img src="classdtn_1_1ContactEvent.png" usemap="#dtn::ContactEvent_map" border="0" alt=""></center>
<map name="dtn::ContactEvent_map">
<area href="classdtn_1_1BundleEvent.html" alt="dtn::BundleEvent" shape="rect" coords="0,0,208,24">
<area href="classdtn_1_1ContactAttributeChangedEvent.html" alt="dtn::ContactAttributeChangedEvent" shape="rect" coords="218,112,426,136">
<area href="classdtn_1_1ContactDownEvent.html" alt="dtn::ContactDownEvent" shape="rect" coords="218,168,426,192">
<area href="classdtn_1_1ContactUpEvent.html" alt="dtn::ContactUpEvent" shape="rect" coords="218,224,426,248">
<area href="classdtn_1_1LinkAttributeChangedEvent.html" alt="dtn::LinkAttributeChangedEvent" shape="rect" coords="218,280,426,304">
<area href="classdtn_1_1LinkAvailableEvent.html" alt="dtn::LinkAvailableEvent" shape="rect" coords="218,336,426,360">
<area href="classdtn_1_1LinkCreatedEvent.html" alt="dtn::LinkCreatedEvent" shape="rect" coords="218,392,426,416">
<area href="classdtn_1_1LinkDeletedEvent.html" alt="dtn::LinkDeletedEvent" shape="rect" coords="218,448,426,472">
<area href="classdtn_1_1LinkStateChangeRequest.html" alt="dtn::LinkStateChangeRequest" shape="rect" coords="218,504,426,528">
<area href="classdtn_1_1LinkUnavailableEvent.html" alt="dtn::LinkUnavailableEvent" shape="rect" coords="218,560,426,584">
</map>
</div>
<p>
<a href="classdtn_1_1ContactEvent-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 Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1ContactEvent.html#e20f7357509a2bcca3d8e6c8daf552f7">reason_t</a> { <br>
<a class="el" href="classdtn_1_1ContactEvent.html#e20f7357509a2bcca3d8e6c8daf552f73a8badb37c6d8128d816779957448c61">INVALID</a> = 0,
<a class="el" href="classdtn_1_1ContactEvent.html#e20f7357509a2bcca3d8e6c8daf552f7745e7897b68d73fa05257424c8746ded">NO_INFO</a>,
<a class="el" href="classdtn_1_1ContactEvent.html#e20f7357509a2bcca3d8e6c8daf552f72e449a76cefd484940a3f3bfc07d188e">USER</a>,
<a class="el" href="classdtn_1_1ContactEvent.html#e20f7357509a2bcca3d8e6c8daf552f7f0c1475c056a0f72e11b5ba8466a27f7">BROKEN</a>,
<br>
<a class="el" href="classdtn_1_1ContactEvent.html#e20f7357509a2bcca3d8e6c8daf552f7648efe2b249ca6cd507125d819392b8d">DISCOVERY</a>,
<a class="el" href="classdtn_1_1ContactEvent.html#e20f7357509a2bcca3d8e6c8daf552f793b4b30e007a04676c706a0b749ef033">CL_ERROR</a>,
<a class="el" href="classdtn_1_1ContactEvent.html#e20f7357509a2bcca3d8e6c8daf552f704fb70b2e32b5f6f3e3707dc12958787">CL_VERSION</a>,
<a class="el" href="classdtn_1_1ContactEvent.html#e20f7357509a2bcca3d8e6c8daf552f72e018ae4b4ab30873b97e51e26e2baf2">SHUTDOWN</a>,
<br>
<a class="el" href="classdtn_1_1ContactEvent.html#e20f7357509a2bcca3d8e6c8daf552f7fe3939848fd2dc31d31aec1c8c1f3c2a">RECONNECT</a>,
<a class="el" href="classdtn_1_1ContactEvent.html#e20f7357509a2bcca3d8e6c8daf552f7cc4b8963a82f22c0d9b61c37e06e877e">IDLE</a>,
<a class="el" href="classdtn_1_1ContactEvent.html#e20f7357509a2bcca3d8e6c8daf552f7eb788e67896aff756d499766183ff6d8">TIMEOUT</a>
<br>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reason codes for contact state operations. <a href="classdtn_1_1ContactEvent.html#e20f7357509a2bcca3d8e6c8daf552f7">More...</a><br></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_1ContactEvent.html#8635649a467cad6168dfb3ea1afad333">ContactEvent</a> (<a class="el" href="namespacedtn.html#c5c552f91168793347acabfc567715e3">event_type_t</a> type, <a class="el" href="classdtn_1_1ContactEvent.html#e20f7357509a2bcca3d8e6c8daf552f7">reason_t</a> reason=NO_INFO)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#8635649a467cad6168dfb3ea1afad333"></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 char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1ContactEvent.html#9ce1fd3e3d0a1c675a90423eefac8a6e">reason_to_str</a> (int reason)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reason to string conversion. <a href="#9ce1fd3e3d0a1c675a90423eefac8a6e"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1ContactEvent.html#1f6f825ff0051afb3432f2983adc8abf">reason_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">reason code for the event <a href="#1f6f825ff0051afb3432f2983adc8abf"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Abstract class for the subset of events related to contacts and links that defines a reason code enumerated type.
<p>Definition at line <a class="el" href="BundleEvent_8h-source.html#l00491">491</a> of file <a class="el" href="BundleEvent_8h-source.html">BundleEvent.h</a>.</p>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="e20f7357509a2bcca3d8e6c8daf552f7"></a><!-- doxytag: member="dtn::ContactEvent::reason_t" ref="e20f7357509a2bcca3d8e6c8daf552f7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classdtn_1_1ContactEvent.html#e20f7357509a2bcca3d8e6c8daf552f7">dtn::ContactEvent::reason_t</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reason codes for contact state operations.
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="e20f7357509a2bcca3d8e6c8daf552f73a8badb37c6d8128d816779957448c61"></a><!-- doxytag: member="INVALID" ref="e20f7357509a2bcca3d8e6c8daf552f73a8badb37c6d8128d816779957448c61" args="" -->INVALID</em> </td><td>
Should not be used. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="e20f7357509a2bcca3d8e6c8daf552f7745e7897b68d73fa05257424c8746ded"></a><!-- doxytag: member="NO_INFO" ref="e20f7357509a2bcca3d8e6c8daf552f7745e7897b68d73fa05257424c8746ded" args="" -->NO_INFO</em> </td><td>
No additional info. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="e20f7357509a2bcca3d8e6c8daf552f72e449a76cefd484940a3f3bfc07d188e"></a><!-- doxytag: member="USER" ref="e20f7357509a2bcca3d8e6c8daf552f72e449a76cefd484940a3f3bfc07d188e" args="" -->USER</em> </td><td>
User action (i.e. console / config). </td></tr>
<tr><td valign="top"><em><a class="anchor" name="e20f7357509a2bcca3d8e6c8daf552f7f0c1475c056a0f72e11b5ba8466a27f7"></a><!-- doxytag: member="BROKEN" ref="e20f7357509a2bcca3d8e6c8daf552f7f0c1475c056a0f72e11b5ba8466a27f7" args="" -->BROKEN</em> </td><td>
Unexpected session interruption. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="e20f7357509a2bcca3d8e6c8daf552f7648efe2b249ca6cd507125d819392b8d"></a><!-- doxytag: member="DISCOVERY" ref="e20f7357509a2bcca3d8e6c8daf552f7648efe2b249ca6cd507125d819392b8d" args="" -->DISCOVERY</em> </td><td>
Dynamically discovered link. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="e20f7357509a2bcca3d8e6c8daf552f793b4b30e007a04676c706a0b749ef033"></a><!-- doxytag: member="CL_ERROR" ref="e20f7357509a2bcca3d8e6c8daf552f793b4b30e007a04676c706a0b749ef033" args="" -->CL_ERROR</em> </td><td>
Convergence layer protocol error. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="e20f7357509a2bcca3d8e6c8daf552f704fb70b2e32b5f6f3e3707dc12958787"></a><!-- doxytag: member="CL_VERSION" ref="e20f7357509a2bcca3d8e6c8daf552f704fb70b2e32b5f6f3e3707dc12958787" args="" -->CL_VERSION</em> </td><td>
Convergence layer version mismatch. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="e20f7357509a2bcca3d8e6c8daf552f72e018ae4b4ab30873b97e51e26e2baf2"></a><!-- doxytag: member="SHUTDOWN" ref="e20f7357509a2bcca3d8e6c8daf552f72e018ae4b4ab30873b97e51e26e2baf2" args="" -->SHUTDOWN</em> </td><td>
Clean connection shutdown. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="e20f7357509a2bcca3d8e6c8daf552f7fe3939848fd2dc31d31aec1c8c1f3c2a"></a><!-- doxytag: member="RECONNECT" ref="e20f7357509a2bcca3d8e6c8daf552f7fe3939848fd2dc31d31aec1c8c1f3c2a" args="" -->RECONNECT</em> </td><td>
Re-establish link after failure. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="e20f7357509a2bcca3d8e6c8daf552f7cc4b8963a82f22c0d9b61c37e06e877e"></a><!-- doxytag: member="IDLE" ref="e20f7357509a2bcca3d8e6c8daf552f7cc4b8963a82f22c0d9b61c37e06e877e" args="" -->IDLE</em> </td><td>
Idle connection shut down by the CL. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="e20f7357509a2bcca3d8e6c8daf552f7eb788e67896aff756d499766183ff6d8"></a><!-- doxytag: member="TIMEOUT" ref="e20f7357509a2bcca3d8e6c8daf552f7eb788e67896aff756d499766183ff6d8" args="" -->TIMEOUT</em> </td><td>
Scheduled link ended duration. </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="BundleEvent_8h-source.html#l00496">496</a> of file <a class="el" href="BundleEvent_8h-source.html">BundleEvent.h</a>.</p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="8635649a467cad6168dfb3ea1afad333"></a><!-- doxytag: member="dtn::ContactEvent::ContactEvent" ref="8635649a467cad6168dfb3ea1afad333" args="(event_type_t type, reason_t reason=NO_INFO)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">dtn::ContactEvent::ContactEvent </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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classdtn_1_1ContactEvent.html#e20f7357509a2bcca3d8e6c8daf552f7">reason_t</a> </td>
<td class="paramname"> <em>reason</em> = <code>NO_INFO</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
<p>Definition at line <a class="el" href="BundleEvent_8h-source.html#l00531">531</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="9ce1fd3e3d0a1c675a90423eefac8a6e"></a><!-- doxytag: member="dtn::ContactEvent::reason_to_str" ref="9ce1fd3e3d0a1c675a90423eefac8a6e" args="(int reason)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const char* dtn::ContactEvent::reason_to_str </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>reason</em> </td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reason to string conversion.
<p>
<p>Definition at line <a class="el" href="BundleEvent_8h-source.html#l00513">513</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#l00500">BROKEN</a>, <a class="el" href="BundleEvent_8h-source.html#l00502">CL_ERROR</a>, <a class="el" href="BundleEvent_8h-source.html#l00503">CL_VERSION</a>, <a class="el" href="BundleEvent_8h-source.html#l00501">DISCOVERY</a>, <a class="el" href="BundleEvent_8h-source.html#l00506">IDLE</a>, <a class="el" href="BundleEvent_8h-source.html#l00497">INVALID</a>, <a class="el" href="BundleEvent_8h-source.html#l00498">NO_INFO</a>, <a class="el" href="BundleEvent_8h-source.html#l00505">RECONNECT</a>, <a class="el" href="BundleEvent_8h-source.html#l00504">SHUTDOWN</a>, <a class="el" href="BundleEvent_8h-source.html#l00507">TIMEOUT</a>, and <a class="el" href="BundleEvent_8h-source.html#l00499">USER</a>.</p>
<p>Referenced by <a class="el" href="CLConnection_8cc-source.html#l00234">dtn::CLConnection::break_contact()</a>, <a class="el" href="BundleDaemon_8cc-source.html#l01832">dtn::BundleDaemon::handle_contact_down()</a>, <a class="el" href="BundleDaemon_8cc-source.html#l01429">dtn::BundleDaemon::handle_link_state_change_request()</a>, and <a class="el" href="ContactManager_8cc-source.html#l00290">dtn::ContactManager::handle_link_unavailable()</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="1f6f825ff0051afb3432f2983adc8abf"></a><!-- doxytag: member="dtn::ContactEvent::reason_" ref="1f6f825ff0051afb3432f2983adc8abf" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classdtn_1_1ContactEvent.html#1f6f825ff0051afb3432f2983adc8abf">dtn::ContactEvent::reason_</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
reason code for the event
<p>
<p>Definition at line <a class="el" href="BundleEvent_8h-source.html#l00534">534</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#l01429">dtn::BundleDaemon::handle_link_state_change_request()</a>, and <a class="el" href="ContactManager_8cc-source.html#l00290">dtn::ContactManager::handle_link_unavailable()</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 Fri Jan 30 09:27:02 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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
29c369053a983cc5d8c880dc6e0a2237
>
files
>
999
