IPacketFlow

module interface

This module interface is implemented by packet flows. A packet flow connects one input to one output. It can operate in both active and passive mode. Packets can be pushed into its input or packets can be pulled from its output. Packets are never dropped but the contents and/or attached meta information may be altered.

Inheritance diagram

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

Implemented by

Name	Type	Description
ContentBasedFilter	simple module	This module filters for packets matching the configured filter criteria. When the filter is pushed by a connected packet producer, it either pushes the packet to the connected packet consumer or drops it depending on the configured packet filter. Similarily, when the filter is pulled by a connected packet collector, it pulls packets from the connected packet provider until it finds one which matches the configured packet filter.
ContentBasedLabeler	simple module	This module attaches various request labels to packets.
ContentBasedTagger	simple module	This module attaches various request tags to packets.
CutthroughSink	simple module	(no description)
CutthroughSource	simple module	(no description)
DualIeee8021qFilter	compound module	This module combines two meters and their corresponding filters per path. This is primarily useful for combining a token bucket based metering with an asynchronous packet shaper. Note that the asynchronous packet shaper also has parts in the network interface queue module.
DualRateThreeColorMeter	simple module	This packet meter module measures the packet flow that is passing through using two token buckets. The meter attaches a LabelsTag to each packet with either green, yellow or red color depending on which token bucket contains the required number of tokens for the packet.
EligibilityTimeFilter	simple module	This module is a packet filter that operates based on the EligibilityTimeTag attached to the packet that is passing through. Packets are dropped if the tag is missing. If the maxResidenceTime parameter is set, then the filter also drops the packets for which the eligibility time in the attached EligibilityTimeTag is greater than the current simulation time plus the maximum residence time.
EligibilityTimeMeter	simple module	This module is a packet meter which measures the packet flow that is passing through and optionally attaches an EligibilityTimeTag to the packets. The tag contains the calculated simulation time when the packet becomes eligibile for transmission according to the asynchronous shaper algorithm.
EthernetAddressChecker	simple module	(no description)
EthernetAddressInserter	simple module	(no description)
EthernetCutthroughSink	simple module	(no description)
EthernetCutthroughSource	simple module	(no description)
EthernetFcsChecker	simple module	(no description)
EthernetFcsInserter	simple module	(no description)
EthernetFragmentFcsChecker	simple module	(no description)
EthernetFragmentFcsInserter	simple module	(no description)
EthernetFragmentPhyHeaderChecker	simple module	(no description)
EthernetFragmentPhyHeaderInserter	simple module	(no description)
EthernetMacHeaderChecker	simple module	(no description)
EthernetMacHeaderInserter	simple module	(no description)
EthernetPhyHeaderChecker	simple module	(no description)
EthernetPhyHeaderInserter	simple module	(no description)
EthernetSocketCommandProcessor	simple module	(no description)
EthernetSocketPacketProcessor	simple module	(no description)
EthernetTypeOrLengthChecker	simple module	(no description)
EthernetTypeOrLengthInserter	simple module	(no description)
ExponentialRateMeter	simple module	This module attaches a RateTag to each packet specifying the datarate and packetrate of the received stream of packets. The algorithm takes older packets into account with an exponentially decreasing weight.
FlowMeasurementRecorder	simple module	This module is part of the flow measurement infrastructure. It can be used to record the collected statistics and also to terminate the flow measurements.
FlowMeasurementStarter	simple module	(no description)
Ieee8021qFilter	compound module	This module implements the IEEE 802.1Q per-stream filtering and policing. The relationship between streams, gates and meters is not one-to-one. The number of streams, gates and meters can be different and the module will take care about the connections between the submodules based on the streamFilterTable parameter.
Ieee8021qSocketCommandProcessor	simple module	(no description)
Ieee8021qSocketPacketProcessor	simple module	(no description)
Ieee8021qTagEpdHeaderChecker	simple module	(no description)
Ieee8021qTagEpdHeaderInserter	simple module	(no description)
Ieee8021qTagTpidHeaderChecker	simple module	(no description)
Ieee8021qTagTpidHeaderInserter	simple module	(no description)
Ieee8021rTagEpdHeaderChecker	simple module	(no description)
Ieee8021rTagEpdHeaderInserter	simple module	(no description)
Ieee8022LlcSocketCommandProcessor	simple module	(no description)
Ieee8022LlcSocketPacketProcessor	simple module	(no description)
LabelFilter	simple module	This packet filter module drops packets that don't match the given packet label filter criteria. The criteria can use wildcards and boolean operators.
MultiPacketFilter	compound module	This module combines multiple packet filters into one.
MultiPacketMeter	compound module	This module combines multiple packet meters into one.
MultiTokenBucketMeter	simple module	This module labels packets according to the first token bucket that contains the required number of tokens. If no such token bucket is found then the default label is attached to the packet.
OmittedIeee8021qTagEpdHeaderChecker	compound module	This module implements the module given interface and can be used as an omitted optional module that removes itself from the module hierarchy during initialize.
OmittedIeee8021qTagEpdHeaderInserter	compound module	This module implements the module given interface and can be used as an omitted optional module that removes itself from the module hierarchy during initialize.
OmittedIeee8021qTagTpidHeaderChecker	compound module	This module implements the module given interface and can be used as an omitted optional module that removes itself from the module hierarchy during initialize.
OmittedIeee8021qTagTpidHeaderInserter	compound module	This module implements the module given interface and can be used as an omitted optional module that removes itself from the module hierarchy during initialize.
OmittedPacketFilter	compound module	This module implements the module given interface and can be used as an omitted optional module that removes itself from the module hierarchy during initialize.
OmittedPacketFlow	compound module	This module implements the module given interface and can be used as an omitted optional module that removes itself from the module hierarchy during initialize.
OmittedPacketMeter	compound module	This module implements the module given interface and can be used as an omitted optional module that removes itself from the module hierarchy during initialize.
PacketDestreamer	simple module	This module takes packets streamed to its input and passes them to its output.
PacketDirectionReverser	simple module	This module is part of the layer 2 architecture. It turns an incoming packet into an outgoing packet simply by removing all attached indication tags and turning some of them into an attached request tag on the packet.
PacketEmitter	simple module	(no description)
PacketFilter	simple module	This module filters for packets matching the configured filter criteria. When the filter is pushed by a connected packet producer, it either pushes the packet to the connected packet consumer or drops it depending on the configured packet filter. Similarily, when the filter is pulled by a connected packet collector, it pulls packets from the connected packet provider until it finds one which matches the configured packet filter.
PacketLabeler	simple module	This module attaches a LabelsTag to packets based on the configured filters. For each matching filter a new label is attached.
PacketStreamer	simple module	This module takes packets passed to its input and streams them to its output.
PacketTagger	simple module	This module attaches various request tags to packets.
PaddingInserter	simple module	(no description)
PreemptableStreamer	simple module	This module takes packets passed to its input and streams them to its output.
RelayInterfaceLearner	simple module	This module extracts the source MAC address of the packet passing through and stores the mapping from this MAC address to the incoming network interface in the MAC address table (forwarding information database).
RelayInterfaceSelector	simple module	This module selects the outgoing interface for the packet passing through from the MAC address table (forwarding information database) based on the destination MAC address. The selected interface is attached to the packet in an InterfaceReq. The packet may be duplicated if multiple interfaces are found.
SimpleIeee8021qFilter	compound module	This 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.
SingleRateThreeColorMeter	simple module	This packet meter module measures the packet flow that is passing through using two token buckets. The meter attaches a LabelsTag to each packet with either green, yellow or red color depending on which token bucket contains the required number of tokens for the packet.
SingleRateTwoColorMeter	simple module	This packet meter module measures the packet flow that is passing through using one token bucket. The meter attaches a LabelsTag to each packet with either green or red color depending on whether the token bucket contains the required number of tokens for the packet.
SlidingWindowRateMeter	simple module	This module attaches a RateTag to each packet specifying the datarate and packetrate of the received stream of packets. The algorithm takes packets into account only in the given time window.
StatisticalRateLimiter	simple module	This module limit the datarate or the packetrate of a stream of packets based on the RateTag attached to the packets.
StreamDecoder	simple module	This module decodes the stream of a packet by matching various tags on the packet against the mapping. It can check for network interface, source address, destination address, VLAN id, and PCP. If a match was found then the stream is attached to the packet in a StreamInd tag.
StreamEncoder	simple module	This module encodes the stream name of a packet into several request tags attached to the packet. It looks up the stream in the mapping and attaches the necessary request tags to the packet based on the specified parameters.
StreamFilter	simple module	This module implements a packet filter using solely the stream name. The stream name must match the filter criteria in order the packet to pass through the filter.
StreamIdentifier	simple module	This module identifies the stream of a packet using packet filter expressions. It can check for arbitrary packet data and assign and if a match was found then the stream is attached to the packet in a StreamReq tag.
StreamMerger	simple module	This module merges the packets of the same stream by removing duplicates. In addition it also replaces the stream name on the packet based on the mapping parameter. For merging it maintains a separate finite buffer per stream with the last seen sequence numbers.
TokenBucketMeter	simple module	This module labels each packet if the token bucket contains enough tokens for the packet that is passing through. The amount of required tokens is equal to the packet length in bits and is subtracted from the number of stored tokens. New tokens are generated with the provided constant rate and they may also be added by other modules.
VlanIndFilter	simple module	This module filters out packets based on the attached VlanInd tag.
VlanReqFilter	simple module	This module filters out packets based on the attached VlanReq tag.
VlanReqMapper	simple module	This module updates the VlanReq tag on packets.

