00001 // [License] 00002 // The Ariba-Underlay Copyright 00003 // 00004 // Copyright (c) 2008-2009, Institute of Telematics, Universität Karlsruhe (TH) 00005 // 00006 // Institute of Telematics 00007 // Universität Karlsruhe (TH) 00008 // Zirkel 2, 76128 Karlsruhe 00009 // Germany 00010 // 00011 // Redistribution and use in source and binary forms, with or without 00012 // modification, are permitted provided that the following conditions are 00013 // met: 00014 // 00015 // 1. Redistributions of source code must retain the above copyright 00016 // notice, this list of conditions and the following disclaimer. 00017 // 2. Redistributions in binary form must reproduce the above copyright 00018 // notice, this list of conditions and the following disclaimer in the 00019 // documentation and/or other materials provided with the distribution. 00020 // 00021 // THIS SOFTWARE IS PROVIDED BY THE INSTITUTE OF TELEMATICS ``AS IS'' AND 00022 // ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 00023 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 00024 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OF TELEMATICS OR 00025 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 00026 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 00027 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 00028 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 00029 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 00030 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 00031 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00032 // 00033 // The views and conclusions contained in the software and documentation 00034 // are those of the authors and should not be interpreted as representing 00035 // official policies, either expressed or implied, of the Institute of 00036 // Telematics. 00037 // [License] 00038 00039 #ifndef COMMUNICATIONLISTENER_H_ 00040 #define COMMUNICATIONLISTENER_H_ 00041 00042 #include "Message.h" 00043 #include "Identifiers.h" 00044 #include "LinkProperties.h" 00045 #include "DataMessage.h" 00046 00047 namespace ariba { 00048 00049 // forward decl 00050 namespace overlay { 00051 class BaseOverlay; 00052 } 00053 00057 class CommunicationListener { 00058 00059 friend class ariba::overlay::BaseOverlay; 00060 friend class Node; 00061 00062 static CommunicationListener DEFAULT; 00063 00064 protected: 00065 00066 CommunicationListener(); 00067 virtual ~CommunicationListener(); 00068 00069 // --- link events --- 00070 00071 virtual void onLinkUp(const LinkID& lnk, const NodeID& remote); 00072 00073 virtual void onLinkDown(const LinkID& lnk, const NodeID& remote); 00074 00075 virtual void onLinkChanged(const LinkID& lnk, const NodeID& remote); 00076 00077 virtual void onLinkFail(const LinkID& lnk, const NodeID& remote); 00078 00079 virtual bool onLinkRequest(const NodeID& remote, const DataMessage& msg = DataMessage::UNSPECIFIED); 00080 00081 // --- general receive method --- 00082 00083 virtual void onMessage(const DataMessage& msg, const NodeID& remote, 00084 const LinkID& lnk = LinkID::UNSPECIFIED); 00085 00086 // --- sniffing related method --- 00087 virtual bool onEnableSideportListener(); 00088 00089 // --- extended message functionality --- 00090 // virtual void onLinkQoSChanged(const LinkID& lnk, const NodeID& remote, 00091 // const LinkProperties& prop); 00092 00093 // --- extended message functionality --- 00094 // virtual void onMessageSent(seqnum_t seq_num, bool failed, 00095 // const DataMessage& msg = DataMessage::UNSPECIFIED); 00096 00097 // --- dht functionality --- 00098 // virtual void onGetResponse( const Identifier<> id, const Message* msg ); 00099 // virtual void onPutResponse( const Identifier<> id, const Message* msg ); 00100 }; 00101 00102 } // namespace ariba 00103 00104 #endif /* COMMUNICATIONLISTENER_H_ */