Struct NetworkConnection

Public representation of a connection. Holds all information needed by the NetworkDriver to link it to an internal virtual connection.

Inherited Members

ValueType.ToString()

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetType()

Namespace: Unity.Networking.Transport

Syntax

public struct NetworkConnection : IEquatable<NetworkConnection>

Properties

InternalId

Gets the value of the connection's internal ID.

Declaration

public readonly int InternalId { get; }

Property Value

Type	Description
Int32

IsCreated

Checks to see if a connection is created.

Declaration

public readonly bool IsCreated { get; }

Property Value

Type	Description
Boolean	Whether the connection is created or not.

Remarks

Connections are considered as created only if they've been obtained by a call to Accept() or Connect(NetworkEndPoint).

Methods

Close(NetworkDriver)

Disconnects a connection and marks it for deletion. The connection will be removed on the next frame. Same as .

Declaration

public int Close(NetworkDriver driver)

Parameters

Type	Name	Description
NetworkDriver	driver	Driver to which the connection belongs.

Returns

Type	Description
Int32	An Error.StatusCode value (0 on success, -1 otherwise).

Disconnect(NetworkDriver)

Disconnects a connection and marks it for deletion. The connection will be removed on the next frame. Same as .

Declaration

public int Disconnect(NetworkDriver driver)

Parameters

Type	Name	Description
NetworkDriver	driver	Driver to which the connection belongs.

Returns

Type	Description
Int32	An Error.StatusCode value (0 on success, -1 otherwise).

Equals(Object)

Declaration

public override bool Equals(object o)

Parameters

Type	Name	Description
Object	o

Returns

Type	Description
Boolean

Overrides

ValueType.Equals(Object)

Equals(NetworkConnection)

Declaration

public bool Equals(NetworkConnection o)

Parameters

Type	Name	Description
NetworkConnection	o

Returns

Type	Description
Boolean

Implements

IEquatable<T>.Equals(T)

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

Overrides

ValueType.GetHashCode()

GetState(NetworkDriver)

Gets the state of the connection.

Declaration

public NetworkConnection.State GetState(NetworkDriver driver)

Parameters

Type	Name	Description
NetworkDriver	driver	Driver to which the connection belongs.

Returns

Type	Description
NetworkConnection.State	The value for the connection.

PopEvent(NetworkDriver, out DataStreamReader)

Receive an event for this specific connection. Should be called until it returns Empty, even if the connection is disconnected.

Declaration

public NetworkEvent.Type PopEvent(NetworkDriver driver, out DataStreamReader stream)

Parameters

Type	Name	Description
NetworkDriver	driver	Driver to which the connection belongs.
DataStreamReader	stream	A DataStreamReader, that will only be populated if a Data (or possibly Disconnect) event was received.

Returns

Type	Description
NetworkEvent.Type	The NetworkEvent.Type of the event.

PopEvent(NetworkDriver, out DataStreamReader, out NetworkPipeline)

Declaration

public NetworkEvent.Type PopEvent(NetworkDriver driver, out DataStreamReader stream, out NetworkPipeline pipeline)

Parameters

Type	Name	Description
NetworkDriver	driver
DataStreamReader	stream
NetworkPipeline	pipeline

Returns

Type	Description
NetworkEvent.Type

Operators

Equality(NetworkConnection, NetworkConnection)

Declaration

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

Parameters

Type	Name	Description
NetworkConnection	lhs
NetworkConnection	rhs

Returns

Type	Description
Boolean

Inequality(NetworkConnection, NetworkConnection)

Declaration

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

Parameters

Type	Name	Description
NetworkConnection	lhs
NetworkConnection	rhs

Returns

Type	Description
Boolean