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 <ctime> 00045 #include <cstdlib> 00046 #include "ariba/utility/logging/Logging.h" 00047 00048 using std::vector; 00049 using std::string; 00050 00051 // forward declaration 00052 namespace ariba { 00053 class AribaModule; 00054 class SideportListener; 00055 } 00056 00057 // local includes 00058 #include "Name.h" 00059 #include "Module.h" 00060 00061 namespace ariba { 00062 00063 // forward declaration 00064 namespace communication { 00065 class EndpointDescriptor; 00066 class BaseCommunication; 00067 } 00068 00087 class AribaModule: public Module { 00088 friend class Node; 00089 use_logging_h(AribaModule); 00090 public: 00094 AribaModule(); 00095 00099 virtual ~AribaModule(); 00100 00111 string getBootstrapHints(const Name& spoVNetName = Name::UNSPECIFIED) const; 00112 00119 void addBootstrapHints(string bootinfo); 00120 00131 void registerSideportListener(SideportListener* sideport); 00132 00133 // --- module implementation --- 00134 00144 void initialize(); 00145 void start(); 00146 void stop(); 00147 string getName() const; 00148 void setProperty(string key, string value); 00149 const string getProperty(string key) const; 00150 const vector<string> getProperties() const; 00151 00155 const string getLocalEndpoints(); 00156 00157 private: 00158 // bootstrap node 00159 class BootstrapNode { 00160 public: 00161 inline BootstrapNode() : 00162 timestamp(0), desc(NULL) { 00163 00164 } 00165 inline BootstrapNode(const BootstrapNode& copy) : 00166 timestamp(copy.timestamp), desc(copy.desc) { 00167 } 00168 inline BootstrapNode(uint32_t timestamp, 00169 communication::EndpointDescriptor* desc) : 00170 timestamp(timestamp), desc(desc) { 00171 } 00172 uint32_t timestamp; 00173 communication::EndpointDescriptor* desc; 00174 }; 00175 00176 // bootstrap info 00177 class BootstrapInfo { 00178 public: 00179 BootstrapInfo() : 00180 spovnetName(), nodes() { 00181 } 00182 00183 BootstrapInfo(const BootstrapInfo& copy) : 00184 spovnetName(copy.spovnetName), nodes(copy.nodes) { 00185 } 00186 00187 Name spovnetName; 00188 vector<BootstrapNode> nodes; 00189 }; 00190 vector<BootstrapInfo> bootstrapNodes; 00191 00192 protected: 00193 // members 00194 string bootstrapFile; //< file with bootstrap information 00195 string endpoints; 00196 bool started; //< flag, if module has been started 00197 00198 // bootstrap node management 00199 void addBootstrapNode(const Name& spovnet, 00200 communication::EndpointDescriptor* desc); 00201 const communication::EndpointDescriptor* getBootstrapNode( 00202 const Name& spovnet) const; 00203 00204 communication::BaseCommunication* base_comm; 00205 SideportListener* sideport_sniffer; 00206 }; 00207 00208 } // namespace ariba 00209 00210 #endif /* ENVIRONMENT_H_ */