docs.unity3d.com
    Show / Hide Table of Contents

    Struct RelayServerData

    Used by the Relay Protocol to describe how to connect to the Relay Service.

    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 RelayServerData

    Constructors

    RelayServerData(String, UInt16, Byte[], Byte[], Byte[], Byte[], Boolean)

    Create a new Relay server data structure.

    Declaration
    public RelayServerData(string host, ushort port, byte[] allocationId, byte[] connectionData, byte[] hostConnectionData, byte[] key, bool isSecure)
    Parameters
    Type Name Description
    String host

    IP address of the Relay server.

    UInt16 port

    Port of the Relay server.

    Byte[] allocationId

    ID of the Relay allocation.

    Byte[] connectionData

    Connection data of the allocation.

    Byte[] hostConnectionData

    Connection data of the host (same as previous for hosts).

    Byte[] key

    HMAC signature of the allocation.

    Boolean isSecure

    Whether the Relay connection is to be secured or not.

    RelayServerData(ref NetworkEndPoint, UInt16, RelayAllocationId, String, String, String, Boolean)

    Initializes a new instance of the RelayServerData class

    Declaration
    [Obsolete("Will be removed in Unity Transport 2.0. Use the new constructor introduced in 1.3 instead.", false)]
    public RelayServerData(ref NetworkEndPoint endpoint, ushort nonce, RelayAllocationId allocationId, string connectionData, string hostConnectionData, string key, bool isSecure)
    Parameters
    Type Name Description
    NetworkEndPoint endpoint

    The endpoint

    UInt16 nonce

    The nonce

    RelayAllocationId allocationId

    The allocation id

    String connectionData

    The connection data

    String hostConnectionData

    The host connection data

    String key

    The key

    Boolean isSecure

    The is secure

    RelayServerData(ref NetworkEndPoint, UInt16, ref RelayAllocationId, ref RelayConnectionData, ref RelayConnectionData, ref RelayHMACKey, Boolean)

    Initializes a new instance of the RelayServerData class

    Declaration
    public RelayServerData(ref NetworkEndPoint endpoint, ushort nonce, ref RelayAllocationId allocationId, ref RelayConnectionData connectionData, ref RelayConnectionData hostConnectionData, ref RelayHMACKey key, bool isSecure)
    Parameters
    Type Name Description
    NetworkEndPoint endpoint

    The endpoint

    UInt16 nonce

    The nonce

    RelayAllocationId allocationId

    The allocation id

    RelayConnectionData connectionData

    The connection data

    RelayConnectionData hostConnectionData

    The host connection data

    RelayHMACKey key

    The key

    Boolean isSecure

    The is secure

    Fields

    AllocationId

    The unique identifier of the client on the Relay Server.

    Declaration
    public RelayAllocationId AllocationId
    Field Value
    Type Description
    RelayAllocationId

    ConnectionData

    The data that describes the client presence on the Relay Server.

    Declaration
    public RelayConnectionData ConnectionData
    Field Value
    Type Description
    RelayConnectionData

    Endpoint

    The endpoint of the Relay Server.

    Declaration
    public NetworkEndPoint Endpoint
    Field Value
    Type Description
    NetworkEndPoint

    HMAC

    The computed HMAC.

    Declaration
    public byte *HMAC
    Field Value
    Type Description
    Byte*

    HMACKey

    The HMAC key for the connection.

    Declaration
    public RelayHMACKey HMACKey
    Field Value
    Type Description
    RelayHMACKey

    HostConnectionData

    The connection data of the host client on the Relay Server.

    Declaration
    public RelayConnectionData HostConnectionData
    Field Value
    Type Description
    RelayConnectionData

    IsSecure

    A byte that identifies the connection as secured.

    Declaration
    public readonly byte IsSecure
    Field Value
    Type Description
    Byte

    Nonce

    The Nonce value used to stablish the connection with the Relay Server.

    Declaration
    public ushort Nonce
    Field Value
    Type Description
    UInt16

    Methods

    ComputeNewNonce()

    Computes the new nonce, this must be called one time!

    Declaration
    [Obsolete("Will be removed in Unity Transport 2.0. There shouldn't be any need to call this method.")]
    public void ComputeNewNonce()
    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