Simple Module TTBuffer

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

C++ definition

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

The TTBuffer registers a timer (~SchedulerActionTimeEvent) at the scheduler module (~TTEScheduler) to send its Message in conformance with the send window.

WARNING: Do not instantiate the module. Use ~TTDoubleBuffer or ~TTQueueBuffer instead!

TODO: The TTBuffer module should be converted to an interface since it should not be used directly in simulation.

See also: ~TTDoubleBuffer, ~TTQueueBuffer, ~Buffer, ~SchedulerActionTimeEvent, ~TTEScheduler

Author: Till Steinbach

TTBuffer

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
CTBuffer simple module

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

Known subclasses:

Name Type Description
TTDoubleBuffer simple module

Represents a double buffer for time-triggered traffic. Messages are sent using the configured send window.

TTQueueBuffer simple module

Represents a queue buffer for time-triggered 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

sendWindowStart int

Beginning of the send window in number of ticks (Changes to this parameter will get active for future scheduled frames only)

sendWindowEnd int 0tick

End of the send window in number of ticks

period string "period[0]"

Period of Scheduler this buffer is assigned to

Properties:

Name Value Description
class AbstractSimpleModule

TTBuffer is implemented by the TTBuffer C++ Class

display i=,red

Gates:

Name Direction Size Description
in input

The buffers Input

out output

The buffers Output

WARNING: CURRENTLY NOT USED!

schedulerIn input

Input gate for the incoming SchedulerActionTimeEvent messages

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:

//
// Represents an abstract Buffer for time-triggerd traffic. Messages are sent using the configured
// send window.
//
// The TTBuffer registers a timer (~SchedulerActionTimeEvent) at the scheduler module (~TTEScheduler) to send its
// Message in conformance with the send window.
//
// @warning Do not instantiate the module. Use ~TTDoubleBuffer or ~TTQueueBuffer instead!
//
// @todo The TTBuffer module should be converted to an interface since it should
// not be used directly in simulation.
//
// @see ~TTDoubleBuffer, ~TTQueueBuffer, ~Buffer, ~SchedulerActionTimeEvent, ~TTEScheduler
//
// @author Till Steinbach
simple TTBuffer extends CTBuffer like IScheduled
{
    parameters:
        //TTBuffer is implemented by the TTBuffer C++ Class
        @class(AbstractSimpleModule);
        @display("i=,red");

        //Beginning of the send window in number of ticks (Changes to this parameter will get active for future scheduled frames only)
        int sendWindowStart @unit(tick);
        //End of the send window in number of ticks
        int sendWindowEnd @unit(tick) = default(0tick);
        //Period of Scheduler this buffer is assigned to
        string period = default("period[0]");

    gates:
        //Input gate for the incoming SchedulerActionTimeEvent messages
        input schedulerIn @directIn;

}