Package: inet.queueing.base

PacketQueueBase

simple module

This is a base module for various packet queue modules which maintains a few statistics.

Available display string format directives:

%p - number of packet
%l - total length
%u - number of pushed packets
%o - number of pulled packets
%r - number of removed packets
%d - number of dropped packets
%n - name of next pulled packet

See also: IPacketQueue

Inheritance diagram

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

Known subclasses

Name	Type	Description
CompoundPacketQueueBase	compound module	This compound module serves as a base module for complex packet queues formed by combining several queueing components.
PacketQueue	simple module	This module implements a widely configurable packet queue, which is suitable among others, to be used in MAC protocols, traffic conditioning, and quality of services. This module can be used on its own, but it's also often supplemented by additional queueing components such as servers, classifiers, schedulers, multiplexers, etc. This kind of composition allows to form a larger module which can act as a packet queue with more complex behavior.

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	"contains %p pk (%l)\npushed %u pulled %o dropped %d"	determines the text that is written on top of the submodule

Properties

Name	Value	Description
display	i=block/queue

Gates

Name	Direction	Size	Description
in	input
out	output

Source code

//
// This is a base module for various packet queue modules which maintains a few
// statistics.
//
// Available display string format directives:
// - %p - number of packet
// - %l - total length
// - %u - number of pushed packets
// - %o - number of pulled packets
// - %r - number of removed packets
// - %d - number of dropped packets
// - %n - name of next pulled packet
//
// @see ~IPacketQueue
//
simple PacketQueueBase extends PacketProcessorBase
{
    parameters:
        displayStringTextFormat = default("contains %p pk (%l)\npushed %u pulled %o dropped %d"); // determines display string text above the submodule
        @display("i=block/queue");
    gates:
        input in @loose;
        output out @loose;
}

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