inet::Ieee8021dInterfaceData Class Reference

Per-interface data needed by the STP and RSTP protocols. More...

#include <Ieee8021dInterfaceData.h>

Inheritance diagram for inet::Ieee8021dInterfaceData:

Classes
class	PortInfo

Public Types
enum	PortRole {   ALTERNATE, NOTASSIGNED, DISABLED, DESIGNATED,   BACKUP, ROOT }
enum	PortState { DISCARDING, LEARNING, FORWARDING }

Public Member Functions
	Ieee8021dInterfaceData ()
virtual std::string	info () const override
virtual std::string	detailedInfo () const override
bool	isLearning () const
bool	isForwarding () const
simtime_t	getAge () const
void	setAge (simtime_t age)
const MACAddress &	getBridgeAddress () const
void	setBridgeAddress (const MACAddress &bridgeAddress)
unsigned int	getBridgePriority () const
void	setBridgePriority (unsigned int bridgePriority)
simtime_t	getFdWhile () const
void	setFdWhile (simtime_t fdWhile)
simtime_t	getFwdDelay () const
void	setFwdDelay (simtime_t fwdDelay)
simtime_t	getHelloTime () const
void	setHelloTime (simtime_t helloTime)
unsigned int	getLinkCost () const
void	setLinkCost (unsigned int linkCost)
simtime_t	getMaxAge () const
void	setMaxAge (simtime_t maxAge)
unsigned int	getPortNum () const
void	setPortNum (unsigned int portNum)
unsigned int	getPortPriority () const
void	setPortPriority (unsigned int portPriority)
unsigned int	getPriority () const
void	setPriority (unsigned int priority)
PortRole	getRole () const
void	setRole (PortRole role)
const MACAddress &	getRootAddress () const
void	setRootAddress (const MACAddress &rootAddress)
unsigned int	getRootPathCost () const
void	setRootPathCost (unsigned int rootPathCost)
unsigned int	getRootPriority () const
void	setRootPriority (unsigned int rootPriority)
PortState	getState () const
void	setState (PortState state)
bool	isEdge () const
void	setEdge (bool edge)
simtime_t	getTCWhile () const
void	setTCWhile (simtime_t TCWhile)
unsigned int	getLostBPDU () const
void	setLostBPDU (unsigned int lostBPDU)
const char *	getRoleName () const
const char *	getStateName () const
simtime_t	getNextUpgrade () const
void	setNextUpgrade (simtime_t nextUpgrade)
Public Member Functions inherited from inet::InterfaceProtocolData
	InterfaceProtocolData ()
InterfaceEntry *	getInterfaceEntry () const
	Returns the InterfaceEntry that contains this data object, or nullptr. More...

Static Public Member Functions
static const char *	getRoleName (PortRole role)
static const char *	getStateName (PortState state)

Protected Attributes
PortInfo	portData
Protected Attributes inherited from inet::InterfaceProtocolData
InterfaceEntry *	ownerp = nullptr

Additional Inherited Members
Protected Member Functions inherited from inet::InterfaceProtocolData
virtual void	changed (simsignal_t signalID, int fieldId)

Detailed Description

Per-interface data needed by the STP and RSTP protocols.

Member Enumeration Documentation

enum inet::Ieee8021dInterfaceData::PortRole

Enumerator
ALTERNATE
NOTASSIGNED
DISABLED
DESIGNATED
BACKUP
ROOT

{ ALTERNATE, NOTASSIGNED, DISABLED, DESIGNATED, BACKUP, ROOT };

enum inet::Ieee8021dInterfaceData::PortState

Enumerator
DISCARDING
LEARNING
FORWARDING

{ DISCARDING, LEARNING, FORWARDING };

Constructor & Destructor Documentation

inet::Ieee8021dInterfaceData::Ieee8021dInterfaceData

(

)

{
}

Member Function Documentation

std::string inet::Ieee8021dInterfaceData::detailedInfo ( ) const

overridevirtual

{
    std::stringstream out;
    out << "role:" << getRoleName() << "\tstate:" << getStateName() << "\n";
    out << "priority:" << getPriority() << "\n";
    out << "linkCost:" << getLinkCost() << "\n";

    return out.str();
}

