00001 00002 /* 00003 * routecache.h 00004 * Copyright (C) 2000 by the University of Southern California 00005 * $Id: routecache.h,v 1.8 2006/02/21 15:20:18 mahrenho Exp $ 00006 * 00007 * This program is free software; you can redistribute it and/or 00008 * modify it under the terms of the GNU General Public License, 00009 * version 2, as published by the Free Software Foundation. 00010 * 00011 * This program is distributed in the hope that it will be useful, 00012 * but WITHOUT ANY WARRANTY; without even the implied warranty of 00013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00014 * GNU General Public License for more details. 00015 * 00016 * You should have received a copy of the GNU General Public License along 00017 * with this program; if not, write to the Free Software Foundation, Inc., 00018 * 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. 00019 * 00020 * 00021 * The copyright of this module includes the following 00022 * linking-with-specific-other-licenses addition: 00023 * 00024 * In addition, as a special exception, the copyright holders of 00025 * this module give you permission to combine (via static or 00026 * dynamic linking) this module with free software programs or 00027 * libraries that are released under the GNU LGPL and with code 00028 * included in the standard release of ns-2 under the Apache 2.0 00029 * license or under otherwise-compatible licenses with advertising 00030 * requirements (or modified versions of such code, with unchanged 00031 * license). You may copy and distribute such a system following the 00032 * terms of the GNU GPL for this module and the licenses of the 00033 * other code concerned, provided that you include the source code of 00034 * that other code when and as the GNU GPL requires distribution of 00035 * source code. 00036 * 00037 * Note that people who make modified versions of this module 00038 * are not obligated to grant this special exception for their 00039 * modified versions; it is their choice whether to do so. The GNU 00040 * General Public License gives permission to release a modified 00041 * version without this exception; this exception also makes it 00042 * possible to release a modified version which carries forward this 00043 * exception. 00044 * 00045 */ 00046 00047 // Other copyrights might apply to parts of this software and are so 00048 // noted when applicable. 00049 // 00050 // Ported from CMU/Monarch's code, appropriate copyright applies. 00051 /* -*- c++ -*- 00052 routecache.h 00053 00054 Interface all route caches must support 00055 00056 */ 00057 00058 #ifndef _routecache_h 00059 #define _routecache_h 00060 00061 #include <cstdarg> 00062 00063 #include <object.h> 00064 #include <trace.h> 00065 00066 #include "path.h" 00067 00068 #ifdef DSR_CACHE_STATS 00069 class RouteCache; 00070 #include <dsr/cache_stats.h> 00071 #endif 00072 00073 class RouteCache : public TclObject { 00074 00075 public: 00076 RouteCache(); 00077 ~RouteCache(); 00078 00079 virtual void noticeDeadLink(const ID&from, const ID& to, Time t) = 0; 00080 // the link from->to isn't working anymore, purge routes containing 00081 // it from the cache 00082 00083 virtual void noticeRouteUsed(const Path& route, Time t, 00084 const ID& who_from) = 0; 00085 // tell the cache about a route we saw being used 00086 // if first tested is set, then we assume the first link was recently 00087 // known to work 00088 00089 virtual void addRoute(const Path& route, Time t, const ID& who_from) = 0; 00090 // add this route to the cache (presumably we did a route request 00091 // to find this route and don't want to lose it) 00092 00093 virtual bool findRoute(ID dest, Path& route, int for_use) = 0; 00094 // if there is a cached path from us to dest returns true and fills in 00095 // the route accordingly. returns false otherwise 00096 // if for_use, then we assume that the node really wants to keep 00097 // the returned route 00098 00099 virtual int command(int argc, const char*const* argv); 00100 void trace(char* fmt, ...); 00101 00102 // ******************************************************* 00103 00104 int pre_addRoute(const Path& route, Path &rt, 00105 Time t, const ID& who_from); 00106 // returns 1 if the Route should be added to the cache, 0 otherwise. 00107 00108 int pre_noticeRouteUsed(const Path& p, Path& stub, 00109 Time t, const ID& who_from); 00110 // returns 1 if the Route should be added to the cache, 0 otherwise. 00111 00112 #ifdef DSR_CACHE_STATS 00113 MobiHandler mh; 00114 struct cache_stats stat; 00115 00116 virtual void periodic_checkCache() = 0; 00117 int checkRoute_logall(Path *p, int action, int start); 00118 #endif 00119 00120 00121 //********************************************************** 00122 00123 ID MAC_id, net_id; 00124 virtual void dump(FILE *out); 00125 00126 protected: 00127 Trace *logtarget; 00128 }; 00129 00130 RouteCache * makeRouteCache(); 00131 // return a ref to the route cache that should be used in this sim 00132 00133 #endif // _routecache_h