docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class RelayParameterExtensions

    Extensions for RelayNetworkParameter.

    Inheritance
    object
    RelayParameterExtensions
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Unity.Networking.Transport.Relay
    Assembly: Unity.Networking.Transport.dll
    Syntax
    public static class RelayParameterExtensions

    Methods

    GetRelayParameters(ref NetworkSettings)

    Gets the RelayNetworkParameter in the settings.

    Declaration
    public static RelayNetworkParameter GetRelayParameters(this ref NetworkSettings settings)
    Parameters
    Type Name Description
    NetworkSettings settings

    Settings to get parameters from.

    Returns
    Type Description
    RelayNetworkParameter

    Structure containing the relay parameters.

    WithRelayParameters(ref NetworkSettings, ref RelayServerData, int)

    Sets the RelayNetworkParameter in the settings.

    Declaration
    public static ref NetworkSettings WithRelayParameters(this ref NetworkSettings settings, ref RelayServerData serverData, int relayConnectionTimeMS = 3000)
    Parameters
    Type Name Description
    NetworkSettings settings

    Settings to modify.

    RelayServerData serverData

    Connection information about the relay server.

    int relayConnectionTimeMS

    Frequency at which the relay server will be pinged to maintain the connection alive. Should be set to less than 10 seconds (default is 3 seconds) since that's the time after which the relay server will sever the connection if there is no activity.

    Returns
    Type Description
    NetworkSettings

    Settings structure with modified values.

    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)