ATSIeee8021qFilter

Package: inet.linklayer.ieee8021q

ATSIeee8021qFilter

compound module

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

This module is part of the asynchronous shaper infrastructure.

<b>See also:</b> ~EligibilityTimeGate, ~GroupEligibilityTimeMeter, ~EligibilityTimeFilter, ~EligibilityTimeQueue, ~EligibilityTimeTag

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"); } groupEligibilityTimeTable : GroupEligibilityTimeTable Source: groupEligibilityTimeTable: GroupEligibilityTimeTable { @display("p=43,30"); }

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.

Extends

Name Type Description
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.

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
groupEligibilityTimeTable.displayStringTextFormat string ""

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

Source code

// Implements a filtering module for the asynchronous traffic shaper
// taking scheduler groups into account.
//
// This module is part of the asynchronous shaper infrastructure.
//
// @see ~EligibilityTimeGate, ~GroupEligibilityTimeMeter, ~EligibilityTimeFilter, ~EligibilityTimeQueue, ~EligibilityTimeTag
//
module ATSIeee8021qFilter extends SimpleIeee8021qFilter
{
    parameters:
        **.groupEligibilityTimeTableModule = default(absPath(".groupEligibilityTimeTable"));

        meter[*].typename = "GroupEligibilityTimeMeter";
        filter[*].typename = "EligibilityTimeFilter";

    submodules:
        groupEligibilityTimeTable: GroupEligibilityTimeTable {
            @display("p=43,30");
        }
}
File: src/inet/linklayer/ieee8021q/ATSIeee8021qFilter.ned

This documentation is released under the Creative Commons license