Koorde.h

Go to the documentation of this file.

//
// Copyright (C) 2007 Institut fuer Telematik, Universitaet Karlsruhe (TH)
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
//

#ifndef __KOORDE_H_
#define __KOORDE_H_

#include <omnetpp.h>

#include <IPvXAddress.h>

#include <OverlayKey.h>
#include <NodeHandle.h>
#include <BaseOverlay.h>

#include "../chord/ChordSuccessorList.h"
#include "../chord/Chord.h"

namespace oversim {

class Koorde : public Chord
{
  public:
    virtual ~Koorde();

    // see BaseOverlay.h
    virtual void initializeOverlay(int stage);

    // see BaseOverlay.h
    virtual void handleTimerEvent(cMessage* msg);

    // see BaseOverlay.h
    virtual void handleUDPMessage(BaseOverlayMessage* msg);

    // see BaseOverlay.h
    virtual void recordOverlaySentStats(BaseOverlayMessage* msg);

    // see BaseOverlay.h
    virtual void finishOverlay();

    virtual void updateTooltip ();

  protected:
    //parameters
    int deBruijnDelay; 
    int deBruijnNumber; 
    int deBruijnListSize; 
    int shiftingBits; 
    bool useOtherLookup; 
    bool useSucList; 
    bool breakLookup; 
    bool setupDeBruijnBeforeJoin; 
    bool setupDeBruijnAtJoin; 
    //statistics
    int deBruijnCount; 
    int deBruijnBytesSent; 
    //Node handles
    NodeHandle* deBruijnNodes; 
    NodeHandle deBruijnNode; 
    //Timer Messages
    cMessage* deBruijn_timer; 
    virtual void changeState(int state);

    virtual void handleDeBruijnTimerExpired();

    //virtual void handleFixFingersTimerExpired(cMessage* msg);

    // see BaseOverlay.h
    virtual bool handleRpcCall(BaseCallMessage* msg);

    // see BaseOverlay.h
    virtual void handleRpcResponse(BaseResponseMessage* msg,
                                   cPolymorphic* context, int rpcId,
                                   simtime_t rtt );

    // see BaseOverlay.h
    virtual void handleRpcTimeout(BaseCallMessage* msg,
                                  const TransportAddress& dest,
                                  cPolymorphic* context,
                                  int rpcId, const OverlayKey& destKey);

    virtual void handleRpcJoinResponse(JoinResponse* joinResponse);

    virtual void handleRpcDeBruijnRequest(DeBruijnCall* deBruinCall);

    virtual void handleRpcDeBruijnResponse(DeBruijnResponse* deBruijnResponse);

    virtual void handleDeBruijnTimeout(DeBruijnCall* deBruijnCall);

    virtual NodeHandle findDeBruijnHop(const OverlayKey& destKey,
                                       KoordeFindNodeExtMessage* findNodeExt);

    // see BaseOverlay.h
    NodeVector* findNode(const OverlayKey& key,
                         int numRedundantNodes,
                         int numSiblings,
                         BaseOverlayMessage* msg);
    virtual OverlayKey findStartKey(const OverlayKey& startKey,
                                    const OverlayKey& endKey,
                                    const OverlayKey& destKey,
                                    int& step);

    virtual const NodeHandle& walkDeBruijnList(const OverlayKey& key);

    virtual const NodeHandle& walkSuccessorList(const OverlayKey& key);

    // see BaseOverlay.h
    virtual bool handleFailedNode(const TransportAddress& failed);

    // see Chord.h
    virtual void rpcJoin(JoinCall* call);

    // see Chord.h
    virtual void findFriendModules();

    // see Chord.h
    virtual void initializeFriendModules();

};

}; //namespace

#endif