<!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::CustodySignal 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_1CustodySignal.html">CustodySignal</a>
</div>
</div>
<div class="contents">
<h1>dtn::CustodySignal Class Reference</h1><!-- doxytag: class="dtn::CustodySignal" -->Utility class to format and parse custody signal bundles.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="CustodySignal_8h-source.html">CustodySignal.h</a>></code>
<p>
<p>
<a href="classdtn_1_1CustodySignal-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structdtn_1_1CustodySignal_1_1data__t.html">data_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Struct to hold the payload data of the custody signal. <a href="structdtn_1_1CustodySignal_1_1data__t.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <br class="typebreak">
<a class="el" href="classdtn_1_1BundleProtocol.html#e339b3a1104cd188459059e46543490b">BundleProtocol::custody_signal_reason_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1CustodySignal.html#a1d50e0480ee5bbe4837a861ef2a39cf">reason_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The reason codes are defined in the bundle protocol class. <a href="#a1d50e0480ee5bbe4837a861ef2a39cf"></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 void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1CustodySignal.html#2fe29b70ddb0f7cf92d417d996c4a8e0">create_custody_signal</a> (<a class="el" href="classdtn_1_1Bundle.html">Bundle</a> *bundle, const <a class="el" href="classdtn_1_1Bundle.html">Bundle</a> *orig_bundle, const <a class="el" href="classdtn_1_1EndpointID.html">EndpointID</a> &source_eid, <a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> succeeded, <a class="el" href="classdtn_1_1BundleProtocol.html#e339b3a1104cd188459059e46543490b">reason_t</a> reason)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor-like function to create a new custody signal bundle. <a href="#2fe29b70ddb0f7cf92d417d996c4a8e0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1CustodySignal.html#854ca4797421b5399d6260d1ab9efcb4">parse_custody_signal</a> (<a class="el" href="structdtn_1_1CustodySignal_1_1data__t.html">data_t</a> *data, const u_char *bp, u_int len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parsing function for custody signal bundles. <a href="#854ca4797421b5399d6260d1ab9efcb4"></a><br></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_1CustodySignal.html#af7a2262319a7b2a348d1f8dc5415c2f">reason_to_str</a> (u_int8_t reason)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pretty printer for custody signal reasons. <a href="#af7a2262319a7b2a348d1f8dc5415c2f"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Utility class to format and parse custody signal bundles.
<p>Definition at line <a class="el" href="CustodySignal_8h-source.html#l00028">28</a> of file <a class="el" href="CustodySignal_8h-source.html">CustodySignal.h</a>.</p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="a1d50e0480ee5bbe4837a861ef2a39cf"></a><!-- doxytag: member="dtn::CustodySignal::reason_t" ref="a1d50e0480ee5bbe4837a861ef2a39cf" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classdtn_1_1BundleProtocol.html#e339b3a1104cd188459059e46543490b">BundleProtocol::custody_signal_reason_t</a> <a class="el" href="classdtn_1_1BundleProtocol.html#e339b3a1104cd188459059e46543490b">dtn::CustodySignal::reason_t</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The reason codes are defined in the bundle protocol class.
<p>
<p>Definition at line <a class="el" href="CustodySignal_8h-source.html#l00033">33</a> of file <a class="el" href="CustodySignal_8h-source.html">CustodySignal.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="2fe29b70ddb0f7cf92d417d996c4a8e0"></a><!-- doxytag: member="dtn::CustodySignal::create_custody_signal" ref="2fe29b70ddb0f7cf92d417d996c4a8e0" args="(Bundle *bundle, const Bundle *orig_bundle, const EndpointID &source_eid, bool succeeded, reason_t reason)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void dtn::CustodySignal::create_custody_signal </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classdtn_1_1Bundle.html">Bundle</a> * </td>
<td class="paramname"> <em>bundle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classdtn_1_1Bundle.html">Bundle</a> * </td>
<td class="paramname"> <em>orig_bundle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classdtn_1_1EndpointID.html">EndpointID</a> & </td>
<td class="paramname"> <em>source_eid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> </td>
<td class="paramname"> <em>succeeded</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classdtn_1_1BundleProtocol.html#e339b3a1104cd188459059e46543490b">reason_t</a> </td>
<td class="paramname"> <em>reason</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor-like function to create a new custody signal bundle.
<p>
<p>Definition at line <a class="el" href="CustodySignal_8cc-source.html#l00029">29</a> of file <a class="el" href="CustodySignal_8cc-source.html">CustodySignal.cc</a>.</p>
<p>References <a class="el" href="BundleProtocol_8h-source.html#l00220">dtn::BundleProtocol::ADMIN_CUSTODY_SIGNAL</a>, <a class="el" href="BundleProtocol_8h-source.html#l00228">dtn::BundleProtocol::ADMIN_IS_FRAGMENT</a>, <a class="el" href="SDNV_8cc-source.html#l00044">ASSERT</a>, <a class="el" href="EndpointID_8h-source.html#l00084">dtn::EndpointID::assign()</a>, <a class="el" href="EndpointID_8h-source.html#l00264">dtn::EndpointID::c_str()</a>, <a class="el" href="bundling_2Bundle_8h-source.html#l00234">dtn::Bundle::creation_ts()</a>, <a class="el" href="bundling_2Bundle_8h-source.html#l00206">dtn::Bundle::custodian()</a>, <a class="el" href="SDNV_8cc-source.html#l00062">encode()</a>, <a class="el" href="SDNV_8cc-source.html#l00107">encoding_len()</a>, <a class="el" href="EndpointID_8h-source.html#l00126">dtn::EndpointID::equals()</a>, <a class="el" href="bundling_2Bundle_8h-source.html#l00221">dtn::Bundle::expiration()</a>, <a class="el" href="bundling_2Bundle_8h-source.html#l00222">dtn::Bundle::frag_offset()</a>, <a class="el" href="BundleTimestamp_8cc-source.html#l00034">dtn::BundleTimestamp::get_current_time()</a>, <a class="el" href="bundling_2Bundle_8h-source.html#l00209">dtn::Bundle::is_fragment()</a>, <a class="el" href="num2sdnv_8c-source.html#l00034">len</a>, <a class="el" href="EndpointID_8h-source.html#l00266">dtn::EndpointID::length()</a>, <a class="el" href="bundling_2Bundle_8h-source.html#l00245">dtn::Bundle::mutable_custodian()</a>, <a class="el" href="bundling_2Bundle_8h-source.html#l00243">dtn::Bundle::mutable_dest()</a>, <a class="el" href="bundling_2Bundle_8h-source.html#l00272">dtn::Bundle::mutable_payload()</a>, <a class="el" href="bundling_2Bundle_8h-source.html#l00244">dtn::Bundle::mutable_replyto()</a>, <a class="el" href="bundling_2Bundle_8h-source.html#l00242">dtn::Bundle::mutable_source()</a>, <a class="el" href="EndpointID_8h-source.html#l00358">dtn::EndpointID::NULL_EID()</a>, <a class="el" href="bundling_2Bundle_8h-source.html#l00223">dtn::Bundle::orig_length()</a>, <a class="el" href="sdnv-c_8h.html#61025d18c2abbee27eba89034e1fb025">sdnv_encoding_len()</a>, <a class="el" href="BundleTimestamp_8h-source.html#l00031">dtn::BundleTimestamp::seconds_</a>, <a class="el" href="BundleTimestamp_8h-source.html#l00032">dtn::BundleTimestamp::seqno_</a>, <a class="el" href="BundlePayload_8cc-source.html#l00349">dtn::BundlePayload::set_data()</a>, <a class="el" href="bundling_2Bundle_8h-source.html#l00259">dtn::Bundle::set_expiration()</a>, <a class="el" href="bundling_2Bundle_8h-source.html#l00248">dtn::Bundle::set_is_admin()</a>, <a class="el" href="BundleProtocol_8cc-source.html#l00569">dtn::BundleProtocol::set_timestamp()</a>, <a class="el" href="bundling_2Bundle_8h-source.html#l00204">dtn::Bundle::source()</a>, and <a class="el" href="BundleProtocol_8cc-source.html#l00605">dtn::BundleProtocol::ts_encoding_len()</a>.</p>
<p>Referenced by <a class="el" href="BundleDaemon_8cc-source.html#l00259">dtn::BundleDaemon::generate_custody_signal()</a>.</p>
</div>
</div><p>
<a class="anchor" name="854ca4797421b5399d6260d1ab9efcb4"></a><!-- doxytag: member="dtn::CustodySignal::parse_custody_signal" ref="854ca4797421b5399d6260d1ab9efcb4" args="(data_t *data, const u_char *bp, u_int len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> dtn::CustodySignal::parse_custody_signal </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structdtn_1_1CustodySignal_1_1data__t.html">data_t</a> * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const u_char * </td>
<td class="paramname"> <em>bp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u_int </td>
<td class="paramname"> <em>len</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parsing function for custody signal bundles.
<p>
<p>Definition at line <a class="el" href="CustodySignal_8cc-source.html#l00153">153</a> of file <a class="el" href="CustodySignal_8cc-source.html">CustodySignal.cc</a>.</p>
<p>References <a class="el" href="BundleProtocol_8h-source.html#l00220">dtn::BundleProtocol::ADMIN_CUSTODY_SIGNAL</a>, <a class="el" href="CustodySignal_8h-source.html#l00040">dtn::CustodySignal::CustodySignal::data_t::admin_flags_</a>, <a class="el" href="BundleProtocol_8h-source.html#l00228">dtn::BundleProtocol::ADMIN_IS_FRAGMENT</a>, <a class="el" href="CustodySignal_8h-source.html#l00039">dtn::CustodySignal::CustodySignal::data_t::admin_type_</a>, <a class="el" href="EndpointID_8h-source.html#l00084">dtn::EndpointID::assign()</a>, <a class="el" href="CustodySignal_8h-source.html#l00045">dtn::CustodySignal::CustodySignal::data_t::custody_signal_tv_</a>, <a class="el" href="SDNV_8cc-source.html#l00117">decode()</a>, <a class="el" href="BundleProtocol_8cc-source.html#l00584">dtn::BundleProtocol::get_timestamp()</a>, <a class="el" href="CustodySignal_8h-source.html#l00046">dtn::CustodySignal::CustodySignal::data_t::orig_creation_tv_</a>, <a class="el" href="CustodySignal_8h-source.html#l00044">dtn::CustodySignal::CustodySignal::data_t::orig_frag_length_</a>, <a class="el" href="CustodySignal_8h-source.html#l00043">dtn::CustodySignal::CustodySignal::data_t::orig_frag_offset_</a>, <a class="el" href="CustodySignal_8h-source.html#l00047">dtn::CustodySignal::CustodySignal::data_t::orig_source_eid_</a>, <a class="el" href="CustodySignal_8h-source.html#l00042">dtn::CustodySignal::CustodySignal::data_t::reason_</a>, and <a class="el" href="CustodySignal_8h-source.html#l00041">dtn::CustodySignal::CustodySignal::data_t::succeeded_</a>.</p>
<p>Referenced by <a class="el" href="AdminRegistration_8cc-source.html#l00042">dtn::AdminRegistration::deliver_bundle()</a>, and <a class="el" href="TclRegistration_8cc-source.html#l00164">dtn::TclRegistration::parse_bundle_data()</a>.</p>
</div>
</div><p>
<a class="anchor" name="af7a2262319a7b2a348d1f8dc5415c2f"></a><!-- doxytag: member="dtn::CustodySignal::reason_to_str" ref="af7a2262319a7b2a348d1f8dc5415c2f" args="(u_int8_t reason)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * dtn::CustodySignal::reason_to_str </td>
<td>(</td>
<td class="paramtype">u_int8_t </td>
<td class="paramname"> <em>reason</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Pretty printer for custody signal reasons.
<p>
<p>Definition at line <a class="el" href="CustodySignal_8cc-source.html#l00221">221</a> of file <a class="el" href="CustodySignal_8cc-source.html">CustodySignal.cc</a>.</p>
<p>References <a class="el" href="num2sdnv_8c-source.html#l00035">buf</a>, <a class="el" href="BundleProtocol_8h-source.html#l00254">dtn::BundleProtocol::CUSTODY_BLOCK_UNINTELLIGIBLE</a>, <a class="el" href="BundleProtocol_8h-source.html#l00250">dtn::BundleProtocol::CUSTODY_DEPLETED_STORAGE</a>, <a class="el" href="BundleProtocol_8h-source.html#l00251">dtn::BundleProtocol::CUSTODY_ENDPOINT_ID_UNINTELLIGIBLE</a>, <a class="el" href="BundleProtocol_8h-source.html#l00248">dtn::BundleProtocol::CUSTODY_NO_ADDTL_INFO</a>, <a class="el" href="BundleProtocol_8h-source.html#l00252">dtn::BundleProtocol::CUSTODY_NO_ROUTE_TO_DEST</a>, <a class="el" href="BundleProtocol_8h-source.html#l00253">dtn::BundleProtocol::CUSTODY_NO_TIMELY_CONTACT</a>, and <a class="el" href="BundleProtocol_8h-source.html#l00249">dtn::BundleProtocol::CUSTODY_REDUNDANT_RECEPTION</a>.</p>
<p>Referenced by <a class="el" href="BundleDaemon_8cc-source.html#l01908">dtn::BundleDaemon::handle_custody_signal()</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="CustodySignal_8h-source.html">CustodySignal.h</a><li><a class="el" href="CustodySignal_8cc-source.html">CustodySignal.cc</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jan 30 09:27:03 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
>
1019
