An Overlay-based
Virtual Network Substrate
SpoVNet

source: source/ariba/NodeListener.h @ 10700

Last change on this file since 10700 was 9684, checked in by mies, 8 years ago

almost forgot to commit: doxygen modules :)

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