source: source/ariba/overlay/modules/onehop/OneHop.h@ 3603

// [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 _ONE_HOP_H
#define _ONE_HOP_H

#include <map>
#include "ariba/overlay/modules/OverlayInterface.h"
#include "ariba/overlay/modules/onehop/messages/OneHopMessage.h"
#include "ariba/overlay/modules/onehop/messages/NodeListingRequest.h"
#include "ariba/overlay/modules/onehop/messages/NodeListingReply.h"
#include "ariba/utility/logging/Logging.h"

using std::map;
using ariba::overlay::OverlayInterface;
using ariba::overlay::OneHopMessage;
using ariba::overlay::NodeListingRequest;
using ariba::overlay::NodeListingReply;

namespace ariba {
namespace overlay {

class OneHop : public OverlayInterface {
        use_logging_h( OneHop );
public:
        OneHop(
                BaseOverlay& _overlay,
                const NodeID& _nodeid,
                OverlayStructureEvents* _eventsReceiver
        );

        virtual ~OneHop();

protected:

        //
        // OverlayInterface.h
        //

        virtual void createOverlay();
        virtual void deleteOverlay();

        virtual void joinOverlay(const EndpointDescriptor& bootstrapEp = EndpointDescriptor::UNSPECIFIED);
        virtual void leaveOverlay();

        virtual const EndpointDescriptor& resolveNode( const NodeID& node );
        virtual void routeMessage( const NodeID& destnode, Message* msg );

        virtual NodeList getKnownNodes() const;

        //
        // see CommunicationListener.h or OverlayInterface.h
        //

        virtual void onLinkUp(const LinkID& lnk, const NodeID& remote);
        virtual void onLinkDown(const LinkID& lnk, const NodeID& remote);
        virtual void onMessage(const DataMessage& msg, const NodeID& remote, const LinkID& lnk = LinkID::UNSPECIFIED);

private:

        /**
         * The other nodes in the overlay
         */
        typedef map<const NodeID,const LinkID> OverlayNodeMapping;
        OverlayNodeMapping overlayNodes;

        /**
         * The current state of the overlay
         */
        typedef enum _OneHopState {
                OneHopStateInvalid                = 0,
                OneHopStateJoinInitiated          = 1,
                OneHopStateJoinListingRequested   = 2,
                OneHopStateCompleted              = 3,
        } OneHopState;

        OneHopState state;

        uint16_t pendingLinks;
        LinkID bootstrapLink;

};

}} // namespace ariba, overlay

#endif // _ONE_HOP_H