Used in compound modules

Name	Type	Description
DirectionReverserLayer	compound module	This module provides a layer that combines the decision for local delivery with the service of reversing the direction of an incoming packet to outgoing for packet forwarding.
EthernetApp	compound module	This module generates traffic as an Ethernet application. The traffic source and traffic sink modules can be built from queueing model elements.
EthernetFragmentingMacLayer	compound module	(no description)
EthernetLayer	compound module	(no description)
EthernetMacLayer	compound module	(no description)
EthernetPhyLayer	compound module	(no description)
EthernetPreemptingPhyLayer	compound module	(no description)
EthernetStreamingMacLayer	compound module	(no description)
Ieee8021qProtocol	compound module	This module implements the IEEE 802.1Q protocol encapsulation/decapsulation. It also provides socket support so applications can use the protocol directly.
Ieee8022LlcApp	compound module	This module generates traffic as an IEEE 802.2 LLC application. The traffic source and traffic sink modules can be built from queueing model elements.
Ieee8022LlcLayer	compound module	(no description)
InterfaceRelayLayer	compound module	This module combines the interface MAC address learning from incoming packets with the outgoing interface selection for outgoing packets into a single layer.
IpApp	compound module	This module generates traffic for a IP application. The traffic source and traffic sink modules can be built from queueing model elements.
MeasurementLayer	compound module	(no description)
MultiMeasurementLayer	compound module	(no description)
StreamCoderLayer	compound module	This module combines a stream decoder and a stream encoder into a layer. For incoming packets the stream decoder determines the stream of the packet. For outgoing packets the stream encoder determines the VLAN id, etc. of the packet.
StreamIdentifierLayer	compound module	This module wraps a stream identifier into a protocol layer so that it can be used in a layered compound module.
TcpClientApp	compound module	This module is a generic TCP client application. The traffic source and traffic sink modules can be built from queueing model elements.
TcpServerConnection	compound module	This module is a generic TCP server connection. The traffic source and traffic sink modules can be built from queueing model elements.
UdpApp	compound module	This module generates traffic for a UDP application. The traffic source and traffic sink modules can be built from queueing model elements.
VlanPolicyLayer	compound module	(no description)

