source: source/ariba/overlay/modules/chord/Chord.h@ 5665

Last change on this file since 5665 was 5646, checked in by mies, 15 years ago
File size: 4.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 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
48class chord_routing_table;
49
50namespace ariba {
51namespace overlay {
52
53using ariba::communication::EndpointDescriptor;
54using ariba::utility::Timer;
55
56using 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 */
71class Chord : public OverlayInterface, protected Timer {
72 use_logging_h( Chord );
73private:
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 int discovery_count;
81
82 // helper: sets up a link using the "base overlay"
83 LinkID setup( const EndpointDescriptor& endp, const NodeID& node = NodeID::UNSPECIFIED );
84
85 // helper: sends a message using the "base overlay"
86 seqnum_t send( Message* msg, const LinkID& link );
87
88 // stabilization: sends a discovery message to the specified neighborhood
89 void send_discovery_to( const NodeID& destination, int ttl = 3 );
90
91public:
92 Chord(BaseOverlay& _baseoverlay, const NodeID& _nodeid,
93 OverlayStructureEvents* _eventsReceiver, const OverlayParameterSet& param);
94 virtual ~Chord();
95
96 /// @see OverlayInterface.h
97 virtual const LinkID& getNextLinkId( const NodeID& id ) const;
98
99 /// @see OverlayInterface.h
100 virtual void createOverlay();
101
102 /// @see OverlayInterface.h
103 virtual void deleteOverlay();
104
105 /// @see OverlayInterface.h
106 virtual void joinOverlay(
107 const EndpointDescriptor& boot = EndpointDescriptor::UNSPECIFIED()
108 );
109
110 /// @see OverlayInterface.h
111 virtual void leaveOverlay();
112
113 /// @see OverlayInterface.h
114 virtual const EndpointDescriptor& resolveNode( const NodeID& node );
115
116 /// @see OverlayInterface.h
117 virtual void routeMessage( const NodeID& destnode, Message* msg );
118
119 /// @see OverlayInterface.h
120 virtual void routeMessage(const NodeID& node, const LinkID& link, Message* msg);
121
122 /// @see OverlayInterface.h
123 virtual NodeList getKnownNodes(bool deep = true) const;
124
125 /// @see CommunicationListener.h or @see OverlayInterface.h
126 virtual void onLinkUp(const LinkID& lnk, const NodeID& remote);
127
128 /// @see CommunicationListener.h or @see OverlayInterface.h
129 virtual void onLinkDown(const LinkID& lnk, const NodeID& remote);
130
131 /// @see CommunicationListener.h or @see OverlayInterface.h
132 virtual void onMessage(const DataMessage& msg, const NodeID& remote,
133 const LinkID& lnk = LinkID::UNSPECIFIED);
134
135 /// @see Timer.h
136 virtual void eventFunction();
137};
138
139}}
140
141#endif /* CHORD_H_ */
Note: See TracBrowser for help on using the repository browser.