simtime_t inet::Ieee8021dInterfaceData::getAge ( ) const

inline

Referenced by inet::STP::checkTimers(), inet::STP::handleTick(), inet::RSTP::printState(), inet::RSTP::sendBPDU(), and inet::RSTP::sendTCNtoRoot().

{ return portData.age; }

const MACAddress& inet::Ieee8021dInterfaceData::getBridgeAddress ( ) const

inline

Referenced by inet::RSTP::compareInterfacedata(), inet::STP::comparePorts(), inet::RSTP::contestInterfacedata(), inet::RSTP::getBestAlternate(), inet::RSTP::printState(), and inet::RSTP::processBPDU().

{ return portData.bridgeAddress; }

unsigned int inet::Ieee8021dInterfaceData::getBridgePriority ( ) const

inline

Referenced by inet::RSTP::compareInterfacedata(), inet::STP::comparePorts(), inet::RSTP::contestInterfacedata(), inet::RSTP::getBestAlternate(), and inet::RSTP::printState().

{ return portData.bridgePriority; }

simtime_t inet::Ieee8021dInterfaceData::getFdWhile ( ) const

inline

Referenced by inet::STP::checkTimers(), and inet::STP::handleTick().

{ return portData.fdWhile; }

simtime_t inet::Ieee8021dInterfaceData::getFwdDelay ( ) const

inline

Referenced by inet::STP::selectRootPort().

{ return portData.fwdDelay; }

simtime_t inet::Ieee8021dInterfaceData::getHelloTime ( ) const

inline

Referenced by inet::STP::selectRootPort().

{ return portData.helloTime; }

unsigned int inet::Ieee8021dInterfaceData::getLinkCost ( ) const

inline

Referenced by inet::RSTP::contestInterfacedata(), detailedInfo(), inet::STP::isSuperiorBPDU(), inet::operator<<(), inet::RSTP::processBetterSource(), inet::RSTP::processBPDU(), inet::RSTP::processSameSource(), inet::STP::selectDesignatedPorts(), inet::STP::setSuperiorBPDU(), and inet::RSTP::updateInterfacedata().

{ return portData.linkCost; }

unsigned int inet::Ieee8021dInterfaceData::getLostBPDU ( ) const

inline

Referenced by inet::RSTP::handleHelloTime().

{ return portData.lostBPDU; }

simtime_t inet::Ieee8021dInterfaceData::getMaxAge ( ) const

inline

Referenced by inet::STP::selectRootPort().

{ return portData.maxAge; }

simtime_t inet::Ieee8021dInterfaceData::getNextUpgrade ( ) const

inline

Referenced by inet::RSTP::handleUpgrade(), and inet::RSTP::scheduleNextUpgrade().

{ return portData.nextUpgrade; }

unsigned int inet::Ieee8021dInterfaceData::getPortNum ( ) const

inline

Referenced by inet::RSTP::compareInterfacedata(), inet::STP::comparePorts(), inet::RSTP::contestInterfacedata(), inet::RSTP::getBestAlternate(), and inet::RSTP::printState().

{ return portData.portNum; }

unsigned int inet::Ieee8021dInterfaceData::getPortPriority ( ) const

inline

Referenced by inet::RSTP::compareInterfacedata(), inet::STP::comparePorts(), inet::RSTP::contestInterfacedata(), inet::RSTP::getBestAlternate(), inet::RSTP::handleBackup(), inet::RSTP::printState(), and inet::RSTP::processBetterSource().

{ return portData.portPriority; }

unsigned int inet::Ieee8021dInterfaceData::getPriority ( ) const

inline

Referenced by detailedInfo(), inet::operator<<(), inet::STP::selectDesignatedPorts(), and inet::STP::selectRootPort().

{ return portData.priority; }

PortRole inet::Ieee8021dInterfaceData::getRole ( ) const

inline

