ScribeGroup.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 __SCRIBEGROUP_H_
#define __SCRIBEGROUP_H_

#include <set>
#include "OverlayKey.h"
#include "NodeHandle.h"

class ScribeGroup;

#include "ScribeMessage_m.h"

class ScribeGroup
{
    private:
        OverlayKey groupId;
        NodeHandle rendezvousPoint;
        NodeHandle parent;
        std::set<NodeHandle> children;
        bool subscription;
        bool amISource;

        ScribeTimer* parentTimer;
        ScribeTimer* heartbeatTimer;

    public:
        ScribeGroup( OverlayKey id );
        ~ScribeGroup( );

        std::pair<std::set<NodeHandle>::iterator, bool> addChild( const NodeHandle& node );

        void removeChild( const NodeHandle& node );

        std::set<NodeHandle>::iterator getChildrenBegin();

        std::set<NodeHandle>::iterator getChildrenEnd();

        int numChildren() const { return children.size(); }

        bool isForwarder() const;

        bool getAmISource() const { return amISource; }

        void setAmISource( bool source ) { amISource = source; }

        bool getSubscription() const { return subscription; }

        void setSubscription( bool subscribe ) { subscription = subscribe; }

        NodeHandle getParent() const { return parent; }

        void setParent( NodeHandle& _parent ) { parent = _parent; }

        NodeHandle getRendezvousPoint() const { return rendezvousPoint; }

        void setRendezvousPoint( const NodeHandle& _rendezvousPoint ) { rendezvousPoint = _rendezvousPoint; }

        OverlayKey getGroupId() const { return groupId; }

        ScribeTimer* getParentTimer() { return parentTimer; }

        void setParentTimer(ScribeTimer* t ) { parentTimer = t; }

        ScribeTimer* getHeartbeatTimer() { return heartbeatTimer; }

        void setHeartbeatTimer(ScribeTimer* t ) { heartbeatTimer = t; }

        bool operator== (const OverlayKey& id) const { return id == groupId; };

        bool operator== (const ScribeGroup& a) const { return a.getGroupId() == groupId; };

        bool operator< (const OverlayKey& id) const { return id < groupId; };

        bool operator< (const ScribeGroup& a) const { return groupId < a.getGroupId(); };
};

#endif