Struct NetworkConnection

The NetworkConnection is a struct that hold all information needed by the driver to link it with a virtual connection. The NetworkConnection is a public representation of a connection.

Namespace: Unity.Networking.Transport
Syntax
public struct NetworkConnection

Properties

InternalId

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

IsCreated

Check to see if a NetworkConnection is Created.

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

true if the NetworkConnection has been correctly created by a call to Accept() or Connect(NetworkEndPoint)

Methods

Close<T>(T)

Close an active NetworkConnection, similar to Disconnect<T>(T).

Declaration
public int Close<T>(T driver)
    where T : struct, INetworkDriver
Parameters
Type Name Description
T driver

The driver that owns the virtual connection.
Returns
Type Description
Int32
Type Parameters
Name Description
T

Disconnect<T>(T)

Disconnects a virtual connection and marks it for deletion. This connection will be removed on next the next frame.

Declaration
public int Disconnect<T>(T driver)
    where T : struct, INetworkDriver
Parameters
Type Name Description
T driver

The driver that owns the virtual connection.
Returns
Type Description
Int32
Type Parameters
Name Description
T

Equals(Object)

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

Equals(NetworkConnection)

Declaration
public bool Equals(NetworkConnection o)
Parameters
Type Name Description
NetworkConnection o
Returns
Type Description
Boolean

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
Overrides

GetState<T>(T)

Declaration
public NetworkConnection.State GetState<T>(T driver)
    where T : struct, INetworkDriver
Parameters
Type Name Description
T driver
Returns
Type Description
NetworkConnection.State
Type Parameters
Name Description
T

PopEvent<T>(T, out DataStreamReader)

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

Declaration
public NetworkEvent.Type PopEvent<T>(T driver, out DataStreamReader stream)
    where T : struct, INetworkDriver
Parameters
Type Name Description
T driver

The driver that owns the virtual connection.
DataStreamReader stream
Returns
Type Description
NetworkEvent.Type
Type Parameters
Name Description
T

Send<T>(T, DataStreamWriter)

Send data to the remote endpoint.

Declaration
public int Send<T>(T driver, DataStreamWriter bs)
    where T : struct, INetworkDriver
Parameters
Type Name Description
T driver

The driver that owns the virtual connection.
DataStreamWriter bs
Returns
Type Description
Int32
Type Parameters
Name Description
T

Send<T>(T, NetworkPipeline, DataStreamWriter)

Declaration
public int Send<T>(T driver, NetworkPipeline pipeline, DataStreamWriter bs)
    where T : struct, INetworkDriver
Parameters
Type Name Description
T driver
NetworkPipeline pipeline
DataStreamWriter bs
Returns
Type Description
Int32
Type Parameters
Name Description
T

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