inet::EthernetCutthroughSource Class Reference

#include <EthernetCutthroughSource.h>

Inheritance diagram for inet::EthernetCutthroughSource:

Public Member Functions
virtual	~EthernetCutthroughSource ()
virtual void	pushPacketStart (Packet *packet, cGate *gate, bps datarate) override
	Starts pushing the packet into the packet sink at the given gate. More...
virtual void	pushPacketEnd (Packet *packet, cGate *gate) override
	Ends pushing the packet into the packet sink at the given gate. More...
Public Member Functions inherited from inet::PacketDestreamer
virtual	~PacketDestreamer ()
virtual IPassivePacketSink *	getConsumer (cGate *gate) override
	Returns the passive packet sink where packets are pushed or nullptr if the connected module doesn't implement the interface. More...
virtual IPassivePacketSource *	getProvider (cGate *gate) override
	Returns the passive packet source from where packets are pulled or nullptr if the connected module doesn't implement the interface. More...
virtual bool	supportsPacketPushing (cGate *gate) const override
	Returns true if the processor supports pushing packets at the given gate. More...
virtual bool	supportsPacketPulling (cGate *gate) const override
	Returns true if the processor supports pulling packets at the given gate. More...
virtual bool	supportsPacketPassing (cGate *gate) const override
	Returns true if the processor supports passing packets as a whole at the given gate. More...
virtual bool	supportsPacketStreaming (cGate *gate) const override
	Returns true if the processor supports streaming packets at the given gate. More...
virtual bool	canPushSomePacket (cGate *gate) const override
	Returns false if the packet sink is full at the given gate and no more packets can be pushed into it without raising an error. More...
virtual bool	canPushPacket (Packet *packet, cGate *gate) const override
	Returns true if the given packet can be pushed at the given gate into the packet sink without raising an error. More...
virtual void	pushPacket (Packet *packet, cGate *gate) override
	Pushes the packet into the packet sink at the given gate. More...
virtual void	pushPacketProgress (Packet *packet, cGate *gate, bps datarate, b position, b extraProcessableLength=b(0)) override
	Progresses pushing the packet into the packet sink at the given gate. More...
virtual void	handleCanPushPacketChanged (cGate *gate) override
	Notifies about a change in the possibility of pushing some packet into the passive packet sink at the given gate. More...
virtual void	handlePushPacketProcessed (Packet *packet, cGate *gate, bool successful) override
	Notifies about the completion of the packet processing for a packet that was pushed earlier independently whether the packet is passed or streamed. More...
virtual bool	canPullSomePacket (cGate *gate) const override
	Returns false if the packet source is empty at the given gate and no more packets can be pulled from it without raising an error. More...
virtual Packet *	canPullPacket (cGate *gate) const override
	Returns the packet that can be pulled at the given gate. More...
virtual Packet *	pullPacket (cGate *gate) override
	Pulls the packet from the packet source at the given gate. More...
virtual Packet *	pullPacketStart (cGate *gate, bps datarate) override
	Starts pulling the packet from the packet source at the given gate. More...
virtual Packet *	pullPacketEnd (cGate *gate) override
	Ends pulling the packet from the packet source at the given gate. More...
virtual Packet *	pullPacketProgress (cGate *gate, bps datarate, b position, b extraProcessableLength) override
	Progresses pulling the packet from the packet source at the given gate. More...
virtual void	handlePullPacketProcessed (Packet *packet, cGate *gate, bool successful) override
	Notifies about the completion of the packet processing for a packet that was pulled earlier independently whether the packet is passed or streamed. More...
virtual void	handleCanPullPacketChanged (cGate *gate) override
	Notifies about a change in the possibility of pulling some packet from the passive packet source at the given gate. More...
Public Member Functions inherited from inet::queueing::PacketProcessorBase
virtual bool	supportsPacketSending (cGate *gate) const override
	Returns true if the processor supports sending packets at the given gate. More...
