<!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: CustodySignal.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>CustodySignal.h</h1><a href="CustodySignal_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 Intel Corporation</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 _CUSTODYSIGNAL_H_</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define _CUSTODYSIGNAL_H_</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include "<a class="code" href="bundling_2Bundle_8h.html">Bundle.h</a>"</span>
<a name="l00021"></a>00021 <span class="preprocessor">#include "<a class="code" href="BundleProtocol_8h.html">BundleProtocol.h</a>"</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="keyword">namespace </span>dtn {
<a name="l00024"></a>00024
<a name="l00028"></a><a class="code" href="classdtn_1_1CustodySignal.html">00028</a> <span class="keyword">class </span><a class="code" href="classdtn_1_1CustodySignal.html" title="Utility class to format and parse custody signal bundles.">CustodySignal</a> {
<a name="l00029"></a>00029 <span class="keyword">public</span>:
<a name="l00033"></a><a class="code" href="classdtn_1_1CustodySignal.html#a1d50e0480ee5bbe4837a861ef2a39cf">00033</a> <span class="keyword">typedef</span> <a class="code" href="classdtn_1_1BundleProtocol.html#e339b3a1104cd188459059e46543490b" title="Custody Signal Reason Codes.">BundleProtocol::custody_signal_reason_t</a> <a class="code" href="classdtn_1_1BundleProtocol.html#e339b3a1104cd188459059e46543490b" title="Custody Signal Reason Codes.">reason_t</a>;
<a name="l00034"></a>00034
<a name="l00038"></a><a class="code" href="structdtn_1_1CustodySignal_1_1data__t.html">00038</a> <span class="keyword">struct </span><a class="code" href="structdtn_1_1CustodySignal_1_1data__t.html" title="Struct to hold the payload data of the custody signal.">data_t</a> {
<a name="l00039"></a><a class="code" href="structdtn_1_1CustodySignal_1_1data__t.html#ee10cd35c41e68f61dacdb92746aca3d">00039</a> u_int8_t <a class="code" href="structdtn_1_1CustodySignal_1_1data__t.html#ee10cd35c41e68f61dacdb92746aca3d">admin_type_</a>;
<a name="l00040"></a><a class="code" href="structdtn_1_1CustodySignal_1_1data__t.html#a69b2abd004398671ef3075418d70900">00040</a> u_int8_t <a class="code" href="structdtn_1_1CustodySignal_1_1data__t.html#a69b2abd004398671ef3075418d70900">admin_flags_</a>;
<a name="l00041"></a><a class="code" href="structdtn_1_1CustodySignal_1_1data__t.html#e6e11f65859d8662d2115c211a44aed4">00041</a> <span class="keywordtype">bool</span> <a class="code" href="structdtn_1_1CustodySignal_1_1data__t.html#e6e11f65859d8662d2115c211a44aed4">succeeded_</a>;
<a name="l00042"></a><a class="code" href="structdtn_1_1CustodySignal_1_1data__t.html#a51d3016cfedaef076bb6779adb4edb2">00042</a> u_int8_t <a class="code" href="structdtn_1_1CustodySignal_1_1data__t.html#a51d3016cfedaef076bb6779adb4edb2">reason_</a>;
<a name="l00043"></a><a class="code" href="structdtn_1_1CustodySignal_1_1data__t.html#1570a98b95b2df91845aee1583275c1a">00043</a> u_int64_t <a class="code" href="structdtn_1_1CustodySignal_1_1data__t.html#1570a98b95b2df91845aee1583275c1a">orig_frag_offset_</a>;
<a name="l00044"></a><a class="code" href="structdtn_1_1CustodySignal_1_1data__t.html#f3a8cef680803f103257b0a5881ed8bd">00044</a> u_int64_t <a class="code" href="structdtn_1_1CustodySignal_1_1data__t.html#f3a8cef680803f103257b0a5881ed8bd">orig_frag_length_</a>;
<a name="l00045"></a><a class="code" href="structdtn_1_1CustodySignal_1_1data__t.html#d066106605dcd0ed17cb2ba0c304c093">00045</a> <a class="code" href="structdtn_1_1BundleTimestamp.html" title="Simple struct definition for bundle creation timestamps.">BundleTimestamp</a> <a class="code" href="structdtn_1_1CustodySignal_1_1data__t.html#d066106605dcd0ed17cb2ba0c304c093">custody_signal_tv_</a>;
<a name="l00046"></a><a class="code" href="structdtn_1_1CustodySignal_1_1data__t.html#850387bcc745b3911dbdf5e14ed2baff">00046</a> <a class="code" href="structdtn_1_1BundleTimestamp.html" title="Simple struct definition for bundle creation timestamps.">BundleTimestamp</a> <a class="code" href="structdtn_1_1CustodySignal_1_1data__t.html#850387bcc745b3911dbdf5e14ed2baff">orig_creation_tv_</a>;
<a name="l00047"></a><a class="code" href="structdtn_1_1CustodySignal_1_1data__t.html#21be3f276fe52bd85f0fd3c2f4e1ff63">00047</a> <a class="code" href="classdtn_1_1EndpointID.html">EndpointID</a> <a class="code" href="structdtn_1_1CustodySignal_1_1data__t.html#21be3f276fe52bd85f0fd3c2f4e1ff63">orig_source_eid_</a>;
<a name="l00048"></a>00048 };
<a name="l00049"></a>00049
<a name="l00053"></a>00053 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1CustodySignal.html#2fe29b70ddb0f7cf92d417d996c4a8e0" title="Constructor-like function to create a new custody signal bundle.">create_custody_signal</a>(<a class="code" href="classdtn_1_1Bundle.html" title="The internal representation of a bundle.">Bundle</a>* bundle,
<a name="l00054"></a>00054 <span class="keyword">const</span> <a class="code" href="classdtn_1_1Bundle.html" title="The internal representation of a bundle.">Bundle</a>* orig_bundle,
<a name="l00055"></a>00055 <span class="keyword">const</span> <a class="code" href="classdtn_1_1EndpointID.html">EndpointID</a>& source_eid,
<a name="l00056"></a>00056 <span class="keywordtype">bool</span> succeeded,
<a name="l00057"></a>00057 <a class="code" href="classdtn_1_1BundleProtocol.html#e339b3a1104cd188459059e46543490b" title="Custody Signal Reason Codes.">reason_t</a> reason);
<a name="l00058"></a>00058
<a name="l00062"></a>00062 <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classdtn_1_1CustodySignal.html#854ca4797421b5399d6260d1ab9efcb4" title="Parsing function for custody signal bundles.">parse_custody_signal</a>(<a class="code" href="structdtn_1_1CustodySignal_1_1data__t.html" title="Struct to hold the payload data of the custody signal.">data_t</a>* data,
<a name="l00063"></a>00063 <span class="keyword">const</span> u_char* bp, u_int <a class="code" href="num2sdnv_8c.html#fed088663f8704004425cdae2120b9b3">len</a>);
<a name="l00064"></a>00064
<a name="l00068"></a>00068 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classdtn_1_1CustodySignal.html#af7a2262319a7b2a348d1f8dc5415c2f" title="Pretty printer for custody signal reasons.">reason_to_str</a>(u_int8_t reason);
<a name="l00069"></a>00069 };
<a name="l00070"></a>00070
<a name="l00071"></a>00071 } <span class="comment">// namespace dtn</span>
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <span class="preprocessor">#endif </span><span class="comment">/* _CUSTODYSIGNAL_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>
