source: source/ariba/communication/CommunicationEvents.h@ 3690

Last change on this file since 3690 was 3690, checked in by mies, 16 years ago

Merged 20090512-mies-connectors changes r3472:r3689 into trunk.

File size: 3.9 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 ARIBA PROJECT 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 __COMMUNICATION_EVENTS_H
40#define __COMMUNICATION_EVENTS_H
41
42#include "ariba/utility/types/LinkID.h"
43#include "ariba/communication/modules/network/NetworkLocator.h"
44#include "ariba/utility/types/QoSParameterSet.h"
45
46using ariba::utility::LinkID;
47using ariba::utility::QoSParameterSet;
48using ariba::communication::NetworkLocator;
49
50namespace ariba {
51namespace communication {
52
53class CommunicationEvents {
54
55 friend class BaseCommunication;
56
57public:
58 CommunicationEvents();
59 virtual ~CommunicationEvents();
60
61protected:
62
63 /**
64 * This method is called when a link request is received.
65 * If this method returns true, a the link request is processed
66 * and a new link will be established.
67 *
68 * @param id The provisional link identifier of the new link
69 * @return True, if the link should be established
70 */
71 virtual bool onLinkRequest( const LinkID& id, const NetworkLocator* local, const NetworkLocator* remote );
72
73 /**
74 * This method is called when a link is established and can
75 * be used to send messages.
76 *
77 * @param id The link id of the established link
78 */
79 virtual void onLinkUp( const LinkID& id, const NetworkLocator* local, const NetworkLocator* remote );
80
81 /**
82 * This method is called when a link is dropped.
83 *
84 * @param id The link identifier of the dropped link
85 */
86 virtual void onLinkDown( const LinkID& id, const NetworkLocator* local, const NetworkLocator* remote );
87
88 /**
89 * This method is called when a link has been changed because
90 * of interface failure, mobility, etc. in this case messages
91 * can still be sent over the link -- connectivity is still provided
92 * with different link properties.
93 *
94 * @param id The link identifier of the changed link
95 */
96 virtual void onLinkChanged( const LinkID& id, const NetworkLocator* oldlocal, const NetworkLocator* newlocal, const NetworkLocator* oldremote, const NetworkLocator* newremote );
97
98 virtual void onLinkFail( const LinkID& id, const NetworkLocator* local, const NetworkLocator* remote );
99
100 virtual void onLinkQoSChanged( const LinkID& id, const NetworkLocator* local, const NetworkLocator* remote, const QoSParameterSet& qos );
101};
102
103}} // namespace ariba, communication
104
105#endif //__COMMUNICATION_EVENTS_H
Note: See TracBrowser for help on using the repository browser.