source: source/ariba/CommunicationListener.h@ 10002

Last change on this file since 10002 was 9684, checked in by mies, 14 years ago

almost forgot to commit: doxygen modules :)

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