docs.unity3d.com
    Show / Hide Table of Contents

    Struct RelayNetworkParameter

    Relay protocol network parementers used to connect to the Unity Relay service. This data must be provided to the Create(NetworkSettings) function in order to be able to use connect to Relay.

    Inherited Members
    ValueType.Equals(Object)
    ValueType.GetHashCode()
    ValueType.ToString()
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Namespace: Unity.Networking.Transport.Relay
    Syntax
    public struct RelayNetworkParameter : INetworkParameter

    Fields

    RelayConnectionTimeMS

    The timeout in milliseconds after which a ping message is sent to the Relay Server to keep the connection alive.

    Declaration
    public int RelayConnectionTimeMS
    Field Value
    Type Description
    Int32

    ServerData

    The data that is used to describe the connection to the Relay Server.

    Declaration
    public RelayServerData ServerData
    Field Value
    Type Description
    RelayServerData

    Methods

    Validate()

    Validate the settings.

    Declaration
    public bool Validate()
    Returns
    Type Description
    Boolean

    True if the settings are valid, false otherwise.

    Implements
    INetworkParameter.Validate()
    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