Struct NetworkEndPoint

Describes a raw network endpoint (typically IP and port number).

Inherited Members
Namespace: Unity.Networking.Transport
Syntax
public struct NetworkEndPoint

Properties

Address

Gets the endpoint's representation as a string.

Declaration
public readonly string Address { get; }
Property Value
Type Description
String

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
Type Description
NetworkEndPoint

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
Type Description
NetworkEndPoint

Family

Gets or sets NetworkFamily of the endpoint.

Declaration
public NetworkFamily Family { get; set; }
Property Value
Type Description
NetworkFamily

IsAny

Whether the endpoint is using an "any" address.

Declaration
public readonly bool IsAny { get; }
Property Value
Type Description
Boolean

IsLoopback

Whether the endpoint is using a loopback address.

Declaration
public readonly bool IsLoopback { get; }
Property Value
Type Description
Boolean

IsValid

Whether the endpoint is valid or not.

Declaration
public readonly bool IsValid { get; }
Property Value
Type Description
Boolean

Length

Returns the length of the raw network endpoint in bytes.

Declaration
public readonly int Length { get; }
Property Value
Type Description
Int32

LoopbackIpv4

Gets an IPv4 loopback endpoint (127.0.0.1:0).

Declaration
public static readonly NetworkEndPoint LoopbackIpv4 { get; }
Property Value
Type Description
NetworkEndPoint

LoopbackIpv6

Gets an IPv6 loopback endpoint ([::1]:0).

Declaration
public static readonly NetworkEndPoint LoopbackIpv6 { get; }
Property Value
Type Description
NetworkEndPoint

Port

Gets or sets port number of the endpoint.

Declaration
public ushort Port { get; set; }
Property Value
Type Description
UInt16

RawPort

Gets or sets the value of the raw port number.

Declaration
public ushort RawPort { get; set; }
Property Value
Type Description
UInt16

Methods

Equals(Object)

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

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
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)

Same as , except an endpoint is always returned. If the given address, port, and family don't represent a valid endpoint, the default one is returned.

Declaration
public static NetworkEndPoint Parse(string address, ushort port, NetworkFamily family = NetworkFamily.Ipv4)
Parameters
Type Name Description
String address

String representation of the address.
UInt16 port

Return value for the parsed endpoint.
NetworkFamily family

Address family of 'address'.
Returns
Type Description
NetworkEndPoint

Parsed network endpoint (default if parsing failed).

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
Type Name Description
NativeArray<Byte> bytes

Raw bytes to use for the endpoint.
NetworkFamily family

Endpoint's address family.
Exceptions
Type Condition
InvalidOperationException

Length of bytes doesn't match family.

ToString()

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

TryParse(String, UInt16, out NetworkEndPoint, NetworkFamily)

Try to parse the given address and port into a new NetworkEndPoint.

Declaration
public static bool TryParse(string address, ushort port, out NetworkEndPoint endpoint, NetworkFamily family = NetworkFamily.Ipv4)
Parameters
Type Name Description
String address

String representation of the address.
UInt16 port

Port number.
NetworkEndPoint endpoint

Return value for the parsed endpoint.
NetworkFamily family

Address family of 'address'.
Returns
Type Description
Boolean

Whether the endpoint was successfully parsed or not.

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
Type Description
NetworkEndPoint

The endpoint (this).

Operators

Equality(NetworkEndPoint, NetworkEndPoint)

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

Inequality(NetworkEndPoint, NetworkEndPoint)

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