Referenced by inet::STP::checkTimers(), inet::RSTP::getBestAlternate(), inet::Ieee8021dRelay::handleAndDispatchFrame(), inet::STP::handleBPDU(), inet::RSTP::handleHelloTime(), inet::STP::handleTick(), inet::RSTP::handleUpgrade(), inet::operator<<(), inet::RSTP::processSameSource(), inet::RSTP::receiveSignal(), inet::RSTP::scheduleNextUpgrade(), inet::STP::selectDesignatedPorts(), inet::RSTP::sendBPDU(), inet::RSTP::sendBPDUs(), inet::RSTP::sendTCNtoRoot(), and inet::STP::setAllDesignated().

{ return portData.role; }

const char* inet::Ieee8021dInterfaceData::getRoleName ( ) const

inline

Referenced by detailedInfo(), getRoleName(), info(), inet::RSTP::printState(), and inet::STPBase::refreshDisplay().

{ return getRoleName(getRole()); }

const char * inet::Ieee8021dInterfaceData::getRoleName ( PortRole  role )

static

{
    switch (role) {
        case ALTERNATE:
            return "ALTERNATE";

        case NOTASSIGNED:
            return "NOTASSIGNED";

        case DISABLED:
            return "DISABLED";

        case DESIGNATED:
            return "DESIGNATED";

        case BACKUP:
            return "BACKUP";

        case ROOT:
            return "ROOT";

        default:
            throw cRuntimeError("Unknown port role %d", role);
    }
}

const MACAddress& inet::Ieee8021dInterfaceData::getRootAddress ( ) const

inline

Referenced by inet::STP::checkRootEligibility(), inet::RSTP::compareInterfacedata(), inet::STP::comparePorts(), inet::RSTP::contestInterfacedata(), inet::RSTP::getBestAlternate(), inet::RSTP::printState(), inet::STP::selectRootPort(), inet::RSTP::sendBPDU(), and inet::RSTP::sendTCNtoRoot().

{ return portData.rootAddress; }

unsigned int inet::Ieee8021dInterfaceData::getRootPathCost ( ) const

inline

Referenced by inet::RSTP::compareInterfacedata(), inet::STP::comparePorts(), inet::RSTP::contestInterfacedata(), inet::RSTP::getBestAlternate(), inet::RSTP::printState(), inet::STP::selectRootPort(), inet::RSTP::sendBPDU(), and inet::RSTP::sendTCNtoRoot().

{ return portData.rootPathCost; }

unsigned int inet::Ieee8021dInterfaceData::getRootPriority ( ) const

inline

Referenced by inet::STP::checkRootEligibility(), inet::RSTP::compareInterfacedata(), inet::STP::comparePorts(), inet::RSTP::contestInterfacedata(), inet::RSTP::getBestAlternate(), inet::RSTP::printState(), inet::STP::selectRootPort(), inet::RSTP::sendBPDU(), and inet::RSTP::sendTCNtoRoot().

{ return portData.rootPriority; }

PortState inet::Ieee8021dInterfaceData::getState ( ) const

inline

Referenced by inet::RSTP::checkTC(), inet::STP::checkTimers(), inet::RSTP::handleUpgrade(), inet::operator<<(), inet::RSTP::processBetterSource(), inet::RSTP::receiveSignal(), inet::STPBase::refreshDisplay(), and inet::RSTP::scheduleNextUpgrade().

{ return portData.state; }

const char* inet::Ieee8021dInterfaceData::getStateName ( ) const

inline

Referenced by detailedInfo(), getStateName(), info(), inet::RSTP::printState(), and inet::STPBase::refreshDisplay().

{ return getStateName(getState()); }

const char * inet::Ieee8021dInterfaceData::getStateName ( PortState  state )

static

{
    switch (state) {
        case DISCARDING:
            return "DISCARDING";

        case LEARNING:
            return "LEARNING";

        case FORWARDING:
            return "FORWARDING";

        default:
            throw cRuntimeError("Unknown port state %d", state);
    }
}

simtime_t inet::Ieee8021dInterfaceData::getTCWhile ( ) const

inline

Referenced by inet::RSTP::sendBPDU(), and inet::RSTP::sendTCNtoRoot().

{ return portData.TCWhile; }

std::string inet::Ieee8021dInterfaceData::info ( ) const

