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

Last change on this file since 2460 was 2460, checked in by mies, 16 years ago

changed: renamed TidyXXX files

File size: 3.7 KB
Line 
1// [Licence]
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// [Licence]
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/overlay/modules/onehop/messages/OneHopMessage.h"
45#include "ariba/overlay/modules/onehop/messages/NodeListingRequest.h"
46#include "ariba/overlay/modules/onehop/messages/NodeListingReply.h"
47#include "ariba/utility/logging/Logging.h"
48
49using std::map;
50using ariba::overlay::OverlayInterface;
51using ariba::overlay::OneHopMessage;
52using ariba::overlay::NodeListingRequest;
53using ariba::overlay::NodeListingReply;
54
55namespace ariba {
56namespace overlay {
57
58class OneHop : public OverlayInterface {
59 use_logging_h( OneHop );
60public:
61 OneHop(
62 BaseOverlay& _overlay,
63 const NodeID& _nodeid,
64 OverlayStructureEvents* _eventsReceiver
65 );
66
67 virtual ~OneHop();
68
69protected:
70
71 //
72 // OverlayInterface.h
73 //
74
75 virtual void createOverlay();
76 virtual void deleteOverlay();
77
78 virtual void joinOverlay(const EndpointDescriptor& bootstrapEp = EndpointDescriptor::UNSPECIFIED);
79 virtual void leaveOverlay();
80
81 virtual const EndpointDescriptor& resolveNode( const NodeID& node );
82 virtual void routeMessage( const NodeID& destnode, Message* msg );
83
84 virtual NodeList getKnownNodes() const;
85
86 //
87 // see ServiceInterface.h and OverlayInterface.h
88 //
89
90 virtual void onLinkUp( const LinkID& link, const NodeID& local, const NodeID& remote );
91 virtual void onLinkDown( const LinkID& link, const NodeID& local, const NodeID& remote );
92 virtual bool receiveMessage( const Message* message, const LinkID& link, const NodeID& node );
93
94private:
95
96 /**
97 * The other nodes in the overlay
98 */
99 typedef map<const NodeID,const LinkID> OverlayNodeMapping;
100 OverlayNodeMapping overlayNodes;
101
102 /**
103 * The current state of the overlay
104 */
105 typedef enum _OneHopState {
106 OneHopStateInvalid = 0,
107 OneHopStateJoinInitiated = 1,
108 OneHopStateJoinListingRequested = 2,
109 OneHopStateCompleted = 3,
110 } OneHopState;
111
112 OneHopState state;
113
114 uint16_t pendingLinks;
115 LinkID bootstrapLink;
116
117};
118
119}} // namespace ariba, overlay
120
121#endif // _ONE_HOP_H
Note: See TracBrowser for help on using the repository browser.