ExampleNetworkTutorialStep

Package: inet.tutorials.queueing

ExampleNetworkTutorialStep

network

(no description)

ExampleHost ExampleCable ExampleHost

Usage diagram

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

Properties

Name Value Description
isNetwork

Unassigned submodule parameters

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

determines the text that is written on top of the submodule
source.sourceApplication.packetNameFormat string "%a-%c"

see directives in module documentation
source.sourceApplication.packetRepresentation string "byteCount"

determines the chunk of the packet data
source.sourceApplication.packetLength int
source.sourceApplication.packetData int -1
source.sourceApplication.attachCreationTimeTag bool true
source.sourceApplication.attachIdentityTag bool true
source.sourceApplication.attachDirectionTag bool true
source.sourceApplication.clockModule string ""

relative path of a module that implements IClock(1,2); optional
source.sourceApplication.initialProductionOffset double 0s
source.sourceApplication.productionInterval double

elapsed time between subsequent packets pushed to the connected packet consumer
source.sourceApplication.scheduleForAbsoluteTime bool true

when a clock is used relative means that setting the clock will not affect the simulation time of the event
source.destinationApplication.displayStringTextFormat string "received %p pk (%l)"

determines the text that is written on top of the submodule
source.destinationApplication.clockModule string ""

relative path of a module that implements IClock(1,2); optional
source.destinationApplication.consumptionInterval double 0s

elapsed time between subsequent packets allowed to be pushed by the connected packet producer, 0 means any number of packets can be pushed at the same simulation time
source.destinationApplication.scheduleForAbsoluteTime bool true

when a clock is used relative means that setting the clock will not affect the simulation time of the event
source.interface.queue.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
source.interface.queue.packetCapacity int -1

maximum number of packets in the queue, no limit by default
source.interface.queue.dataCapacity int -1b

maximum total length of packets in the queue, no limit by default
source.interface.queue.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
source.interface.queue.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
source.interface.queue.bufferModule string ""

relative module path to the IPacketBuffer module used by this queue, implicit buffer by default
source.interface.server.displayStringTextFormat string "served %p pk (%l)\n%s"

determines the text that is written on top of the submodule
source.interface.server.clockModule string ""

relative path of a module that implements IClock(1,2); optional
source.interface.server.processingTime double

determines additional processing time per packet
source.interface.server.processingBitrate double inf bps

determines additional processing time per bit
cable.aDelayer.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
cable.aDelayer.clockModule string ""

relative path of a module that implements IClock(1,2); optional
cable.aDelayer.delay double
cable.bDelayer.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
cable.bDelayer.clockModule string ""

relative path of a module that implements IClock(1,2); optional
cable.bDelayer.delay double
destination.sourceApplication.displayStringTextFormat string "created %p pk (%l)"

determines the text that is written on top of the submodule
destination.sourceApplication.packetNameFormat string "%a-%c"

see directives in module documentation
destination.sourceApplication.packetRepresentation string "byteCount"

determines the chunk of the packet data
destination.sourceApplication.packetLength int
destination.sourceApplication.packetData int -1
destination.sourceApplication.attachCreationTimeTag bool true
destination.sourceApplication.attachIdentityTag bool true
destination.sourceApplication.attachDirectionTag bool true
destination.sourceApplication.clockModule string ""

relative path of a module that implements IClock(1,2); optional
destination.sourceApplication.initialProductionOffset double 0s
destination.sourceApplication.productionInterval double

elapsed time between subsequent packets pushed to the connected packet consumer
destination.sourceApplication.scheduleForAbsoluteTime bool true

when a clock is used relative means that setting the clock will not affect the simulation time of the event
destination.destinationApplication.displayStringTextFormat string "received %p pk (%l)"

determines the text that is written on top of the submodule
destination.destinationApplication.clockModule string ""

relative path of a module that implements IClock(1,2); optional
destination.destinationApplication.consumptionInterval double 0s

elapsed time between subsequent packets allowed to be pushed by the connected packet producer, 0 means any number of packets can be pushed at the same simulation time
destination.destinationApplication.scheduleForAbsoluteTime bool true

when a clock is used relative means that setting the clock will not affect the simulation time of the event
destination.interface.queue.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
destination.interface.queue.packetCapacity int -1

maximum number of packets in the queue, no limit by default
destination.interface.queue.dataCapacity int -1b

maximum total length of packets in the queue, no limit by default
destination.interface.queue.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
destination.interface.queue.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
destination.interface.queue.bufferModule string ""

relative module path to the IPacketBuffer module used by this queue, implicit buffer by default
destination.interface.server.displayStringTextFormat string "served %p pk (%l)\n%s"

determines the text that is written on top of the submodule
destination.interface.server.clockModule string ""

relative path of a module that implements IClock(1,2); optional
destination.interface.server.processingTime double

determines additional processing time per packet
destination.interface.server.processingBitrate double inf bps

determines additional processing time per bit

Source code

network ExampleNetworkTutorialStep
{
    submodules:
        source: ExampleHost {
            @display("p=100,100");
        }
        cable: ExampleCable {
            @display("p=200,100");
        }
        destination: ExampleHost {
            @display("p=300,100");
        }
    connections:
        source.lowerOut --> cable.aIn;
        cable.aOut --> destination.lowerIn;
        destination.lowerOut --> cable.bIn;
        cable.bOut --> source.lowerIn;
}
File: tutorials/queueing/QueueingTutorial.ned

This documentation is released under the Creative Commons license