| 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 COMMUNICATIONLISTENER_H_
|
|---|
| 40 | #define COMMUNICATIONLISTENER_H_
|
|---|
| 41 |
|
|---|
| 42 | #include "Message.h"
|
|---|
| 43 | #include "Identifiers.h"
|
|---|
| 44 | #include "LinkProperties.h"
|
|---|
| 45 | #include "DataMessage.h"
|
|---|
| 46 |
|
|---|
| 47 | namespace ariba {
|
|---|
| 48 |
|
|---|
| 49 | // forward decl
|
|---|
| 50 | namespace overlay {
|
|---|
| 51 | class BaseOverlay;
|
|---|
| 52 | }
|
|---|
| 53 |
|
|---|
| 54 | /**
|
|---|
| 55 | * Listener for communication events on links.
|
|---|
| 56 | */
|
|---|
| 57 | class CommunicationListener {
|
|---|
| 58 |
|
|---|
| 59 | friend class ariba::overlay::BaseOverlay;
|
|---|
| 60 | friend class Node;
|
|---|
| 61 |
|
|---|
| 62 | public:
|
|---|
| 63 | static CommunicationListener DEFAULT; //< default implementation
|
|---|
| 64 |
|
|---|
| 65 | protected:
|
|---|
| 66 |
|
|---|
| 67 | /**
|
|---|
| 68 | * Construct a communication listener
|
|---|
| 69 | */
|
|---|
| 70 | CommunicationListener();
|
|---|
| 71 |
|
|---|
| 72 | /**
|
|---|
| 73 | * Destruct a communication listener
|
|---|
| 74 | */
|
|---|
| 75 | virtual ~CommunicationListener();
|
|---|
| 76 |
|
|---|
| 77 | // --- link events ---
|
|---|
| 78 |
|
|---|
| 79 | /**
|
|---|
| 80 | * Event called when a link goes up
|
|---|
| 81 | * @param lnk The id of the link
|
|---|
| 82 | * @param remote The remote node where the link ends
|
|---|
| 83 | */
|
|---|
| 84 | virtual void onLinkUp(const LinkID& lnk, const NodeID& remote);
|
|---|
| 85 |
|
|---|
| 86 | /**
|
|---|
| 87 | * Event called when a link goes down
|
|---|
| 88 | * @param lnk The id of the link
|
|---|
| 89 | * @param remote The remote node where the link ends
|
|---|
| 90 | */
|
|---|
| 91 | virtual void onLinkDown(const LinkID& lnk, const NodeID& remote);
|
|---|
| 92 |
|
|---|
| 93 | /**
|
|---|
| 94 | * Event called when a link has changed,
|
|---|
| 95 | * e.g. through mobility
|
|---|
| 96 | * @param lnk The id of the link
|
|---|
| 97 | * @param remote The remote node where the link ends
|
|---|
| 98 | */
|
|---|
| 99 | virtual void onLinkChanged(const LinkID& lnk, const NodeID& remote);
|
|---|
| 100 |
|
|---|
| 101 | /**
|
|---|
| 102 | * Event called when a link has failed
|
|---|
| 103 | * @param lnk The id of the link
|
|---|
| 104 | * @param remote The remote node where the link ends
|
|---|
| 105 | */
|
|---|
| 106 | virtual void onLinkFail(const LinkID& lnk, const NodeID& remote);
|
|---|
| 107 |
|
|---|
| 108 | /**
|
|---|
| 109 | * Request from remote node to open up a link
|
|---|
| 110 | * @param remote The remote node that requests the new link
|
|---|
| 111 | */
|
|---|
| 112 | virtual bool onLinkRequest(const NodeID& remote);
|
|---|
| 113 |
|
|---|
| 114 | // --- general receive method ---
|
|---|
| 115 |
|
|---|
| 116 | /**
|
|---|
| 117 | * Called when a message is incoming
|
|---|
| 118 | * @param msg The data message that is received
|
|---|
| 119 | * @param remote The remote node that sent the message
|
|---|
| 120 | * @param lnk The link id of the link where the message is received
|
|---|
| 121 | */
|
|---|
| 122 | virtual void onMessage(const DataMessage& msg, const NodeID& remote,
|
|---|
| 123 | const LinkID& lnk = LinkID::UNSPECIFIED);
|
|---|
| 124 |
|
|---|
| 125 | // --- dht functionality ---
|
|---|
| 126 |
|
|---|
| 127 | /**
|
|---|
| 128 | * Called when a key has been resolved in the DHT
|
|---|
| 129 | * @param key The key that was requested
|
|---|
| 130 | * @param value the data items the key was resolved to
|
|---|
| 131 | */
|
|---|
| 132 | virtual void onKeyValue( const Data& key, const vector<Data>& value );
|
|---|
| 133 |
|
|---|
| 134 | };
|
|---|
| 135 |
|
|---|
| 136 | } // namespace ariba
|
|---|
| 137 |
|
|---|
| 138 | #endif /* COMMUNICATIONLISTENER_H_ */
|
|---|
