inet::PIMDM::UpstreamInterface Struct Reference

Inheritance diagram for inet::PIMDM::UpstreamInterface:

Public Types
enum	Flags { SOURCE_DIRECTLY_CONNECTED = 0x01 }
enum	GraftPruneState { FORWARDING, PRUNED, ACK_PENDING }
enum	OriginatorState { NOT_ORIGINATOR, ORIGINATOR }
Public Types inherited from inet::PIMBase::Interface
enum	AssertState { NO_ASSERT_INFO, I_LOST_ASSERT, I_WON_ASSERT }

Public Member Functions
	UpstreamInterface (Route *owner, InterfaceEntry *ie, IPv4Address neighbor, bool isSourceDirectlyConnected)
virtual	~UpstreamInterface ()
Route *	route () const
PIMDM *	pimdm () const
int	getInterfaceId () const
IPv4Address	rpfNeighbor ()
bool	isSourceDirectlyConnected () const
void	startGraftRetryTimer ()
	The method is used to create PIMGraftRetry timer. More...
void	startOverrideTimer ()
void	startSourceActiveTimer ()
	The method is used to create PIMSourceActive timer. More...
void	startStateRefreshTimer ()
	The method is used to create PIMStateRefresh timer. More...
void	startPruneLimitTimer ()
void	stopPruneLimitTimer ()
bool	isPruneLimitTimerRunning ()
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
IPv4Address	nextHop
GraftPruneState	graftPruneState
cMessage *	graftRetryTimer
cMessage *	overrideTimer
simtime_t	lastPruneSentTime
OriginatorState	originatorState
cMessage *	sourceActiveTimer
cMessage *	stateRefreshTimer
unsigned short	maxTtlSeen
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::UpstreamInterface::Flags

Enumerator
SOURCE_DIRECTLY_CONNECTED

                   {
            SOURCE_DIRECTLY_CONNECTED = 0x01
        };

enum inet::PIMDM::UpstreamInterface::GraftPruneState

Enumerator
FORWARDING
PRUNED
ACK_PENDING

                             {
            FORWARDING,    // oiflist != nullptr
            PRUNED,    // olist is empty
            ACK_PENDING    // waiting for a Graft Ack
        };

enum inet::PIMDM::UpstreamInterface::OriginatorState

Enumerator
NOT_ORIGINATOR
ORIGINATOR

{ NOT_ORIGINATOR, ORIGINATOR };

Constructor & Destructor Documentation

inet::PIMDM::UpstreamInterface::UpstreamInterface ( Route *  owner, InterfaceEntry *  ie, IPv4Address  neighbor, bool  isSourceDirectlyConnected  )

inline

            : Interface(owner, ie), nextHop(neighbor),
            graftPruneState(FORWARDING), graftRetryTimer(nullptr), overrideTimer(nullptr), lastPruneSentTime(0.0),
            originatorState(NOT_ORIGINATOR), sourceActiveTimer(nullptr), stateRefreshTimer(nullptr), maxTtlSeen(0)
        { setFlag(SOURCE_DIRECTLY_CONNECTED, isSourceDirectlyConnected); }

inet::PIMDM::UpstreamInterface::~UpstreamInterface ( )

virtual

{
    owner->owner->cancelAndDelete(stateRefreshTimer);
    owner->owner->cancelAndDelete(graftRetryTimer);
    owner->owner->cancelAndDelete(sourceActiveTimer);
    owner->owner->cancelAndDelete(overrideTimer);
}

Member Function Documentation

int inet::PIMDM::UpstreamInterface::getInterfaceId ( ) const

inline

Referenced by inet::PIMDM::multicastPacketArrivedOnNonRpfInterface(), inet::PIMDM::multicastPacketArrivedOnRpfInterface(), inet::PIMDM::processGraftRetryTimer(), inet::PIMDM::processOlistEmptyEvent(), inet::PIMDM::processOlistNonEmptyEvent(), and inet::PIMDM::processOverrideTimer().

{ return ie->getInterfaceId(); }

bool inet::PIMDM::UpstreamInterface::isPruneLimitTimerRunning ( )

inline

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

{ return lastPruneSentTime > 0.0 && simTime() < lastPruneSentTime + pimdm()->pruneLimitInterval; }

bool inet::PIMDM::UpstreamInterface::isSourceDirectlyConnected ( ) const

inline

Referenced by inet::PIMDM::multicastPacketArrivedOnNonRpfInterface(), inet::PIMDM::multicastPacketArrivedOnRpfInterface(), inet::PIMDM::processOlistEmptyEvent(), inet::PIMDM::processOlistNonEmptyEvent(), inet::PIMDM::processPrune(), and inet::PIMDM::rpfInterfaceHasChanged().

{ return isFlagSet(SOURCE_DIRECTLY_CONNECTED); }

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

inline

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

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

inline

Referenced by inet::PIMDM::processGraftRetryTimer(), inet::PIMDM::processOverrideTimer(), inet::PIMDM::processSourceActiveTimer(), and inet::PIMDM::processStateRefreshTimer().

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

IPv4Address inet::PIMDM::UpstreamInterface::rpfNeighbor ( )

inline

Referenced by inet::PIMDM::multicastPacketArrivedOnNonRpfInterface(), inet::PIMDM::multicastPacketArrivedOnRpfInterface(), inet::PIMDM::processGraftRetryTimer(), inet::PIMDM::processOlistEmptyEvent(), inet::PIMDM::processOlistNonEmptyEvent(), inet::PIMDM::processOverrideTimer(), and inet::PIMDM::rpfInterfaceHasChanged().

