inet::PIMSM::PimsmInterface Struct Reference

Inheritance diagram for inet::PIMSM::PimsmInterface:

Public Types
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
	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
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::PimsmInterface::Flags

Enumerator
RECEIVER_INCLUDE
RECEIVER_EXCLUDE
COULD_ASSERT
ASSERT_TRACKING_DESIRED

                   {
            RECEIVER_INCLUDE = 1 << 0,    // local_receiver_include(S,G,I) or local_receiver_include(*,G,I)
            RECEIVER_EXCLUDE = 1 << 1,    // local_receiver_exclude(S,G,I)
            COULD_ASSERT = 1 << 2,    // CouldAssert(S,G,I)
            ASSERT_TRACKING_DESIRED = 1 << 3    // AssertTrackingDesired(S,G,I)
        };

Constructor & Destructor Documentation

inet::PIMSM::PimsmInterface::PimsmInterface	(	Route *	owner,
		InterfaceEntry *	ie
	)

    : Interface(owner, ie), expiryTimer(nullptr)
{
}

inet::PIMSM::PimsmInterface::~PimsmInterface ( )

virtual

{
    pimsm()->cancelAndDelete(expiryTimer);
    pimsm()->cancelAndDelete(assertTimer);
}

Member Function Documentation

bool inet::PIMSM::PimsmInterface::assertTrackingDesired ( ) const

inline

Referenced by inet::PIMSM::processAssertG(), and inet::PIMSM::processAssertSG().

{ return isFlagSet(ASSERT_TRACKING_DESIRED); }

bool inet::PIMSM::PimsmInterface::couldAssert ( ) const

inline

Referenced by inet::PIMSM::multicastPacketArrivedOnNonRpfInterface(), inet::PIMSM::processAssertG(), and inet::PIMSM::processAssertSG().

{ return isFlagSet(COULD_ASSERT); }

bool inet::PIMSM::PimsmInterface::localReceiverExclude ( ) const

inline

{ return isFlagSet(RECEIVER_EXCLUDE); }

bool inet::PIMSM::PimsmInterface::localReceiverInclude ( ) const

inline

{ return isFlagSet(RECEIVER_INCLUDE); }

bool inet::PIMSM::PimsmInterface::pimExclude ( ) const

inline

Referenced by inet::PIMSM::DownstreamInterface::isInInheritedOlist().

        {
            return localReceiverExclude() &&
                   ((    /*I_am_DR AND*/ assertState != I_LOST_ASSERT) || assertState == I_WON_ASSERT);
        }

bool inet::PIMSM::PimsmInterface::pimInclude ( ) const

inline

Referenced by inet::PIMSM::DownstreamInterface::isInImmediateOlist(), and inet::PIMSM::DownstreamInterface::isInInheritedOlist().

        {
            return localReceiverInclude() &&
                   ((    /*I_am_DR AND*/ assertState != I_LOST_ASSERT) || assertState == I_WON_ASSERT);
        }

PIMSM* inet::PIMSM::PimsmInterface::pimsm ( ) const

inline

Referenced by startExpiryTimer(), inet::PIMSM::DownstreamInterface::startPrunePendingTimer(), inet::PIMSM::DownstreamInterface::~DownstreamInterface(), and ~PimsmInterface().

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

Route* inet::PIMSM::PimsmInterface::route ( ) const

inline

Referenced by inet::PIMSM::DownstreamInterface::isInImmediateOlist(), inet::PIMSM::DownstreamInterface::isInInheritedOlist(), inet::PIMSM::processAssertG(), inet::PIMSM::processAssertSG(), inet::PIMSM::processAssertTimer(), and inet::PIMSM::processPrunePendingTimer().

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

void inet::PIMSM::PimsmInterface::setAssertTrackingDesired ( bool  value )

inline

{ setFlag(ASSERT_TRACKING_DESIRED, value); }

void inet::PIMSM::PimsmInterface::setCouldAssert ( bool  value )

inline

{ setFlag(COULD_ASSERT, value); }

void inet::PIMSM::PimsmInterface::setLocalReceiverExclude ( bool  value )

inline

{ setFlag(RECEIVER_EXCLUDE, value); }

void inet::PIMSM::PimsmInterface::setLocalReceiverInclude ( bool  value )

inline

Referenced by inet::PIMSM::multicastReceiverAdded(), and inet::PIMSM::multicastReceiverRemoved().

{ setFlag(RECEIVER_INCLUDE, value); }

void inet::PIMSM::PimsmInterface::startExpiryTimer

(

double

holdTime

)

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

{
    expiryTimer = new cMessage("PIMExpiryTimer", ExpiryTimer);
    expiryTimer->setContextPointer(this);
    pimsm()->scheduleAt(simTime() + holdTime, expiryTimer);
}

Member Data Documentation

cMessage* inet::PIMSM::PimsmInterface::expiryTimer

Referenced by inet::PIMSM::processExpiryTimer(), inet::PIMSM::processJoinG(), inet::PIMSM::processJoinSG(), inet::PIMSM::processPrunePendingTimer(), inet::PIMSM::restartExpiryTimer(), startExpiryTimer(), and ~PimsmInterface().

---

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

• PIMSM.h
• PIMSM.cc