overridevirtual

{
    std::stringstream out;
    out << "role:" << getRoleName() << " state:" << getStateName();
    return out.str();
}

bool inet::Ieee8021dInterfaceData::isEdge ( ) const

inline

Referenced by inet::RSTP::handleHelloTime(), inet::RSTP::initPorts(), inet::RSTP::printState(), inet::RSTP::processBetterSource(), and inet::RSTP::sendBPDUs().

{ return portData.edge; }

bool inet::Ieee8021dInterfaceData::isForwarding ( ) const

inline

Referenced by inet::Ieee8021dRelay::handleAndDispatchFrame(), inet::STPTester::isForwarding(), and inet::operator<<().

{ return portData.state == FORWARDING; }

bool inet::Ieee8021dInterfaceData::isLearning ( ) const

inline

Referenced by inet::Ieee8021dRelay::learn(), and inet::operator<<().

{ return portData.state == LEARNING || portData.state == FORWARDING; }

void inet::Ieee8021dInterfaceData::setAge ( simtime_t  age )

inline

Referenced by inet::STP::handleTick(), inet::RSTP::initInterfacedata(), inet::STP::initInterfacedata(), inet::STP::setSuperiorBPDU(), and inet::RSTP::updateInterfacedata().

{ portData.age = age; }

void inet::Ieee8021dInterfaceData::setBridgeAddress ( const MACAddress &  bridgeAddress )

inline

Referenced by inet::RSTP::initInterfacedata(), inet::STP::initInterfacedata(), inet::STP::isSuperiorBPDU(), inet::STP::selectDesignatedPorts(), inet::STP::setSuperiorBPDU(), and inet::RSTP::updateInterfacedata().

{ portData.bridgeAddress = bridgeAddress; }

void inet::Ieee8021dInterfaceData::setBridgePriority ( unsigned int  bridgePriority )

inline

Referenced by inet::RSTP::initInterfacedata(), inet::STP::initInterfacedata(), inet::STP::isSuperiorBPDU(), inet::STP::selectDesignatedPorts(), inet::STP::setSuperiorBPDU(), and inet::RSTP::updateInterfacedata().

{ portData.bridgePriority = bridgePriority; }

void inet::Ieee8021dInterfaceData::setEdge ( bool  edge )

inline

Referenced by inet::L2NetworkConfigurator::configureInterface().

{ portData.edge = edge; }

void inet::Ieee8021dInterfaceData::setFdWhile ( simtime_t  fdWhile )

inline

Referenced by inet::STP::checkTimers(), inet::STP::handleTick(), and inet::STP::isSuperiorBPDU().

{ portData.fdWhile = fdWhile; }

void inet::Ieee8021dInterfaceData::setFwdDelay ( simtime_t  fwdDelay )

inline

Referenced by inet::STP::setSuperiorBPDU().

{ portData.fwdDelay = fwdDelay; }

void inet::Ieee8021dInterfaceData::setHelloTime ( simtime_t  helloTime )

inline

Referenced by inet::STP::setSuperiorBPDU().

{ portData.helloTime = helloTime; }

void inet::Ieee8021dInterfaceData::setLinkCost ( unsigned int  linkCost )

inline

Referenced by inet::L2NetworkConfigurator::configureInterface().

{ portData.linkCost = linkCost; }

void inet::Ieee8021dInterfaceData::setLostBPDU ( unsigned int  lostBPDU )

inline

Referenced by inet::RSTP::handleBackup(), inet::RSTP::handleHelloTime(), inet::RSTP::initInterfacedata(), inet::STP::initInterfacedata(), inet::RSTP::processBetterSource(), inet::RSTP::processSameSource(), and inet::RSTP::updateInterfacedata().

{ portData.lostBPDU = lostBPDU; }

void inet::Ieee8021dInterfaceData::setMaxAge ( simtime_t  maxAge )

inline

Referenced by inet::STP::setSuperiorBPDU().

{ portData.maxAge = maxAge; }

void inet::Ieee8021dInterfaceData::setNextUpgrade ( simtime_t  nextUpgrade )

inline

