Photon Fusion 1.1.2

Public Member Functions | Public Attributes | List of all members
NetworkSimulationConfiguration Class Reference

Configuration for network conditions simulation (induced latency and loss). More...

Public Member Functions

NetworkSimulationConfiguration Clone ()
 
NetConfigSimulation Create ()
 

Public Attributes

bool Enabled
 If adverse network conditions are being simulated. More...
 
NetConfigSimulationOscillator.WaveShape DelayShape = NetConfigSimulationOscillator.WaveShape.Sine
 The pattern used to oscillate between DelayMin and DelayMax values. More...
 
double DelayMin = .01
 The lowest packet delay value returned from the DelayShape oscillator. More...
 
double DelayMax = .1
 The highest packet delay value returned from the DelayShape oscillator. More...
 
double DelayPeriod = 3
 The period of the DelayShape oscillator (the rate at which delay oscillates in seconds). More...
 
double DelayThreshold = .5
 The DelayShape oscillates between 0 and 1. Values below this threshold are reduced to zero, resulting in a value equal to DelayMin. More...
 
double AdditionalJitter = .01
 After the delay value from the DelayShape oscillator is determined, random 0 to this value of additional seconds be added to the packet latency. More...
 
NetConfigSimulationOscillator.WaveShape LossChanceShape = NetConfigSimulationOscillator.WaveShape.Sine
 The pattern used to oscillate between LossChanceMin and LossChanceMax values. More...
 
double LossChanceMin = 0
 The lowest loss chance value the LossChanceShape oscillator will produce. 0 = 0% chance of being lost. 1 = 100% chance of being lost. More...
 
double LossChanceMax = 0.02
 The highest loss chance value the LossChanceShape oscillator will produce. 0 = 0% chance of being lost. 1 = 100% chance of being lost. More...
 
double LossChanceThreshold = 0.9
 The LossChanceShape wave oscillates between 0 and 1. Values below this threshold are reduced to zero, resulting in a value equal to LossChanceMin. More...
 
double LossChancePeriod = 3
 The period of the LossChanceShape oscillator (the rate at which delay oscillates between LossChanceMin and LossChanceMax). More...
 
double AdditionalLoss = 0.005
 After the LossChanceShape oscillation loss chance is calculated, an additional random value of 0 to this (normalized) percentage of loss chance is added. More...
 

Detailed Description

Configuration for network conditions simulation (induced latency and loss).

Member Data Documentation

◆ AdditionalJitter

double AdditionalJitter = .01

After the delay value from the DelayShape oscillator is determined, random 0 to this value of additional seconds be added to the packet latency.

◆ AdditionalLoss

double AdditionalLoss = 0.005

After the LossChanceShape oscillation loss chance is calculated, an additional random value of 0 to this (normalized) percentage of loss chance is added.

◆ DelayMax

double DelayMax = .1

The highest packet delay value returned from the DelayShape oscillator.

◆ DelayMin

double DelayMin = .01

The lowest packet delay value returned from the DelayShape oscillator.

◆ DelayPeriod

double DelayPeriod = 3

The period of the DelayShape oscillator (the rate at which delay oscillates in seconds).

◆ DelayShape

NetConfigSimulationOscillator.WaveShape DelayShape = NetConfigSimulationOscillator.WaveShape.Sine

The pattern used to oscillate between DelayMin and DelayMax values.

◆ DelayThreshold

double DelayThreshold = .5

The DelayShape oscillates between 0 and 1. Values below this threshold are reduced to zero, resulting in a value equal to DelayMin.

◆ Enabled

bool Enabled

If adverse network conditions are being simulated.

◆ LossChanceMax

double LossChanceMax = 0.02

The highest loss chance value the LossChanceShape oscillator will produce. 0 = 0% chance of being lost. 1 = 100% chance of being lost.

◆ LossChanceMin

double LossChanceMin = 0

The lowest loss chance value the LossChanceShape oscillator will produce. 0 = 0% chance of being lost. 1 = 100% chance of being lost.

◆ LossChancePeriod

double LossChancePeriod = 3

The period of the LossChanceShape oscillator (the rate at which delay oscillates between LossChanceMin and LossChanceMax).

◆ LossChanceShape

NetConfigSimulationOscillator.WaveShape LossChanceShape = NetConfigSimulationOscillator.WaveShape.Sine

The pattern used to oscillate between LossChanceMin and LossChanceMax values.

◆ LossChanceThreshold

double LossChanceThreshold = 0.9

The LossChanceShape wave oscillates between 0 and 1. Values below this threshold are reduced to zero, resulting in a value equal to LossChanceMin.