inet::PIMSM::Route Struct Reference

Inheritance diagram for inet::PIMSM::Route:

Public Types
enum	Flags {   PRUNED = 0x01, REGISTER = 0x02, SPT_BIT = 0x04, JOIN_DESIRED = 0x08,   SOURCE_DIRECTLY_CONNECTED = 0x10 }
enum	RegisterState { RS_NO_INFO, RS_JOIN, RS_PRUNE, RS_JOIN_PENDING }

Public Member Functions
	Route (PIMSM *owner, RouteType type, IPv4Address origin, IPv4Address group)
virtual	~Route ()
PIMSM *	pimsm () const
void	addDownstreamInterface (DownstreamInterface *outInterface)
void	removeDownstreamInterface (unsigned int i)
DownstreamInterface *	findDownstreamInterfaceByInterfaceId (int interfaceId)
DownstreamInterface *	getDownstreamInterfaceByInterfaceId (int interfaceId)
int	findDownstreamInterface (InterfaceEntry *ie)
bool	isImmediateOlistNull ()
bool	isInheritedOlistNull ()
bool	joinDesired () const
bool	isSourceDirectlyConnected () const
void	startKeepAliveTimer (double keepAlivePeriod)
void	startRegisterStopTimer (double interval)
void	startJoinTimer (double joinPrunePeriod)

Public Attributes
RouteType	type
IPv4Address	rpAddr
Route *	rpRoute
Route *	gRoute
Route *	sgrptRoute
unsigned int	sequencenumber
simtime_t	installtime
cMessage *	keepAliveTimer
cMessage *	joinTimer
RegisterState	registerState
cMessage *	registerStopTimer
UpstreamInterface *	upstreamInterface
DownstreamInterfaceVector	downstreamInterfaces
	Out interfaces (downstream) More...

Member Enumeration Documentation

enum inet::PIMSM::Route::Flags

Enumerator
PRUNED
REGISTER
SPT_BIT
JOIN_DESIRED
SOURCE_DIRECTLY_CONNECTED

                   {
            PRUNED = 0x01,    // UpstreamJPState
            REGISTER = 0x02,    // Register flag
            SPT_BIT = 0x04,    // used to distinguish whether to forward on (*,*,RP)/(*,G) or on (S,G) state
            JOIN_DESIRED = 0x08,
            SOURCE_DIRECTLY_CONNECTED = 0x10
        };

enum inet::PIMSM::Route::RegisterState

Enumerator
RS_NO_INFO
RS_JOIN
RS_PRUNE
RS_JOIN_PENDING

{ RS_NO_INFO, RS_JOIN, RS_PRUNE, RS_JOIN_PENDING };

Constructor & Destructor Documentation

inet::PIMSM::Route::Route	(	PIMSM *	owner,
		RouteType	type,
		IPv4Address	origin,
		IPv4Address	group
	)

    : RouteEntry(owner, origin, group), type(type), rpAddr(IPv4Address::UNSPECIFIED_ADDRESS),
    rpRoute(nullptr), gRoute(nullptr), sgrptRoute(nullptr),
    sequencenumber(0), keepAliveTimer(nullptr), joinTimer(nullptr), registerState(RS_NO_INFO), registerStopTimer(nullptr),
    upstreamInterface(nullptr)
{
}

inet::PIMSM::Route::~Route ( )

virtual

{
    owner->cancelAndDelete(keepAliveTimer);
    owner->cancelAndDelete(registerStopTimer);
    owner->cancelAndDelete(joinTimer);
    delete upstreamInterface;
    for (auto & elem : downstreamInterfaces)
        delete elem;
}

Member Function Documentation

void inet::PIMSM::Route::addDownstreamInterface

(

DownstreamInterface *

outInterface

)

Referenced by inet::PIMSM::addNewRouteG().

{
    ASSERT(outInterface);

    auto it = downstreamInterfaces.begin();
    for ( ; it != downstreamInterfaces.end(); ++it) {
        if ((*it)->ie == outInterface->ie)
            break;
    }

    if (it != downstreamInterfaces.end()) {
        delete *it;
        *it = outInterface;
    }
    else {
        downstreamInterfaces.push_back(outInterface);
    }
}