virtual const char *	resolveDirective (char directive) const override
Public Member Functions inherited from inet::queueing::IPacketProcessor
virtual	~IPacketProcessor ()
Public Member Functions inherited from inet::queueing::IPassivePacketSink
virtual	~IPassivePacketSink ()
Public Member Functions inherited from inet::queueing::IActivePacketSink
virtual	~IActivePacketSink ()
Public Member Functions inherited from inet::queueing::IPassivePacketSource
virtual	~IPassivePacketSource ()
Public Member Functions inherited from inet::queueing::IActivePacketSource
virtual	~IActivePacketSource ()

Protected Member Functions
virtual void	initialize (int stage) override
virtual void	handleMessage (cMessage *message) override
Protected Member Functions inherited from inet::PacketDestreamer
virtual bool	isStreaming () const
Protected Member Functions inherited from inet::queueing::PacketProcessorBase
virtual int	numInitStages () const override
virtual void	refreshDisplay () const override
virtual void	handlePacketProcessed (Packet *packet)
virtual void	checkPacketOperationSupport (cGate *gate) const
virtual void	checkPacketOperationSupport (cGate *startGate, cGate *endGate) const
virtual void	animate (Packet *packet, cGate *gate, const SendOptions &sendOptions, Action action) const
virtual void	animatePacket (Packet *packet, cGate *gate, Action action) const
virtual void	animatePacketStart (Packet *packet, cGate *gate, bps datarate, long transmissionId, Action action) const
virtual void	animatePacketStart (Packet *packet, cGate *gate, bps datarate, const SendOptions &sendOptions, Action action) const
virtual void	animatePacketEnd (Packet *packet, cGate *gate, long transmissionId, Action action) const
virtual void	animatePacketEnd (Packet *packet, cGate *gate, const SendOptions &sendOptions, Action action) const
virtual void	animatePacketProgress (Packet *packet, cGate *gate, bps datarate, b position, b extraProcessableLength, long transmissionId, Action action) const
virtual void	animatePacketProgress (Packet *packet, cGate *gate, bps datarate, b position, b extraProcessableLength, const SendOptions &sendOptions, Action action) const
virtual void	pushOrSendPacket (Packet *packet, cGate *gate, IPassivePacketSink *consumer)
virtual void	pushOrSendPacketStart (Packet *packet, cGate *gate, IPassivePacketSink *consumer, bps datarate, int transmissionId)
virtual void	pushOrSendPacketEnd (Packet *packet, cGate *gate, IPassivePacketSink *consumer, int transmissionId)
virtual void	pushOrSendPacketProgress (Packet *packet, cGate *gate, IPassivePacketSink *consumer, bps datarate, b position, b extraProcessableLength, int transmissionId)
virtual void	animatePush (Packet *packet, cGate *gate, const SendOptions &sendOptions) const
virtual void	animatePushPacket (Packet *packet, cGate *gate) const
virtual void	animatePushPacketStart (Packet *packet, cGate *gate, bps datarate, long transmissionId) const
virtual void	animatePushPacketStart (Packet *packet, cGate *gate, bps datarate, const SendOptions &sendOptions) const
virtual void	animatePushPacketEnd (Packet *packet, cGate *gate, long transmissionId) const
virtual void	animatePushPacketEnd (Packet *packet, cGate *gate, const SendOptions &sendOptions) const
virtual void	animatePushPacketProgress (Packet *packet, cGate *gate, bps datarate, b position, b extraProcessableLength, long transmissionId) const
virtual void	animatePushPacketProgress (Packet *packet, cGate *gate, bps datarate, b position, b extraProcessableLength, const SendOptions &sendOptions) const
virtual void	animatePull (Packet *packet, cGate *gate, const SendOptions &sendOptions) const
virtual void	animatePullPacket (Packet *packet, cGate *gate) const
virtual void	animatePullPacketStart (Packet *packet, cGate *gate, bps datarate, long transmissionId) const
virtual void	animatePullPacketStart (Packet *packet, cGate *gate, bps datarate, const SendOptions &sendOptions) const
virtual void	animatePullPacketEnd (Packet *packet, cGate *gate, long transmissionId) const
virtual void	animatePullPacketEnd (Packet *packet, cGate *gate, const SendOptions &sendOptions) const
virtual void	animatePullPacketProgress (Packet *packet, cGate *gate, bps datarate, b position, b extraProcessableLength, long transmissionId) const
virtual void	animatePullPacketProgress (Packet *packet, cGate *gate, bps datarate, b position, b extraProcessableLength, const SendOptions &sendOptions) const
virtual void	dropPacket (Packet *packet, PacketDropReason reason, int limit=-1)
virtual void	updateDisplayString () const

