networkTrafficOnOff

On-Off application traffic pattern generator

Since R2022a

Download Required: To use networkTrafficOnOff, first download the Communications Toolbox Wireless Network Simulation Library add-on.

Description

The networkTrafficOnOff object specifies the configuration parameters to generate an On-Off application traffic pattern. The On-Off traffic model, as depicted in the figure, consists of two states: on and off. This model generates packets with fixed inter-arrival time during on-state. The on-state and off-state durations follow an exponential distribution with mean OnExponentialMean and OffExponentialMean, respectively.

You can configure the networkTrafficOnOff object to generate a traffic pattern that is either periodic or bursty in nature.

Creation

Syntax

cfgOnOff = networkTrafficOnOff

cfgOnOff = networkTrafficOnOff(Name=Value)

Description

cfgOnOff = networkTrafficOnOff creates a default On-Off application traffic pattern object.

cfgOnOff = networkTrafficOnOff(Name=Value) sets properties using one or more name-value arguments. For example, GeneratePacket=true generates an application packet.

Properties

OnTime — On state duration

[ ] (default) | positive scalar

On state duration, specified as a positive scalar. Units are in seconds. To specify a customized value for the On time, specify this property. If you do not specify this property, the object uses the exponential distribution to calculate the On time.

Data Types: double

OffTime — Off state duration

[ ] (default) | nonnegative scalar

Off state duration in seconds, specified as a nonnegative scalar. To specify a customized value for the Off time, specify this property. If you do not specify this property, the object uses the exponential distribution to calculate the Off time.

Data Types: double

OnExponentialMean — Exponential distribution mean value to calculate On state duration

1 (default) | positive scalar

Exponential distribution mean value in seconds to calculate the On state duration, specified as a positive scalar.

Dependencies

To enable this property, set the OnTime property to [ ].

Data Types: double

OffExponentialMean — Exponential distribution mean value to calculate Off state duration

2 (default) | nonnegative scalar

Exponential distribution mean value in seconds to calculate the Off state duration, specified as a nonnegative scalar.

Dependencies

To enable this property, set the OffTime property to [ ].

Data Types: double

DataRate — Packet generation rate during On state

5 (default) | positive scalar

Packet generation rate in Kbps during the On state, specified as a positive scalar.

Note

If the value of this property is low and the PacketSize property value is large, the object might not generate packets in the On state.

Data Types: double

PacketSize — Length of packet to be generated

1500 (default) | positive scalar

Length in bytes of the packet to be generated, specified as a positive scalar. If the value of this property is greater than the DataRate property value, the object accumulates the data across multiple On times to generate a packet.

Data Types: double

GeneratePacket — Flag to indicate whether to generate application packet

false or 0 (default) | true or 1

Flag to indicate whether the object generates an application packet with payload, specified as a logical 0 (false) or 1 (true).

Data Types: logical

ApplicationData — Application data to be added in packet

1500-by-1 vector of 1s (default) | column vector of integers in the range [0, 255]

Application data to be added in the packet, specified as a column vector of integers in the range [0, 255]. If the size of the application data is greater than the PacketSize property value, the object truncates the application data. If the size of the application data is less than the PacketSize property value, the object appends zeros.

Dependencies

To enable this property, set the GeneratePacket property to true.

Data Types: double

Object Functions

Specific to This Object

generate

Generate next FTP, On-Off, VoIP, or video conference application traffic packet

Examples

Generate On-Off Application Traffic Pattern

Create a default On-Off application traffic pattern object.

cfgOnOff = networkTrafficOnOff;

Generate an On-Off application traffic pattern.

[dt,packetSize] = generate(cfgOnOff);

Generate On-Off Application Traffic Pattern Using On State Mean Value

Create an On-Off application traffic pattern object, specifying the exponentially distributed mean value of the On state.

cfgOnOff = networkTrafficOnOff(OnExponentialMean=5);

Generate an On-Off application traffic pattern.

[dt,packetSize] = generate(cfgOnOff);

Generate On-Off Application Traffic Pattern and Data Packet

Create an On-Off application traffic pattern object to generate an On-Off data packet.

cfgOnOff = networkTrafficOnOff(GeneratePacket=true);

Generate an On-Off application traffic pattern and data packet.

[dt,packetSize,packet] = generate(cfgOnOff);

Extended Capabilities

C/C++ Code Generation
Generate C and C++ code using MATLAB® Coder™.

Version History

Introduced in R2022a

R2023a: Moved to Communications Toolbox Wireless Network Simulation Library from 5G Toolbox, WLAN Toolbox, and Bluetooth Toolbox

Previously, networkTrafficOnOff required 5G Toolbox™, WLAN Toolbox™, or Bluetooth^® Toolbox.