source: source/ariba/Node.cpp@ 3038

// [License]
// 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 INSTITUTE OF TELEMATICS 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.
// [License]

#include "Node.h"

#include "ariba/overlay/BaseOverlay.h"
#include "ariba/utility/types/OverlayParameterSet.h"
#include "ariba/interface/ServiceInterface.h"
#include "ariba/communication/EndpointDescriptor.h"

using ariba::communication::EndpointDescriptor;

namespace ariba {

class ServiceInterfaceWrapper: public interface::ServiceInterface {
private:
        NodeListener* nodeListener;
        CommunicationListener* commListener;
public:
        ServiceInterfaceWrapper(NodeListener* listener) :
                nodeListener(listener), commListener(NULL) {

        }

        ServiceInterfaceWrapper(CommunicationListener* listener) :
                nodeListener(NULL), commListener(listener) {
        }

        ~ServiceInterfaceWrapper() {
        }

protected:

        bool isJoinAllowed(const NodeID& nodeid, const SpoVNetID& spovnetid) {
                return true;
        }

        void onNodeJoin(const NodeID& nodeid, const SpoVNetID& spovnetid) {
                // not handled
        }

        void onNodeLeave(const NodeID& id, const SpoVNetID& spovnetid) {
                // not handled
        }

        void onJoinSuccess(const SpoVNetID& spovnetid) {
                if (nodeListener != NULL) nodeListener->onJoinCompleted(spovnetid);
        }

        void onJoinFail(const SpoVNetID& spovnetid) {
                if (nodeListener != NULL) nodeListener->onJoinFailed(spovnetid);
        }

        void onLeaveSuccess( const SpoVNetID& spovnetid ){
                if (nodeListener != NULL) nodeListener->onLeaveCompleted(spovnetid);
        }

        void onLeaveFail( const SpoVNetID& spovnetid ){
                if (nodeListener != NULL) nodeListener->onLeaveFailed(spovnetid);
        }

        void onLinkUp(const LinkID& link, const NodeID& local, const NodeID& remote) {
                if (commListener != NULL) commListener->onLinkUp(link, remote);
        }

        void onLinkDown(const LinkID& link, const NodeID& local,
                        const NodeID& remote) {
                if (commListener != NULL) commListener->onLinkDown(link, remote);
        }

        void onLinkChanged(const LinkID& link, const NodeID& local,
                        const NodeID& remote) {
                if (commListener != NULL) commListener->onLinkChanged(link, remote);
        }

        void onLinkFail(const LinkID& id, const NodeID& local, const NodeID& remote) {
                if (commListener != NULL) commListener->onLinkFail(id, remote);
        }

        void onLinkQoSChanged(const LinkID& id, const NodeID& local,
                        const NodeID& remote, const QoSParameterSet& qos) {
                if (commListener != NULL) commListener->onLinkQoSChanged(id, remote,
                                LinkProperties::DEFAULT);
        }