Protected Attributes
cGate *	cutthroughOutputGate = nullptr
ModuleRef< IPassivePacketSink >	cutthroughConsumer
NetworkInterface *	networkInterface = nullptr
ModuleRefByPar< IMacForwardingTable >	macForwardingTable
bool	cutthroughInProgress = false
cMessage *	cutthroughTimer = nullptr
Protected Attributes inherited from inet::PacketDestreamer
bps	datarate
cGate *	inputGate = nullptr
IActivePacketSource *	producer = nullptr
IPassivePacketSource *	provider = nullptr
cGate *	outputGate = nullptr
IPassivePacketSink *	consumer = nullptr
IActivePacketSink *	collector = nullptr
bps	streamDatarate = bps(NaN)
Packet *	streamedPacket = nullptr
Protected Attributes inherited from inet::queueing::PacketProcessorBase
const char *	displayStringTextFormat = nullptr
int	numProcessedPackets = -1
b	processedTotalLength = b(-1)

Additional Inherited Members
Protected Types inherited from inet::queueing::PacketProcessorBase
enum	Action { PUSH, PULL }

Constructor & Destructor Documentation

~EthernetCutthroughSource()

virtual inet::EthernetCutthroughSource::~EthernetCutthroughSource ( )

inlinevirtual

{ cancelAndDelete(cutthroughTimer); }

Member Function Documentation

handleMessage()

void inet::EthernetCutthroughSource::handleMessage ( cMessage *  message )

overrideprotectedvirtual

Reimplemented from inet::PacketDestreamer.

{
    if (message == cutthroughTimer) {
        const auto& header = streamedPacket->peekAtFront<EthernetMacAddressFields>();
        auto sourceAddress = header->getSrc();
        auto destinationAddress = header->getDest();
        if (!sourceAddress.isMulticast())
            macForwardingTable->learnUnicastAddressForwardingInterface(networkInterface->getInterfaceId(), sourceAddress);
        int interfaceId = destinationAddress.isMulticast() ? -1 : macForwardingTable->getUnicastAddressForwardingInterface(destinationAddress);
        if (interfaceId != -1 && cutthroughConsumer->canPushPacket(streamedPacket, cutthroughOutputGate)) {
            streamedPacket->trim();
            streamedPacket->addTag<InterfaceReq>()->setInterfaceId(interfaceId);
            streamedPacket->addTagIfAbsent<DirectionTag>()->setDirection(DIRECTION_OUTBOUND);
            streamedPacket->removeTagIfPresent<DispatchProtocolReq>();
            EV_INFO << "Starting streaming packet " << streamedPacket->getName() << "." << std::endl;
            pushOrSendPacketStart(streamedPacket, cutthroughOutputGate, cutthroughConsumer, streamDatarate, streamedPacket->getTransmissionId());
            streamedPacket = nullptr;
            cutthroughInProgress = true;
            updateDisplayString();
        }
        else
            PacketDestreamer::pushPacketStart(streamedPacket, outputGate, streamDatarate);
    }
    else
        PacketDestreamer::handleMessage(message);
}

initialize()

void inet::EthernetCutthroughSource::initialize ( int  stage )

overrideprotectedvirtual

Reimplemented from inet::PacketDestreamer.

{
    PacketDestreamer::initialize(stage);
    if (stage == INITSTAGE_LOCAL) {
        cutthroughOutputGate = gate("cutthroughOut");
        cutthroughConsumer.reference(cutthroughOutputGate, false);
        networkInterface = getContainingNicModule(this);
        macForwardingTable.reference(this, "macTableModule", true);
        cutthroughTimer = new cMessage("CutthroughTimer");
    }
}

pushPacketEnd()

void inet::EthernetCutthroughSource::pushPacketEnd ( Packet *  packet, cGate *  gate  )

overridevirtual

Ends pushing the packet into the packet sink at the given gate.

This is a packet streaming operation. The onwership of the packet is transferred to the sink.

