| 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 |
|
|---|
| 46 | using std::string;
|
|---|
| 47 |
|
|---|
| 48 | namespace ariba {
|
|---|
| 49 | // forward declaration
|
|---|
| 50 | class SpoVNetProperties;
|
|---|
| 51 | }
|
|---|
| 52 |
|
|---|
| 53 | #include "Identifiers.h"
|
|---|
| 54 | #include "Name.h"
|
|---|
| 55 |
|
|---|
| 56 | namespace 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 | */
|
|---|
| 66 | class SpoVNetProperties {
|
|---|
| 67 | public:
|
|---|
| 68 | enum OverlayType {
|
|---|
| 69 | ONE_HOP_OVERLAY = 0,
|
|---|
| 70 | CHORD_OVERLAY = 1,
|
|---|
| 71 | KADEMLIA_OVERLAY = 2,
|
|---|
| 72 | };
|
|---|
| 73 |
|
|---|
| 74 |
|
|---|
| 75 | /**
|
|---|
| 76 | * This object holds the default settings for a newly created spovnet
|
|---|
| 77 | * instance.
|
|---|
| 78 | */
|
|---|
| 79 | static const SpoVNetProperties DEFAULT;
|
|---|
| 80 |
|
|---|
| 81 | /**
|
|---|
| 82 | * Constructs a new default SpoVnet property object.
|
|---|
| 83 | */
|
|---|
| 84 | SpoVNetProperties();
|
|---|
| 85 |
|
|---|
| 86 | /**
|
|---|
| 87 | * Constructs a new SpoVnet property object.
|
|---|
| 88 | *
|
|---|
| 89 | * TODO: replace with setters! for downwards compatibility
|
|---|
| 90 | */
|
|---|
| 91 | /*
|
|---|
| 92 | SpoVNetProperties(const Name& name, SpoVNetID id, OverlayType type,
|
|---|
| 93 | uint16_t idLength, const NodeID& initiator, bool hidden = false) :
|
|---|
| 94 | name(name), id(id), type(type), idLength(idLength),
|
|---|
| 95 | initiator(initiator), hidden(hidden) {
|
|---|
| 96 | }*/
|
|---|
| 97 |
|
|---|
| 98 | /**
|
|---|
| 99 | * Copy constructor.
|
|---|
| 100 | */
|
|---|
| 101 | SpoVNetProperties(const SpoVNetProperties& copy);
|
|---|
| 102 |
|
|---|
| 103 | /**
|
|---|
| 104 | * Destructor.
|
|---|
| 105 | */
|
|---|
| 106 | virtual ~SpoVNetProperties();
|
|---|
| 107 |
|
|---|
| 108 | /**
|
|---|
| 109 | * Returns the canonical SpoVNet name
|
|---|
| 110 | */
|
|---|
| 111 | const Name& getName() const;
|
|---|
| 112 |
|
|---|
| 113 | /**
|
|---|
| 114 | * Returns the SpoVNet id
|
|---|
| 115 | */
|
|---|
| 116 | const SpoVNetID& getId() const;
|
|---|
| 117 |
|
|---|
| 118 | /**
|
|---|
| 119 | * Returns the node id of the initiator of the spovnet.
|
|---|
| 120 | * If the node id is unspecified, the initiator wanted to be anonymous.
|
|---|
| 121 | */
|
|---|
| 122 | const NodeID& getInitiator() const;
|
|---|
| 123 |
|
|---|
| 124 | /**
|
|---|
| 125 | * Returns the node identifier length in bites
|
|---|
| 126 | */
|
|---|
| 127 | uint16_t getIdentifierLength() const;
|
|---|
| 128 |
|
|---|
| 129 | /**
|
|---|
| 130 | * Returns the overlay type.
|
|---|
| 131 | */
|
|---|
| 132 | const OverlayType getBaseOverlayType() const;
|
|---|
| 133 |
|
|---|
| 134 | /**
|
|---|
| 135 | * Returns true, if the spovnet is hidden
|
|---|
| 136 | */
|
|---|
| 137 | bool isHidden() const;
|
|---|
| 138 |
|
|---|
| 139 | /**
|
|---|
| 140 | * Returns a human readable string representation of the SpoVNet properties
|
|---|
| 141 | *
|
|---|
| 142 | * @return A human readable string representation of the SpoVNet properties
|
|---|
| 143 | */
|
|---|
| 144 | std::string toString() const;
|
|---|
| 145 |
|
|---|
| 146 | private:
|
|---|
| 147 | Name name;
|
|---|
| 148 | SpoVNetID id;
|
|---|
| 149 | uint8_t type;
|
|---|
| 150 | uint16_t idLength;
|
|---|
| 151 | NodeID initiator;
|
|---|
| 152 | bool hidden;
|
|---|
| 153 | };
|
|---|
| 154 |
|
|---|
| 155 | } // namespace ariba
|
|---|
| 156 |
|
|---|
| 157 | #endif /* SPOVNETPROPERTIES_H_ */
|
|---|
