Struct NetworkEndPoint
Describes a raw network endpoint (typically IP and port number).
Syntax
public struct NetworkEndPoint
Properties
Address
Declaration
public readonly string Address { get; }
Property Value
AnyIpv4
Gets an IPv4 endpoint that can be used to bind to any address available (0.0.0.0:0).
Declaration
public static readonly NetworkEndPoint AnyIpv4 { get; }
Property Value
AnyIpv6
Gets an IPv6 endpoint that can be used to bind to any address available ([::0]:0).
Declaration
public static readonly NetworkEndPoint AnyIpv6 { get; }
Property Value
Family
Declaration
public NetworkFamily Family { get; set; }
Property Value
IsAny
Whether the endpoint is using an "any" address.
Declaration
public readonly bool IsAny { get; }
Property Value
IsLoopback
Whether the endpoint is using a loopback address.
Declaration
public readonly bool IsLoopback { get; }
Property Value
IsValid
Whether the endpoint is valid or not.
Declaration
public readonly bool IsValid { get; }
Property Value
Length
Returns the length of the raw network endpoint in bytes.
Declaration
public readonly int Length { get; }
Property Value
LoopbackIpv4
Gets an IPv4 loopback endpoint (127.0.0.1:0).
Declaration
public static readonly NetworkEndPoint LoopbackIpv4 { get; }
Property Value
LoopbackIpv6
Gets an IPv6 loopback endpoint ([::1]:0).
Declaration
public static readonly NetworkEndPoint LoopbackIpv6 { get; }
Property Value
Port
Gets or sets port number of the endpoint.
Declaration
public ushort Port { get; set; }
Property Value
RawPort
Gets or sets the value of the raw port number.
Declaration
public ushort RawPort { get; set; }
Property Value
Methods
Equals(Object)
Declaration
public override bool Equals(object other)
Parameters
| Type |
Name |
Description |
| Object |
other |
|
Returns
GetHashCode()
Declaration
public override int GetHashCode()
Returns
GetRawAddressBytes()
Gets the raw bytes for the endpoint.
Declaration
public NativeArray<byte> GetRawAddressBytes()
Returns
| Type |
Description |
| NativeArray<Byte> |
Native array containing the raw bytes (uses temporary allocation).
|
Parse(String, UInt16, NetworkFamily)
Declaration
public static NetworkEndPoint Parse(string address, ushort port, NetworkFamily family = default(NetworkFamily))
Parameters
Returns
SetRawAddressBytes(NativeArray<Byte>, NetworkFamily)
Directly sets the raw bytes of the endpoint using the specified bytes and family.
Declaration
public void SetRawAddressBytes(NativeArray<byte> bytes, NetworkFamily family = default(NetworkFamily))
Parameters
| Type |
Name |
Description |
| NativeArray<Byte> |
bytes |
Raw bytes to use for the endpoint.
|
| NetworkFamily |
family |
Endpoint's address family.
|
ToString()
Declaration
public override string ToString()
Returns
TryParse(String, UInt16, out NetworkEndPoint, NetworkFamily)
Declaration
public static bool TryParse(string address, ushort port, out NetworkEndPoint endpoint, NetworkFamily family = default(NetworkFamily))
Parameters
Returns
WithPort(UInt16)
Use the given port number for this endpoint.
Declaration
public NetworkEndPoint WithPort(ushort port)
Parameters
| Type |
Name |
Description |
| UInt16 |
port |
The port number.
|
Returns
Operators
Equality(NetworkEndPoint, NetworkEndPoint)
Declaration
public static bool operator ==(NetworkEndPoint lhs, NetworkEndPoint rhs)
Parameters
Returns
Inequality(NetworkEndPoint, NetworkEndPoint)
Declaration
public static bool operator !=(NetworkEndPoint lhs, NetworkEndPoint rhs)
Parameters
Returns
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.