FailureProtectionConfigurator

Package: inet.linklayer.configurator

FailureProtectionConfigurator

simple module

This module provides Time-Sensitive Networking (TSN) configuration using other configurators. One is used to provie the stream redundancy (stream splitting and stream merging) configuration, the other one ise used to provide the gate scheduling configuration.

The key parameters are the linkFailureProtection and nodeFailureProtection fields of the individual configuration entries. Both of these take a number and a set of links or nodes respectively. The former specifies the number of failed links or nodes from the given set against which the stream must be protected.

Inheritance diagram

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

Parameters

Name Type Default value Description
streamRedundancyConfiguratorModule string "streamRedundancyConfigurator"
gateScheduleConfiguratorModule string "gateScheduleConfigurator"
configuration object []

a vector of objects (e.g. [{...}, {...}]) where each object has the following fields: name, type, application, source, destination, PCP, gate index, packetFilter, packetLength, packetInterval, maxLatency, linkFailureProtection, nodeFailureProtection, maxRedundancy here is an example: [{name: "s1", application: "app[0]", source: "source", destination: "destination", pcp: 0, gateIndex: 0, packetFilter: "*", packetLength: 200B, packetInterval: 500us, maxLatency: 100us, linkFailureProtection: [{any: 1, of: "*"}], maxRedundancy: 2}]

Properties

Name Value Description
display i=block/cogwheel

Direct method calls (observed)

call tofunctioninfo
InterfaceTableinet::InterfaceTable::findInterfaceByNodeInputGateIdfindInterfaceByNodeInputGateId
InterfaceTableinet::InterfaceTable::findInterfaceByNodeOutputGateIdfindInterfaceByNodeOutputGateId

Source code

//
// This module provides Time-Sensitive Networking (TSN) configuration using other
// configurators. One is used to provie the stream redundancy (stream splitting
// and stream merging) configuration, the other one ise used to provide the gate
// scheduling configuration.
//
// The key parameters are the linkFailureProtection and nodeFailureProtection
// fields of the individual configuration entries. Both of these take a number
// and a set of links or nodes respectively. The former specifies the number of
// failed links or nodes from the given set against which the stream must be
// protected.
//
simple FailureProtectionConfigurator like INetworkConfigurator
{
    parameters:
        string streamRedundancyConfiguratorModule = default("streamRedundancyConfigurator");
        string gateScheduleConfiguratorModule = default("gateScheduleConfigurator");
        object configuration = default([]); // a vector of objects (e.g. [{...}, {...}]) where each object has the following fields: name, type, application, source, destination, PCP, gate index, packetFilter, packetLength, packetInterval, maxLatency, linkFailureProtection, nodeFailureProtection, maxRedundancy
                                            // here is an example: [{name: "s1", application: "app[0]", source: "source", destination: "destination", pcp: 0, gateIndex: 0, packetFilter: "*", packetLength: 200B, packetInterval: 500us, maxLatency: 100us, linkFailureProtection: [{any: 1, of: "*"}], maxRedundancy: 2}]
        @display("i=block/cogwheel");
}

File: src/inet/linklayer/configurator/FailureProtectionConfigurator.ned