Index: source/ariba/overlay/BaseOverlay.cpp =================================================================== --- source/ariba/overlay/BaseOverlay.cpp (revision 3041) +++ source/ariba/overlay/BaseOverlay.cpp (revision 3055) @@ -40,5 +40,6 @@ #include "ariba/utility/misc/OvlVis.h" -using ariba::utility::OvlVis; +#include "ariba/NodeListener.h" +#include "ariba/CommunicationListener.h" namespace ariba { @@ -146,5 +147,5 @@ // inform all registered services of the event - BOOST_FOREACH( ServiceInterface* i, listenerMux.getOneList() ){ + BOOST_FOREACH( NodeListener* i, nodeListeners ){ if( ret ) i->onLeaveSuccess( spovnetId ); else i->onLeaveFail( spovnetId ); @@ -176,5 +177,5 @@ overlayInterface->joinOverlay(); - BOOST_FOREACH( ServiceInterface* i, listenerMux.getOneList() ){ + BOOST_FOREACH( NodeListener* i, nodeListeners ){ i->onJoinSuccess( spovnetId ); } @@ -221,10 +222,10 @@ const LinkID BaseOverlay::establishLink(const EndpointDescriptor& ep, const ServiceID& service){ - if( !listenerMux.contains( service ) ){ + if( !communicationListeners.contains( service ) ){ logging_error( "no registered listener on serviceid " << service.toString() ); return LinkID::UNSPECIFIED; } - ServiceInterface* receiver = listenerMux.get( service ); + CommunicationListener* receiver = communicationListeners.get( service ); const LinkID link = bc->establishLink( ep ); @@ -308,30 +309,58 @@ } -bool BaseOverlay::bind(ServiceInterface* service, const ServiceID& sid) { - - logging_debug( "binding service " << service << " on serviceid " << sid.toString() ); - - if( listenerMux.contains( sid ) ){ - logging_error( "some service already registered for service id " << sid.toString() ); +void BaseOverlay::bind(CommunicationListener* listener, const ServiceID& sid){ + logging_debug( "binding communication listener " << listener + << " on serviceid " << sid.toString() ); + + if( communicationListeners.contains( sid ) ){ + logging_error( "some listener already registered for service id " + << sid.toString() ); return false; } - listenerMux.registerItem( service, sid ); + communicationListeners.registerItem( listener, sid ); return true; } -ServiceInterface* BaseOverlay::unbind(const ServiceID& sid){ - - logging_debug( "unbinding service from serviceid " << sid.toString() ); - - if( !listenerMux.contains( sid ) ){ - logging_warn( "cannot unbind service. no service registered on service id " << sid.toString() ); - return NULL; - } - - ServiceInterface* iface = listenerMux.get( sid ); - listenerMux.unregisterItem( sid ); - - return NULL; //iface; +void BaseOverlay::unbind(CommunicationListener* listener, const ServiceID& sid){ + logging_debug( "unbinding listener " << listener + << " from serviceid " << sid.toString() ); + + if( !communicationListeners.contains( sid ) ){ + logging_warn( "cannot unbind listener. no listener registered on service id " << sid.toString() ); + return; + } + + if( communicationListeners.get(sid) != listener ){ + logging_warn( "listener bound to service id " << sid.toString() + << " is different than listener trying to unbind" ); + return; + } + + communicationListeners.unregisterItem( sid ); +} + +void BaseOverlay::bind(NodeListener* listener){ + logging_debug( "binding node listener " << listener ); + + NodeListenerVector::iterator i = nodeListeners.find( listener ); + if( i != nodeListeners.end() ){ + logging_warn( "node listener " << listener << " is already bound, cannot bind" ); + return; + } + + nodeListeners.push_back( listener ); +} + +void BaseOverlay::unbind(NodeListener* listener){ + logging_debug( "unbinding node listener " << listener ); + + NodeListenerVector::iterator i = nodeListeners.find( listener ); + if( i == nodeListeners.end() ){ + logging_warn( "node listener " << listener << " is not bound, cannot unbind" ); + return; + } + + nodeListeners.erase( i ); } @@ -501,5 +530,5 @@ const ServiceID& service = overlayMsg->getService(); - ServiceInterface* serviceListener = listenerMux.get( service ); + CommunicationListener* serviceListener = communicationListeners.get( service ); logging_debug( "received data for service " << service.toString() ); @@ -544,5 +573,5 @@ bool allow = true; - BOOST_FOREACH( ServiceInterface* i, listenerMux.getOneList() ){ + BOOST_FOREACH( NodeListener* i, nodeListeners ){ allow &= i->isJoinAllowed( overlayMsg->getSourceNode(), spovnetId ); } @@ -615,5 +644,5 @@ // inform all registered services of the event - BOOST_FOREACH( ServiceInterface* i, listenerMux.getOneList() ){ + BOOST_FOREACH( NodeListener* i, nodeListeners{ i->onJoinFail( spovnetId ); } @@ -640,5 +669,5 @@ // inform all registered services of the event - BOOST_FOREACH( ServiceInterface* i, listenerMux.getOneList() ){ + BOOST_FOREACH( NodeListener* i, nodeListeners ){ i->onJoinFail( spovnetId ); } @@ -662,5 +691,5 @@ // inform all registered services of the event - BOOST_FOREACH( ServiceInterface* i, listenerMux.getOneList() ){ + BOOST_FOREACH( NodeListener* i, nodeListeners ){ i->onJoinSuccess( spovnetId ); } @@ -717,10 +746,10 @@ // - if( !listenerMux.contains( service ) ){ + if( !communicationListeners.contains( service ) ){ logging_warn( "linkup event for service that has not been registered" ); return false; } - ServiceInterface* iface = listenerMux.get( service ); + CommunicationListener* iface = communicationListeners.get( service ); if( iface == NULL ){ logging_warn( "linkup event for service that has been registered with a NULL interface" ); @@ -762,5 +791,5 @@ // inform all registered services of the event - BOOST_FOREACH( ServiceInterface* i, listenerMux.getOneList() ){ + BOOST_FOREACH( NodeListener* i, nodeListeners ){ i->onLeaveFail( spovnetId ); } @@ -774,5 +803,5 @@ // inform all registered services of the event - BOOST_FOREACH( ServiceInterface* i, listenerMux.getOneList() ){ + BOOST_FOREACH( NodeListener* i, nodeListeners ){ i->onNodeLeave( overlayMsg->getSourceNode(), spovnetId ); } @@ -879,5 +908,5 @@ << node.toString() ); - BOOST_FOREACH( ServiceInterface* i, listenerMux.getOneList() ){ + BOOST_FOREACH( NodeListener* i, nodeListeners ){ i->onNodeJoin( node, spovnetId ); } Index: source/ariba/overlay/BaseOverlay.h =================================================================== --- source/ariba/overlay/BaseOverlay.h (revision 3041) +++ source/ariba/overlay/BaseOverlay.h (revision 3055) @@ -59,6 +59,4 @@ #include "ariba/communication/CommunicationEvents.h" -#include "ariba/interface/ServiceInterface.h" - #include "ariba/overlay/modules/OverlayInterface.h" #include "ariba/overlay/modules/OverlayFactory.h" @@ -67,4 +65,14 @@ #include "ariba/overlay/messages/JoinRequest.h" #include "ariba/overlay/messages/JoinReply.h" + +// forward declerations +namespace ariba { + class NodeListener; + class CommunicationListener; + + namespace utility { + class OvlVis; + } +} using std::vector; @@ -76,9 +84,10 @@ using std::find; +using ariba::NodeListener; +using ariba::CommunicationListener; + using ariba::communication::EndpointDescriptor; using ariba::communication::BaseCommunication; using ariba::communication::CommunicationEvents; - -using ariba::interface::ServiceInterface; using ariba::overlay::OverlayMsg; @@ -101,13 +110,8 @@ using ariba::utility::seqnum_t; using ariba::utility::Timer; +using ariba::utility::OvlVis; #define ovl OvlVis::instance() #define ovlId OvlVis::NETWORK_ID_BASE_OVERLAY - -// needed for friend decleration -// in different namespace -namespace ariba { - class Node; -} namespace ariba { @@ -121,8 +125,5 @@ use_logging_h( BaseOverlay ); - friend class ariba::Node; - public: - /** * Constructs an empty non-functional base overlay instance @@ -147,11 +148,14 @@ /** * Starts a link establishment procedure to the specfied node + * for the service with id service * - * @param node The node id + * @param node Destination node id + * @param service Service to connect to */ const LinkID establishLink( const NodeID& node, const ServiceID& service ); /** - * TODO + * Starts a link establishment procedure to the specified + * endpoint and to the specified service */ const LinkID establishLink( const EndpointDescriptor& ep, const ServiceID& service ); @@ -176,8 +180,5 @@ * Depending on the structure of the overlay, this can be very different. */ - void broadcastMessage( - Message* message, - const ServiceID& service - ); + void broadcastMessage( Message* message, const ServiceID& service ); /** @@ -200,16 +201,22 @@ /** - * Registers a receiver. - * - * @param receiver An implementation of the receiver interface - */ - bool bind( ServiceInterface* service, const ServiceID& sid ); - - /** - * Unregister a receiver. - * - * @param sid The service id to unregister - */ - ServiceInterface* unbind( const ServiceID& sid ); + * TODO + */ + void bind(CommunicationListener* listener, const ServiceID& sid); + + /** + * TODO + */ + void unbind(CommunicationListener* listener, const ServiceID& sid); + + /** + * TODO + */ + void bind(NodeListener* listener); + + /** + * TODO + */ + void unbind(NodeListener* listener); /** @@ -221,15 +228,12 @@ const NodeID& getNodeID( const LinkID& lid = LinkID::UNSPECIFIED ) const ; -protected: - - //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - void joinSpoVNet( - const SpoVNetID& id, - const EndpointDescriptor& bootstrapEp - ); - + /** + * TODO + */ + void joinSpoVNet( const SpoVNetID& id, const EndpointDescriptor& bootstrapEp ); + + /** + * TODO + */ void createSpoVNet( const SpoVNetID& id, @@ -239,19 +243,31 @@ ); - void leaveSpoVNet( - ); - - //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - + /** + * TODO + */ + void leaveSpoVNet(); + +protected: + + /** + * TODO + */ virtual void onLinkUp( const LinkID& id, const NetworkLocator* local, const NetworkLocator* remote ); + /** + * TODO + */ virtual void onLinkDown( const LinkID& id, const NetworkLocator* local, const NetworkLocator* remote ); virtual void onLinkChanged( const LinkID& id, const NetworkLocator* oldlocal, const NetworkLocator* newlocal, const NetworkLocator* oldremote, const NetworkLocator* newremote ); + /** + * TODO + */ virtual void onLinkFail( const LinkID& id, const NetworkLocator* local, const NetworkLocator* remote ); + /** + * TODO + */ virtual void onLinkQoSChanged( const LinkID& id, const NetworkLocator* local, const NetworkLocator* remote, const QoSParameterSet& qos ); @@ -260,4 +276,7 @@ //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + /** + * TODO + */ virtual bool receiveMessage( const Message* message, const LinkID& link, const NodeID& ); // nodeid is not valid in this case! @@ -270,11 +289,17 @@ */ virtual void incomingRouteMessage( Message* msg ); + + /** + * see OverlayStructureEvents.h, called from specific OverlayInterface class + */ virtual void onNodeJoin( const NodeID& node ); - // for timer events + + /** + * TODO, for timer events + */ virtual void eventFunction(); private: - /** * The BaseCommunication the BaseOverlay @@ -295,8 +320,17 @@ /** - * A demultiplexer that maps listeners to service ids - * to deliver upcoming messages to the correct service. - */ - Demultiplexer listenerMux; + * TODO + */ + Demultiplexer communicationListeners; + + /** + * TODO + */ + typedef vector NodeListenerVector; + + /** + * TODO + */ + NodeListenerVector nodeListeners; /** @@ -322,4 +356,7 @@ } BaseOverlayState; + /** + * TODO + */ BaseOverlayState state; @@ -344,5 +381,5 @@ LinkItem( const LinkID& _link, const NodeID& _node, - const ServiceID& _service, ServiceInterface* _interface ) + const ServiceID& _service, CommunicationListener* _interface ) : link( _link ), node( _node ), service( _service ), interface( _interface ), autolink( false ), lastuse( time(NULL) ) { @@ -354,5 +391,5 @@ NodeID node; ServiceID service; - ServiceInterface* interface; + CommunicationListener* interface; // information needed for auto links @@ -370,6 +407,9 @@ LinkMapping linkMapping; - // nodes with pending joines. TODO: should be cleaned every some seconds - // add timestamps to each, and check on occasion + + /** + * nodes with pending joines. TODO: should be cleaned every + * some seconds, add timestamps to each, and check on occasion + */ typedef vector JoiningNodes; JoiningNodes joiningNodes; Index: source/ariba/overlay/OverlayEvents.cpp =================================================================== --- source/ariba/overlay/OverlayEvents.cpp (revision 3041) +++ (revision ) @@ -1,82 +1,0 @@ -// [Licence] -// The Ariba-Underlay Copyright -// -// Copyright (c) 2008-2009, Institute of Telematics, UniversitÀt Karlsruhe (TH) -// -// Institute of Telematics -// UniversitÀt Karlsruhe (TH) -// Zirkel 2, 76128 Karlsruhe -// Germany -// -// Redistribution and use in source and binary forms, with or without -// modification, are permitted provided that the following conditions are -// met: -// -// 1. Redistributions of source code must retain the above copyright -// notice, this list of conditions and the following disclaimer. -// 2. Redistributions in binary form must reproduce the above copyright -// notice, this list of conditions and the following disclaimer in the -// documentation and/or other materials provided with the distribution. -// -// THIS SOFTWARE IS PROVIDED BY THE INSTITUTE OF TELEMATICS ``AS IS'' AND -// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ARIBA PROJECT OR -// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, -// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, -// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR -// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF -// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING -// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS -// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -// -// The views and conclusions contained in the software and documentation -// are those of the authors and should not be interpreted as representing -// official policies, either expressed or implied, of the Institute of -// Telematics. -// [Licence] - -#include "OverlayEvents.h" - -namespace ariba { -namespace overlay { - -OverlayEvents::OverlayEvents(){ -} - -OverlayEvents::~OverlayEvents(){ -} - -bool OverlayEvents::isJoinAllowed( const NodeID& nodeid, const SpoVNetID& spovnetid ){ - // default: allow all nodes to join - return true; -} - -void OverlayEvents::onNodeJoin( const NodeID& nodeid, const SpoVNetID& spovnetid ){ -} - -void OverlayEvents::onNodeLeave( const NodeID& id, const SpoVNetID& spovnetid ){ -} - -void OverlayEvents::onJoinSuccess( const SpoVNetID& spovnetid ){ -} - -void OverlayEvents::onJoinFail( const SpoVNetID& spovnetid ){ -} - -void OverlayEvents::onLeaveSuccess( const SpoVNetID& spovnetid ){ -} - -void OverlayEvents::onLeaveFail( const SpoVNetID& spovnetid ){ -} - -void OverlayEvents::onLinkUp( const LinkID& link, const NodeID& local, const NodeID& remote ){ -} - -void OverlayEvents::onLinkDown( const LinkID& link, const NodeID& local, const NodeID& remote ){ -} - -void OverlayEvents::onLinkChanged( const LinkID& link, const NodeID& local, const NodeID& remote ){ -} - -}} // namespace ariba, overlay Index: source/ariba/overlay/OverlayEvents.h =================================================================== --- source/ariba/overlay/OverlayEvents.h (revision 3041) +++ (revision ) @@ -1,78 +1,0 @@ -// [Licence] -// The Ariba-Underlay Copyright -// -// Copyright (c) 2008-2009, Institute of Telematics, UniversitÀt Karlsruhe (TH) -// -// Institute of Telematics -// UniversitÀt Karlsruhe (TH) -// Zirkel 2, 76128 Karlsruhe -// Germany -// -// Redistribution and use in source and binary forms, with or without -// modification, are permitted provided that the following conditions are -// met: -// -// 1. Redistributions of source code must retain the above copyright -// notice, this list of conditions and the following disclaimer. -// 2. Redistributions in binary form must reproduce the above copyright -// notice, this list of conditions and the following disclaimer in the -// documentation and/or other materials provided with the distribution. -// -// THIS SOFTWARE IS PROVIDED BY THE INSTITUTE OF TELEMATICS ``AS IS'' AND -// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ARIBA PROJECT OR -// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, -// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, -// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR -// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF -// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING -// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS -// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -// -// The views and conclusions contained in the software and documentation -// are those of the authors and should not be interpreted as representing -// official policies, either expressed or implied, of the Institute of -// Telematics. -// [Licence] - -#ifndef __OVERLAY_EVENTS_H -#define __OVERLAY_EVENTS_H - -#include "ariba/utility/types/LinkID.h" -#include "ariba/utility/types/NodeID.h" -#include "ariba/utility/types/SpoVNetID.h" - -using ariba::utility::LinkID; -using ariba::utility::NodeID; -using ariba::utility::SpoVNetID; - -namespace ariba { -namespace overlay { - -class OverlayEvents { - friend class BaseOverlay; -public: - OverlayEvents(); - virtual ~OverlayEvents(); - -protected: - /// for initiator about remote nodes - virtual bool isJoinAllowed( const NodeID& nodeid, const SpoVNetID& spovnetid ); - virtual void onNodeJoin( const NodeID& nodeid, const SpoVNetID& spovnetid ); - virtual void onNodeLeave( const NodeID& id, const SpoVNetID& spovnetid ); - - /// our local status - virtual void onJoinSuccess( const SpoVNetID& spovnetid ); - virtual void onJoinFail( const SpoVNetID& spovnetid ); - virtual void onLeaveSuccess( const SpoVNetID& spovnetid ); - virtual void onLeaveFail( const SpoVNetID& spovnetid ); - - virtual void onLinkUp( const LinkID& link, const NodeID& local, const NodeID& remote ); - virtual void onLinkDown( const LinkID& link, const NodeID& local, const NodeID& remote ); - virtual void onLinkChanged( const LinkID& link, const NodeID& local, const NodeID& remote ); -}; - -}} // namespace ariba, overlay - -#endif // __OVERLAY_EVENTS_H Index: source/ariba/overlay/modules/OverlayInterface.h =================================================================== --- source/ariba/overlay/modules/OverlayInterface.h (revision 3041) +++ source/ariba/overlay/modules/OverlayInterface.h (revision 3055) @@ -40,12 +40,12 @@ #define __OVERLAY_INTERFACE_H +#include "ariba/CommunicationListener.h" #include "ariba/communication/EndpointDescriptor.h" -#include "ariba/interface/ServiceInterface.h" #include "ariba/overlay/modules/OverlayStructureEvents.h" #include "ariba/utility/types/NodeID.h" #include "ariba/utility/types/ServiceID.h" +using ariba::CommunicationListener; using ariba::communication::EndpointDescriptor; -using ariba::interface::ServiceInterface; using ariba::overlay::OverlayStructureEvents; using ariba::utility::NodeID; @@ -57,5 +57,5 @@ class BaseOverlay; -class OverlayInterface : public ServiceInterface { +class OverlayInterface : public CommunicationListener { public: OverlayInterface( Index: source/ariba/overlay/modules/onehop/OneHop.h =================================================================== --- source/ariba/overlay/modules/onehop/OneHop.h (revision 3041) +++ source/ariba/overlay/modules/onehop/OneHop.h (revision 3055) @@ -85,5 +85,5 @@ // - // see ServiceInterface.h and OverlayInterface.h + // see CommunicationListener.h and OverlayInterface.h //