Package: inet.queueing.marker
ContentBasedLabeler
simple moduleThis module attaches various request labels to packets.
Inheritance diagram
The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.
Extends
| Name | Type | Description |
|---|---|---|
| PacketLabelerBase | simple module |
This is a base module for various packet labeler modules. |
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| displayStringTextFormat | string | "marked %p pk (%l)" |
determines the text that is written on top of the submodule |
| labels | string | "" |
a space separated list of labels |
| packetFilters | object | ["*"] |
array of packet filter expressions, matches all packets by default |
Properties
| Name | Value | Description |
|---|---|---|
| display | i=block/star | |
| class | ContentBasedLabeler |
Gates
| Name | Direction | Size | Description |
|---|---|---|---|
| in | input | ||
| out | output |
Signals
| Name | Type | Unit |
|---|---|---|
| packetPushedIn | inet::Packet | |
| packetPulledIn | inet::Packet | |
| packetPushedOut | inet::Packet | |
| packetPulledOut | inet::Packet |
Statistics
| Name | Title | Source | Record | Unit | Interpolation Mode |
|---|---|---|---|---|---|
| flowIncomingDataRate | flow specific incoming data rate | throughput(demuxFlow(merge(packetPushedIn, packetPulledIn))) | vector | bps | linear |
| outgoingDataRate | outgoing data rate | throughput(merge(packetPushedOut, packetPulledOut)) | vector | bps | linear |
| incomingDataRate | incoming data rate | throughput(merge(packetPushedIn, packetPulledIn)) | vector | bps | linear |
| outgoingPacketLengths | outgoing packet lengths | packetLength(merge(packetPushedOut, packetPulledOut)) | sum, histogram, vector | b | none |
| flowIncomingPacketLengths | flow specific incoming packet lengths | packetLength(demuxFlow(merge(packetPushedIn, packetPulledIn))) | sum, histogram, vector | b | none |
| flowOutgoingDataRate | flow specific outgoing data rate | throughput(demuxFlow(merge(packetPushedOut, packetPulledOut))) | vector | bps | linear |
| incomingPacketLengths | incoming packet lengths | packetLength(merge(packetPushedIn, packetPulledIn)) | sum, histogram, vector | b | none |
| flowOutgoingPacketLengths | flow specific outgoing packet lengths | packetLength(demuxFlow(merge(packetPushedOut, packetPulledOut))) | sum, histogram, vector | b | none |
| incomingPackets | incoming packets | merge(packetPushedIn, packetPulledIn) | count | pk | |
| outgoingPackets | outgoing packets | merge(packetPushedOut, packetPulledOut) | count | pk |
Direct method calls (observed)
| call to | function | info |
|---|---|---|
| LabelClassifier | inet::queueing::LabelClassifier::pushPacket | pushPacket |
| ActivePacketSource | inet::queueing::ActivePacketSource::handleCanPushPacketChanged | handleCanPushPacketChanged |
Called methods (observed)
| function | info | call from |
|---|---|---|
| inet::queueing::ContentBasedLabeler::handleCanPushPacketChanged | handleCanPushPacketChanged | LabelClassifier |
| inet::queueing::ContentBasedLabeler::pushPacket | pushPacket | ActivePacketSource |
Pushed in messages (observed)
| gate | msg | kind | ctrl | srcModule | tags |
|---|---|---|---|---|---|
| in | Packet | 0 | ActivePacketSource | DirectionTag |
Push out messages (observed)
| gate | msg | kind | ctrl | destModule | tags |
|---|---|---|---|---|---|
| out | Packet | 0 | LabelClassifier | DirectionTag, LabelsTag |
Packet operations (observed)
| chunkType | packetAction |
|---|---|
| peekData, setBackOffset, setFrontOffset |
Shared Tagging operations (observed)
| tagType | tagAction |
|---|---|
| LabelsTag | addTagIfAbsent |
| PacketProtocolTag | findTag |
Region Tagging operations (observed)
| tagType | tagAction |
|---|---|
| FlowTag | mapAllTags |
Source code
// // This module attaches various request labels to packets. // simple ContentBasedLabeler extends PacketLabelerBase like IPacketMarker { parameters: object packetFilters = default(["*"]); // array of packet filter expressions, matches all packets by default @class(ContentBasedLabeler); }File: src/inet/queueing/marker/ContentBasedLabeler.ned