docs.unity3d.com
    Show / Hide Table of Contents

    Struct BaselibNetworkInterface

    Default NetworkInterface implementation based on Unity's internal Baselib UDP sockets this is ensure to work on all platforms except for Unity's WebGL.

    Inherited Members
    ValueType.Equals(Object)
    ValueType.GetHashCode()
    ValueType.ToString()
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Namespace: Unity.Networking.Transport
    Syntax
    [BurstCompile]
    public struct BaselibNetworkInterface : INetworkInterface, IDisposable

    Fields

    DefaultParameters

    Default Parameters for BaselibNetworkInterface

    Declaration
    public static BaselibNetworkParameter DefaultParameters
    Field Value
    Type Description
    BaselibNetworkParameter

    Properties

    IsCreated

    Gets if the interface has been created.

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

    LocalEndPoint

    Returns the local endpoint the BaselibNetworkInterface is bound to.

    Declaration
    public readonly NetworkInterfaceEndPoint LocalEndPoint { get; }
    Property Value
    Type Description
    NetworkInterfaceEndPoint

    NetworkInterfaceEndPoint

    Implements
    INetworkInterface.LocalEndPoint

    Methods

    Bind(NetworkInterfaceEndPoint)

    Binds the medium to a specific endpoint.

    Declaration
    public int Bind(NetworkInterfaceEndPoint endpoint)
    Parameters
    Type Name Description
    NetworkInterfaceEndPoint endpoint

    A valid NetworkInterfaceEndPoint.

    Returns
    Type Description
    Int32

    Returns 0 on success.

    Implements
    INetworkInterface.Bind(NetworkInterfaceEndPoint)

    CreateInterfaceEndPoint(NetworkEndPoint, out NetworkInterfaceEndPoint)

    Converts a generic NetworkEndPoint to its NetworkInterfaceEndPoint version for the BaselibNetworkInterface.

    Declaration
    public int CreateInterfaceEndPoint(NetworkEndPoint address, out NetworkInterfaceEndPoint endpoint)
    Parameters
    Type Name Description
    NetworkEndPoint address

    The NetworkEndPoint endpoint to convert.

    NetworkInterfaceEndPoint endpoint

    The new NetworkInterfaceEndPoint.

    Returns
    Type Description
    Int32

    returns 0 on success and sets the converted endpoint value

    Implements
    INetworkInterface.CreateInterfaceEndPoint(NetworkEndPoint, out NetworkInterfaceEndPoint)

    CreateSendInterface()

    Creates the send interface

    Declaration
    public NetworkSendInterface CreateSendInterface()
    Returns
    Type Description
    NetworkSendInterface

    The network send interface

    Implements
    INetworkInterface.CreateSendInterface()

    Dispose()

    Disposes this instance

    Declaration
    public void Dispose()
    Implements
    IDisposable.Dispose()

    GetGenericEndPoint(NetworkInterfaceEndPoint)

    Converts a NetworkInterfaceEndPoint to its generic NetworkEndPoint version.

    Declaration
    public NetworkEndPoint GetGenericEndPoint(NetworkInterfaceEndPoint endpoint)
    Parameters
    Type Name Description
    NetworkInterfaceEndPoint endpoint

    The NetworkInterfaceEndPoint endpoint to convert.

    Returns
    Type Description
    NetworkEndPoint

    Returns the converted endpoint value.

    Implements
    INetworkInterface.GetGenericEndPoint(NetworkInterfaceEndPoint)

    Initialize(NetworkSettings)

    Initializes a instance of the BaselibNetworkInterface struct.

    Declaration
    public int Initialize(NetworkSettings settings)
    Parameters
    Type Name Description
    NetworkSettings settings

    NetworkSettings with which to configure the interface.

    Returns
    Type Description
    Int32

    Returns 0 on success.

    Implements
    INetworkInterface.Initialize(NetworkSettings)

    Listen()

    Listens on the socket, currently this Interface doesn't support listening as its UDP based.

    Declaration
    public int Listen()
    Returns
    Type Description
    Int32

    Returns 0

    Implements
    INetworkInterface.Listen()

    ScheduleReceive(NetworkPacketReceiver, JobHandle)

    Schedule a ReceiveJob. This is used to read data from your supported medium and pass it to the AppendData function supplied by NetworkDriver

    Declaration
    public JobHandle ScheduleReceive(NetworkPacketReceiver receiver, JobHandle dep)
    Parameters
    Type Name Description
    NetworkPacketReceiver receiver

    A NetworkDriver used to parse the data received.

    JobHandle dep

    A JobHandle to any dependency we might have.

    Returns
    Type Description
    JobHandle

    A JobHandle to our newly created ScheduleReceive Job.

    Implements
    INetworkInterface.ScheduleReceive(NetworkPacketReceiver, JobHandle)

    ScheduleSend(NativeQueue<QueuedSendMessage>, JobHandle)

    Schedule a SendJob. This is used to flush send queues to your supported medium

    Declaration
    public JobHandle ScheduleSend(NativeQueue<QueuedSendMessage> sendQueue, JobHandle dep)
    Parameters
    Type Name Description
    NativeQueue<QueuedSendMessage> sendQueue

    The send queue which can be used to emulate parallel send.

    JobHandle dep

    A JobHandle to any dependency we might have.

    Returns
    Type Description
    JobHandle

    A JobHandle to our newly created ScheduleSend Job.

    Implements
    INetworkInterface.ScheduleSend(NativeQueue<QueuedSendMessage>, JobHandle)
    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