inet::PIMBase::Interface Struct Reference

#include <PIMBase.h>

Inheritance diagram for inet::PIMBase::Interface:

Public Types
enum	AssertState { NO_ASSERT_INFO, I_LOST_ASSERT, I_WON_ASSERT }

Public Member Functions
	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
RouteEntry *	owner
InterfaceEntry *	ie
int	flags
AssertState	assertState
cMessage *	assertTimer
AssertMetric	winnerMetric

Member Enumeration Documentation

enum inet::PIMBase::Interface::AssertState

Enumerator
NO_ASSERT_INFO
I_LOST_ASSERT
I_WON_ASSERT

{ NO_ASSERT_INFO, I_LOST_ASSERT, I_WON_ASSERT };

Constructor & Destructor Documentation

inet::PIMBase::Interface::Interface ( RouteEntry *  owner, InterfaceEntry *  ie  )

inline

            : owner(owner), ie(ie), flags(0),
            assertState(NO_ASSERT_INFO), assertTimer(nullptr)
        { ASSERT(owner), ASSERT(ie); }

virtual inet::PIMBase::Interface::~Interface ( )

inlinevirtual

{ owner->owner->cancelAndDelete(assertTimer); }

Member Function Documentation

void inet::PIMBase::Interface::clearFlag ( int  flag )

inline

{ flags &= (~flag); }

void inet::PIMBase::Interface::deleteAssertInfo ( )

inline

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

        {
            assertState = NO_ASSERT_INFO;
            winnerMetric = AssertMetric::PIM_INFINITE;
            owner->owner->cancelAndDelete(assertTimer);
            assertTimer = nullptr;
        }

bool inet::PIMBase::Interface::isFlagSet ( int  flag ) const

inline

{ return (flags & flag) != 0; }

void inet::PIMBase::Interface::setFlag ( int  flag, bool  value  )

inline

{ if (value) setFlags(flag); else clearFlag(flag); }

void inet::PIMBase::Interface::setFlags ( int  flags )

inline

{ this->flags |= flags; }

void inet::PIMBase::Interface::startAssertTimer ( double  assertTime )

inline

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

        {
            ASSERT(assertTimer == nullptr);
            assertTimer = new cMessage("PimAssertTimer", AssertTimer);
            assertTimer->setContextPointer(this);
            owner->owner->scheduleAt(simTime() + assertTime, assertTimer);
        }

Member Data Documentation

AssertState inet::PIMBase::Interface::assertState

Referenced by inet::PIMSM::DownstreamInterface::isInImmediateOlist(), inet::PIMSM::DownstreamInterface::isInInheritedOlist(), inet::PIMDM::multicastPacketArrivedOnNonRpfInterface(), inet::PIMSM::multicastPacketArrivedOnNonRpfInterface(), inet::PIMDM::processAssert(), inet::PIMSM::processAssertG(), inet::PIMSM::processAssertPacket(), inet::PIMSM::processAssertSG(), inet::PIMDM::processAssertTimer(), inet::PIMSM::processAssertTimer(), inet::PIMDM::processGraft(), inet::PIMDM::processJoin(), inet::PIMDM::processPrune(), inet::PIMDM::processStateRefreshPacket(), and inet::PIMDM::processStateRefreshTimer().

cMessage* inet::PIMBase::Interface::assertTimer

Referenced by inet::PIMDM::multicastPacketArrivedOnNonRpfInterface(), inet::PIMDM::processAssert(), inet::PIMSM::processAssertG(), inet::PIMSM::processAssertSG(), inet::PIMDM::processAssertTimer(), inet::PIMSM::processAssertTimer(), and inet::PIMSM::PimsmInterface::~PimsmInterface().

int inet::PIMBase::Interface::flags

InterfaceEntry* inet::PIMBase::Interface::ie

Referenced by inet::PIMSM::Route::addDownstreamInterface(), inet::PIMSM::addNewRouteG(), inet::PIMSM::createIPv4Route(), inet::PIMSM::Route::findDownstreamInterface(), inet::PIMSM::DownstreamInterface::isInInheritedOlist(), inet::PIMDM::multicastPacketArrivedOnNonRpfInterface(), inet::PIMSM::multicastPacketArrivedOnNonRpfInterface(), inet::PIMDM::multicastPacketArrivedOnRpfInterface(), inet::PIMDM::multicastReceiverAdded(), inet::operator<<(), inet::PIMDM::processAssert(), inet::PIMSM::processAssertG(), inet::PIMDM::processAssertPacket(), inet::PIMSM::processAssertSG(), inet::PIMDM::processAssertTimer(), inet::PIMSM::processAssertTimer(), inet::PIMDM::processGraft(), inet::PIMDM::processGraftAckPacket(), inet::PIMDM::processJoin(), inet::PIMDM::processPrune(), inet::PIMSM::processPrunePendingTimer(), inet::PIMDM::processStateRefreshTimer(), inet::PIMDM::Route::removeDownstreamInterface(), inet::PIMSM::restartExpiryTimer(), inet::PIMDM::rpfInterfaceHasChanged(), inet::PIMDM::sendStateRefreshPacket(), and inet::PIMDM::unroutableMulticastPacketArrived().

RouteEntry* inet::PIMBase::Interface::owner

Referenced by inet::PIMDM::processAssert(), and inet::PIMDM::processAssertTimer().

AssertMetric inet::PIMBase::Interface::winnerMetric

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

---

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

• PIMBase.h