int inet::PIMSM::Route::findDownstreamInterface

(

InterfaceEntry *

ie

)

{
    for (unsigned int i = 0; i < downstreamInterfaces.size(); i++) {
        DownstreamInterface *downstream = downstreamInterfaces[i];
        if (downstream->ie == ie)
            return i;
    }
    return -1;
}

PIMSM::DownstreamInterface * inet::PIMSM::Route::findDownstreamInterfaceByInterfaceId

(

int

interfaceId

)

Referenced by getDownstreamInterfaceByInterfaceId(), inet::PIMSM::DownstreamInterface::isInInheritedOlist(), inet::PIMSM::multicastPacketArrivedOnNonRpfInterface(), inet::PIMSM::processJoinG(), inet::PIMSM::processJoinSG(), inet::PIMSM::processPruneG(), and inet::PIMSM::processPruneSG().

{
    for (auto & elem : downstreamInterfaces) {
        DownstreamInterface *downstream = elem;
        if (downstream->getInterfaceId() == interfaceId)
            return downstream;
    }
    return nullptr;
}

PIMSM::DownstreamInterface * inet::PIMSM::Route::getDownstreamInterfaceByInterfaceId

(

int

interfaceId

)

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

{
    DownstreamInterface *downstream = findDownstreamInterfaceByInterfaceId(interfaceId);
    if (!downstream)
        throw cRuntimeError("getDownstreamInterfaceByInterfaceId(): interface %d not found", interfaceId);
    return downstream;
}

bool inet::PIMSM::Route::isImmediateOlistNull

(

)

Referenced by inet::PIMSM::updateJoinDesired().

{
    for (auto & elem : downstreamInterfaces)
        if (elem->isInImmediateOlist())
            return false;

    return true;
}

bool inet::PIMSM::Route::isInheritedOlistNull

(

)

Referenced by inet::PIMSM::multicastPacketArrivedOnRpfInterface(), inet::PIMSM::processJoinTimer(), inet::PIMSM::processRegisterPacket(), and inet::PIMSM::updateJoinDesired().

{
    for (auto & elem : downstreamInterfaces)
        if (elem->isInInheritedOlist())
            return false;

    return true;
}

bool inet::PIMSM::Route::isSourceDirectlyConnected ( ) const

inline

Referenced by inet::PIMSM::joinDesiredChanged().

{ return isFlagSet(SOURCE_DIRECTLY_CONNECTED); }

bool inet::PIMSM::Route::joinDesired ( ) const

inline

Referenced by inet::PIMSM::joinDesiredChanged(), and inet::PIMSM::updateJoinDesired().

{ return isFlagSet(JOIN_DESIRED); }

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

inline

Referenced by removeDownstreamInterface().

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

void inet::PIMSM::Route::removeDownstreamInterface

(

unsigned int

i

)

{
    // remove corresponding out interface from the IPv4 route,
    // because it refers to the downstream interface to be deleted
    IPv4MulticastRoute *ipv4Route = pimsm()->findIPv4Route(source, group);
    ipv4Route->removeOutInterface(i);

    DownstreamInterface *outInterface = downstreamInterfaces[i];
    downstreamInterfaces.erase(downstreamInterfaces.begin() + i);
    delete outInterface;
}

void inet::PIMSM::Route::startJoinTimer

(

double

joinPrunePeriod

)

Referenced by inet::PIMSM::joinDesiredChanged().

{
    joinTimer = new cMessage("PIMJoinTimer", JoinTimer);
    joinTimer->setContextPointer(this);
    owner->scheduleAt(simTime() + joinPrunePeriod, joinTimer);
}

void inet::PIMSM::Route::startKeepAliveTimer

(

double

keepAlivePeriod

)

Referenced by inet::PIMSM::multicastPacketArrivedOnRpfInterface(), inet::PIMSM::processJoinSG(), inet::PIMSM::processRegisterPacket(), and inet::PIMSM::unroutableMulticastPacketArrived().

{
    ASSERT(this->type == SG);
    keepAliveTimer = new cMessage("PIMKeepAliveTimer", KeepAliveTimer);
    keepAliveTimer->setContextPointer(this);
    owner->scheduleAt(simTime() + keepAlivePeriod, keepAliveTimer);
}

