source: source/ariba/NodeListener.h@ 4758

Last change on this file since 4758 was 3056, checked in by Christoph Mayer, 16 years ago

-fixed all compile errors, but now the overlay functionality is messed up somewhere

File size: 3.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 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 NODELISTENER_H_
40#define NODELISTENER_H_
41
42#include "Identifiers.h"
43
44namespace ariba {
45
46// forward decl
47namespace overlay {
48 class BaseOverlay;
49}
50
51/**
52 * This class is used to inform a listener about node changes.
53 *
54 * @author Sebastian Mies <mies@tm.uka.de>
55 * @author Christoph Mayer <mayer@tm.uka.de>
56 */
57class NodeListener {
58 friend class ariba::overlay::BaseOverlay;
59public:
60 NodeListener();
61 virtual ~NodeListener();
62
63protected:
64 /**
65 * This event method is called, when a node has completed its join
66 * procedure.
67 *
68 * @param vid The spovnet id
69 * @param nid The node id
70 */
71 virtual void onJoinCompleted( const SpoVNetID& vid );
72
73 /**
74 * This event method is called, when a node failed to join a spovnet.
75 *
76 * @param vid The spovnet id
77 * @param nid The node id
78 */
79 virtual void onJoinFailed( const SpoVNetID& vid );
80
81 /**
82 * This event method is called, when a node succeeded to leave a spovnet.
83 *
84 * @param vid The spovnet id
85 * @param nid The node id
86 */
87 virtual void onLeaveCompleted( const SpoVNetID& vid );
88
89 /**
90 * This event method is called, when a node failed to leave a spovnet.
91 *
92 * @param vid The spovnet id
93 * @param nid The node id
94 */
95 virtual void onLeaveFailed( const SpoVNetID& vid );
96};
97
98} // namespace ariba
99
100#endif /* NODELISTENER_H_ */
Note: See TracBrowser for help on using the repository browser.