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 CHORD_H_
|
---|
40 | #define CHORD_H_
|
---|
41 |
|
---|
42 | #include "ariba/utility/system/Timer.h"
|
---|
43 | #include "ariba/utility/logging/Logging.h"
|
---|
44 | #include "ariba/communication/EndpointDescriptor.h"
|
---|
45 | #include "../OverlayInterface.h"
|
---|
46 | #include <vector>
|
---|
47 |
|
---|
48 | class chord_routing_table;
|
---|
49 |
|
---|
50 | namespace ariba {
|
---|
51 | namespace overlay {
|
---|
52 |
|
---|
53 | using ariba::communication::EndpointDescriptor;
|
---|
54 | using ariba::utility::Timer;
|
---|
55 |
|
---|
56 | using namespace std;
|
---|
57 |
|
---|
58 | /**
|
---|
59 | * This class implements a structured overlay inspired by chord.
|
---|
60 | * It differs to the original form of chord in the following manner:
|
---|
61 | *
|
---|
62 | * (1) The graph is bidirectional
|
---|
63 | * (2) Stabilization is done in a reactive manner
|
---|
64 | *
|
---|
65 | * It therefore can be considered as a kind of Chorded-Kademlia :)
|
---|
66 | *
|
---|
67 | * The resulting overlay graph has a diameter of O(log N).
|
---|
68 | *
|
---|
69 | * @author Sebastian Mies <mies@tm.uka.de>
|
---|
70 | */
|
---|
71 | class Chord : public OverlayInterface, protected Timer {
|
---|
72 | use_logging_h( Chord );
|
---|
73 | private:
|
---|
74 | chord_routing_table* table;
|
---|
75 | int orphan_removal_counter;
|
---|
76 | int stabilize_counter;
|
---|
77 | int stabilize_finger;
|
---|
78 | vector<LinkID> bootstrapLinks;
|
---|
79 | vector<NodeID> pending;
|
---|
80 |
|
---|
81 | // helper: sets up a link using the "base overlay"
|
---|
82 | LinkID setup( const EndpointDescriptor& endp, const NodeID& node = NodeID::UNSPECIFIED );
|
---|
83 |
|
---|
84 | // helper: sends a message using the "base overlay"
|
---|
85 | seqnum_t send( Message* msg, const LinkID& link );
|
---|
86 |
|
---|
87 | // stabilization: sends a discovery message to the specified neighborhood
|
---|
88 | void send_discovery_to( const NodeID& destination, int ttl = 4 );
|
---|
89 |
|
---|
90 | public:
|
---|
91 | Chord(BaseOverlay& _baseoverlay, const NodeID& _nodeid,
|
---|
92 | OverlayStructureEvents* _eventsReceiver, const OverlayParameterSet& param);
|
---|
93 | virtual ~Chord();
|
---|
94 |
|
---|
95 | /// @see OverlayInterface.h
|
---|
96 | virtual const LinkID& getNextLinkId( const NodeID& id ) const;
|
---|
97 |
|
---|
98 | /// @see OverlayInterface.h
|
---|
99 | virtual void createOverlay();
|
---|
100 |
|
---|
101 | /// @see OverlayInterface.h
|
---|
102 | virtual void deleteOverlay();
|
---|
103 |
|
---|
104 | /// @see OverlayInterface.h
|
---|
105 | virtual void joinOverlay(
|
---|
106 | const EndpointDescriptor& boot = EndpointDescriptor::UNSPECIFIED
|
---|
107 | );
|
---|
108 |
|
---|
109 | /// @see OverlayInterface.h
|
---|
110 | virtual void leaveOverlay();
|
---|
111 |
|
---|
112 | /// @see OverlayInterface.h
|
---|
113 | virtual const EndpointDescriptor& resolveNode( const NodeID& node );
|
---|
114 |
|
---|
115 | /// @see OverlayInterface.h
|
---|
116 | virtual void routeMessage( const NodeID& destnode, Message* msg );
|
---|
117 |
|
---|
118 | /// @see OverlayInterface.h
|
---|
119 | virtual void routeMessage(const NodeID& node, const LinkID& link, Message* msg);
|
---|
120 |
|
---|
121 | /// @see OverlayInterface.h
|
---|
122 | virtual NodeList getKnownNodes(bool deep = true) const;
|
---|
123 |
|
---|
124 | /// @see CommunicationListener.h or @see OverlayInterface.h
|
---|
125 | virtual void onLinkUp(const LinkID& lnk, const NodeID& remote);
|
---|
126 |
|
---|
127 | /// @see CommunicationListener.h or @see OverlayInterface.h
|
---|
128 | virtual void onLinkDown(const LinkID& lnk, const NodeID& remote);
|
---|
129 |
|
---|
130 | /// @see CommunicationListener.h or @see OverlayInterface.h
|
---|
131 | virtual void onMessage(const DataMessage& msg, const NodeID& remote,
|
---|
132 | const LinkID& lnk = LinkID::UNSPECIFIED);
|
---|
133 |
|
---|
134 | /// @see Timer.h
|
---|
135 | virtual void eventFunction();
|
---|
136 | };
|
---|
137 |
|
---|
138 | }}
|
---|
139 |
|
---|
140 | #endif /* CHORD_H_ */
|
---|