<!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: CustodyTimer.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>CustodyTimer.h</h1><a href="CustodyTimer_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 _CUSTODYTIMER_H_</span> <a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define _CUSTODYTIMER_H_</span> <a name="l00019"></a>00019 <span class="preprocessor"></span> <a name="l00020"></a>00020 <span class="preprocessor">#include <oasys/serialize/Serialize.h></span> <a name="l00021"></a>00021 <span class="preprocessor">#include <oasys/thread/Timer.h></span> <a name="l00022"></a>00022 <span class="preprocessor">#include <oasys/util/Time.h></span> <a name="l00023"></a>00023 <span class="preprocessor">#include "<a class="code" href="BundleRef_8h.html">bundling/BundleRef.h</a>"</span> <a name="l00024"></a>00024 <span class="preprocessor">#include "<a class="code" href="contacts_2Link_8h.html">contacts/Link.h</a>"</span> <a name="l00025"></a>00025 <a name="l00026"></a>00026 <span class="keyword">namespace </span>dtn { <a name="l00027"></a>00027 <a name="l00028"></a>00028 <span class="keyword">class </span>Bundle; <a name="l00029"></a>00029 <a name="l00047"></a><a class="code" href="classdtn_1_1CustodyTimerSpec.html">00047</a> <span class="keyword">class </span><a class="code" href="classdtn_1_1CustodyTimerSpec.html" title="Utility class to abstract out various parameters that can be used to calculate custody...">CustodyTimerSpec</a> : <span class="keyword">public</span> oasys::SerializableObject { <a name="l00048"></a>00048 <span class="keyword">public</span>: <a name="l00052"></a><a class="code" href="classdtn_1_1CustodyTimerSpec.html#c6d5e712cc94e4eb00f712c85065ac5c">00052</a> <span class="keyword">static</span> <a class="code" href="classdtn_1_1CustodyTimerSpec.html" title="Utility class to abstract out various parameters that can be used to calculate custody...">CustodyTimerSpec</a> <a class="code" href="classdtn_1_1CustodyTimerSpec.html#c6d5e712cc94e4eb00f712c85065ac5c" title="Custody timer defaults, values set in the static initializer.">defaults_</a>; <a name="l00053"></a>00053 <a name="l00057"></a><a class="code" href="classdtn_1_1CustodyTimerSpec.html#37fd692d0e6fd3027607526e93883c86">00057</a> <a class="code" href="classdtn_1_1CustodyTimerSpec.html#f011c7a1d4146d8dd5dcd4e1bfd7b9a1" title="Default Constructor.">CustodyTimerSpec</a>(u_int32_t min, <a name="l00058"></a>00058 u_int32_t lifetime_pct, <a name="l00059"></a>00059 u_int32_t max) <a name="l00060"></a>00060 : <a class="code" href="classdtn_1_1CustodyTimerSpec.html#4eeda04970206428027b49cd227c139e" title="min timer">min_</a>(min), <a class="code" href="classdtn_1_1CustodyTimerSpec.html#a678b1d99b6769917d161d651d431db3" title="percentage of lifetime">lifetime_pct_</a>(lifetime_pct), <a class="code" href="classdtn_1_1CustodyTimerSpec.html#22fdcd31911dbfc1740664b6c21a939e" title="upper bound">max_</a>(max) {} <a name="l00061"></a>00061 <a name="l00065"></a><a class="code" href="classdtn_1_1CustodyTimerSpec.html#f011c7a1d4146d8dd5dcd4e1bfd7b9a1">00065</a> <a class="code" href="classdtn_1_1CustodyTimerSpec.html#f011c7a1d4146d8dd5dcd4e1bfd7b9a1" title="Default Constructor.">CustodyTimerSpec</a>() <a name="l00066"></a>00066 : <a class="code" href="classdtn_1_1CustodyTimerSpec.html#4eeda04970206428027b49cd227c139e" title="min timer">min_</a>(<a class="code" href="classdtn_1_1CustodyTimerSpec.html#c6d5e712cc94e4eb00f712c85065ac5c" title="Custody timer defaults, values set in the static initializer.">defaults_</a>.<a class="code" href="classdtn_1_1CustodyTimerSpec.html#4eeda04970206428027b49cd227c139e" title="min timer">min_</a>), <a name="l00067"></a>00067 <a class="code" href="classdtn_1_1CustodyTimerSpec.html#a678b1d99b6769917d161d651d431db3" title="percentage of lifetime">lifetime_pct_</a>(<a class="code" href="classdtn_1_1CustodyTimerSpec.html#c6d5e712cc94e4eb00f712c85065ac5c" title="Custody timer defaults, values set in the static initializer.">defaults_</a>.<a class="code" href="classdtn_1_1CustodyTimerSpec.html#a678b1d99b6769917d161d651d431db3" title="percentage of lifetime">lifetime_pct_</a>), <a name="l00068"></a>00068 <a class="code" href="classdtn_1_1CustodyTimerSpec.html#22fdcd31911dbfc1740664b6c21a939e" title="upper bound">max_</a>(<a class="code" href="classdtn_1_1CustodyTimerSpec.html#c6d5e712cc94e4eb00f712c85065ac5c" title="Custody timer defaults, values set in the static initializer.">defaults_</a>.<a class="code" href="classdtn_1_1CustodyTimerSpec.html#22fdcd31911dbfc1740664b6c21a939e" title="upper bound">max_</a>) {} <a name="l00069"></a>00069 <a name="l00073"></a>00073 u_int32_t <a class="code" href="classdtn_1_1CustodyTimerSpec.html#594012538951c0ddb74c19052aea505a" title="Calculate the appropriate timeout for the given bundle.">calculate_timeout</a>(<span class="keyword">const</span> <a class="code" href="classdtn_1_1Bundle.html" title="The internal representation of a bundle.">Bundle</a>* bundle) <span class="keyword">const</span>; <a name="l00074"></a>00074 <a name="l00082"></a>00082 <span class="keywordtype">int</span> <a class="code" href="classdtn_1_1CustodyTimerSpec.html#8d26dd3fc0961ed3d0bf558f86342cc9" title="Parse options to set the fields of the custody timer.">parse_options</a>(<span class="keywordtype">int</span> argc, <span class="keyword">const</span> <span class="keywordtype">char</span>* argv[], <a name="l00083"></a>00083 <span class="keyword">const</span> <span class="keywordtype">char</span>** invalidp = NULL); <a name="l00084"></a>00084 <a name="l00085"></a>00085 <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1CustodyTimerSpec.html#ca4a6d5cfbc6e87d5b833c9ed294fcc1">serialize</a>(oasys::SerializeAction* a); <a name="l00086"></a>00086 <a name="l00087"></a><a class="code" href="classdtn_1_1CustodyTimerSpec.html#4eeda04970206428027b49cd227c139e">00087</a> u_int32_t <a class="code" href="classdtn_1_1CustodyTimerSpec.html#4eeda04970206428027b49cd227c139e" title="min timer">min_</a>; <a name="l00088"></a><a class="code" href="classdtn_1_1CustodyTimerSpec.html#a678b1d99b6769917d161d651d431db3">00088</a> u_int32_t <a class="code" href="classdtn_1_1CustodyTimerSpec.html#a678b1d99b6769917d161d651d431db3" title="percentage of lifetime">lifetime_pct_</a>; <a name="l00089"></a><a class="code" href="classdtn_1_1CustodyTimerSpec.html#22fdcd31911dbfc1740664b6c21a939e">00089</a> u_int32_t <a class="code" href="classdtn_1_1CustodyTimerSpec.html#22fdcd31911dbfc1740664b6c21a939e" title="upper bound">max_</a>; <a name="l00090"></a>00090 }; <a name="l00091"></a>00091 <a name="l00105"></a><a class="code" href="classdtn_1_1CustodyTimer.html">00105</a> <span class="keyword">class </span><a class="code" href="classdtn_1_1CustodyTimer.html" title="A custody transfer timer.">CustodyTimer</a> : <span class="keyword">public</span> oasys::Timer, <span class="keyword">public</span> oasys::<a class="code" href="classoasys_1_1Logger.html">Logger</a> { <a name="l00106"></a>00106 <span class="keyword">public</span>: <a name="l00108"></a>00108 <a class="code" href="classdtn_1_1CustodyTimer.html#5618bfc30dbb8f0b4b42a22468ebd552" title="Constructor.">CustodyTimer</a>(<span class="keyword">const</span> oasys::Time& xmit_time, <a name="l00109"></a>00109 <span class="keyword">const</span> <a class="code" href="classdtn_1_1CustodyTimerSpec.html" title="Utility class to abstract out various parameters that can be used to calculate custody...">CustodyTimerSpec</a>& spec, <a name="l00110"></a>00110 <a class="code" href="classdtn_1_1Bundle.html" title="The internal representation of a bundle.">Bundle</a>* bundle, <span class="keyword">const</span> <a class="code" href="namespacedtn.html#6efb37e503f8062c537b022eb755b94e" title="Typedef for a reference on a link.">LinkRef</a>& link); <a name="l00111"></a>00111 <a name="l00113"></a>00113 <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1CustodyTimer.html#61f808a539ceda142c206cd8fd593d0b" title="Virtual timeout function.">timeout</a>(<span class="keyword">const</span> <span class="keyword">struct</span> timeval& now); <a name="l00114"></a>00114 <a name="l00116"></a>00116 <a class="code" href="namespacedtn.html#87094f3b26b9f1d469e616d311ae57b1" title="Class definition for a Bundle reference.">BundleRef</a> <a class="code" href="classdtn_1_1CustodyTimer.html#3e51c7d8d3e9ae9a9fc0e83e00aec548" title="The link that it was transmitted on.">bundle_</a>; <a name="l00117"></a>00117 <a name="l00119"></a><a class="code" href="classdtn_1_1CustodyTimer.html#c56d45a08c165fa2d0a6c3d2ea1b82aa">00119</a> <a class="code" href="namespacedtn.html#6efb37e503f8062c537b022eb755b94e" title="Typedef for a reference on a link.">LinkRef</a> <a class="code" href="classdtn_1_1CustodyTimer.html#c56d45a08c165fa2d0a6c3d2ea1b82aa">link_</a>; <a name="l00120"></a>00120 }; <a name="l00121"></a>00121 <a name="l00125"></a><a class="code" href="classdtn_1_1CustodyTimerVec.html">00125</a> <span class="keyword">class </span><a class="code" href="classdtn_1_1CustodyTimerVec.html" title="Class for a vector of custody timers.">CustodyTimerVec</a> : <span class="keyword">public</span> std::<a class="code" href="classstd_1_1vector.html">vector</a><CustodyTimer*> {}; <a name="l00126"></a>00126 <a name="l00127"></a>00127 } <span class="comment">// namespace dtn</span> <a name="l00128"></a>00128 <a name="l00129"></a>00129 <span class="preprocessor">#endif </span><span class="comment">/* _CUSTODYTIMER_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>