PastryStateObject.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 __PASTRYSTATEOBJECT_H
#define __PASTRYSTATEOBJECT_H


#include <vector>

#include <omnetpp.h>

#include <NodeHandle.h>
#include <NodeVector.h>

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

class PastryStateObject : public cSimpleModule
{
  public:

    void handleMessage(cMessage* msg);

    int numInitStages(void) const;

    void initialize(int stage);

    virtual const NodeHandle& getDestinationNode(const OverlayKey& destination);

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

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

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

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

    virtual void dumpToStateMessage(PastryStateMessage* msg) const = 0;

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

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

    bool isCloser(const NodeHandle& test, const OverlayKey& destination,
                  const NodeHandle& reference =
                      NodeHandle::UNSPECIFIED_NODE) const;

    bool specialCloserCondition(const NodeHandle& test,
                                const OverlayKey& destination,
                                const NodeHandle& reference =
                                    NodeHandle::UNSPECIFIED_NODE) const;

  protected:

    NodeHandle owner;

    uint32_t bitsPerDigit;

  private:
    static const PastryExtendedNode* _unspecNode;

  protected:
    static const PastryExtendedNode& unspecNode()
    {
        if (_unspecNode == NULL)
            _unspecNode = new PastryExtendedNode();
        return *_unspecNode;
    }

  private:

    virtual void earlyInit(void) = 0;

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

    const OverlayKey* keyDist(const OverlayKey& a, const OverlayKey& b) const;
};


#endif