PastryLeafSet.h

Go to the documentation of this file.

#ifndef __PASTRYLEAFSET_H
#define __PASTRYLEAFSET_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 <NodeVector.h>

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

#include "BasePastry.h"

class BasePastry;

struct PLSRepairData
{
    simtime_t ts;
    bool left;
    PLSRepairData(simtime_t ts = 0, bool left = true) : ts(ts), left(left) {};
};

class PastryLeafSet : public PastryStateObject
{
  public:

    void initializeSet(uint32_t numberOfLeaves,
                       uint32_t bitsPerDigit,
                       simtime_t repairTimeout,
                       const NodeHandle& owner,
                       BasePastry* overlay);

    virtual const NodeHandle& getDestinationNode(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);

    bool isClosestNode(const OverlayKey& destination) const;

    virtual void dumpToStateMessage(PastryStateMessage* msg) const;

    virtual const TransportAddress& getRandomNode();

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

    virtual bool mergeState(const PastryStateMessage* msg,
                            const PastryStateMsgProximity* prox);

    const NodeHandle& getPredecessor(void) const;

    const NodeHandle& getSuccessor(void) const;

    bool isValid(void) const;

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

    NodeVector* createSiblingVector(const OverlayKey& key, int numSiblings) const;

    PastryNewLeafsMessage* getNewLeafsMessage(void);

    OverlayKey estimateMeanDistance();

  private:

    uint32_t numberOfLeaves;
    simtime_t repairTimeout;
    BasePastry* overlay; 
    std::vector<NodeHandle> leaves;
    std::vector<NodeHandle>::iterator smaller;
    std::vector<NodeHandle>::iterator bigger;

    std::map<TransportAddress, PLSRepairData> awaitingRepair;

    bool newLeafs;

    bool isFull;
    bool wasFull;

    virtual void earlyInit(void);

    const NodeHandle& getBiggestNode(void) const;

    const OverlayKey& getBiggestKey(void) const;

    const NodeHandle& getSmallestNode(void) const;

    const OverlayKey& getSmallestKey(void) const;

    bool isLeft(const OverlayKey& key) const;

    void insertLeaf(std::vector<NodeHandle>::iterator& it,
                    const NodeHandle& node);

    bool balanceLeafSet();
};


#endif