An Overlay-based
Virtual Network Substrate
SpoVNet

source: source/ariba/AribaModule.h @ 7535

Last change on this file since 7535 was 7535, checked in by Christoph Mayer, 10 years ago

-missing doxygen in interface

File size: 7.6 KB
Line 
1// [License]
2// The Ariba-Underlay Copyright
3//
4// Copyright (c) 2008-2009, Institute of Telematics, UniversitÀt Karlsruhe (TH)
5//
6// Institute of Telematics
7// UniversitÀt Karlsruhe (TH)
8// Zirkel 2, 76128 Karlsruhe
9// Germany
10//
11// Redistribution and use in source and binary forms, with or without
12// modification, are permitted provided that the following conditions are
13// met:
14//
15// 1. Redistributions of source code must retain the above copyright
16// notice, this list of conditions and the following disclaimer.
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// THIS SOFTWARE IS PROVIDED BY THE INSTITUTE OF TELEMATICS ``AS IS'' AND
22// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ARIBA PROJECT OR
25// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32//
33// The views and conclusions contained in the software and documentation
34// are those of the authors and should not be interpreted as representing
35// official policies, either expressed or implied, of the Institute of
36// Telematics.
37// [License]
38
39#ifndef ARIBAMODULE_H_
40#define ARIBAMODULE_H_
41
42#include <string>
43#include <vector>
44#include <ctime>
45#include <cstdlib>
46#include <algorithm>
47
48using std::vector;
49using std::string;
50
51// forward declaration
52namespace ariba {
53        class AribaModule;
54        class SideportListener;
55}
56
57// local includes
58#include "Name.h"
59#include "Module.h"
60
61namespace ariba {
62
63// forward declaration
64namespace communication {
65        class EndpointDescriptor;
66        class BaseCommunication;
67}
68
69/**
70 * This class implements a container class for ariba base services. Each node
71 * is a running using this base-module. It also manages Bootstrap information
72 * in a abstract simple way.
73 *
74 *        +---+   +---+
75 *        |N1 |   |N2 |
76 *     +--|   |---|   |--+
77 *     |  +---+   +---+  |
78 *     |                 |
79 *     |     AribaModule |
80 *     +-----------------+
81 *
82 * N1, N2 are nodes.
83 *
84 * @author Sebastian Mies <mies@tm.uka.de>
85 * @author Christoph Mayer <mayer@tm.uka.de>
86 */
87class AribaModule: public Module {
88        friend class Node;
89        use_logging_h(AribaModule);
90public:
91        /**
92         * Constructor of the ariba underlay module
93         */
94        AribaModule();
95
96        /**
97         * Destructor of the ariba underlay module
98         */
99        virtual ~AribaModule();
100
101        /**
102         * Returns all known bootstrap endpoints to this ariba module in
103         * a human-readable string. This information can be used by other
104         * nodes for bootstraping. It may also be used to publish this info
105         * to other nodes via the web, for example.
106         *
107         * @param The name of the spovnet
108         * @return A human-readable string containing all known bootstrap
109         *   information known to this module.
110         */
111        string getBootstrapHints(const Name& spoVNetName = Name::UNSPECIFIED) const;
112
113        /**
114         * Adds bootstrap hints to the local database. The format of the string
115         * must is the same as returned by <code>getBootstrapInfo</code>.
116         *
117         * @param bootinfo A string containing bootstrap information.
118         */
119        void addBootstrapHints(string bootinfo);
120
121        /**
122         * Register a sideport for sniffing on communication events
123         * and get advanced information. The sniffer is attached to
124         * every node that is created on the module. Only one such
125         * sniffer can be active system-wide, a new call to this
126         * register function will only attach the sniffer to nodes
127         * created after the registration call.
128         *
129         * @param sideport The SideportListener to integrate
130         */
131        void registerSideportListener(SideportListener* sideport);
132
133        // --- module implementation ---
134
135        /**
136         * Module Property information:
137         *
138         * ip.addr  = preferred ip address (otherwise bind to all)
139         * tcp.port = preferred tcp port (or use default value)
140         * udp.port = preferred udp port (or use default value)
141         * bootstrap.hints = used bootstrap hints
142         * bootstrap.file  = used file for bootstrap information
143         */
144        void initialize();                          ///< @see Module.h
145        void start();                               ///< @see Module.h
146        void stop();                                ///< @see Module.h
147        string getName() const;                     ///< @see Module.h
148        void setProperty(string key, string value); ///< @see Module.h
149        const string getProperty(string key) const; ///< @see Module.h
150        const vector<string> getProperties() const; ///< @see Module.h
151
152        /**
153         * Get the local endpoint information
154         */
155        const string getLocalEndpoints();
156
157private:
158
159        /**
160         * Available bootstrap mechanisms
161         */
162        enum BootstrapMechanism {
163                BootstrapMechanismInvalid = 0,
164                BootstrapMechanismStatic = 1,
165                BootstrapMechanismBroadcast = 2,
166                BootstrapMechanismMulticastDNS = 3,
167                BootstrapMechanismSDP = 4,
168        };
169        static const string BootstrapMechanismNames[5];
170
171        /**
172         * bootstrap node information
173         */
174        class BootstrapNode {
175        public:
176                inline BootstrapNode() :
177                        timestamp(0), desc(NULL), mechanism(BootstrapMechanismInvalid), info("") {
178
179                }
180                inline BootstrapNode(const BootstrapNode& copy) :
181                        timestamp(copy.timestamp), desc(copy.desc), mechanism(copy.mechanism), info(copy.info) {
182                }
183                inline BootstrapNode(
184                                uint32_t timestamp,
185                                communication::EndpointDescriptor* desc,
186                                BootstrapMechanism mechanism, string info) :
187                        timestamp(timestamp), desc(desc), mechanism(mechanism), info(info) {
188                }
189                uint32_t timestamp;
190                communication::EndpointDescriptor* desc;
191                BootstrapMechanism mechanism;
192                string info;
193        };
194
195        /*
196         * bootstrap info, all bootstrap nodes
197         * for a specific spovnet
198         */
199        class BootstrapInfo {
200        public:
201                BootstrapInfo() :
202                        spovnetName(), nodes() {
203                }
204
205                BootstrapInfo(const BootstrapInfo& copy) :
206                        spovnetName(copy.spovnetName), nodes(copy.nodes) {
207                }
208
209                Name spovnetName;
210                vector<BootstrapNode> nodes;
211        };
212
213        vector<BootstrapInfo> bootstrapNodes; //< all available bootstrap information
214
215protected:
216        // members
217        string endpoints; //< local endpoints the ariba module is bound to
218        bool started; //< flag, if module has been started
219
220        /**
221         * bootstrap node management
222         * add a bootstrap node
223         */
224        void addBootstrapNode(
225                        const Name& spovnet,
226                        communication::EndpointDescriptor* desc,
227                        const string& info,
228                        const BootstrapMechanism& mechanism
229                        );
230
231        /**
232         * bootstrap node management
233         * add a bootstrap node
234         */
235        void addBootstrapNode(
236                        const Name& spovnet,
237                        const BootstrapNode& node
238                        );
239
240        /**
241         * bootstrap node management
242         * get all available bootstrap mechanisms
243         * where bootstrap nodes are available for
244         */
245        vector<AribaModule::BootstrapMechanism> getBootstrapMechanisms(
246                        const Name& spovnet
247                        ) const;
248
249        /**
250         * get a endpoint descriptor for a spovnet
251         * using a specific bootstrap mechanisms.
252         * will currently only work with static
253         */
254        const communication::EndpointDescriptor* getBootstrapNode(
255                        const Name& spovnet,
256                        const BootstrapMechanism mechanism
257                        ) const;
258
259        /**
260         * get the info field associated for a given
261         * spovnet through a given mechanism
262         */
263        string getBootstrapInfo(
264                        const Name& spovnet,
265                        const BootstrapMechanism mechanism
266                        ) const;
267
268        communication::BaseCommunication* base_comm; //< the base communication
269        SideportListener* sideport_sniffer; //< the sideport listener
270};
271
272} // namespace ariba
273
274#endif /* ENVIRONMENT_H_ */
Note: See TracBrowser for help on using the repository browser.