Referenced by inet::RSTP::handleHelloTime(), inet::RSTP::handleUpgrade(), inet::RSTP::initPorts(), inet::RSTP::processBetterSource(), inet::RSTP::processSameSource(), and inet::RSTP::receiveSignal().

{ portData.nextUpgrade = nextUpgrade; }

void inet::Ieee8021dInterfaceData::setPortNum ( unsigned int  portNum )

inline

Referenced by inet::RSTP::initInterfacedata(), inet::STP::initInterfacedata(), inet::STP::isSuperiorBPDU(), inet::STP::selectDesignatedPorts(), inet::STP::setSuperiorBPDU(), and inet::RSTP::updateInterfacedata().

{ portData.portNum = portNum; }

void inet::Ieee8021dInterfaceData::setPortPriority ( unsigned int  portPriority )

inline

Referenced by inet::RSTP::initInterfacedata(), inet::STP::initInterfacedata(), inet::STP::isSuperiorBPDU(), inet::STP::selectDesignatedPorts(), inet::STP::setSuperiorBPDU(), and inet::RSTP::updateInterfacedata().

{ portData.portPriority = portPriority; }

void inet::Ieee8021dInterfaceData::setPriority ( unsigned int  priority )

inline

Referenced by inet::L2NetworkConfigurator::configureInterface().

{ portData.priority = priority; }

void inet::Ieee8021dInterfaceData::setRole ( PortRole  role )

inline

Referenced by inet::RSTP::handleBackup(), inet::RSTP::handleHelloTime(), inet::RSTP::handleUpgrade(), inet::STP::initInterfacedata(), inet::RSTP::initPorts(), inet::RSTP::processBetterSource(), inet::RSTP::processSameSource(), inet::STP::selectDesignatedPorts(), inet::STP::selectRootPort(), and inet::STP::setAllDesignated().

{ portData.role = role; }

void inet::Ieee8021dInterfaceData::setRootAddress ( const MACAddress &  rootAddress )

inline

Referenced by inet::RSTP::initInterfacedata(), inet::STP::initInterfacedata(), inet::STP::isSuperiorBPDU(), inet::STP::selectDesignatedPorts(), inet::STP::setSuperiorBPDU(), and inet::RSTP::updateInterfacedata().

{ portData.rootAddress = rootAddress; }

void inet::Ieee8021dInterfaceData::setRootPathCost ( unsigned int  rootPathCost )

inline

Referenced by inet::RSTP::initInterfacedata(), inet::STP::initInterfacedata(), inet::STP::isSuperiorBPDU(), inet::STP::selectDesignatedPorts(), inet::STP::setSuperiorBPDU(), and inet::RSTP::updateInterfacedata().

{ portData.rootPathCost = rootPathCost; }

void inet::Ieee8021dInterfaceData::setRootPriority ( unsigned int  rootPriority )

inline

Referenced by inet::RSTP::initInterfacedata(), inet::STP::initInterfacedata(), inet::STP::isSuperiorBPDU(), inet::STP::selectDesignatedPorts(), inet::STP::setSuperiorBPDU(), and inet::RSTP::updateInterfacedata().

{ portData.rootPriority = rootPriority; }

void inet::Ieee8021dInterfaceData::setState ( PortState  state )

inline

Referenced by inet::STP::checkTimers(), inet::RSTP::handleBackup(), inet::RSTP::handleHelloTime(), inet::RSTP::handleUpgrade(), inet::STP::initInterfacedata(), inet::RSTP::initPorts(), inet::STP::isSuperiorBPDU(), inet::RSTP::processBetterSource(), and inet::RSTP::processSameSource().

{ portData.state = state; }

void inet::Ieee8021dInterfaceData::setTCWhile ( simtime_t  TCWhile )

inline

Referenced by inet::RSTP::checkTC(), inet::RSTP::flushOtherPorts(), and inet::RSTP::processBetterSource().

{ portData.TCWhile = TCWhile; }

Member Data Documentation

PortInfo inet::Ieee8021dInterfaceData::portData

protected

---

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

• Ieee8021dInterfaceData.h
• Ieee8021dInterfaceData.cc