docs.unity3d.com
    Show / Hide Table of Contents

    Struct IPCAndSocketDriverConstructor

    The default NetCode driver constructor. It creates:

    • On the server: both IPCNetworkInterface and UDPNetworkInterface NetworkDriver in the editor and only a single UDPNetworkInterface driver in the build.
    • On the client:
    • a single IPCNetworkInterface NetworkDriver if the both client and server worlds are present in the same process.
    • a single UDPNetworkInterface driver in all other cases.
      In the Editor and Development build, if the network simulator is enabled, force on the client to use the UDPNetworkInterface network driver. To let the client use the IPC network interface In ClientServer mode it is mandatory to always create the server world first.
    Inherited Members
    ValueType.Equals(Object)
    ValueType.GetHashCode()
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Namespace: Unity.NetCode
    Syntax
    public struct IPCAndSocketDriverConstructor : INetworkStreamDriverConstructor

    Methods

    CreateClientDriver(World, ref NetworkDriverStore, NetDebug)

    Create and register a new NetworkDriver suitable for connecting client to server to the destination NetworkDriverStore. The network driver instance will use socket or IPC network interfaces based on the RequestedPlayType and the presence of a server instance in the same process.

    Declaration
    public void CreateClientDriver(World world, ref NetworkDriverStore driverStore, NetDebug netDebug)
    Parameters
    Type Name Description
    World world

    The destination world in which the driver will be created

    NetworkDriverStore driverStore

    An instance of a NetworkDriverStore where the driver will be registered

    NetDebug netDebug

    The singleton, for logging errors and debug information

    Implements
    INetworkStreamDriverConstructor.CreateClientDriver(World, ref NetworkDriverStore, NetDebug)

    CreateServerDriver(World, ref NetworkDriverStore, NetDebug)

    Create and register one or more network drivers that can be used to listen for incoming connection into the destination NetworkDriverStore. By default, a NetworkDriver that uses a socket network interface is always created. In the Editor or in a Client/Server player build, if the RequestedPlayType mode is set to ClientAndServer, a second NetworkDriver that use an IPC network interface will be also created and that will be used for minimizing the latency for the in-proc client connection.

    Declaration
    public void CreateServerDriver(World world, ref NetworkDriverStore driverStore, NetDebug netDebug)
    Parameters
    Type Name Description
    World world

    The destination world in which the driver will be created

    NetworkDriverStore driverStore

    An instance of a NetworkDriverStore where the driver will be registered

    NetDebug netDebug

    The singleton, for logging errors and debug information

    Implements
    INetworkStreamDriverConstructor.CreateServerDriver(World, ref NetworkDriverStore, NetDebug)
    In This Article
    • Methods
      • CreateClientDriver(World, ref NetworkDriverStore, NetDebug)
      • CreateServerDriver(World, ref NetworkDriverStore, NetDebug)
    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