Simple Module CTBuffer

Package: core4inet.buffer.AS6802
File: src/core4inet/buffer/AS6802/CTBuffer.ned

C++ definition

Abstract base Buffer used for critical traffic Buffers of TTEthernet. Since this is an abstract module please do not instantiate it

WARNING: Currently the out gate is not used. Instead the buffer sends its message via sendDirect to all via addDestinationGate() registred gates.

See also: Buffer

Author: Till Steinbach

CTBuffer

Usage diagram:

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram. Click here to see the full picture.

Inheritance diagram:

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram. Click here to see the full picture.

Extends:

Name Type Description
Buffer simple module

Abstract base Buffer used for the various Buffers of (real-time) Ethernet. Since this is an abstract module please do not instantiate it

Known subclasses:

Name Type Description
RCBuffer simple module

Represents an abstract Buffer for rate-constrained traffic. Messages are sent using the configured bandwidth allocation gap.

TTBuffer simple module

Represents an abstract Buffer for time-triggerd traffic. Messages are sent using the configured send window.

Parameters:

Name Type Default value Description
destination_gates string ""

Comma seperated list of gates where the frames of the buffer are delivered

maxMessageSize int 1522B

The maximum allowed message size for this buffer. Larger Frames are dropped.

enabled bool true

Switch to enable and disable the buffer

priority int -1

Priority of the buffer (currently only used for rate-constrained traffic)

ct_id int

Critical traffic ID of the buffer

ct_marker int

Critical traffic marker of the buffer

ct_mask int

Critical traffic mask of the buffer

oscillator string "^.scheduler.oscillator"

Oscillator this buffer is assigned to

timer string "^.scheduler.timer"

Timer this buffer is assigned to

Properties:

Name Value Description
class AbstractSimpleModule
display i=block/buffer

Gates:

Name Direction Size Description
in input

The buffers Input

out output

The buffers Output

WARNING: CURRENTLY NOT USED!

Signals:

Name Type Unit
rxPk inet::EtherFrame
txPk inet::EtherFrame

Statistics:

Name Title Source Record Unit Interpolation Mode
rxLatency End-to-end latency (received) messageAge(rxPk) stats?, histogram?, vector? s none
rxBytes Received Bytes rxPk sum(packetBytes)?, vector(packetBytes)?, histogram(packetBytes)? B none
rxPk Received Packets rxPk count packets
txBytes Transmitted Bytes txPk sum(packetBytes), vector(packetBytes), histogram(packetBytes)? B none
minPacketSize Minimum Packet Size in Interval rxPk IntervalMinVector(packetBytes)? B linear
bandwidth Bandwidth used over Interval rxPk IntervalSumVector(packetBytes)? B linear
txPk Transmitted Packets txPk count packets
txLatency End-to-end latency (transmitted) messageAge(txPk) stats, histogram?, vector s none
maxPacketSize Maximum Packet Size in Interval rxPk IntervalMaxVector(packetBytes)? B linear

Source code:

//
// Abstract base Buffer used for critical traffic Buffers of TTEthernet.
// Since this is an abstract module please do not instantiate it
//
// @warning Currently the out gate is not used. Instead the buffer sends its
// message via sendDirect to all via addDestinationGate() registred gates.
//
// @see Buffer
//
// @author Till Steinbach
simple CTBuffer extends Buffer
{
    parameters:
        @class(AbstractSimpleModule);
        @display("i=block/buffer");
        //Priority of the buffer (currently only used for rate-constrained traffic)
        int priority = default(-1);
        //Critical traffic ID of the buffer
        int ct_id;
        //Critical traffic marker of the buffer
        int ct_marker;
        //Critical traffic mask of the buffer
        int ct_mask;

        //Oscillator this buffer is assigned to
        string oscillator = default("^.scheduler.oscillator");
        //Timer this buffer is assigned to
        string timer = default("^.scheduler.timer");

}