An Overlay-based
Virtual Network Substrate
SpoVNet

source: source/ariba/Module.h @ 10700

Last change on this file since 10700 was 9684, checked in by mies, 9 years ago

almost forgot to commit: doxygen modules :)

File size: 3.1 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 INSTITUTE OF TELEMATICS 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 MODULE_H_
40#define MODULE_H_
41
42#include <string>
43#include <vector>
44
45// usings
46using std::vector;
47using std::string;
48
49namespace ariba {
50
51/**
52 * \addtogroup public
53 * @{
54 *
55 * This class serves as base class for generic modules that
56 * can be initialized, started, stopped and configured using standard
57 * human-readable properties.
58 *
59 * @author Sebastian Mies <mies@tm.uka.de>
60 */
61class Module {
62public:
63        Module();
64        virtual ~Module();
65
66        /**
67         * This method (re-)initializes this module.
68         */
69        virtual void initialize();
70
71        /**
72         * This method (re-)starts this module
73         */
74        virtual void start();
75
76        /**
77         * This method stops this module
78         */
79        virtual void stop();
80
81        /**
82         * Returns the name of this module
83         *
84         * @return The name of this module
85         */
86        virtual string getName() const;
87
88        /**
89         * Sets a property in this module
90         *
91         * @param key The key of the property
92         * @param value The value of the property
93         */
94        virtual void setProperty( string key, string value );
95
96        /**
97         * Returns the value of a specified property
98         *
99         * @param key The key of the property
100         * @return The value of the property
101         */
102        virtual const string getProperty( string key ) const;
103
104        /**
105         * Returns a vector containing all possible property keys in a
106         * human-readable form
107         *
108         * @return A vector containing all possible property keys
109         */
110        virtual const vector<string> getProperties() const;
111};
112
113} // namespace ariba
114
115/** @} */
116
117#endif /* MODULE_H_ */
Note: See TracBrowser for help on using the repository browser.