void inet::PIMSM::Route::startRegisterStopTimer

(

double

interval

)

Referenced by inet::PIMSM::processRegisterStopPacket(), and inet::PIMSM::processRegisterStopTimer().

{
    registerStopTimer = new cMessage("PIMRegisterStopTimer", RegisterStopTimer);
    registerStopTimer->setContextPointer(this);
    owner->scheduleAt(simTime() + interval, registerStopTimer);
}

Member Data Documentation

DownstreamInterfaceVector inet::PIMSM::Route::downstreamInterfaces

Out interfaces (downstream)

Referenced by addDownstreamInterface(), inet::PIMSM::createIPv4Route(), findDownstreamInterface(), findDownstreamInterfaceByInterfaceId(), isImmediateOlistNull(), isInheritedOlistNull(), inet::operator<<(), inet::PIMSM::processRegisterPacket(), removeDownstreamInterface(), inet::PIMSM::restartExpiryTimer(), and ~Route().

Route* inet::PIMSM::Route::gRoute

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

simtime_t inet::PIMSM::Route::installtime

cMessage* inet::PIMSM::Route::joinTimer

Referenced by inet::PIMSM::joinDesiredChanged(), inet::PIMSM::processJoinTimer(), startJoinTimer(), and ~Route().

cMessage* inet::PIMSM::Route::keepAliveTimer

Referenced by inet::PIMSM::multicastPacketArrivedOnRpfInterface(), inet::PIMSM::multicastPacketForwarded(), inet::PIMSM::processKeepAliveTimer(), inet::PIMSM::processRegisterPacket(), startKeepAliveTimer(), inet::PIMSM::updateJoinDesired(), and ~Route().

RegisterState inet::PIMSM::Route::registerState

Referenced by inet::PIMSM::multicastPacketForwarded(), inet::PIMSM::processRegisterStopPacket(), inet::PIMSM::processRegisterStopTimer(), and inet::PIMSM::unroutableMulticastPacketArrived().

cMessage* inet::PIMSM::Route::registerStopTimer

Referenced by inet::PIMSM::processRegisterStopPacket(), inet::PIMSM::processRegisterStopTimer(), startRegisterStopTimer(), and ~Route().

IPv4Address inet::PIMSM::Route::rpAddr

Referenced by inet::PIMSM::addNewRouteG(), inet::PIMSM::joinDesiredChanged(), inet::PIMSM::multicastPacketForwarded(), inet::operator<<(), inet::PIMSM::processJoinTimer(), and inet::PIMSM::processPrunePendingTimer().

Route* inet::PIMSM::Route::rpRoute

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

unsigned int inet::PIMSM::Route::sequencenumber

Route* inet::PIMSM::Route::sgrptRoute

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

RouteType inet::PIMSM::Route::type

Referenced by inet::PIMSM::deleteMulticastRoute(), inet::PIMSM::DownstreamInterface::isInInheritedOlist(), inet::PIMSM::joinDesiredChanged(), inet::PIMSM::multicastPacketArrivedOnNonRpfInterface(), inet::PIMSM::multicastPacketArrivedOnRpfInterface(), inet::PIMSM::processAssertTimer(), inet::PIMSM::processJoinTimer(), inet::PIMSM::processKeepAliveTimer(), inet::PIMSM::processPrunePendingTimer(), inet::PIMSM::processRegisterStopTimer(), inet::PIMSM::removeRoute(), startKeepAliveTimer(), and inet::PIMSM::updateJoinDesired().

UpstreamInterface* inet::PIMSM::Route::upstreamInterface

Referenced by inet::PIMSM::addNewRouteG(), inet::PIMSM::createIPv4Route(), inet::PIMSM::joinDesiredChanged(), inet::operator<<(), inet::PIMSM::processAssertPacket(), inet::PIMSM::processJoinG(), inet::PIMSM::processJoinTimer(), inet::PIMSM::processRegisterPacket(), inet::PIMSM::restartExpiryTimer(), and ~Route().

---

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

• PIMSM.h
• PIMSM.cc