        bool receiveMessage(const Message* message, const LinkID& link,
                        const NodeID& node) {
                if (commListener != NULL) commListener->onMessage(
                                const_cast<Message*>(message), node, link);
        }
};

ServiceID Node::anonymousService = ServiceID(0xFF00);

Node::Node(AribaModule& ariba_mod, const Name& node_name) :
        ariba_mod(ariba_mod), name(node_name), base_overlay(NULL) {
}

Node::~Node() {
}

//TODO: Implement error handling: no bootstrap node available
void Node::join(const Name& vnetname) {
        spovnetId = vnetname.toSpoVNetId();
        nodeId = generateNodeId(name);

        //logging("joining spovnet on"
        //              << " [spovnetid=]" << spovnetId.toString()
        //              << " [nodeid=]" << nodeId.toString() );

        //logging_info("starting base communication...");
        ariba_mod.base_comm->start(ariba_mod.ip_addr, ariba_mod.tcp_port);

        //logging_info("starting base overlay...");
        base_overlay = new BaseOverlay( *ariba_mod.base_comm, nodeId );

        const communication::EndpointDescriptor* ep =
                        ariba_mod.getBootstrapNode(vnetname);
        if( ep == NULL ) return;

        base_overlay->joinSpoVNet( spovnetId, *ep);
}

void Node::initiate(const Name& vnetname, const SpoVNetProperties& parm) {
        utility::OverlayParameterSet ovrpset =
                        (utility::OverlayParameterSet::_OverlayStructure)
                        parm.getBaseOverlayType();

        spovnetId = vnetname.toSpoVNetId();
        nodeId = generateNodeId(name);

        //logging("joining spovnet on"
        //                      << " [spovnetid=]" << spovnetId.toString()
        //                      << " [nodeid=]" << nodeId.toString() );

        //logging_info("starting base communication...");
        ariba_mod.base_comm->start(ariba_mod.ip_addr, ariba_mod.tcp_port);

        //logging_info("starting base overlay...");
        base_overlay = new BaseOverlay( *ariba_mod.base_comm, nodeId );
        base_overlay->createSpoVNet( spovnetId );

        ariba_mod.addBootstrapNode(vnetname,
                new EndpointDescriptor(ariba_mod.base_comm->getEndpointDescriptor()));
}

void Node::leave() {
        base_overlay->leaveSpoVNet();
        ariba_mod.base_comm->stop();

        delete base_overlay;
        base_overlay = NULL;
}

const SpoVNetProperties& Node::getSpoVNetProperties() const {
        return SpoVNetProperties::DEFAULT;
}

const SpoVNetID& Node::getSpoVNetId() const {
        return spovnetId;
}

const NodeID& Node::getNodeId(const LinkID& lid) const {
        if( lid == LinkID::UNSPECIFIED ) return nodeId;
        else return base_overlay->getNodeID( lid );
}

NodeID Node::generateNodeId(const Name& name) const {
        if (name == Name::UNSPECIFIED) return Name::random().toNodeId();
        else return name.toNodeId();
}

vector<NodeID> Node::getNeighborNodes() const {
        return base_overlay->getOverlayNeighbors();
}

LinkID Node::establishLink(const NodeID& nid, const ServiceID& sid,
                const LinkProperties& req, const DataMessage& msg) {
        return base_overlay->establishLink(nid, sid);
}

void Node::dropLink(const LinkID& lnk) {
        base_overlay->dropLink(lnk);
}

seqnum_t Node::sendMessage(const DataMessage& msg, const NodeID& nid,
                const ServiceID& sid, const LinkProperties& req) {
        return base_overlay->sendMessage((Message*) msg, nid, sid);
}

seqnum_t Node::sendMessage(const DataMessage& msg, const LinkID& lnk) {
        return base_overlay->sendMessage((Message*) msg, lnk);
}

void Node::sendBroadcastMessage(const DataMessage& msg, const ServiceID& sid) {
        return base_overlay->broadcastMessage((Message*)msg, sid);
}

void Node::bind(NodeListener* listener) {
        base_overlay->bind(new ServiceInterfaceWrapper(listener),
                        Node::anonymousService);
}

void Node::unbind(NodeListener* listener) {
        delete base_overlay->unbind(Node::anonymousService);
}

void Node::bind(CommunicationListener* listener, const ServiceID& sid) {
        base_overlay->bind(new ServiceInterfaceWrapper(listener), sid);
}

void Node::unbind(CommunicationListener* listener, const ServiceID& sid) {
        delete base_overlay->unbind(sid);
}

// service directory
/*
 void Node::put(const Identifier<>& key, Message* value) {
 }

 void Node::get(const Identifier<>& key) {

 }
 */

// @see Module.h
void Node::initialize() {

}

// @see Module.h
void Node::start() {

}

// @see Module.h
void Node::stop() {

}

// @see Module.h
string Node::getName() const {

}

// @see Module.h
void Node::setProperty(string key, string value) {

}

// @see Module.h
const string Node::getProperty(string key) const {

}

// @see Module.h
const vector<string> Node::getProperties() const {

}

} // namespace ariba