00001 // [License] 00002 // The Ariba-Underlay Copyright 00003 // 00004 // Copyright (c) 2008-2009, Institute of Telematics, Universität Karlsruhe (TH) 00005 // 00006 // Institute of Telematics 00007 // Universität Karlsruhe (TH) 00008 // Zirkel 2, 76128 Karlsruhe 00009 // Germany 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 // 1. Redistributions of source code must retain the above copyright 00016 // notice, this list of conditions and the following disclaimer. 00017 // 2. Redistributions in binary form must reproduce the above copyright 00018 // notice, this list of conditions and the following disclaimer in the 00019 // documentation and/or other materials provided with the distribution. 00020 // 00021 // THIS SOFTWARE IS PROVIDED BY THE INSTITUTE OF TELEMATICS ``AS IS'' AND 00022 // ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 00023 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 00024 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ARIBA PROJECT OR 00025 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 00026 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 00027 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 00028 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 00029 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 00030 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 00031 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00032 // 00033 // The views and conclusions contained in the software and documentation 00034 // are those of the authors and should not be interpreted as representing 00035 // official policies, either expressed or implied, of the Institute of 00036 // Telematics. 00037 // [License] 00038 00039 #ifndef ARIBAMODULE_H_ 00040 #define ARIBAMODULE_H_ 00041 00042 #include <string> 00043 #include <vector> 00044 #include <boost/foreach.hpp> 00045 00046 using std::vector; 00047 using std::string; 00048 00049 // forward declaration 00050 namespace ariba { 00051 class AribaModule; 00052 class SideportListener; 00053 } 00054 00055 // local includes 00056 #include "Name.h" 00057 #include "Module.h" 00058 00059 namespace ariba { 00060 00061 namespace communication { 00062 class EndpointDescriptor; 00063 class NetworkLocator; 00064 } 00065 namespace communication { 00066 class BaseCommunication; 00067 } 00068 00087 class AribaModule: public Module { 00088 friend class Node; 00089 public: 00093 AribaModule(); 00094 00098 virtual ~AribaModule(); 00099 00110 string getBootstrapHints(const Name& spoVNetName = Name::UNSPECIFIED) const; 00111 00118 void addBootstrapHints(string bootinfo); 00119 00130 void registerSideportListener(SideportListener* sideport); 00131 00132 // --- module implementation --- 00133 00143 void initialize(); 00144 void start(); 00145 void stop(); 00146 string getName() const; 00147 void setProperty(string key, string value); 00148 const string getProperty(string key) const; 00149 const vector<string> getProperties() const; 00150 00151 private: 00152 // bootstrap node 00153 class BootstrapNode { 00154 public: 00155 inline BootstrapNode() : 00156 timestamp(0), desc(NULL) { 00157 00158 } 00159 inline BootstrapNode(const BootstrapNode& copy) : 00160 timestamp(copy.timestamp), desc(copy.desc) { 00161 } 00162 inline BootstrapNode(uint32_t timestamp, 00163 communication::EndpointDescriptor* desc) : 00164 timestamp(timestamp), desc(desc) { 00165 } 00166 uint32_t timestamp; 00167 communication::EndpointDescriptor* desc; 00168 }; 00169 00170 // bootstrap info 00171 class BootstrapInfo { 00172 public: 00173 BootstrapInfo() : 00174 spovnetName(), nodes() { 00175 } 00176 00177 BootstrapInfo(const BootstrapInfo& copy) : 00178 spovnetName(copy.spovnetName), nodes(copy.nodes) { 00179 } 00180 00181 Name spovnetName; 00182 vector<BootstrapNode> nodes; 00183 }; 00184 vector<BootstrapInfo> bootstrapNodes; 00185 00186 protected: 00187 // members 00188 string bootstrapFile; //< file with bootstrap information 00189 bool started; //< flag, if module has been started 00190 00191 // bootstrap node management 00192 void addBootstrapNode(const Name& spovnet, 00193 communication::EndpointDescriptor* desc); 00194 const communication::EndpointDescriptor* getBootstrapNode( 00195 const Name& spovnet) const; 00196 00197 communication::BaseCommunication* base_comm; 00198 SideportListener* sideport_sniffer; 00199 00200 // TODO: use "abstract" representations here! 00201 communication::NetworkLocator* ip_addr; 00202 uint16_t tcp_port, udp_port; 00203 }; 00204 00205 } // namespace ariba 00206 00207 #endif /* ENVIRONMENT_H_ */