Skip to main content

Unity.Networking.Transport.NetworkEndPoint

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

Inherited Members#

ValueType.ToString()

Object.Equals(Object, Object)

Object.GetType()

Object.ReferenceEquals(Object, Object)

Namespace: System.Dynamic.ExpandoObject#
Assembly: transport.dll#
Syntax#
public struct NetworkEndPoint

Address#

Declaration#

public readonly string Address { get; }

Property Value#

TypeDescription
System.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#

TypeDescription
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#

TypeDescription
NetworkEndPoint

Family#

Gets or sets NetworkFamily of the endpoint.

Declaration#

public NetworkFamily Family { get; set; }

Property Value#

TypeDescription
NetworkFamily

IsAny#

Whether the endpoint is using an "any" address.

Declaration#

public readonly bool IsAny { get; }

Property Value#

TypeDescription
System.Boolean

IsLoopback#

Whether the endpoint is using a loopback address.

Declaration#

public readonly bool IsLoopback { get; }

Property Value#

TypeDescription
System.Boolean

IsValid#

Whether the endpoint is valid or not.

Declaration#

public readonly bool IsValid { get; }

Property Value#

TypeDescription
System.Boolean

Length#

Returns the length of the raw network endpoint in bytes.

Declaration#

public readonly int Length { get; }

Property Value#

TypeDescription
System.Int32

LoopbackIpv4#

Gets an IPv4 loopback endpoint (127.0.0.1:0).

Declaration#

public static readonly NetworkEndPoint LoopbackIpv4 { get; }

Property Value#

TypeDescription
NetworkEndPoint

LoopbackIpv6#

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

Declaration#

public static readonly NetworkEndPoint LoopbackIpv6 { get; }

Property Value#

TypeDescription
NetworkEndPoint

Port#

Gets or sets port number of the endpoint.

Declaration#

public ushort Port { get; set; }

Property Value#

TypeDescription
System.UInt16

RawPort#

Gets or sets the value of the raw port number.

Declaration#

public ushort RawPort { get; set; }

Property Value#

TypeDescription
System.UInt16

#

Equals(Object)#

Declaration#

public override bool Equals(object other)

Parameters#

TypeNameDescription
System.Objectother

Returns#

TypeDescription
System.Boolean

Overrides#

System.ValueType.Equals(System.Object)

GetHashCode()#

Declaration#

public override int GetHashCode()

Returns#

TypeDescription
System.Int32

Overrides#

System.ValueType.GetHashCode()

GetRawAddressBytes()#

Gets the raw bytes for the endpoint.

Declaration#

public NativeArray<byte> GetRawAddressBytes()

Returns#

TypeDescription
NativeArray\<System.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#

TypeNameDescription
System.Stringaddress
System.UInt16port
NetworkFamilyfamily

Returns#

TypeDescription
NetworkEndPoint

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#

TypeNameDescription
NativeArray\<System.Byte>bytesRaw bytes to use for the endpoint.
NetworkFamilyfamilyEndpoint's address family.

Exceptions#

TypeCondition
System.InvalidOperationExceptionLength of bytes doesn't match family.

TryParse(String, UInt16, out NetworkEndPoint, NetworkFamily)#

Declaration#

public static bool TryParse(string address, ushort port, out NetworkEndPoint endpoint, NetworkFamily family = NetworkFamily.Ipv4)

Parameters#

TypeNameDescription
System.Stringaddress
System.UInt16port
NetworkEndPointendpoint
NetworkFamilyfamily

Returns#

TypeDescription
System.Boolean

WithPort(UInt16)#

Use the given port number for this endpoint.

Declaration#

public NetworkEndPoint WithPort(ushort port)

Parameters#

TypeNameDescription
System.UInt16portThe port number.

Returns#

TypeDescription
NetworkEndPointThe endpoint (this).

#

Equality(NetworkEndPoint, NetworkEndPoint)#

Declaration#

public static bool operator ==(NetworkEndPoint lhs, NetworkEndPoint rhs)

Parameters#

TypeNameDescription
NetworkEndPointlhs
NetworkEndPointrhs

Returns#

TypeDescription
System.Boolean

Inequality(NetworkEndPoint, NetworkEndPoint)#

Declaration#

public static bool operator !=(NetworkEndPoint lhs, NetworkEndPoint rhs)

Parameters#

TypeNameDescription
NetworkEndPointlhs
NetworkEndPointrhs

Returns#

TypeDescription
System.Boolean