PassivePacketSource

Package: inet.queueing.source

PassivePacketSource

simple module

This module is a passive packet source which can be pulled for packets from the connected packet collector.

Inheritance diagram

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

Used in compound modules

Name Type Description
ResponseProducer compound module

This module is capable of generating several different streams of packets, one after the other. For each traffic category, the packets are produced by a separate token based server. The traffic stream can be started by adding tokens the corresponding server module. The packet data, packet length, and timing distributions can be configured in the corresponding packet provider.

Extends

Name Type Description
PassivePacketSourceBase simple module

This is a base module for various active packet source modules.

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 "%a-%c"

see directives in module documentation

packetRepresentation string "byteCount"

determines the chunk of the packet data

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

relative path of a module that implements IClock; optional

initialProvidingOffset double 0s

initial duration before which packets are not provided

providingInterval double 0s

elapsed time between subsequent packets allowed to be pulled by the connected packet collector, 0 means any number of packets can be pulled at the same simulation time

scheduleForAbsoluteTime bool true

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

Properties

Name Value Description
display i=block/source
class PassivePacketSource

Gates

Name Direction Size Description
out output

Signals

Name Type Unit
packetPulled inet::Packet

Statistics

Name Title Source Record Unit Interpolation Mode
packetLengths packet lengths packetLength(packetPulled) sum, histogram, vector b none
dataRate data rate throughput(packetPulled) vector bps linear
packets packets packetPulled count pk

Scheduled messages (observed)

msgkindctrltagsmsgnamecontext
ClockEvent0ProvidingTimer

Direct method calls (observed)

call tofunctioninfo
PacketDemultiplexerinet::queueing::PacketDemultiplexer::handleCanPullPacketChangedhandleCanPullPacketChanged
ContentBasedFilterinet::queueing::ContentBasedFilter::handleCanPullPacketChangedhandleCanPullPacketChanged
PacketGateinet::queueing::PacketGate::handleCanPullPacketChangedhandleCanPullPacketChanged
ContentBasedSchedulerinet::queueing::ContentBasedScheduler::handleCanPullPacketChangedhandleCanPullPacketChanged
MarkovSchedulerinet::queueing::MarkovScheduler::handleCanPullPacketChangedhandleCanPullPacketChanged
PacketSchedulerinet::queueing::PacketScheduler::handleCanPullPacketChangedhandleCanPullPacketChanged
WrrSchedulerinet::queueing::WrrScheduler::handleCanPullPacketChangedhandleCanPullPacketChanged
PacketServerinet::queueing::PacketServer::handleCanPullPacketChangedhandleCanPullPacketChanged
TokenBasedServerinet::queueing::TokenBasedServer::handleCanPullPacketChangedhandleCanPullPacketChanged
ActivePacketSinkinet::queueing::ActivePacketSink::handleCanPullPacketChangedhandleCanPullPacketChanged

Called methods (observed)

functioninfocall from
inet::queueing::PassivePacketSource::canPullPacketcanPullPacketContentBasedFilter, ContentBasedScheduler, PacketScheduler, TokenBasedServer, ActivePacketSink
inet::queueing::PassivePacketSource::pullPacketpullPacketPacketDemultiplexer, ContentBasedFilter, PacketGate, ContentBasedScheduler, MarkovScheduler, PacketScheduler, WrrScheduler, PacketServer, TokenBasedServer, ActivePacketSink

Pulled out messages (observed)

gatemsgkindctrldestModuletags
outPacket0PacketDemultiplexerDirectionTag, PacketProtocolTag
outPacket0ContentBasedFilterDirectionTag, PacketProtocolTag
outPacket0PacketGateDirectionTag, PacketProtocolTag
outPacket0ContentBasedSchedulerDirectionTag, PacketProtocolTag
outPacket0MarkovSchedulerDirectionTag, PacketProtocolTag
outPacket0PacketSchedulerDirectionTag, PacketProtocolTag
outPacket0WrrSchedulerDirectionTag, PacketProtocolTag
outPacket0PacketServerDirectionTag, PacketProtocolTag
outPacket0TokenBasedServerDirectionTag, PacketProtocolTag
outPacket0ActivePacketSinkDirectionTag, PacketProtocolTag

Packet operations (observed)

chunkTypepacketAction
ByteCountChunkPacket

Shared Tagging operations (observed)

tagTypetagAction
DirectionTagaddTagIfAbsent
PacketProtocolTagaddTag

Region Tagging operations (observed)

tagTypetagAction
CreationTimeTagaddTag
IdentityTagaddTag

Source code

//
// This module is a passive packet source which can be pulled for packets from
// the connected packet collector.
//
simple PassivePacketSource extends PassivePacketSourceBase like IPassivePacketSource
{
    parameters:
        string clockModule = default(""); // relative path of a module that implements IClock; optional
        double initialProvidingOffset @unit(s) = default(0s); // initial duration before which packets are not provided
        volatile double providingInterval @unit(s) = default(0s); // elapsed time between subsequent packets allowed to be pulled by the connected packet collector, 0 means any number of packets can be pulled at the same simulation time
        bool scheduleForAbsoluteTime = default(true); // when a clock is used relative means that setting the clock will not affect the simulation time of the event
        @class(PassivePacketSource);
    gates:
        output out @labels(pull);
}
File: src/inet/queueing/source/PassivePacketSource.ned