inet::PIMSM::DownstreamInterface Struct Reference

Inheritance diagram for inet::PIMSM::DownstreamInterface:

Public Types
enum	JoinPruneState { NO_INFO, JOIN, PRUNE_PENDING }
	States of each outgoing interface. More...
Public Types inherited from inet::PIMSM::PimsmInterface
enum	Flags { RECEIVER_INCLUDE = 1 << 0, RECEIVER_EXCLUDE = 1 << 1, COULD_ASSERT = 1 << 2, ASSERT_TRACKING_DESIRED = 1 << 3 }
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, JoinPruneState joinPruneState, bool show=true)
virtual	~DownstreamInterface ()
int	getInterfaceId () const
bool	isInImmediateOlist () const
bool	isInInheritedOlist () const
void	startPrunePendingTimer (double joinPruneOverrideInterval)
Public Member Functions inherited from inet::PIMSM::PimsmInterface
	PimsmInterface (Route *owner, InterfaceEntry *ie)
virtual	~PimsmInterface ()
Route *	route () const
PIMSM *	pimsm () const
void	startExpiryTimer (double holdTime)
bool	localReceiverInclude () const
void	setLocalReceiverInclude (bool value)
bool	localReceiverExclude () const
void	setLocalReceiverExclude (bool value)
bool	couldAssert () const
void	setCouldAssert (bool value)
bool	assertTrackingDesired () const
void	setAssertTrackingDesired (bool value)
bool	pimInclude () const
bool	pimExclude () const
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
JoinPruneState	joinPruneState
cMessage *	prunePendingTimer
Public Attributes inherited from inet::PIMSM::PimsmInterface
cMessage *	expiryTimer
Public Attributes inherited from inet::PIMBase::Interface
RouteEntry *	owner
InterfaceEntry *	ie
int	flags
AssertState	assertState
cMessage *	assertTimer
AssertMetric	winnerMetric

Member Enumeration Documentation

enum inet::PIMSM::DownstreamInterface::JoinPruneState

States of each outgoing interface.

Enumerator
NO_INFO
JOIN
PRUNE_PENDING

{ NO_INFO, JOIN, PRUNE_PENDING };

Constructor & Destructor Documentation

inet::PIMSM::DownstreamInterface::DownstreamInterface ( Route *  owner, InterfaceEntry *  ie, JoinPruneState  joinPruneState, bool  show = true  )

inline

            : PimsmInterface(owner, ie), joinPruneState(joinPruneState), prunePendingTimer(nullptr) {}

inet::PIMSM::DownstreamInterface::~DownstreamInterface ( )

virtual

{
    pimsm()->cancelAndDelete(prunePendingTimer);
}

Member Function Documentation

int inet::PIMSM::DownstreamInterface::getInterfaceId ( ) const

inline

Referenced by inet::PIMSM::Route::findDownstreamInterfaceByInterfaceId(), inet::PIMSM::processRegisterPacket(), and inet::PIMSM::restartExpiryTimer().

{ return ie->getInterfaceId(); }

bool inet::PIMSM::DownstreamInterface::isInImmediateOlist

(

)

const

{
    // immediate_olist(*,*,RP) = joins(*,*,RP)
    // immediate_olist(*,G) = joins(*,G) (+) pim_include(*,G) (-) lost_assert(*,G)
    // immediate_olist(S,G) = joins(S,G) (+) pim_include(S,G) (-) lost_assert(S,G)
    switch (route()->type) {
        case RP:
            return joinPruneState != NO_INFO;

        case G:
            return assertState != I_LOST_ASSERT && (joinPruneState != NO_INFO || pimInclude());

        case SG:
            return assertState != I_LOST_ASSERT && (joinPruneState != NO_INFO || pimInclude());

        case SGrpt:
            ASSERT(false);
            break;
    }
    return false;
}

bool inet::PIMSM::DownstreamInterface::isInInheritedOlist

(

)

const

Referenced by inet::PIMSM::PIMSMOutInterface::isEnabled(), isInInheritedOlist(), and inet::PIMSM::processRegisterPacket().

