inet::PIMDM::DownstreamInterface Struct Reference

Inheritance diagram for inet::PIMDM::DownstreamInterface:

Public Types
enum	Flags { HAS_CONNECTED_RECEIVERS = 0x01 }
enum	PruneState { NO_INFO, PRUNE_PENDING, PRUNED }
Public Types inherited from inet::PIMBase::Interface
enum	AssertState { NO_ASSERT_INFO, I_LOST_ASSERT, I_WON_ASSERT }

Public Member Functions
	DownstreamInterface (Route *owner, InterfaceEntry *ie)
	~DownstreamInterface ()
Route *	route () const
PIMDM *	pimdm () const
bool	hasConnectedReceivers () const
void	setHasConnectedReceivers (bool value)
bool	isInOlist () const
void	startPruneTimer (double holdTime)
	The method is used to create PIMPrune timer. More...
void	stopPruneTimer ()
void	startPrunePendingTimer (double overrideInterval)
void	stopPrunePendingTimer ()
Public Member Functions inherited from inet::PIMBase::Interface
	Interface (RouteEntry *owner, InterfaceEntry *ie)
virtual	~Interface ()
bool	isFlagSet (int flag) const
void	setFlags (int flags)
void	clearFlag (int flag)
void	setFlag (int flag, bool value)
void	startAssertTimer (double assertTime)
void	deleteAssertInfo ()

Public Attributes
PruneState	pruneState
cMessage *	pruneTimer
cMessage *	prunePendingTimer
Public Attributes inherited from inet::PIMBase::Interface
RouteEntry *	owner
InterfaceEntry *	ie
int	flags
AssertState	assertState
cMessage *	assertTimer
AssertMetric	winnerMetric

Member Enumeration Documentation

enum inet::PIMDM::DownstreamInterface::Flags

Enumerator
HAS_CONNECTED_RECEIVERS

                   {
            HAS_CONNECTED_RECEIVERS = 0x01
        };

enum inet::PIMDM::DownstreamInterface::PruneState

Enumerator
NO_INFO
PRUNE_PENDING
PRUNED

                        {
            NO_INFO,    // no prune info, neither pruneTimer or prunePendingTimer is running
            PRUNE_PENDING,    // received a prune from a downstream neighbor, waiting for an override
            PRUNED    // received a prune from a downstream neighbor and it was not overridden
        };

Constructor & Destructor Documentation

inet::PIMDM::DownstreamInterface::DownstreamInterface ( Route *  owner, InterfaceEntry *  ie  )

inline

            : Interface(owner, ie),
            pruneState(NO_INFO), pruneTimer(nullptr), prunePendingTimer(nullptr)
        { ASSERT(owner), ASSERT(ie); }

inet::PIMDM::DownstreamInterface::~DownstreamInterface

(

)

{
    owner->owner->cancelAndDelete(pruneTimer);
    owner->owner->cancelAndDelete(prunePendingTimer);
}

Member Function Documentation

bool inet::PIMDM::DownstreamInterface::hasConnectedReceivers ( ) const

inline

{ return isFlagSet(HAS_CONNECTED_RECEIVERS); }

bool inet::PIMDM::DownstreamInterface::isInOlist

(

)

const

Referenced by inet::PIMDM::PIMDMOutInterface::isEnabled(), inet::PIMDM::multicastReceiverAdded(), inet::PIMDM::multicastReceiverRemoved(), and inet::PIMDM::processGraft().

{
    // TODO check boundary
    bool hasNeighbors = pimdm()->pimNbt->getNumNeighbors(ie->getInterfaceId()) > 0;
    return ((hasNeighbors && pruneState != PRUNED) || hasConnectedReceivers()) && assertState != I_LOST_ASSERT;
}

PIMDM* inet::PIMDM::DownstreamInterface::pimdm ( ) const

inline

{ return check_and_cast<PIMDM *>(owner->owner); }

Route* inet::PIMDM::DownstreamInterface::route ( ) const

inline

Referenced by inet::PIMDM::processPrunePendingTimer(), and inet::PIMDM::processPruneTimer().

{ return check_and_cast<Route *>(owner); }

void inet::PIMDM::DownstreamInterface::setHasConnectedReceivers ( bool  value )

inline

Referenced by inet::PIMDM::multicastReceiverAdded(), and inet::PIMDM::unroutableMulticastPacketArrived().

{ setFlag(HAS_CONNECTED_RECEIVERS, value); }

void inet::PIMDM::DownstreamInterface::startPrunePendingTimer

(

double

overrideInterval

)

Referenced by inet::PIMDM::processPrune().

{
    ASSERT(!prunePendingTimer);
    cMessage *timer = new cMessage("PimPrunePendingTimer", PrunePendingTimer);
    timer->setContextPointer(this);
    owner->owner->scheduleAt(simTime() + overrideInterval, timer);
    prunePendingTimer = timer;
}

void inet::PIMDM::DownstreamInterface::startPruneTimer

(

double

holdTime

)

The method is used to create PIMPrune timer.

The timer is set when outgoing interface goes to pruned state. After expiration (usually 3min) interface goes back to forwarding state. It is set to (S,G,I).

Referenced by inet::PIMDM::multicastPacketArrivedOnNonRpfInterface(), and inet::PIMDM::processPrunePendingTimer().

{
    cMessage *timer = new cMessage("PimPruneTimer", PruneTimer);
    timer->setContextPointer(this);
    owner->owner->scheduleAt(simTime() + holdTime, timer);
    pruneTimer = timer;
}

void inet::PIMDM::DownstreamInterface::stopPrunePendingTimer

(

)

Referenced by inet::PIMDM::processGraft(), and inet::PIMDM::processJoin().

{
    if (prunePendingTimer) {
        if (prunePendingTimer->isScheduled())
            owner->owner->cancelEvent(prunePendingTimer);
        delete prunePendingTimer;
        prunePendingTimer = nullptr;
    }
}

void inet::PIMDM::DownstreamInterface::stopPruneTimer

(

)

Referenced by inet::PIMDM::processGraft(), inet::PIMDM::processJoin(), and inet::PIMDM::processPruneTimer().

{
    if (pruneTimer) {
        if (pruneTimer->isScheduled())
            owner->owner->cancelEvent(pruneTimer);
        delete pruneTimer;
        pruneTimer = nullptr;
    }
}

Member Data Documentation

cMessage* inet::PIMDM::DownstreamInterface::prunePendingTimer

Referenced by inet::PIMDM::processPrunePendingTimer().

PruneState inet::PIMDM::DownstreamInterface::pruneState

Referenced by inet::PIMDM::multicastPacketArrivedOnNonRpfInterface(), inet::PIMDM::multicastReceiverAdded(), inet::PIMDM::processGraft(), inet::PIMDM::processJoin(), inet::PIMDM::processPrune(), inet::PIMDM::processPrunePendingTimer(), inet::PIMDM::processPruneTimer(), inet::PIMDM::processStateRefreshPacket(), inet::PIMDM::processStateRefreshTimer(), and inet::PIMDM::sendStateRefreshPacket().

cMessage* inet::PIMDM::DownstreamInterface::pruneTimer

Referenced by inet::PIMDM::processPrune(), inet::PIMDM::processPruneTimer(), inet::PIMDM::processStateRefreshPacket(), and inet::PIMDM::processStateRefreshTimer().

---

The documentation for this struct was generated from the following files:

• PIMDM.h
• PIMDM.cc