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
Overrides
GetHashCode()
Declaration
public override int GetHashCode()
Returns
Overrides
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 = NetworkFamily.Ipv4)
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 = NetworkFamily.Ipv4)
Parameters
Exceptions
ToString()
Declaration
public override string ToString()
Returns
Overrides
TryParse(String, UInt16, out NetworkEndPoint, NetworkFamily)
Declaration
public static bool TryParse(string address, ushort port, out NetworkEndPoint endpoint, NetworkFamily family = NetworkFamily.Ipv4)
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