Struct SimulatorUtility.Parameters | Unity Transport | 0.2.4-preview.0
docs.unity3d.com
    Show / Hide Table of Contents

    Struct SimulatorUtility.Parameters

    Configuration parameters for the simulator pipeline stage.

    Namespace: Unity.Networking.Transport.Utilities
    Syntax
    public struct Parameters : INetworkParameter

    Fields

    MaxPacketCount

    The maximum amount of packets the pipeline can keep track of. This used when a packet is delayed, the packet is stored in the pipeline processing buffer and can be later brought back.

    Declaration
    public int MaxPacketCount
    Field Value
    Type Description
    Int32

    MaxPacketSize

    The maximum size of a packet which the simulator stores. If a packet exceeds this size it will bypass the simulator.

    Declaration
    public int MaxPacketSize
    Field Value
    Type Description
    Int32

    PacketDelayMs

    Fixed delay to apply to all packets which pass through.

    Declaration
    public int PacketDelayMs
    Field Value
    Type Description
    Int32

    PacketDropInterval

    Fixed interval to drop packets on. This is most suitable for tests where predictable behaviour is desired, every Xth packet will be dropped. If PacketDropInterval is 5 every 5th packet is dropped.

    Declaration
    public int PacketDropInterval
    Field Value
    Type Description
    Int32

    PacketDropPercentage

    Use a drop percentage when deciding when to drop packet. For every packet a random number generator is used to determine if the packet should be dropped or not. A percentage of 5 means approximately every 20th packet will be dropped.

    Declaration
    public int PacketDropPercentage
    Field Value
    Type Description
    Int32

    PacketJitterMs

    Variable delay to apply to all packets which pass through, adds or subtracts amount from fixed delay.

    Declaration
    public int PacketJitterMs
    Field Value
    Type Description
    Int32
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023