====== Impairment Layer (impair) ====== The impairment layer can be used to introduce packet loss and latency. It can be placed on top of any layer. ===== Impairment Layer Configuration Parameters ===== ^ Parameter^ Type^ Description^ | Alias| String| | | Debug Log Level| Number| Debug Level| | Dependencies| String| Other dependencies to this element| | Destination Peer| Number| | | Event Filter| String| Filter of Event| | Exact Match| Boolean| | | Max Event Queue Size| Number| Maximum Queue Size| | Max Instances| Number| Maximum Number of Instances of a Component| | Name| String| Component Name| | No Events| Boolean| | | Passthrough| Boolean| High-to-Low Layer Passthrough| | RX BER| String| | | RX BER Distribution| Number| | | RX BER Variance| String| | | RX Delay| Number| Reception Delay Mean (ms)| | RX Delay Distribution| Number| Reception Delay Distribution Type| | RX Delay Variance| Number| Reception Delay Variance (ms$^2$)| | RX Loss| Number| Reception Loss Mean (ms)| | RX Loss Distribution| Number| Reception Loss Distribution Type| | RX Loss Variance| Number| Reception Loss Variance (ms$^2$)| | Raw Data To Inject| String| Data Packet to Inject| | Raw Dst L2 To Inject| String| Destination L2 Address| | Raw Dst L3 To Inject| String| Destination L3 Address| | Raw Dst L4 To Inject| String| Destination L4 Address| | Request Timeout| Number| | | Save Dynamic Config| Boolean| | | Show Commands| Boolean| Show Commands| | Show Events| Boolean| Show Events| | TX BER| String| | | TX BER Distribution| Number| | | TX BER Variance| String| | | TX Delay| Number| Transmission Delay Mean (ms)| | TX Delay Distribution| Number| Transmission Delay Distribution Type| | TX Delay Variance| Number| Transmission Delay Variance (ms$^2$)| | TX Loss| Number| Transmission Loss Mean (ms)| | TX Loss Distribution| Number| Transmission Loss Distribution Type| | TX Loss Variance| Number| Transmission Loss Variance (ms$^2$)| | Watch| Boolean| Watch Layer| ===== Impairment Layer Real-Time Parameters ===== ^ Parameter^ Type^ Description^ | Allow Blocking Event| Boolean| Blocking Events| | Blocked| Boolean| Disable Component| | Debug Log Level| Number| Debug Level| | Max Instances| Number| Maximum Number of Instances of a Component| | Passthrough| Boolean| High-to-Low Layer Passthrough| | RX Delay| Number| Reception Delay Mean (ms)| | RX Delay Distribution| Number| Reception Delay Distribution Type| | RX Delay Variance| Number| Reception Delay Variance (ms$^2$)| | RX Loss| Number| Reception Loss Mean (ms)| | RX Loss Distribution| Number| Reception Loss Distribution Type| | RX Loss Variance| Number| Reception Loss Variance (ms$^2$)| | TX Delay| Number| Transmission Delay Mean (ms)| | TX Delay Distribution| Number| Transmission Delay Distribution Type| | TX Delay Variance| Number| Transmission Delay Variance (ms$^2$)| | TX Loss| Number| Transmission Loss Mean (ms)| | TX Loss Distribution| Number| Transmission Loss Distribution Type| | TX Loss Variance| Number| Transmission Loss Variance (ms$^2$)| | Watch| Boolean| Watch Layer| ===== Impairment Layer Functions ===== ^ Function^ Type^ Description^ | getImpairAllowBlockingEvent(layer)| getter| Get "Allow Blocking Event" Parameter| | getImpairBlocked(layer)| getter| Get "Blocked" Parameter| | getImpairDebugLogLevel(layer)| getter| Get "Debug Log Level" Parameter| | getImpairDestinationPeer(layer)| getter| Get "Destination Peer" Parameter| | getImpairMaxInstances(layer)| getter| Get "Max Instances" Parameter| | getImpairNoEvents(layer)| getter| Get "No Events" Parameter| | getImpairPassthrough(layer)| getter| Get "Passthrough" Parameter| | getImpairRXBER(layer)| getter| Get "RX BER" Parameter| | getImpairRXBERDistribution(layer)| getter| Get "RX BER Distribution" Parameter| | getImpairRXBERVariance(layer)| getter| Get "RX BER Variance" Parameter| | getImpairRXDelay(layer)| getter| Get "RX Delay" Parameter| | getImpairRXDelayDistribution(layer)| getter| Get "RX Delay Distribution" Parameter| | getImpairRXDelayVariance(layer)| getter| Get "RX Delay Variance" Parameter| | getImpairRXLoss(layer)| getter| Get "RX Loss" Parameter| | getImpairRXLossDistribution(layer)| getter| Get "RX Loss Distribution" Parameter| | getImpairRXLossVariance(layer)| getter| Get "RX Loss Variance" Parameter| | getImpairTXBER(layer)| getter| Get "TX BER" Parameter| | getImpairTXBERDistribution(layer)| getter| Get "TX BER Distribution" Parameter| | getImpairTXBERVariance(layer)| getter| Get "TX BER Variance" Parameter| | getImpairTXDelay(layer)| getter| Get "TX Delay" Parameter| | getImpairTXDelayDistribution(layer)| getter| Get "TX Delay Distribution" Parameter| | getImpairTXDelayVariance(layer)| getter| Get "TX Delay Variance" Parameter| | getImpairTXLoss(layer)| getter| Get "TX Loss" Parameter| | getImpairTXLossDistribution(layer)| getter| Get "TX Loss Distribution" Parameter| | getImpairTXLossVariance(layer)| getter| Get "TX Loss Variance" Parameter| | getImpairWatch(layer)| getter| Get "Watch" Parameter| | getStatsImpairAvailableInstances(layer)| getter| Get "Available Instances" Parameter| | getStatsImpairDownstreamLastPacket(layer)| getter| Get "Downstream Last Packet" Parameter| | getStatsImpairDownstreamPacketCount(layer)| getter| Get "Downstream Packet Count" Parameter| | getStatsImpairMaxDownstreamDelay(layer)| getter| Get "Max Downstream Delay" Parameter| | getStatsImpairMaxUpstreamDelay(layer)| getter| Get "Max Upstream Delay" Parameter| | getStatsImpairMeanDownstreamDelay(layer)| getter| Get "Mean Downstream Delay" Parameter| | getStatsImpairMeanUpstreamDelay(layer)| getter| Get "Mean Upstream Delay" Parameter| | getStatsImpairMinDownstreamDelay(layer)| getter| Get "Min Downstream Delay" Parameter| | getStatsImpairMinUpstreamDelay(layer)| getter| Get "Min Upstream Delay" Parameter| | getStatsImpairName(layer)| getter| Get "Name" Parameter| | getStatsImpairRateBpsDownstream(layer)| getter| Get "Rate Bps Downstream" Parameter| | getStatsImpairRateBpsUpstream(layer)| getter| Get "Rate Bps Upstream" Parameter| | getStatsImpairTimestampIn(layer)| getter| Get "Timestamp In" Parameter| | getStatsImpairTimestampOut(layer)| getter| Get "Timestamp Out" Parameter| | getStatsImpairType(layer)| getter| Get "Type" Parameter| | getStatsImpairUpstreamLastPacket(layer)| getter| Get "Upstream Last Packet" Parameter| | getStatsImpairUpstreamPacketCount(layer)| getter| Get "Upstream Packet Count" Parameter| | getStatsImpairVarianceDownstreamDelay(layer)| getter| Get "Variance Downstream Delay" Parameter| | getStatsImpairVarianceUpstreamDelay(layer)| getter| Get "Variance Upstream Delay" Parameter| | setImpairAllowBlockingEvent(layer,value)| setter| Set "Allow Blocking Event" Parameter| | setImpairBlocked(layer,value)| setter| Set "Blocked" Parameter| | setImpairDebugLogLevel(layer,value)| setter| Set "Debug Log Level" Parameter| | setImpairNoEvents(layer,value)| setter| Set "No Events" Parameter| | setImpairPassthrough(layer,value)| setter| Set "Passthrough" Parameter| | setImpairRXBER(layer,value)| setter| Set "RX BER" Parameter| | setImpairRXBERDistribution(layer,value)| setter| Set "RX BER Distribution" Parameter| | setImpairRXBERVariance(layer,value)| setter| Set "RX BER Variance" Parameter| | setImpairRXDelay(layer,value)| setter| Set "RX Delay" Parameter| | setImpairRXDelayDistribution(layer,value)| setter| Set "RX Delay Distribution" Parameter| | setImpairRXDelayVariance(layer,value)| setter| Set "RX Delay Variance" Parameter| | setImpairRXLoss(layer,value)| setter| Set "RX Loss" Parameter| | setImpairRXLossDistribution(layer,value)| setter| Set "RX Loss Distribution" Parameter| | setImpairRXLossVariance(layer,value)| setter| Set "RX Loss Variance" Parameter| | setImpairTXBER(layer,value)| setter| Set "TX BER" Parameter| | setImpairTXBERDistribution(layer,value)| setter| Set "TX BER Distribution" Parameter| | setImpairTXBERVariance(layer,value)| setter| Set "TX BER Variance" Parameter| | setImpairTXDelay(layer,value)| setter| Set "TX Delay" Parameter| | setImpairTXDelayDistribution(layer,value)| setter| Set "TX Delay Distribution" Parameter| | setImpairTXDelayVariance(layer,value)| setter| Set "TX Delay Variance" Parameter| | setImpairTXLoss(layer,value)| setter| Set "TX Loss" Parameter| | setImpairTXLossDistribution(layer,value)| setter| Set "TX Loss Distribution" Parameter| | setImpairTXLossVariance(layer,value)| setter| Set "TX Loss Variance" Parameter| | setImpairWatch(layer,value)| setter| Set "Watch" Parameter|