Class DefaultDriverBuilder

Default helper method implementation for constructing NetworkDriverStore.NetworkDriverInstance, default NetworkSettings and registering these on the NetworkDriverStore.

Inheritance
object
DefaultDriverBuilder
Inherited Members
Namespace: Unity.NetCode
Assembly: solution.dll
Syntax
public static class DefaultDriverBuilder

Properties

Name Description
DefaultDriverConstructor

Return an instance of the IPCAndSocketDriverConstructor constructor

Methods

Name Description
ClientUseSocketDriver(NetDebug)

Helper method to determine if the client world should prefer using a socket-based network interface (UDP or WebSocket) or the IPCNetworkInterface. IPC connection type is preferred only in case the RequestedPlayType is set to client/server mode, a server world exist in the process and the Unity.NetCode.NetworkSimulatorSettings are disable (in the editor or development build).
CreateClientNetworkDriver<T>(T)

Helper method for creating NetworkDriver suitable for client. The driver will use the the specified netIf and is configured using the internal defaults. See: GetNetworkSettings().
CreateClientNetworkDriver<T>(T, NetworkSettings)

Helper method for creating NetworkDriver suitable for client. The driver will use the specified Unity.Networking.Transport.INetworkInterface and is configured using the provided settings.
CreateClientPipelines(ref NetworkDriverInstance)

Create the default network pipelines (reliable, unreliable, unreliable fragmented) for the client.
CreateServerNetworkDriver<T>(T, int)

Helper method for creating server NetworkDriver given the specified netIf The driver is configured with the internal defaults. See: GetNetworkServerSettings(int).
CreateServerNetworkDriver<T>(T, NetworkSettings)

Helper method for creating server NetworkDriver given the specified INetworkInterface The driver is configured using the NetworkSettings.
CreateServerPipelines(ref NetworkDriverInstance)

Create the default network pipelines (reliable, unreliable, unreliable fragmented) for the server.
GetNetworkServerSettings(int)

Return a set of internal default settings. This will use the NetworkSimulator parameters set by PlayMode Tools.
GetNetworkSettings()

Return a set of internal default settings. This will use the NetworkSimulator parameters set by PlayMode Tools.
RegisterClientDriver(World, ref NetworkDriverStore, NetDebug)

Register a NetworkDriver instance in the driverStore that uses either:

    These are configured using internal defaults. See: GetNetworkSettings().
    RegisterClientDriver(World, ref NetworkDriverStore, NetDebug, NetworkSettings)

    Register a NetworkDriver instance in the driverStore that uses either:

      These are configured using the NetworkSettings passed in.
      RegisterClientDriver(World, ref NetworkDriverStore, NetDebug, ref RelayServerData)

      Register a NetworkDriver instance in and stores it in driverStore:
      - 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.
      These are configured using the default settings. See GetNetworkSettings().
      RegisterClientIpcDriver(World, ref NetworkDriverStore, NetDebug, NetworkSettings)

      Register an IPCNetworkInterface NetworkDriver instance in driverStore. This are configured using the NetworkSettings passed in.
      RegisterClientUdpDriver(World, ref NetworkDriverStore, NetDebug, NetworkSettings)

      Register a UDPNetworkInterface NetworkDriver instance in driverStore. This are configured using the NetworkSettings passed in.
      RegisterClientWebSocketDriver(World, ref NetworkDriverStore, NetDebug, NetworkSettings)

      Register a WebSocketNetworkInterface NetworkDriver instance in driverStore. This are configured using the NetworkSettings passed in. The constructed driver does not use a reliable pipeline stage (websocket are already reliable) and the reliablePipeline instance is a NullPipelineStage.
      RegisterServerDriver(World, ref NetworkDriverStore, NetDebug, int)

      Register multiple NetworkDriver instances to the driverStore that uses different Unity.Networking.Transport.INetworkInterface:

        These are configured using internal defaults. See: GetNetworkSettings().
        RegisterServerDriver(World, ref NetworkDriverStore, NetDebug, NetworkSettings)

        Register a multiple NetworkDriver instances to hte driverStore:

          These drivers are configured using the NetworkSettings passed in.
          RegisterServerDriver(World, ref NetworkDriverStore, NetDebug, ref RelayServerData, int)

          Register multiple NetworkDriver instances to the driverStore that uses different Unity.Networking.Transport.INetworkInterface:

            These are configured using internal defaults. See: GetNetworkSettings().
            RegisterServerIpcDriver(World, ref NetworkDriverStore, NetDebug, NetworkSettings)

            Register a IPCNetworkInterface NetworkDriver instance in driverStore. This are configured using the NetworkSettings passed in.

            If the requested ClientServerBootstrap.PlayType is Server this will do nothing as no local clients will ever make use of the IPC mechanism.
            RegisterServerUdpDriver(World, ref NetworkDriverStore, NetDebug, NetworkSettings)

            Register a UDPNetworkInterface NetworkDriver instance in driverStore. This are configured using the NetworkSettings passed in.
            RegisterServerWebSocketDriver(World, ref NetworkDriverStore, NetDebug, NetworkSettings)

            Register a WebSocketNetworkInterface NetworkDriver instance in driverStore. This are configured using the NetworkSettings passed in. The constructed driver does not use a reliable pipeline stage (websocket are already reliable) and the reliablePipeline instance is a NullPipelineStage.