BundleRouter.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  * Copyright (c) 2004 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 _BUNDLE_ROUTER_H_
00039 #define _BUNDLE_ROUTER_H_
00040 
00041 #include <vector>
00042 #include <oasys/debug/Logger.h>
00043 #include <oasys/thread/Thread.h>
00044 #include <oasys/util/StringUtils.h>
00045 
00046 #include "bundling/BundleEvent.h"
00047 #include "bundling/BundleEventHandler.h"
00048 #include "naming/EndpointID.h"
00049 
00050 namespace dtn {
00051 
00052 class BundleActions;
00053 class BundleRouter;
00054 class StringBuffer;
00055 
00059 typedef std::vector<BundleRouter*> BundleRouterList;
00060 
00081 class BundleRouter : public BundleEventHandler {
00082 public:
00087     static BundleRouter* create_router(const char* type);
00088 
00093     static struct config_t {
00095         std::string type_;
00096         
00099         bool add_nexthop_routes_;
00100         
00102         int default_priority_;
00103                 
00104     } Config;
00105     
00109     virtual ~BundleRouter();
00110 
00111     /*
00112      *  called after all the global data structures are set up
00113      */
00114     virtual void initialize();
00115 
00120     virtual void handle_event(BundleEvent* event) = 0;
00121     
00125     virtual void get_routing_state(oasys::StringBuffer* buf) = 0;
00126     
00127 protected:
00131     BundleRouter(const char* classname, const std::string& name);
00132 
00134     std::string name_;
00135     
00137     BundleList* pending_bundles_;
00138 
00140     BundleList* custody_bundles_;
00141 
00144     BundleActions* actions_;
00145     
00146 };
00147 
00148 } // namespace dtn
00149 
00150 #endif /* _BUNDLE_ROUTER_H_ */

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