PriorityClassifierTutorialStep

Package: inet.tutorials.queueing

PriorityClassifierTutorialStep

network

(no description)

producer : ActivePacketSource

An active packet source which pushes packets into the connected module.

Source:
producer: ActivePacketSource {
    @display("p=100,100");
} classifier : PriorityClassifier

This classifier pushes packets into the first non-full among its connected packet consumers.

Source:
classifier: PriorityClassifier {
    @display("p=300,100");
} queue1 : PacketQueue

Implements a configurable packet queue, which is suitable for use in MAC protocols, traffic...

Source:
queue1: PacketQueue {
    @display("p=525,100");
} queue2 : PacketQueue

Implements a configurable packet queue, which is suitable for use in MAC protocols, traffic...

Source:
queue2: PacketQueue {
    @display("p=525,225");
} collector1 : ActivePacketSink

An active packet sink which pulls packets from the connected module.

Source:
collector1: ActivePacketSink {
    @display("p=750,100");
} collector2 : ActivePacketSink

An active packet sink which pulls packets from the connected module.

Source:
collector2: ActivePacketSink {
    @display("p=750,225");
}

Usage diagram

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

Properties

Name Value Description
isNetwork
display bgb=850,300

Unassigned submodule parameters

Name Type Default value Description
producer.displayStringTextFormat string "created %p pk (%l)"

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

producer.packetNameFormat string "%a-%c"

See directives in module documentation

producer.packetRepresentation string "byteCount"

Determines the chunk of the packet data

producer.packetProtocol string "unknown"
producer.packetLength int
producer.packetData int -1
producer.attachCreationTimeTag bool true
producer.attachIdentityTag bool true
producer.attachDirectionTag bool true
producer.clockModule string ""

Relative path of a module that implements IClock(1,2); optional

producer.initialProductionOffset double -1s

Initial duration before which packets are not produced. When negative, then produce packet in initialize()

producer.productionInterval double

Elapsed time between subsequent packets pushed to the connected packet consumer

producer.scheduleForAbsoluteTime bool true

When a clock is used, "relative" means that setting the clock will not affect the simulation time of the event

classifier.displayStringTextFormat string "classified %p pk (%l)"

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

classifier.reverseOrder bool false
queue1.displayStringTextFormat string "contains %p pk (%l) pushed %u\npulled %o removed %r dropped %d"

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

queue1.packetCapacity int -1

Maximum number of packets in the queue, no limit by default

queue1.dataCapacity int -1b

Maximum total length of packets in the queue, no limit by default

queue1.dropperClass string ""

Determines which packets are dropped when the queue is overloaded, packets are not dropped by default; the parameter must be the name of a C++ class which implements the IPacketDropperFunction C++ interface and is registered via Register_Class

queue1.comparatorClass string ""

Determines the order of packets in the queue, insertion order by default; the parameter must be the name of a C++ class which implements the IPacketComparatorFunction C++ interface and is registered via Register_Class

queue1.bufferModule string ""

Relative module path to the IPacketBuffer module used by this queue, implicit buffer by default

queue2.displayStringTextFormat string "contains %p pk (%l) pushed %u\npulled %o removed %r dropped %d"

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

queue2.packetCapacity int -1

Maximum number of packets in the queue, no limit by default

queue2.dataCapacity int -1b

Maximum total length of packets in the queue, no limit by default

queue2.dropperClass string ""

Determines which packets are dropped when the queue is overloaded, packets are not dropped by default; the parameter must be the name of a C++ class which implements the IPacketDropperFunction C++ interface and is registered via Register_Class

queue2.comparatorClass string ""

Determines the order of packets in the queue, insertion order by default; the parameter must be the name of a C++ class which implements the IPacketComparatorFunction C++ interface and is registered via Register_Class

queue2.bufferModule string ""

Relative module path to the IPacketBuffer module used by this queue, implicit buffer by default

collector1.displayStringTextFormat string "received %p pk (%l)"

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

collector1.clockModule string ""

Relative path of a module that implements IClock(1,2); optional

collector1.initialCollectionOffset double -1s

Initial duration before which packets are not collected, negative value means: try the first collection in initialize()

collector1.collectionInterval double

Elapsed time between subsequent packets pulled from the connected packet provider

collector1.scheduleForAbsoluteTime bool true

When a clock is used, relative means that setting the clock will not affect the simulation time of the event

collector2.displayStringTextFormat string "received %p pk (%l)"

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

collector2.clockModule string ""

Relative path of a module that implements IClock(1,2); optional

collector2.initialCollectionOffset double -1s

Initial duration before which packets are not collected, negative value means: try the first collection in initialize()

collector2.collectionInterval double

Elapsed time between subsequent packets pulled from the connected packet provider

collector2.scheduleForAbsoluteTime bool true

When a clock is used, relative means that setting the clock will not affect the simulation time of the event

Source code

network PriorityClassifierTutorialStep
{
    @display("bgb=850,300");
    submodules:
        producer: ActivePacketSource {
            @display("p=100,100");
        }
        classifier: PriorityClassifier {
            @display("p=300,100");
        }
        queue1: PacketQueue {
            @display("p=525,100");
        }
        queue2: PacketQueue {
            @display("p=525,225");
        }
        collector1: ActivePacketSink {
            @display("p=750,100");
        }
        collector2: ActivePacketSink {
            @display("p=750,225");
        }
    connections allowunconnected:
        producer.out --> classifier.in;
        classifier.out++ --> queue1.in;
        classifier.out++ --> queue2.in;
        queue1.out --> collector1.in;
        queue2.out --> collector2.in;
}

//-------------------------------------------------

File: tutorials/queueing/QueueingTutorial.ned