close Warning: Can't use blame annotator: 
No changeset 2280 in the repository

source: source/ariba/Node.h@ 4552

Last change on this file since 4552 was 3578, checked in by Christoph Mayer, 15 years ago

-paar fixes von pp branch zurück gemergt, one-shot Timer Fehler, Node Logausgabe wenn kein Bootstrap
-make dist hook damit alle .svn dateien gelöscht werden
File size: 10.6 KB
RevLine 
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 NODE_H_
40#define NODE_H_
41
42// forward declarations
43namespace ariba {
44 class Node;
45 namespace overlay {
46 class BaseOverlay;
47 }
48}
49
50#include <vector>
51#include <iostream>
52#include "Module.h"
53#include "Identifiers.h"
54#include "SpoVNetProperties.h"
55#include "NodeListener.h"
56#include "Name.h"
57#include "AribaModule.h"
58#include "CommunicationListener.h"
59#include "DataMessage.h"
60#include "SideportListener.h"
61
62using std::vector;
63using ariba::overlay::BaseOverlay;
64
65namespace ariba {
66
67/**
68 * This class should implement all ariba node functionality.
69 *
70 * @author Sebastian Mies <mies@tm.uka.de>
71 * @author Christoph Mayer <mayer@tm.uka.de>
72 */
73class Node: public Module {
74public:
75 /**
76 * Constructs a new node using a given ariba module
77 *
78 * @param ariba_mod The ariba module
79 * @param name The canonical node name of the new node. When NULL a
80 * randomly chosen name is created.
81 * @param len The length of the canonical node name or -1, if the name
82 * is a zero-terminated char-string.
83 */
84 Node(AribaModule& ariba_mod, const Name& node_name = Name::UNSPECIFIED);
85
86 /**
87 * Destroys the node. Before destruction some pre-conditions
88 * must be met:<br />
89 *
90 * 1. The node is not part of any SpoVNet <br />
91 * 2. All listeners must be unbound from this node <br />
92 * 3. The module has been stopped<br />
93 */
94 ~Node();
95
96 //--- node control ---
97
98 /**
99 * This method instructs the node to join a particular spovnet.
100 * Callees may bind with a NodeListener to receive events, when
101 * a node has been successfully joined.
102 *
103 * @param vnetId The SpoVNet name
104 */
105 void join(const Name& name);
106
107 /**
108 * This method initiates a new SpoVNet with the given SpoVNetID and
109 * parameters.
110 *
111 * @param name The SpoVNet name
112 * @param param The SpoVNet properties
113 */
114 void initiate(const Name& name, const SpoVNetProperties& parm =
115 SpoVNetProperties::DEFAULT);
116
117 /**
118 * This method initiates the leave procedure of this node.
119 */
120 void leave();
121
122 /**
123 * This method is used to bind a node listener to this node.
124 *
125 * @param listener The node listener
126 * @return boolean indicating success of failure
127 */
128 bool bind(NodeListener* listener);
129
130 /**
131 * This method is used to unbind a node listener to this node.
132 *
133 * @param listener The node listener
134 * @return boolean indicating success of failure
135 */
136 bool unbind(NodeListener* listener);
137
138 //--- spovnet properties ---
139
140 /**
141 * Returns the properties of the spovnet the node has joined.
142 *
143 * @return The properties of the spovnet the node has joined
144 */
145 const SpoVNetProperties& getSpoVNetProperties() const;
146
147 /**
148 * Returns the spovnet identifier
149 *
150 * @return The spovnet idenfifier
151 */
152 const SpoVNetID& getSpoVNetId() const;
153
154 /**
155 * Returns true, if the node is part of a spovnet.
156 *
157 * @return True, if the node is part of a spovnet
158 */
159 bool isJoined() const;
160
161 //--- addressing ---
162
163 /**
164 * Returns the node id of this node if the link id is unspecified or
165 * the node id of the remote node.
166 *
167 * @return The local or the remote node identifier
168 */
169 const NodeID& getNodeId(const LinkID& lid = LinkID::UNSPECIFIED) const;
170
171 /**
172 * Returns the node id to a node name according to the currently joined
173 * spovnet (usually derives a node identifier by hashing the name).
174 *
175 * @return The node identifier to the given name
176 */
177 NodeID generateNodeId(const Name& name) const;
178
179 /**
180 * Returns the name of this node if the link id is unspecified or
181 * the node name of the remote node, if known -- otherwise it returns
182 * an unspecified name.
183 *
184 * TODO: RFE -- send request to remote node and inform service.
185 *
186 * @return A node's name or an unspecified name, if unknown
187 */
188 const Name getNodeName(const LinkID& lid = LinkID::UNSPECIFIED) const;
189
190 /**
191 * Get a list of neighboring nodes in the overlay structure.
192 * The number and identities of nodes depends highly on the
193 * used overlay structure.
194 *
195 * @return a list of NodeIDs that are neighbors in the overlay structure
196 * @see sendBroadcastMessage
197 */
198 vector<NodeID> getNeighborNodes() const;
199
200 //--- communication ---
201
202 /**
203 * Establishes a new link to another node and service with the given
204 * link properties. An optional message could be sent with the request.
205 *
206 * @param nid The remote node identifier
207 * @param sid The remote service identifier
208 * @param req The required link properties
209 * @param msg An optional message that is sent with the request
210 * @return A new link id
211 */
212 LinkID establishLink(const NodeID& nid, const ServiceID& sid,
213 const LinkProperties& req = LinkProperties::DEFAULT,
214 const DataMessage& msg = DataMessage::UNSPECIFIED);
215
216 /**
217 * This method drops an established link.
218 *
219 * @param lnk The link identifier of an active link
220 */
221 void dropLink(const LinkID& lnk);
222
223 // message sending
224
225 /**
226 * Sends a one-shot message to a service. If link properties are specified,
227 * the node tries to fulfill those requirements. This may cause the node
228 * to first establish a temporary link, second sending the message and last
229 * dropping the link. This would result in a small amount of extra latency
230 * until the message is delivered. If reliable transport was selected,
231 * the method returns a sequence number and a communication event is
232 * triggered on message delivery or loss.
233 *
234 * @param msg The message to be sent
235 * @param nid The remote node identifier
236 * @param sid The remote service identifier
237 * @param req The requirements associated with the message
238 * @return A sequence number
239 */
240 seqnum_t sendMessage(const DataMessage& msg, const NodeID& nid, const ServiceID& sid,
241 const LinkProperties& req = LinkProperties::DEFAULT);
242
243 /**
244 * Sends a message via an established link. If reliable transport was
245 * selected, the method returns a sequence number and a communication event
246 * is triggered on message delivery or loss.
247 *
248 * @param msg The message to be sent
249 * @param lnk The link to be used for sending the message
250 */
251 seqnum_t sendMessage(const DataMessage& msg, const LinkID& lnk);
252
253 /**
254 * Sends a message to all known hosts in the overlay structure
255 * the nodes that are reached here depend on the overlay structure.
256 *
257 * @param msg The message to be send
258 * @param sid The id of the service that should receive the message
259 * @see getNeighborNodes
260 */
261 void sendBroadcastMessage(const DataMessage& msg, const ServiceID& sid);
262
263 // --- communication listeners ---
264
265 /**
266 * Binds a listener to a specifed service identifier.
267 * Whenever a link is established/dropped or messages are received the
268 * events inside the interface are called.
269 *
270 * @param listener The listener to be registered
271 * @param sid The service identifier
272 * @return boolean indicating success of failure
273 */
274 bool bind(CommunicationListener* listener, const ServiceID& sid);
275
276 /**
277 * Un-binds a listener from this node.
278 *
279 * @param The listener to be unbound
280 * @return boolean indicating success of failure
281 */
282 bool unbind(CommunicationListener* listener, const ServiceID& sid);
283
284 // --- extension proposal: service directory --
285 // main-idea: use this methods to register groups/rendevous points inside
286 // the base overlay via a distributed storage service.
287 //
288 //void put(const KeyID& key, Message* value);
289 //void get(const KeyID& key);
290 //-------------------------------------------------------------------------
291 //
292 // --- optimization proposal: allow direct endpoint descriptor exchange ---
293 // main-idea: directly allow exchanging endpoint descriptors to establish
294 // links. Depending on the overlay structure used in the base overlay, this
295 // allows a node to directly establish links between two nodes when an
296 // endpoint descriptor is known.
297 //
298 //const EndpointDescriptor& getEndpointDescriptor( const LinkID& lid );
299 //void sendMessage( EndpointDescriptor& epd, Message* msg );
300 //LinkID setupLink( const EndpointDescriptor& endpointDesc,
301 // const LinkProperties& req = LinkProperties::UNSPECIFIED,
302 // const Message* msg = NULL );
303 //
304 //-------------------------------------------------------------------------
305
306 // --- module implementation ---
307 //
308 // main-idea: use module properties to configure nodeid, spovnetid etc. and
309 // select start/stop procedures. This allows simulations to start a
310 // node without manually calling join etc.
311
312 /** @see Module.h */
313 void initialize();
314
315 /** @see Module.h */
316 void start();
317
318 /** @see Module.h */
319 void stop();
320
321 /** @see Module.h */
322 string getName() const;
323
324 /** @see Module.h */
325 void setProperty(string key, string value);
326
327 /** @see Module.h */
328 const string getProperty(string key) const;
329
330 /** @see Module.h */
331 const vector<string> getProperties() const;
332
333protected:
334 // friends
335 friend class AribaModule;
336
337 // member variables
338 Name name; //< node name
339 AribaModule& ariba_mod; //< ariba module
340 SpoVNetID spovnetId; //< current spovnet id
341 NodeID nodeId; //< current node id
342 overlay::BaseOverlay* base_overlay; //< the base overlay
343};
344
345} // namespace ariba
346
347#endif /* NODE_H_ */
Note: See TracBrowser for help on using the repository browser.