Struct NetworkConnection | Unity Transport | 0.3.1-preview.4
docs.unity3d.com
    Show / Hide Table of Contents

    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(NetworkDriver)

    Close an active NetworkConnection, similar to .

    Declaration
    public int Close(NetworkDriver driver)
    Parameters
    Type Name Description
    NetworkDriver driver

    The driver that owns the virtual connection.

    Returns
    Type Description
    Int32

    Disconnect(NetworkDriver)

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

    Declaration
    public int Disconnect(NetworkDriver driver)
    Parameters
    Type Name Description
    NetworkDriver driver

    The driver that owns the virtual connection.

    Returns
    Type Description
    Int32

    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

    GetHashCode()

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

    GetState(NetworkDriver)

    Declaration
    public NetworkConnection.State GetState(NetworkDriver driver)
    Parameters
    Type Name Description
    NetworkDriver driver
    Returns
    Type Description
    NetworkConnection.State

    PopEvent(NetworkDriver, 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(NetworkDriver driver, out DataStreamReader stream)
    Parameters
    Type Name Description
    NetworkDriver driver

    The driver that owns the virtual connection.

    DataStreamReader stream
    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
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023