ChordSuccessorList.h

Go to the documentation of this file.

//
// Copyright (C) 2006 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 __CHORDSUCCESSORLIST_H_
#define __CHORDSUCCESSORLIST_H_

#include <map>

#include <omnetpp.h>

#include <InitStages.h>
#include <NodeHandle.h>

class OverlayKey;
class NotifyResponse;

namespace oversim {

class Chord;

struct SuccessorListEntry
{
    NodeHandle nodeHandle ;//*< the nodehandle
    bool newEntry;  //*< true, if this entry has just been added
};

std::ostream& operator<<(std::ostream& os, const SuccessorListEntry& e);


class ChordSuccessorList : public cSimpleModule
{
  public:
    virtual int numInitStages() const
    {
        return MAX_STAGE_OVERLAY + 1;
    }
    virtual void initialize(int stage);
    virtual void handleMessage(cMessage* msg);

    virtual void initializeList(uint32_t size, NodeHandle owner,
        Chord* overlay);

    virtual uint32_t getSize();

    virtual bool isEmpty();

    virtual const NodeHandle& getSuccessor(uint32_t pos = 0);

    virtual void addSuccessor(NodeHandle successor, bool resize = true);

    virtual void updateList(NotifyResponse* notify);

    bool handleFailedNode(const TransportAddress& failed);

    void display ();


  protected:
    NodeHandle thisNode; 
    std::map<OverlayKey, SuccessorListEntry> successorMap; 
    uint32_t successorListSize; 
    Chord* overlay; 
    void removeOldSuccessors();

    void updateDisplayString();

    void updateTooltip();
};

}; //namespace
#endif