{
    // inherited_olist(S,G,rpt) = ( joins(*,*,RP(G)) (+) joins(*,G) (-) prunes(S,G,rpt) )
    //                            (+) ( pim_include(*,G) (-) pim_exclude(S,G))
    //                            (-) ( lost_assert(*,G) (+) lost_assert(S,G,rpt) )
    // inherited_olist(S,G) = inherited_olist(S,G,rpt) (+)
    //                        joins(S,G) (+) pim_include(S,G) (-) lost_assert(S,G)
    Route *route = this->route();
    int interfaceId = ie->getInterfaceId();
    bool include = false;

    switch (route->type) {
        case RP:
            // joins(*,*,RP(G))
            include |= joinPruneState != NO_INFO;
            break;

        case G:    // inherited_olist(S,G,rpt) when there is not (S,G,rpt) state
            // joins(*,*,RP(G))
            if (route->rpRoute) {
                DownstreamInterface *downstream = route->rpRoute->findDownstreamInterfaceByInterfaceId(interfaceId);
                include |= downstream && downstream->joinPruneState != NO_INFO;
            }
            include |= joinPruneState != NO_INFO;
            include |= pimInclude();
            include &= assertState != I_LOST_ASSERT;
            break;

        case SGrpt:
            // joins(*,*,RP(G)
            if (route->rpRoute) {
                DownstreamInterface *downstream = route->rpRoute->findDownstreamInterfaceByInterfaceId(interfaceId);
                include |= downstream && downstream->joinPruneState != NO_INFO;
            }
            // (+) joins(*,G)
            if (route->gRoute) {
                DownstreamInterface *downstream = route->gRoute->findDownstreamInterfaceByInterfaceId(interfaceId);
                include |= downstream && downstream->joinPruneState != NO_INFO;
            }

            // TODO (-) prunes(S,G,prt)

            if (route->gRoute) {
                DownstreamInterface *downstream = route->gRoute->findDownstreamInterfaceByInterfaceId(interfaceId);
                // (+) ( pim_include(*,G) (-) pim_exclude(S,G))
                include |= (downstream && downstream->pimInclude()) && !pimExclude();
                // (-) lost_assert(*,G)
                include &= !downstream || downstream->assertState != I_LOST_ASSERT;
            }

            // (-) lost_assert(S,G)
            include &= assertState != I_LOST_ASSERT;
            break;

        case SG:
            // inherited_olist(S,G,rpt)
            if (route->sgrptRoute) {
                DownstreamInterface *downstream = route->sgrptRoute->findDownstreamInterfaceByInterfaceId(interfaceId);
                include |= downstream && downstream->isInInheritedOlist();
            }
            else if (route->gRoute) {
                DownstreamInterface *downstream = route->gRoute->findDownstreamInterfaceByInterfaceId(interfaceId);
                include |= downstream && downstream->isInInheritedOlist();
            }
            // (+) joins(S,G)
            include |= joinPruneState != NO_INFO;
            // (+) pim_include(S,G)
            include |= pimInclude();
            // (-) lost_assert(S,G)
            include &= assertState != I_LOST_ASSERT;
            break;
    }
    return include;
}

void inet::PIMSM::DownstreamInterface::startPrunePendingTimer

(

double

joinPruneOverrideInterval

)

Referenced by inet::PIMSM::processPruneG(), and inet::PIMSM::processPruneSG().

{
    ASSERT(!prunePendingTimer);
    prunePendingTimer = new cMessage("PIMPrunePendingTimer", PrunePendingTimer);
    prunePendingTimer->setContextPointer(this);
    pimsm()->scheduleAt(simTime() + joinPruneOverrideInterval, prunePendingTimer);
}

Member Data Documentation

JoinPruneState inet::PIMSM::DownstreamInterface::joinPruneState

Referenced by isInInheritedOlist(), inet::PIMSM::processExpiryTimer(), inet::PIMSM::processJoinG(), inet::PIMSM::processJoinSG(), inet::PIMSM::processPruneG(), inet::PIMSM::processPrunePendingTimer(), and inet::PIMSM::processPruneSG().

cMessage* inet::PIMSM::DownstreamInterface::prunePendingTimer

Referenced by inet::PIMSM::processExpiryTimer(), inet::PIMSM::processJoinG(), inet::PIMSM::processJoinSG(), and inet::PIMSM::processPrunePendingTimer().

---

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

• PIMSM.h
• PIMSM.cc