ChordFingerTable.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 __CHORDFINGERTABLE_H_
#define __CHORDFINGERTABLE_H_

#include <deque>
#include <map>

#include <omnetpp.h>

#include <NodeVector.h>
#include <InitStages.h>

class BaseOverlay;

namespace oversim {

typedef std::multimap<simtime_t, NodeHandle> Successors;
typedef std::pair<NodeHandle, Successors> FingerEntry;

class Chord;

class ChordFingerTable : public cSimpleModule
{
  public:

    virtual int numInitStages() const
    {
        return MAX_STAGE_OVERLAY + 1;
    }

    virtual void initialize(int stage);
    virtual void handleMessage(cMessage* msg);

    virtual void initializeTable(uint32_t size, const NodeHandle& owner,
                                 Chord* overlay);

    virtual void setFinger(uint32_t pos, const NodeHandle& node,
                           Successors const* sucNodes = NULL);
    virtual void setFinger(uint32_t pos, const Successors& nodes);

    virtual bool updateFinger(uint32_t pos, const NodeHandle& node, simtime_t rtt);

    virtual const NodeHandle& getFinger(uint32_t pos);

    virtual NodeVector* getFinger(uint32_t pos, const OverlayKey& key);

    bool handleFailedNode(const TransportAddress& failed);

    void removeFinger(uint32_t pos);

    virtual uint32_t getSize();

private:

    uint32_t maxSize; 
    std::deque<FingerEntry> fingerTable; 
    Chord* overlay; 
};

}; //namespace

std::ostream& operator<<(std::ostream& os, const oversim::Successors& suc);
std::ostream& operator<<(std::ostream& os, const oversim::FingerEntry& entry);

#endif