PastryRoutingTable.h

Go to the documentation of this file.

#ifndef __PASTRYROUTINGTABLE_H_
#define __PASTRYROUTINGTABLE_H_

//
// 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.
//

#include <vector>

#include <omnetpp.h>

#include <NodeHandle.h>

#include "PastryStateObject.h"
#include "PastryTypes.h"
#include "PastryMessage_m.h"


typedef std::vector<PastryExtendedNode> PRTRow;

struct PRTTrackRepair
{
    TransportAddress node;//*< the node last asked for repair
    simtime_t timestamp;  //*< the time when it was asked
    uint32_t failedRow;       //*< row of the failed node
    uint32_t failedCol;   //*< col of the failed node
    uint32_t askedRow;    //*< row of the node last asked
    uint32_t askedCol;    //*< col of the node last asked
};

class PastryRoutingTable : public PastryStateObject
{

  public:
    void initializeTable(uint32_t bitsPerDigit, double repairTimeout,
                         const NodeHandle& owner);

    const NodeHandle& lookupNextHop(const OverlayKey& destination);

    virtual const NodeHandle& findCloserNode(const OverlayKey& destination,
                                             bool optimize = false);

    void findCloserNodes(const OverlayKey& destination,
                         NodeVector* nodes);

    virtual const TransportAddress& failedNode(const TransportAddress& failed);

    virtual const TransportAddress& repair(const PastryStateMessage* msg,
                                           const PastryStateMsgProximity* prox);

    virtual void dumpToStateMessage(PastryStateMessage* msg) const;

    virtual void dumpRowToMessage(PastryStateMessage* msg, int row) const;

    int getLastRow();

    std::vector<TransportAddress>* getRow(uint8_t row) const;

    virtual const TransportAddress& getRandomNode(int row);


    bool mergeNode(const NodeHandle& node, simtime_t prox);

    bool initStateFromHandleVector(const std::vector<PastryStateMsgHandle>& handles);

    virtual void dumpToVector(std::vector<TransportAddress>& affected) const;

    uint32_t nodesPerRow; //TODO getter/setter + private

  private:

    double repairTimeout;
    std::vector<PRTRow> rows;
    std::vector<PRTTrackRepair> awaitingRepair;

    virtual void earlyInit(void);

    void addRow(void);

    uint32_t digitAt(uint32_t n, const OverlayKey& key) const;

    const PastryExtendedNode& nodeAt(uint32_t row, uint32_t col) const;

    void findNextNodeToAsk(PRTTrackRepair& track) const;

};

std::ostream& operator<<(std::ostream& os, const PRTRow& row);

#endif