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.
Assembly: Unity.Networking.Transport.dll
Syntax
public struct RelayAllocationId : IEquatable<RelayAllocationId>, IComparable<RelayAllocationId>
Fields
Value
The raw data of the Allocation Id.
Declaration
Field Value
k_Length
The length in bytes of the Allocation Id.
Declaration
public const int k_Length = 16
Field Value
Methods
CompareTo(RelayAllocationId)
Declaration
public int CompareTo(RelayAllocationId other)
Parameters
Returns
Equals(object)
Declaration
public override bool Equals(object other)
Parameters
| Type |
Name |
Description |
| object |
other |
|
Returns
Overrides
Equals(RelayAllocationId)
Declaration
public bool Equals(RelayAllocationId other)
Parameters
Returns
FromByteArray(byte[])
Declaration
public static RelayAllocationId FromByteArray(byte[] data)
Parameters
| Type |
Name |
Description |
| byte[] |
data |
Array to convert.
|
Returns
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 {k_Length} but got {length}.
|
GetHashCode()
Declaration
public override int GetHashCode()
Returns
Overrides
Operators
operator ==(RelayAllocationId, RelayAllocationId)
Declaration
public static bool operator ==(RelayAllocationId lhs, RelayAllocationId rhs)
Parameters
Returns
operator !=(RelayAllocationId, RelayAllocationId)
Declaration
public static bool operator !=(RelayAllocationId lhs, RelayAllocationId rhs)
Parameters
Returns
Implements
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.