SimpleIeee8021qFilter

Package: inet.linklayer.ieee8021q

SimpleIeee8021qFilter

compound module

Implements a simplified version of the IEEE 802.1Q per-stream filtering and policing. Each filtered stream has its own path where metering and filtering happens independently of any other stream.

classifier : like IPacketClassifier

StreamClassifier: Classifies packets based on the stream they are part of.

IPacketClassifier: Interface for packet classifier modules.

Source:
classifier: <default("StreamClassifier")> like IPacketClassifier {
    gateIndexOffset = default(parent.hasDefaultPath ? 1 : 0);
    defaultGateIndex = default(parent.hasDefaultPath ? 0 : -1);
    @display("p=100,100");
} gateFilter[numStreams] : like IPacketFilter

BackPressureBasedFilter: Implements a packet filter that drops packets when the following module (consumer) does not allow...

IPacketFilter: Interface for packet filter modules.

Source:
gateFilter[numStreams]: <default("BackPressureBasedFilter")> like IPacketFilter {
    @display("p=300,$startY,column,150");
} gate[numStreams] : like IPacketGate

InteractiveGate: This packet gate module allows or forbids packets to pass through depending on whether the gate is...

IPacketGate: Interface for a packet gate.

Source:
gate[numStreams]: <default("InteractiveGate")> like IPacketGate {
    @display("p=500,$startY,column,150");
} meter[numStreams] : like IPacketMeter

DualRateThreeColorMeter: This packet meter module measures the packet flow that is passing through using two token buckets.

IPacketMeter: Interface for packet meter modules.

Source:
meter[numStreams]: <default("DualRateThreeColorMeter")> like IPacketMeter {
    @display("p=700,$startY,column,150");
} filter[numStreams] : like IPacketFilter

LabelFilter: This packet filter module drops packets that don't match the given packet label filter criteria.

IPacketFilter: Interface for packet filter modules.

Source:
filter[numStreams]: <default("LabelFilter")> like IPacketFilter {
    labelFilter = default("green");
    @display("p=900,$startY,column,150");
} multiplexer : PacketMultiplexer

Connects multiple packet producers to one packet consumer.

Source:
multiplexer: PacketMultiplexer {
    @display("p=1100,100");
} barrier : BackPressureBarrier

Prevents backpressure propagation from its output to its input and vice versa.

Source:
barrier: BackPressureBarrier {
    @display("p=1300,100");
}

Usage diagram

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram.

Inheritance diagram

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.

Known subclasses

Name Type Description
ATSIeee8021qFilter compound module

Implements a filtering module for the asynchronous traffic shaper taking scheduler groups into account.

Parameters

Name Type Default value Description
numStreams int 0

Number of different streams to filter for

hasDefaultPath bool true

Specifies if the non-filtered direct path should exist

startY int hasDefaultPath ? 200 : 100

Properties

Name Value Description
display i=block/filter

Gates

Name Direction Size Description
in input
out output

Unassigned submodule parameters

Name Type Default value Description
multiplexer.displayStringTextFormat string "passed %p pk (%l)"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information

multiplexer.forwardServiceRegistration bool true
multiplexer.forwardProtocolRegistration bool true
barrier.displayStringTextFormat string "passed %p pk (%l)"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information

Source code

//
// Implements a simplified version of the IEEE 802.1Q per-stream
// filtering and policing. Each filtered stream has its own path where metering
// and filtering happens independently of any other stream.
//
module SimpleIeee8021qFilter like IPacketFilter
{
    parameters:
        int numStreams = default(0); // Number of different streams to filter for
        bool hasDefaultPath = default(true); // Specifies if the non-filtered direct path should exist
        int startY = default(hasDefaultPath ? 200 : 100);
        @display("i=block/filter");
    gates:
        input in;
        output out;
    submodules:
        classifier: <default("StreamClassifier")> like IPacketClassifier {
            gateIndexOffset = default(parent.hasDefaultPath ? 1 : 0);
            defaultGateIndex = default(parent.hasDefaultPath ? 0 : -1);
            @display("p=100,100");
        }
        gateFilter[numStreams]: <default("BackPressureBasedFilter")> like IPacketFilter {
            @display("p=300,$startY,column,150");
        }
        gate[numStreams]: <default("InteractiveGate")> like IPacketGate {
            @display("p=500,$startY,column,150");
        }
        meter[numStreams]: <default("DualRateThreeColorMeter")> like IPacketMeter {
            @display("p=700,$startY,column,150");
        }
        filter[numStreams]: <default("LabelFilter")> like IPacketFilter {
            labelFilter = default("green");
            @display("p=900,$startY,column,150");
        }
        multiplexer: PacketMultiplexer {
            @display("p=1100,100");
        }
        barrier: BackPressureBarrier {
            @display("p=1300,100");
        }
    connections:
        in --> { @display("m=w"); } --> classifier.in;
        classifier.out++ --> multiplexer.in++ if hasDefaultPath;
        for i=0..numStreams-1 {
            classifier.out++ --> gateFilter[i].in;
            gateFilter[i].out --> gate[i].in;
            gate[i].out --> meter[i].in;
            meter[i].out --> filter[i].in;
            filter[i].out --> multiplexer.in++;
        }
        multiplexer.out --> barrier.in;
        barrier.out --> { @display("m=e"); } --> out;
}
File: src/inet/linklayer/ieee8021q/SimpleIeee8021qFilter.ned