Known subclasses

Name	Type	Description
IPacketFilter	module interface	This module interface is implemented by packet filter modules. A packet filter connects one input to one output. It can operate in both active and passive mode. Packets can be pushed into its input or packets can be pulled from its output. Processed packets are either dropped, if they don't match the filter criteria, or they are passed through without any delay or reordering. Packets are not modified in any way.
IPacketMarker	module interface	This module interface is implemented by packet marker modules. A packet marker connects one input to one output. It can operate in both active and passive mode. Packets can be pushed into its input or packets can be pulled from its output. When processing a packet, a marker attaches some information (such as a label) to the packet based on the data and meta data it contains. The packets are processed individually.
IPacketMeter	module interface	This module interface is implemented by packet meter modules. A packet meter connects one input to one output. It can operate in both active and passive mode. Packets can be pushed into its input or packets can be pulled from its output. When processing packets, a meter attaches some information (such as the packet rate) to the packets based on the data and meta data they contain. The packets are processed as part of a stream.
IProtocolHeaderInserter	module interface	(no description)

Extends

Name	Type	Description
IPacketSink	module interface	This module interface is implemented by packet sink modules which are both passive and active simultaneously.
IPacketSource	module interface	This module interface is implemented by packet source modules which are both active and passive simultaneously.

Properties

Name	Value	Description
display	i=block/star
omittedTypename	OmittedPacketFlow

Source code

//
// This module interface is implemented by packet flows. A packet flow connects
// one input to one output. It can operate in both active and passive mode.
// Packets can be pushed into its input or packets can be pulled from its
// output. Packets are never dropped but the contents and/or attached meta
// information may be altered.
//
moduleinterface IPacketFlow extends IPacketSink, IPacketSource
{
    parameters:
        @omittedTypename(OmittedPacketFlow);
        @display("i=block/star");
}

File: src/inet/queueing/contract/IPacketFlow.ned