docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Struct ReliableUtility

    Utility types, methods, and constants for the ReliableSequencedPipelineStage.

    Inherited Members
    ValueType.Equals(object)
    ValueType.GetHashCode()
    ValueType.ToString()
    object.Equals(object, object)
    object.GetType()
    object.ReferenceEquals(object, object)
    Namespace: Unity.Networking.Transport.Utilities
    Assembly: Unity.Networking.Transport.dll
    Syntax
    public struct ReliableUtility

    Fields

    DefaultMaximumResendTime

    Maximum amount of time to wait before a reliable packet is resent if it's not been acknowledged. That is, even with a high RTT the reliable pipeline will never wait longer than this value to resend a packet. Can be modified at runtime with SetMaximumResendTime(int, NetworkDriver, NetworkPipeline, NetworkConnection) or configured when creating a driver through custom NetworkSettings.

    Declaration
    public const int DefaultMaximumResendTime = 200
    Field Value
    Type Description
    int

    Maximum resend time in milliseconds.

    DefaultMinimumResendTime

    Minimum amount of time to wait before a reliable packet is resent if it's not been acknowledged. Can be modified at runtime with SetMinimumResendTime(int, NetworkDriver, NetworkPipeline, NetworkConnection), or configured when creating a driver through custom NetworkSettings.

    Declaration
    public const int DefaultMinimumResendTime = 64
    Field Value
    Type Description
    int

    Minimum resend time in milliseconds.

    MaximumResendTime

    Obsolete. Renamed to DefaultMaximumResendTime.

    Declaration
    [Obsolete("Renamed to DefaultMaximumResendTime. (UnityUpgradable) -> DefaultMaximumResendTime")]
    public const int MaximumResendTime = 200
    Field Value
    Type Description
    int

    Methods

    SetMaximumResendTime(int, NetworkDriver, NetworkPipeline, NetworkConnection)

    Modify the maximum resend time used by the reliable pipeline stage for the given pipeline and connection. The default value should be good for most use cases, unless the connection is rather poor (more than 200ms RTT), in which case this value should be increased to be slightly above the RTT (otherwise the pipeline will useless resend packets, increasing bandwidth usage).

    Declaration
    public static void SetMaximumResendTime(int value, NetworkDriver driver, NetworkPipeline pipeline, NetworkConnection connection)
    Parameters
    Type Name Description
    int value

    New maximum resend time.

    NetworkDriver driver

    Driver to modify.

    NetworkPipeline pipeline

    Pipeline to modify.

    NetworkConnection connection

    Connection to modify the value for.

    SetMinimumResendTime(int, NetworkDriver, NetworkPipeline, NetworkConnection)

    Modify the minimum resend time used by the reliable pipeline stage for the given pipeline and connection. The default value should be good for most use cases, unless the connection is extremely good (less than 25ms RTT), in which case lowering this value could potentially reduce latency when packet loss occurs.

    Declaration
    public static void SetMinimumResendTime(int value, NetworkDriver driver, NetworkPipeline pipeline, NetworkConnection connection)
    Parameters
    Type Name Description
    int value

    New minimum resend time.

    NetworkDriver driver

    Driver to modify.

    NetworkPipeline pipeline

    Pipeline to modify.

    NetworkConnection connection

    Connection to modify the value for.

    In This Article
    Back to top
    Copyright © 2024 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)