source: source/ariba/overlay/modules/onehop/OneHop.h@ 6947

Last change on this file since 6947 was 6266, checked in by mies, 15 years ago

added basic DHT functionality (untested)

File size: 4.0 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 _ONE_HOP_H
40#define _ONE_HOP_H
41
42#include <map>
43#include "ariba/overlay/modules/OverlayInterface.h"
44#include "ariba/utility/logging/Logging.h"
45#include "ariba/utility/system/Timer.h"
46
47using std::map;
48using ariba::utility::Timer;
49
50namespace ariba {
51namespace overlay {
52
53class OneHop : public OverlayInterface, protected Timer {
54 use_logging_h( OneHop );
55public:
56 OneHop(BaseOverlay& _overlay, const NodeID& _nodeid,
57 OverlayStructureEvents* _eventsReceiver, const OverlayParameterSet& param);
58
59 virtual ~OneHop();
60
61protected:
62
63 /// @see Timer.h
64 virtual void eventFunction();
65
66 /// @see OverlayInterface.h
67 virtual void createOverlay();
68
69 /// @see OverlayInterface.h
70 virtual void deleteOverlay();
71
72 /// @see OverlayInterface.h
73 virtual void joinOverlay(const EndpointDescriptor& boot =
74 EndpointDescriptor::UNSPECIFIED());
75
76 /// @see OverlayInterface.h
77 virtual void leaveOverlay();
78
79 /// @see OverlayInterface.h
80 virtual const EndpointDescriptor& resolveNode(const NodeID& node);
81
82 /// @see OverlayInterface.h
83 virtual bool isClosestNodeTo( const NodeID& node );
84
85 /// @see OverlayInterface.h
86 virtual const LinkID& getNextLinkId( const NodeID& id ) const;
87
88 /// @see OverlayInterface.h
89 virtual void routeMessage(const NodeID& destnode, Message* msg);
90
91 /// @see OverlayInterface.h
92 virtual void routeMessage(const NodeID& node, const LinkID& link, Message* msg);
93
94 /// @see OverlayInterface.h
95 virtual NodeList getKnownNodes(bool deep = true) const;
96
97 /// @see CommunicationListener.h or @see OverlayInterface.h
98 virtual void onLinkUp(const LinkID& lnk, const NodeID& remote);
99
100 /// @see CommunicationListener.h or @see OverlayInterface.h
101 virtual void onLinkDown(const LinkID& lnk, const NodeID& remote);
102
103 /// @see CommunicationListener.h or @see OverlayInterface.h
104 virtual void onMessage(const DataMessage& msg, const NodeID& remote,
105 const LinkID& lnk = LinkID::UNSPECIFIED);
106
107private:
108 /// The other nodes in the overlay
109 typedef map<const NodeID, const LinkID> OverlayNodeMapping;
110 OverlayNodeMapping overlayNodes;
111
112 /// The current state of the overlay
113 typedef enum _OneHopState {
114 OneHopStateInvalid = 0,
115 OneHopStateCompleted = 1,
116 } OneHopState;
117
118 OneHopState state;
119 vector<LinkID> bootstrapLinks;
120};
121
122}} // namespace ariba, overlay
123
124#endif // _ONE_HOP_H
Note: See TracBrowser for help on using the repository browser.