docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Struct RelayAllocationId

    Allocation Id is a unique identifier for a connected client/host to a Relay server. This identifier is used by the Relay protocol as the address of the client.

    Implements
    IEquatable<RelayAllocationId>
    IComparable<RelayAllocationId>
    Inherited Members
    ValueType.ToString()
    object.Equals(object, object)
    object.GetType()
    object.ReferenceEquals(object, object)
    Namespace: Unity.Networking.Transport.Relay
    Assembly: Unity.Networking.Transport.dll
    Syntax
    public struct RelayAllocationId : IEquatable<RelayAllocationId>, IComparable<RelayAllocationId>

    Fields

    Value

    The raw data of the Allocation Id.

    Declaration
    public byte* Value
    Field Value
    Type Description
    byte*

    k_Length

    The length in bytes of the Allocation Id.

    Declaration
    public const int k_Length = 16
    Field Value
    Type Description
    int

    Methods

    CompareTo(RelayAllocationId)

    Declaration
    public int CompareTo(RelayAllocationId other)
    Parameters
    Type Name Description
    RelayAllocationId other
    Returns
    Type Description
    int

    Equals(object)

    Declaration
    public override bool Equals(object other)
    Parameters
    Type Name Description
    object other
    Returns
    Type Description
    bool
    Overrides
    ValueType.Equals(object)

    Equals(RelayAllocationId)

    Declaration
    public bool Equals(RelayAllocationId other)
    Parameters
    Type Name Description
    RelayAllocationId other
    Returns
    Type Description
    bool

    FromByteArray(byte[])

    Convert a byte array to a RelayAllocationId

    Declaration
    public static RelayAllocationId FromByteArray(byte[] data)
    Parameters
    Type Name Description
    byte[] data

    Array to convert.

    Returns
    Type Description
    RelayAllocationId

    New RelayAllocationId.

    FromBytePointer(byte*, int)

    Converts a byte pointer to a RelayAllocationId.

    Declaration
    public static RelayAllocationId FromBytePointer(byte* dataPtr, int length)
    Parameters
    Type Name Description
    byte* dataPtr

    The pointer to the data of the Allocation Id.

    int length

    The length of the data.

    Returns
    Type Description
    RelayAllocationId

    Returns a RelayAllocationId constructed from the provided data.

    Exceptions
    Type Condition
    ArgumentException

    Provided byte array length is invalid, must be but got .

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    int
    Overrides
    ValueType.GetHashCode()

    Operators

    operator ==(RelayAllocationId, RelayAllocationId)

    Declaration
    public static bool operator ==(RelayAllocationId lhs, RelayAllocationId rhs)
    Parameters
    Type Name Description
    RelayAllocationId lhs
    RelayAllocationId rhs
    Returns
    Type Description
    bool

    operator !=(RelayAllocationId, RelayAllocationId)

    Declaration
    public static bool operator !=(RelayAllocationId lhs, RelayAllocationId rhs)
    Parameters
    Type Name Description
    RelayAllocationId lhs
    RelayAllocationId rhs
    Returns
    Type Description
    bool

    Implements

    IEquatable<T>
    IComparable<T>
    In This Article
    Back to top
    Copyright © 2025 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)