inet::ProtocolMapping Class Reference

Maps protocol numbers to output gates. More...

#include <ProtocolMap.h>

Classes
struct	Entry

Public Member Functions
	ProtocolMapping ()
	~ProtocolMapping ()
void	addProtocolMapping (int protocol, int gateIndex)
void	parseProtocolMapping (const char *s)
int	findOutputGateForProtocol (int protocol) const
	find output gate index for protocol ID and returns it. More...
int	getOutputGateForProtocol (int protocol) const
	find output gate index for protocol ID and returns it. More...

Protected Types
typedef std::vector< Entry >	Entries

Protected Attributes
Entries	entries

Detailed Description

Maps protocol numbers to output gates.

Member Typedef Documentation

typedef std::vector<Entry> inet::ProtocolMapping::Entries

protected

Constructor & Destructor Documentation

inet::ProtocolMapping::ProtocolMapping ( )

inline

{}

inet::ProtocolMapping::~ProtocolMapping ( )

inline

{}

Member Function Documentation

void inet::ProtocolMapping::addProtocolMapping	(	int	protocol,
		int	gateIndex
	)

Referenced by inet::GenericNetworkProtocol::handleMessage(), inet::IPv6::handleMessage(), inet::IPv4::handleMessage(), and inet::NetworkProtocolBase::handleUpperCommand().

{
    int registered = findOutputGateForProtocol(protocol);
    if (registered == -2)
        entries.push_back(Entry(protocol, gateIndex));
    else if (registered == gateIndex)
        EV_WARN << "The protocol " << protocol << " already registered to gate index=" << gateIndex << endl;
    else
        throw cRuntimeError("The protocol %d should not register to gate index=%d because it already registered to gate index=%d.", protocol, gateIndex, registered);
}

int inet::ProtocolMapping::findOutputGateForProtocol

(

int

protocol

)

const

find output gate index for protocol ID and returns it.

Returns -2 if not found.

Referenced by addProtocolMapping(), getOutputGateForProtocol(), inet::IPv6::localDeliver(), inet::IPv4::reassembleAndDeliverFinish(), and inet::GenericNetworkProtocol::sendDatagramToHL().

{
    for (const auto & elem : entries)
        if (elem.protocolNumber == protocol)
            return elem.outGateIndex;


    return -2;    // illegal gateindex
}

int inet::ProtocolMapping::getOutputGateForProtocol

(

int

protocol

)

const

find output gate index for protocol ID and returns it.

Throws an error if not found.

Referenced by inet::IPv4::handleIncomingICMP(), inet::IPv6::handleReceivedICMP(), inet::IPv4::sendOnTransportOutGateByProtocolId(), and inet::NetworkProtocolBase::sendUp().

{
    int ret = findOutputGateForProtocol(protocol);
    if (ret >= -1)
        return ret;
    throw cRuntimeError("No output gate defined in protocolMapping for protocol number %d", protocol);
}

void inet::ProtocolMapping::parseProtocolMapping

(

const char *

s

)

{
    while (isspace(*s))
        s++;

    while (*s) {
        Entry entry(-1, -1);

        if (!isdigit(*s))
            throw cRuntimeError("Syntax error: protocol number expected");
        entry.protocolNumber = atoi(s);
        while (isdigit(*s))
            s++;

        if (*s++ != ':')
            throw cRuntimeError("Syntax error: colon expected");

        while (isspace(*s))
            s++;
        if (!isdigit(*s))
            throw cRuntimeError("Syntax error in script: output gate index expected");
        entry.outGateIndex = atoi(s);
        while (isdigit(*s))
            s++;

        // add
        entries.push_back(entry);

        // skip delimiter
        while (isspace(*s))
            s++;
        if (!*s)
            break;
        if (*s++ != ',')
            throw cRuntimeError("Syntax error: comma expected");
        while (isspace(*s))
            s++;
    }
}

Member Data Documentation

Entries inet::ProtocolMapping::entries

protected

Referenced by addProtocolMapping(), findOutputGateForProtocol(), and parseProtocolMapping().

---

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

• ProtocolMap.h
• ProtocolMap.cc