{ return assertState == I_LOST_ASSERT ? winnerMetric.address : nextHop; }

void inet::PIMDM::UpstreamInterface::startGraftRetryTimer

(

)

The method is used to create PIMGraftRetry timer.

The timer is set when router wants to join to multicast tree again and send PIM Prune message to upstream. Router waits for Graft Retry Timer (3 s) for PIM PruneAck message from upstream. If timer expires, router will send PIM Prune message again. It is set to (S,G).

Referenced by inet::PIMDM::processOlistNonEmptyEvent(), and inet::PIMDM::rpfInterfaceHasChanged().

{
    graftRetryTimer = new cMessage("PIMGraftRetryTimer", GraftRetryTimer);
    graftRetryTimer->setContextPointer(this);
    pimdm()->scheduleAt(simTime() + pimdm()->graftRetryInterval, graftRetryTimer);
}

void inet::PIMDM::UpstreamInterface::startOverrideTimer

(

)

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

{
    overrideTimer = new cMessage("PIMOverrideTimer", UpstreamOverrideTimer);
    overrideTimer->setContextPointer(this);
    pimdm()->scheduleAt(simTime() + pimdm()->overrideInterval, overrideTimer);
}

void inet::PIMDM::UpstreamInterface::startPruneLimitTimer ( )

inline

Referenced by inet::PIMDM::multicastPacketArrivedOnRpfInterface(), and inet::PIMDM::processOlistEmptyEvent().

{ lastPruneSentTime = simTime(); }

void inet::PIMDM::UpstreamInterface::startSourceActiveTimer

(

)

The method is used to create PIMSourceActive timer.

The timer is set when source of multicast is connected directly to the router. If timer expires, router will remove the route from multicast routing table. It is set to (S,G).

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

{
    sourceActiveTimer = new cMessage("PIMSourceActiveTimer", SourceActiveTimer);
    sourceActiveTimer->setContextPointer(this);
    pimdm()->scheduleAt(simTime() + pimdm()->sourceActiveInterval, sourceActiveTimer);
}

void inet::PIMDM::UpstreamInterface::startStateRefreshTimer

(

)

The method is used to create PIMStateRefresh timer.

The timer is set when source of multicast is connected directly to the router. If timer expires, router will send StateRefresh message, which will propagate through all network and wil reset Prune Timer. It is set to (S,G).

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

{
    stateRefreshTimer = new cMessage("PIMStateRefreshTimer", StateRefreshTimer);
    sourceActiveTimer->setContextPointer(this);
    pimdm()->scheduleAt(simTime() + pimdm()->stateRefreshInterval, stateRefreshTimer);
}

void inet::PIMDM::UpstreamInterface::stopPruneLimitTimer ( )

inline

Referenced by inet::PIMDM::processOlistNonEmptyEvent(), and inet::PIMDM::rpfInterfaceHasChanged().

{ lastPruneSentTime = 0; }

Member Data Documentation

GraftPruneState inet::PIMDM::UpstreamInterface::graftPruneState

Referenced by inet::PIMDM::multicastPacketArrivedOnNonRpfInterface(), inet::PIMDM::multicastPacketArrivedOnRpfInterface(), inet::PIMDM::multicastReceiverAdded(), inet::PIMDM::processGraftAckPacket(), inet::PIMDM::processGraftRetryTimer(), inet::PIMDM::processJoin(), inet::PIMDM::processOlistEmptyEvent(), inet::PIMDM::processOlistNonEmptyEvent(), inet::PIMDM::processOverrideTimer(), inet::PIMDM::processPrune(), inet::PIMDM::rpfInterfaceHasChanged(), and inet::PIMDM::unroutableMulticastPacketArrived().

cMessage* inet::PIMDM::UpstreamInterface::graftRetryTimer

Referenced by inet::PIMDM::processGraftAckPacket(), inet::PIMDM::processGraftRetryTimer(), inet::PIMDM::processOlistEmptyEvent(), and inet::PIMDM::rpfInterfaceHasChanged().

simtime_t inet::PIMDM::UpstreamInterface::lastPruneSentTime

unsigned short inet::PIMDM::UpstreamInterface::maxTtlSeen

Referenced by inet::PIMDM::multicastPacketArrivedOnRpfInterface(), inet::PIMDM::processStateRefreshTimer(), and inet::PIMDM::unroutableMulticastPacketArrived().

IPv4Address inet::PIMDM::UpstreamInterface::nextHop

OriginatorState inet::PIMDM::UpstreamInterface::originatorState

Referenced by inet::PIMDM::multicastPacketArrivedOnRpfInterface(), inet::PIMDM::processSourceActiveTimer(), inet::PIMDM::processStateRefreshTimer(), and inet::PIMDM::unroutableMulticastPacketArrived().

cMessage* inet::PIMDM::UpstreamInterface::overrideTimer

Referenced by inet::PIMDM::processJoin(), inet::PIMDM::processOverrideTimer(), and inet::PIMDM::processPrune().

cMessage* inet::PIMDM::UpstreamInterface::sourceActiveTimer

Referenced by inet::PIMDM::multicastPacketArrivedOnRpfInterface(), and inet::PIMDM::processSourceActiveTimer().

cMessage* inet::PIMDM::UpstreamInterface::stateRefreshTimer

Referenced by inet::PIMDM::processSourceActiveTimer(), and inet::PIMDM::processStateRefreshTimer().

---

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

• PIMDM.h
• PIMDM.cc