source: source/ariba/SpoVNetProperties.h@ 5630

Last change on this file since 5630 was 5316, checked in by Christoph Mayer, 15 years ago

merge from bootstrap branch

File size: 4.2 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 SPOVNETPROPERTIES_H_
40#define SPOVNETPROPERTIES_H_
41
42#include <string>
43#include <iostream>
44#include <streambuf>
45
46using std::string;
47
48namespace ariba {
49// forward declaration
50class SpoVNetProperties;
51}
52
53#include "Identifiers.h"
54#include "Name.h"
55
56namespace ariba {
57
58/**
59 * This class implements a container that holds all properties of a
60 * SpoVNet instance. It may evolve with new features when new features
61 * are introduced.
62 *
63 * @author Sebastian Mies <mies@tm.uka.de>
64 * @author Christoph Mayer <mayer@tm.uka.de>
65 */
66class SpoVNetProperties {
67public:
68 enum OverlayType {
69 ONE_HOP_OVERLAY = 0,
70 CHORD_OVERLAY = 1,
71 };
72
73 /**
74 * This object holds the default settings for a newly created spovnet
75 * instance.
76 */
77 static const SpoVNetProperties DEFAULT;
78
79 /**
80 * Constructs a new default SpoVnet property object.
81 */
82 SpoVNetProperties();
83
84 /**
85 * Constructs a new SpoVnet property object.
86 *
87 * TODO: replace with setters! for downwards compatibility
88 */
89 /*
90 SpoVNetProperties(const Name& name, SpoVNetID id, OverlayType type,
91 uint16_t idLength, const NodeID& initiator, bool hidden = false) :
92 name(name), id(id), type(type), idLength(idLength),
93 initiator(initiator), hidden(hidden) {
94 }*/
95
96 /**
97 * Copy constructor.
98 */
99 SpoVNetProperties(const SpoVNetProperties& copy);
100
101 /**
102 * Destructor.
103 */
104 virtual ~SpoVNetProperties();
105
106 /**
107 * Returns the canonical SpoVNet name
108 */
109 const Name& getName() const;
110
111 /**
112 * Returns the SpoVNet id
113 */
114 const SpoVNetID& getId() const;
115
116 /**
117 * Returns the node id of the initiator of the spovnet.
118 * If the node id is unspecified, the initiator wanted to be anonymous.
119 */
120 const NodeID& getInitiator() const;
121
122 /**
123 * Returns the node identifier length in bites
124 */
125 uint16_t getIdentifierLength() const;
126
127 void setIdentifierLength( uint16_t length ) {
128 this->idLength = length;
129 }
130
131 /**
132 * Returns the overlay type.
133 */
134 const OverlayType getBaseOverlayType() const;
135
136 void setBaseOverlayType( OverlayType type ) {
137 this->type = type;
138 }
139
140 /**
141 * Returns true, if the spovnet is hidden
142 */
143 bool isHidden() const;
144
145 void setHidden( bool is_hidden ) {
146 this->hidden = is_hidden;
147 }
148
149 /**
150 * Returns a human readable string representation of the SpoVNet properties
151 *
152 * @return A human readable string representation of the SpoVNet properties
153 */
154 std::string toString() const;
155
156private:
157 Name name;
158 SpoVNetID id;
159 uint8_t type;
160 uint16_t idLength;
161 NodeID initiator;
162 bool hidden;
163};
164
165} // namespace ariba
166
167#endif /* SPOVNETPROPERTIES_H_ */
Note: See TracBrowser for help on using the repository browser.