Packet streaming can be started with any of the streaming operations, and ends when the streaming position plus the extra processable packet length equals to the total packet length.

This method is called, for example, when a preemption supporting server module ends streaming a packet to the sink.

The sink must not be full at the gate and no other packet streaming can be in progress. The packet must not be nullptr. The gate must be a valid gate of this module and it must support pushing and streaming packets.

Reimplemented from inet::PacketDestreamer.

{
    if (cutthroughInProgress) {
        Enter_Method("pushPacketEnd");
        take(packet);
        const auto& header = packet->peekAtFront<EthernetMacAddressFields>();
        auto sourceAddress = header->getSrc();
        auto destinationAddress = header->getDest();
        if (!sourceAddress.isMulticast())
            macForwardingTable->learnUnicastAddressForwardingInterface(networkInterface->getInterfaceId(), sourceAddress);
        packet->trim();
        int interfaceId = destinationAddress.isMulticast() ? -1 : macForwardingTable->getUnicastAddressForwardingInterface(destinationAddress);
        if (interfaceId != -1)
            packet->addTag<InterfaceReq>()->setInterfaceId(interfaceId);
        packet->addTagIfAbsent<DirectionTag>()->setDirection(DIRECTION_OUTBOUND);
        packet->removeTagIfPresent<DispatchProtocolReq>();
        delete streamedPacket;
        streamedPacket = packet;
        streamDatarate = datarate;
        EV_INFO << "Ending streaming packet " << streamedPacket->getName() << "." << std::endl;
        pushOrSendPacketEnd(streamedPacket, cutthroughOutputGate, cutthroughConsumer, streamedPacket->getTransmissionId());
        streamedPacket = nullptr;
        cutthroughInProgress = false;
        updateDisplayString();
    }
    else
        PacketDestreamer::pushPacketEnd(packet, gate);
}

pushPacketStart()

void inet::EthernetCutthroughSource::pushPacketStart ( Packet *  packet, cGate *  gate, bps  datarate  )

overridevirtual

Starts pushing the packet into the packet sink at the given gate.

This is a packet streaming operation. The onwership of the packet is transferred to the sink.

Packet streaming can be started with any of the streaming operations, and ends when the streaming position plus the extra processable packet length equals to the total packet length.

This method is called, for example, when a preemption supporting server module starts streaming a packet to the sink.

The sink must not be full at the gate and no other packet streaming can be in progress. The packet must not be nullptr. The gate must be a valid gate of this module and it must support pushing and streaming packets.

Reimplemented from inet::PacketDestreamer.

{
    Enter_Method("pushPacketStart");
    take(packet);
    b cutthroughPosition = PREAMBLE_BYTES + SFD_BYTES + ETHER_MAC_HEADER_BYTES;
    simtime_t delay = s(cutthroughPosition / datarate).get();
    scheduleAt(simTime() + delay, cutthroughTimer);
    delete streamedPacket;
    streamedPacket = packet;
    streamDatarate = datarate;
    updateDisplayString();
}

Member Data Documentation

cutthroughConsumer

ModuleRef<IPassivePacketSink> inet::EthernetCutthroughSource::cutthroughConsumer

protected

Referenced by handleMessage(), initialize(), and pushPacketEnd().

cutthroughInProgress

bool inet::EthernetCutthroughSource::cutthroughInProgress = false

protected

Referenced by handleMessage(), and pushPacketEnd().

cutthroughOutputGate

cGate* inet::EthernetCutthroughSource::cutthroughOutputGate = nullptr

protected

Referenced by handleMessage(), initialize(), and pushPacketEnd().

cutthroughTimer

cMessage* inet::EthernetCutthroughSource::cutthroughTimer = nullptr

protected

Referenced by handleMessage(), initialize(), and pushPacketStart().

macForwardingTable

ModuleRefByPar<IMacForwardingTable> inet::EthernetCutthroughSource::macForwardingTable

protected

Referenced by handleMessage(), initialize(), and pushPacketEnd().

networkInterface

NetworkInterface* inet::EthernetCutthroughSource::networkInterface = nullptr

protected

Referenced by handleMessage(), initialize(), and pushPacketEnd().

---

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

• EthernetCutthroughSource.h
• EthernetCutthroughSource.cc