BrooseBucket.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 __BROOSEBUCKET_H_
#define __BROOSEBUCKET_H_

#include <omnetpp.h>
#include "BrooseHandle.h"
#include "Broose.h"
#include <map>
#include <OverlayKey.h>

class Broose;

class BrooseBucket : public cSimpleModule
{
public:
    virtual int numInitStages() const
    {
        return MAX_STAGE_OVERLAY + 1;
    }

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

    // bucket functions
    virtual bool add(const NodeHandle& node, bool isAlive = false,
                     simtime_t rtt = MAXTIME);

    virtual void remove(const NodeHandle& node);

    virtual const BrooseHandle& get(uint32_t pos = 0);

    virtual const OverlayKey& getDist(uint32_t pos = 0);

    virtual void initializeBucket(int shiftingBits, uint32_t prefix,
                                  int size, Broose* overlay,
                                  bool isBBucket = false);

    virtual uint32_t getSize();

    virtual uint32_t getMaxSize();

    virtual void fillVector(NodeVector* result);

    virtual bool isEmpty();

    virtual void clear();

    virtual int longestPrefix(void);

    virtual bool keyInRange(const OverlayKey& key);

    virtual int getPos(const NodeHandle& node);

    virtual int getFailedResponses (const NodeHandle& node);

    virtual void increaseFailedResponses (const NodeHandle& node);

    virtual void resetFailedResponses (const NodeHandle& node);

    virtual void setRTT(const NodeHandle& node, simtime_t rpcRTT);

    virtual simtime_t getRTT(const NodeHandle& node);

    virtual void setLastSeen(const NodeHandle& node, simtime_t lastSeen);

    virtual simtime_t getLastSeen(const NodeHandle& node);

    void output(int maxEntries = 0);


protected:
    // parameter
    std::map<OverlayKey, BrooseHandle> bucket; 
    std::map<OverlayKey, BrooseHandle>::iterator bucketIter; 
    unsigned int maxSize; 
    OverlayKey key; 
    Broose* overlay; 
    bool isBBucket; 
};
#endif