CustodyTimer.h

Go to the documentation of this file.
00001 /*
00002  * IMPORTANT: READ BEFORE DOWNLOADING, COPYING, INSTALLING OR USING. By
00003  * downloading, copying, installing or using the software you agree to
00004  * this license. If you do not agree to this license, do not download,
00005  * install, copy or use the software.
00006  * 
00007  * Intel Open Source License 
00008  * 
00009  *  2006 Intel Corporation. All rights reserved. 
00010  * 
00011  * Redistribution and use in source and binary forms, with or without
00012  * modification, are permitted provided that the following conditions are
00013  * met:
00014  * 
00015  *   Redistributions of source code must retain the above copyright
00016  *   notice, this list of conditions and the following disclaimer.
00017  * 
00018  *   Redistributions in binary form must reproduce the above copyright
00019  *   notice, this list of conditions and the following disclaimer in the
00020  *   documentation and/or other materials provided with the distribution.
00021  * 
00022  *   Neither the name of the Intel Corporation nor the names of its
00023  *   contributors may be used to endorse or promote products derived from
00024  *   this software without specific prior written permission.
00025  *  
00026  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00027  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00028  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
00029  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE INTEL OR
00030  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00031  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00032  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
00033  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00034  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00035  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00036  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037  */
00038 #ifndef _CUSTODYTIMER_H_
00039 #define _CUSTODYTIMER_H_
00040 
00041 #include <oasys/thread/Timer.h>
00042 #include "bundling/BundleRef.h"
00043 
00044 namespace dtn {
00045 
00046 class Bundle;
00047 class Link;
00048 
00066 class CustodyTimerSpec {
00067 public:
00071     static CustodyTimerSpec defaults_;
00072     
00076     CustodyTimerSpec(u_int32_t min,
00077                      u_int32_t lifetime_pct,
00078                      u_int32_t max)
00079         : min_(min), lifetime_pct_(lifetime_pct), max_(max) {}
00080 
00084     CustodyTimerSpec()
00085         : min_(defaults_.min_),
00086           lifetime_pct_(defaults_.lifetime_pct_),
00087           max_(defaults_.max_) {}
00088 
00092     u_int32_t calculate_timeout(const Bundle* bundle) const;
00093 
00101     int parse_options(int argc, const char* argv[],
00102                       const char** invalidp = NULL);
00103 
00104     u_int32_t min_;             
00105     u_int32_t lifetime_pct_;    
00106     u_int32_t max_;             
00107 };
00108 
00122 class CustodyTimer : public oasys::Timer, public oasys::Logger {
00123 public:
00125     CustodyTimer(const struct timeval& xmit_time,
00126                  const CustodyTimerSpec& spec,
00127                  Bundle* bundle, Link* link);
00128 
00130     void timeout(const struct timeval& now);
00131 
00133     BundleRef bundle_;
00134 
00136     Link* link_;
00137 };
00138 
00142 class CustodyTimerVec : public std::vector<CustodyTimer*> {};
00143 
00144 } // namespace dtn
00145 
00146 #endif /* _CUSTODYTIMER_H_ */

Generated on Fri Dec 22 14:47:58 2006 for DTN Reference Implementation by  doxygen 1.5.1