inet::PacketDissector::PduTreeBuilder Class Reference

#include <PacketDissector.h>

Inheritance diagram for inet::PacketDissector::PduTreeBuilder:

Public Member Functions
bool	isSimplyEncapsulatedPacket () const
const Ptr< ProtocolDataUnit > &	getTopLevelPdu () const
const Ptr< Chunk > &	getRemainingJunk () const
virtual bool	shouldDissectProtocolDataUnit (const Protocol *protocol) override
	True means the packet dissector should recursively process the PDU. More...
virtual void	startProtocolDataUnit (const Protocol *protocol) override
	Notifies about the start of a new protocol data unit (PDU). More...
virtual void	endProtocolDataUnit (const Protocol *protocol) override
	Notifies about the end of the current protocol data unit (PDU). More...
virtual void	markIncorrect () override
	Marks the current protocol data unit as incorrect (e.g. More...
virtual void	visitChunk (const Ptr< const Chunk > &chunk, const Protocol *protocol) override
	Notifies about a new chunk in the current protocol data unit (PDU). More...

Protected Attributes
bool	isEndProtocolDataUnitCalled = false
bool	isSimplyEncapsulatedPacket_ = true
Ptr< ProtocolDataUnit >	topLevelPdu = nullptr
Ptr< Chunk >	remainingJunk = nullptr
std::stack< ProtocolDataUnit * >	pduLevels

Member Function Documentation

endProtocolDataUnit()

void inet::PacketDissector::PduTreeBuilder::endProtocolDataUnit ( const Protocol *  protocol )

overridevirtual

Notifies about the end of the current protocol data unit (PDU).

Implements inet::PacketDissector::ICallback.

{
    isEndProtocolDataUnitCalled = true;
    pduLevels.pop();
}

getRemainingJunk()

const Ptr<Chunk>& inet::PacketDissector::PduTreeBuilder::getRemainingJunk ( ) const

inline

{ return remainingJunk; }

getTopLevelPdu()

const Ptr<ProtocolDataUnit>& inet::PacketDissector::PduTreeBuilder::getTopLevelPdu ( ) const

inline

{ return topLevelPdu; }

Referenced by inet::PacketPrinter::printPacket().

isSimplyEncapsulatedPacket()

bool inet::PacketDissector::PduTreeBuilder::isSimplyEncapsulatedPacket ( ) const

inline

{ return isSimplyEncapsulatedPacket_; }

Referenced by inet::PacketPrinter::printPacket().

markIncorrect()

void inet::PacketDissector::PduTreeBuilder::markIncorrect ( )

overridevirtual

Marks the current protocol data unit as incorrect (e.g.

bad CRC/FCS, incorrect length field, bit error).

Implements inet::PacketDissector::ICallback.

{
    pduLevels.top()->markIncorrect();
}

shouldDissectProtocolDataUnit()

virtual bool inet::PacketDissector::PduTreeBuilder::shouldDissectProtocolDataUnit ( const Protocol *  protocol )

inlineoverridevirtual

True means the packet dissector should recursively process the PDU.

When false, start and end notifications and one visit chunk are still generated.

Implements inet::PacketDissector::ICallback.

{ return true; }

startProtocolDataUnit()

void inet::PacketDissector::PduTreeBuilder::startProtocolDataUnit ( const Protocol *  protocol )

overridevirtual

Notifies about the start of a new protocol data unit (PDU).

Implements inet::PacketDissector::ICallback.

{
    if (isEndProtocolDataUnitCalled)
        isSimplyEncapsulatedPacket_ = false;
    auto level = makeShared<ProtocolDataUnit>(pduLevels.size(), protocol);
    if (pduLevels.size() == 0) {
        if (topLevelPdu == nullptr)
            topLevelPdu = level;
        else if (remainingJunk == nullptr)
            remainingJunk = level;
        else
            throw cRuntimeError("Invalid state");
    }
    else
        pduLevels.top()->insert(level);
    pduLevels.push(level.get());
}

visitChunk()

void inet::PacketDissector::PduTreeBuilder::visitChunk ( const Ptr< const Chunk > &  chunk, const Protocol *  protocol  )

overridevirtual

Notifies about a new chunk in the current protocol data unit (PDU).

Implements inet::PacketDissector::ICallback.

{
    pduLevels.top()->insert(chunk);
}

Member Data Documentation

isEndProtocolDataUnitCalled

bool inet::PacketDissector::PduTreeBuilder::isEndProtocolDataUnitCalled = false

protected

isSimplyEncapsulatedPacket_

bool inet::PacketDissector::PduTreeBuilder::isSimplyEncapsulatedPacket_ = true

protected

pduLevels

std::stack<ProtocolDataUnit *> inet::PacketDissector::PduTreeBuilder::pduLevels

protected

remainingJunk

Ptr<Chunk> inet::PacketDissector::PduTreeBuilder::remainingJunk = nullptr

protected

topLevelPdu

Ptr<ProtocolDataUnit> inet::PacketDissector::PduTreeBuilder::topLevelPdu = nullptr

protected

---

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

• PacketDissector.h
• PacketDissector.cc