Package: inet.queueing.base

PacketBufferBase

simple module

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

Available display string format directives:

%p - number of packet
%l - total length
%a - number of added packets
%r - number of removed packets
%d - number of dropped packets

See also: IPacketBuffer

Inheritance diagram

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

Known subclasses

Name	Type	Description
PacketBuffer	simple module	This module provides packet storage for sharing and optimizing storage space between multiple packet queues. When a packet buffer becomes overloaded, the packet dropping strategy can drop any number of packets from any number of connected packet queues.

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)\nadded %a removed %r dropped %d"	determines the text that is written on top of the submodule

Properties

Name	Value	Description
display	i=block/buffer

Gates

Name	Direction	Size	Description
in	input
out	output

Source code

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

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