| 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 |
|
|---|
| 44 | namespace ariba {
|
|---|
| 45 |
|
|---|
| 46 | // forward decl
|
|---|
| 47 | namespace 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 | * @author Mario Hock <mario.hock@student.kit.edu>
|
|---|
| 60 | */
|
|---|
| 61 | class NodeListener {
|
|---|
| 62 | friend class ariba::overlay::BaseOverlay;
|
|---|
| 63 | public:
|
|---|
| 64 | NodeListener();
|
|---|
| 65 | virtual ~NodeListener();
|
|---|
| 66 |
|
|---|
| 67 | protected:
|
|---|
| 68 | /**
|
|---|
| 69 | * This event method is called, when a node has completed its join
|
|---|
| 70 | * procedure.
|
|---|
| 71 | *
|
|---|
| 72 | * @param vid The spovnet id
|
|---|
| 73 | * @param nid The node id
|
|---|
| 74 | */
|
|---|
| 75 | virtual void onJoinCompleted( const SpoVNetID& vid );
|
|---|
| 76 |
|
|---|
| 77 | /**
|
|---|
| 78 | * This event method is called, when a node failed to join a spovnet.
|
|---|
| 79 | *
|
|---|
| 80 | * @param vid The spovnet id
|
|---|
| 81 | * @param nid The node id
|
|---|
| 82 | */
|
|---|
| 83 | virtual void onJoinFailed( const SpoVNetID& vid );
|
|---|
| 84 |
|
|---|
| 85 | /**
|
|---|
| 86 | * This event method is called, when a node succeeded to leave a spovnet.
|
|---|
| 87 | *
|
|---|
| 88 | * @param vid The spovnet id
|
|---|
| 89 | * @param nid The node id
|
|---|
| 90 | */
|
|---|
| 91 | virtual void onLeaveCompleted( const SpoVNetID& vid );
|
|---|
| 92 |
|
|---|
| 93 | /**
|
|---|
| 94 | * This event method is called, when a node failed to leave a spovnet.
|
|---|
| 95 | *
|
|---|
| 96 | * @param vid The spovnet id
|
|---|
| 97 | * @param nid The node id
|
|---|
| 98 | */
|
|---|
| 99 | virtual void onLeaveFailed( const SpoVNetID& vid );
|
|---|
| 100 |
|
|---|
| 101 | /**
|
|---|
| 102 | * This event method is called, when the number of neighbours gets above one.
|
|---|
| 103 | *
|
|---|
| 104 | * Usually this means, the node is now connected to an existing spovnet, or
|
|---|
| 105 | * another node connected to this node and a "two-elemnt" spovnet just formed up.
|
|---|
| 106 | *
|
|---|
| 107 | * NOTE: This method can be called again, after »onOverlayDisconnected« has
|
|---|
| 108 | * been called.
|
|---|
| 109 | *
|
|---|
| 110 | * @param vid The spovnet id
|
|---|
| 111 | */
|
|---|
| 112 | virtual void onOverlayConnected( const SpoVNetID& vid );
|
|---|
| 113 |
|
|---|
| 114 | /**
|
|---|
| 115 | * This event method is called, when the number of neighbours drops to zero.
|
|---|
| 116 | *
|
|---|
| 117 | * Usually this means, the note has lost connection to the spovnet, or the
|
|---|
| 118 | * spovnet ceased to exist, since all other nodes are gone.
|
|---|
| 119 | *
|
|---|
| 120 | * NOTE: This method will only be called after »onOverlayConnected« has been
|
|---|
| 121 | * called.
|
|---|
| 122 | *
|
|---|
| 123 | * @param vid The spovnet id
|
|---|
| 124 | */
|
|---|
| 125 | virtual void onOverlayDisconnected( const SpoVNetID& vid );
|
|---|
| 126 | };
|
|---|
| 127 |
|
|---|
| 128 | } // namespace ariba
|
|---|
| 129 |
|
|---|
| 130 | /** @} */
|
|---|
| 131 |
|
|---|
| 132 | #endif /* NODELISTENER_H_ */
|
|---|
