docs.unity3d.com
    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.

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

    Fields

    k_Length

    The length in bytes of the Allocation Id.

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

    Value

    The raw data of the Allocation Id.

    Declaration
    public byte *Value
    Field Value
    Type Description
    Byte*

    Methods

    CompareTo(RelayAllocationId)

    Declaration
    public int CompareTo(RelayAllocationId other)
    Parameters
    Type Name Description
    RelayAllocationId other
    Returns
    Type Description
    Int32
    Implements
    IComparable<T>.CompareTo(T)

    Equals(Object)

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

    Equals(RelayAllocationId)

    Declaration
    public bool Equals(RelayAllocationId other)
    Parameters
    Type Name Description
    RelayAllocationId other
    Returns
    Type Description
    Boolean
    Implements
    IEquatable<T>.Equals(T)

    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*, Int32)

    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.

    Int32 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 {k_Length} but got {length}.

    GetHashCode()

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

    Operators

    Equality(RelayAllocationId, RelayAllocationId)

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

    Inequality(RelayAllocationId, RelayAllocationId)

    Declaration
    public static bool operator !=(RelayAllocationId lhs, RelayAllocationId rhs)
    Parameters
    Type Name Description
    RelayAllocationId lhs
    RelayAllocationId rhs
    Returns
    Type Description
    Boolean
    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