source: source/ariba/CommunicationListener.h@ 3718

Last change on this file since 3718 was 3374, checked in by Christoph Mayer, 15 years ago

-Integration of Branch 20090424-mayer-sideport

File size: 3.4 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/**
55 * Listener for communication events on links.
56 */
57class CommunicationListener {
58
59 friend class ariba::overlay::BaseOverlay;
60 friend class Node;
61
62 static CommunicationListener DEFAULT;
63
64protected:
65
66 CommunicationListener();
67 virtual ~CommunicationListener();
68
69 // --- link events ---
70
71 virtual void onLinkUp(const LinkID& lnk, const NodeID& remote);
72
73 virtual void onLinkDown(const LinkID& lnk, const NodeID& remote);
74
75 virtual void onLinkChanged(const LinkID& lnk, const NodeID& remote);
76
77 virtual void onLinkFail(const LinkID& lnk, const NodeID& remote);
78
79 virtual bool onLinkRequest(const NodeID& remote, const DataMessage& msg = DataMessage::UNSPECIFIED);
80
81 // --- general receive method ---
82
83 virtual void onMessage(const DataMessage& msg, const NodeID& remote,
84 const LinkID& lnk = LinkID::UNSPECIFIED);
85
86 // --- sniffing related method ---
87 virtual bool onEnableSideportListener();
88
89 // --- extended message functionality ---
90 // virtual void onLinkQoSChanged(const LinkID& lnk, const NodeID& remote,
91 // const LinkProperties& prop);
92
93 // --- extended message functionality ---
94 // virtual void onMessageSent(seqnum_t seq_num, bool failed,
95 // const DataMessage& msg = DataMessage::UNSPECIFIED);
96
97 // --- dht functionality ---
98 // virtual void onGetResponse( const Identifier<> id, const Message* msg );
99 // virtual void onPutResponse( const Identifier<> id, const Message* msg );
100};
101
102} // namespace ariba
103
104#endif /* COMMUNICATIONLISTENER_H_ */
Note: See TracBrowser for help on using the repository browser.