PacketSourceBase

simple module

This is a base module for various packet source modules. Packets are created randomly with regard to packet length and packet data. The representation of packet data can also be configured.

See also: IPacketSource

Inheritance diagram

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

Known subclasses

Name	Type	Description
ActivePacketSource	simple module	This module is an active packet source which pushes packets into the connected packet consumer.
PassivePacketSource	simple module	This module is a passive packet source which can be popped for packets from the connected packet collector.

Extends

Name	Type	Description
PacketProcessorBase	simple module	This is a base module for various packet processing modules which maintains a few statistics.

Parameters

Name	Type	Default value	Description
displayStringTextFormat	string	"created %p pk (%l)"	determines the text that is written on top of the submodule
packetNameFormat	string	"%n-%c"	%n module name, %c packet number, %l packet length, %d packet data, %t simulation time, %e event number
packetRepresentation	string	"byteCount"	determines the chunk of the packet data
packetLength	int
packetData	int	-1

Properties

Name	Value	Description
class	PacketSourceBase
display	i=block/source

Source code

//
// This is a base module for various packet source modules. Packets are created
// randomly with regard to packet length and packet data. The representation of
// packet data can also be configured.
//
// @see ~IPacketSource
//
simple PacketSourceBase extends PacketProcessorBase
{
    parameters:
        string packetNameFormat = default("%n-%c"); // %n module name, %c packet number, %l packet length, %d packet data, %t simulation time, %e event number
        string packetRepresentation @units("bitCount","bits","byteCount","bytes","applicationPacket") = default("byteCount"); // determines the chunk of the packet data
        volatile int packetLength @unit(b);
        volatile int packetData = default(-1);
        displayStringTextFormat = default("created %p pk (%l)");
        @class(PacketSourceBase);
        @display("i=block/source");
}

File: src/inet/queueing/base/PacketSourceBase.ned