Skip to content

Latest commit

 

History

History
730 lines (556 loc) · 52.5 KB

CHANGELOG.md

File metadata and controls

730 lines (556 loc) · 52.5 KB
Raw

Change log

[2.0.0-pre.8] - 2023-03-30

New features

  • MultiNetworkDriver can then be used for client drivers too. The restriction on it accepting only listening drivers has been lifted, and it now offers a new Connect method to connect client drivers. This makes it easier to write networking code that can be shared between server and client.
  • Added a new ReliableUtility.SetMaximumResendTime static method, allowing to modify the maximum resend time of the reliable pipeline at runtime (there's already a similar method for the minimum resend time). Increasing this value can improve bandwidth usage for poor connections (RTT greater than 200ms).
  • Added the possibility of setting the minimum and maximum resend times of the reliable pipeline through NetworkSettings (with WithReliableStageParameters).

Changes

  • NetworkEndpoint.TryParse will now return false and log an error when attempting to parse an IPv6 address on platforms where IPv6 is not supported. The previous behavior was to throw an exception, but only in the editor. On the devices themselves, the address would be successfully parsed silently, which would lead to confusing socket errors down the line.
  • The SimulatorUtility.Context structure has been made internal. It contained only implementation details, or values that appeared useful but were actually either misleading or broken.
  • The RelayMessageType enum has been made internal. The only purpose of this type was to list the different messages of the Relay protocol, which is an implementation detail that should not be relevant to users.

Fixes

  • Fixed an issue where calling ScheduleFlushSend before the socket was bound would still result in socket system calls being made, resulting in errors being logged.
  • No warning will be printed when attempting to send on a WebSocket connection that has been closed by the remote peer (would only happen if calling ScheduleFlushSend).

[2.0.0-pre.7] - 2023-03-15

New features

  • Added a new MultiNetworkDriver API to make it easier to handle multiple NetworkDriver instances at the same time for cross-play scenarios. Refer to the "cross-play support" section of the documentation for more details on this feature. This new API is also showcased in a new "CrossPlay" package sample.

Changes

  • Update Burst dependency to 1.8.3.
  • The QueuedSendMessage structure was removed as it didn't serve any purpose anymore.
  • The dependency argument of NetworkDriver.ScheduleFlushSend is now optional.
  • SequenceHelpers, RandomHelpers, and the extensions in NativeListExt and FixedStringExt have all been made internal. These are all internal helper classes that shouldn't have been part of the public API in the first place.
  • Many APIs and types inside ReliableUtility have been made internal (among them all APIs and types dealing with send/receive contexts and packet information and timers). The information they contain was meant purely for internal consumption in the first place. The statistics and RTT information inside the shared context remains public.
  • Removed errorCode from ReliableUtility.SharedContext. Any useful information it can provide is already returned by higher-level APIs like NetworkDriver.EndSend.
  • Default send and receive queue sizes are now set to 512 packets (previous value was 64). The queue sizes are modifiable with NetworkSettings.WithNetworkConfigParameters.

Fixes

  • Fixed a possible exception in IPCNetworkInterface if it was fed an unknown endpoint.
  • Fixed NetworkDriver.GetLocalEndpoint when using WebSocketNetworkInterface (note that on web browsers this will now print a warning since local endpoints are not available on WebGL).

[2.0.0-pre.6] - 2023-01-13

New features

  • Added a NetworkConnection.ToFixedString method to allow logging network connections from Burst.

[2.0.0-pre.5] - 2023-01-12

Changes

  • Revert to Collections 2.1.0-pre.6 as pre.7 is not promoted yet.

[2.0.0-pre.4] - 2023-01-12

Changes

  • Update Burst dependency to 1.8.2.
  • Update Collections dependency to 2.1.0-pre.7.
  • The InternalId and Version properties of NetworkConnection are now internal. These referred to internal values and using them directly was error-prone since values could be reused across connections. To compare connections reliably, compare the NetworkConnection objects directly (they implement all the relevant operators and interfaces).
  • Replace NetworkDriverIdentifierParameter (and WithNetworkDriverIdentifierParameters) with a more general LoggingParameter (and WithLoggingParameters). Note that currently these parameters don't affect anything, and are there for future use only.

[2.0.0-pre.3] - 2022-11-29

Changes

  • It is now possible to set a window size of up to 64 for ReliableSequencedPipelineStage (use NetworkSettings.WithReliableStageParameters to modify the value). Doing so increases the packet header size by 4 bytes though, so the default value remains at 32.
  • The Soaker and Pipeline samples were removed in an effort to streamline the samples offered with the package.

Fixes

  • Fixed an issue where following an IP address change, the connection to the Relay server would not be re-established properly because of a malformed bind message.
  • Fixed an issue where connecting to a Relay server on WebGL builds would fail with a SocketException.
  • Fixed an issue where an InvalidOperationException would be thrown when hosting on WebGL even if using Relay (the exception should only be thrown when not using Relay).

[2.0.0-pre.2] - 2022-11-11

Changes

  • The return code of NetworkDriver.Bind and NetworkDriver.Listen is now a proper value from the Error.StatusCode enum, instead of a seemingly random negative value.
  • If the connection to the Relay server fails (e.g. the DTLS handshake fails), then the connection status returned by NetworkDriver.GetRelayConnectionStatus will now be AllocationInvalid. It used to remain NotEstablished which would leave no way for a user to determine that the connection had failed.
  • Status codes NetworkHeaderInvalid and NetworkArgumentMismatch are now marked as obsolete. Nothing in the API returns these status codes anymore.

Fixes

  • Fixed IndexOutOfRangeException when connecting a driver configured with IPC interface and Relay. This case is not valid and now fails with a InvalidOperationException when the driver is created.
  • Fixed a crash on Android when using the Mono backend.

[2.0.0-exp.8] - 2022-10-28

New features

  • Support for the com.unity.logging package has been added. If the package is installed, logs will go through its default logger instead of the classic UnityEngine.Debug mechanism.
  • A new FixedPEMString type is introduced to store certificates and private keys in the PEM format. WithSecureClientParameters and WithSecureServerParameters from NetworkSettings now accept certificates and private keys in this format instead of FixedString4096Bytes. It is still recommended to use the string-based versions, however.

Changes

  • It is not necessary anymore to configure the hostname with NetworkSettings.WithSecureClientParameters when using secure WebSockets connections to the Relay server.
  • Fields have been renamed in the SecureNetworkProtocolParameter structure: Pem is now CACertificate, Rsa is now Certificate, and RsaKey is now PrivateKey. Note that directly using this structure is not recommended. WithSecureClientParameters and WithSecureServerParameters from NetworkSettings are the preferred ways of configuring encryption parameters.
  • The SecureNetworkProtocolParameter structure now stores certificates and private keys as FixedPEMString instead of FixedString4096Bytes, which allows for certificates larger than 4KB.
  • NetworkSettings.WithSimulatorStageParameters now provides default values for parameters maxPacketSize and applyMode. The defaults are respectively the MTU size, and to apply the simulator in both directions (send/receive).

Fixes

  • Fixed Websockets sending ping messages when the HeartbeatsTimeout parameter is disabled (set to 0).
  • Fixed an issue with secure WebSockets where a connection would fail to be established if the end of the TLS handshake and beginning of the WebSocket handshake arrived in the same message.
  • It is now possible to pass certificates larger than 4KB to WithSecureClientParameters and WithSecureServerParameters from NetworkSettings.
  • Fixed an issue where if one end of a reliable pipeline stopped sending any traffic and its latest ACK message was lost, then the other end would stall.

[2.0.0-exp.7] - 2022-09-29

New features

  • It is now possible to obtain RelayAllocationId, RelayConnectionData, and RelayHMACKey structures from byte arrays using their static FromByteArray method.
  • A new constructor for RelayServerData is now provided with argument types that better match those available in the models returned by the Relay SDK. The "RelayPing" sample has been updated to use this constructor.
  • New constructors for RelayServerData are now provided with argument types that better match those available in the models returned by the Relay SDK. The "RelayPing" sample has been updated to use them constructor.
  • NetworkSettings now has a IsCreated property which can be used to check if it's been disposed of or not.

Changes

  • Reverted the fix for the SimulatorPipelineStage always using the same random seed, reverting its behavior to always be deterministic. If non-determinism is desired, use a dynamic random seed (e.g. Stopwatch.GetTimestamp).
  • The default network interface (UDPNetworkInterface) does not enable address reuse anymore. This means NetworkDriver.Bind will now always fail if something else is listening on the same port, even if that something else is bound to a wildcard address and we are trying to bind to a specific one.
  • Added: NetworkDriverIdentifierParameter struct and NetworkSettings.WithDriverIdentifierParameters() method that can be use to identify the NetworkDriver instances with a custom label. Currently this method serves no purpose, but might be used in future releases to make debugging easier.
  • The InitialEventQueueSize, InvalidConnectionId, and DriverDataStreamSize fields were removed from NetworkParameterConstants. They all served no purpose anymore.
  • If using Relay, it is now possible to call Connect without an endpoint (the endpoint would be ignored anyway). This extension to NetworkDriver is provided in the Unity.Networking.Transport.Relay namespace.
  • The RelayServerData.HMAC field is now internal. There was no use to this being available publicly.
  • The deprecated constructor for RelayServerData that was taking strings for the allocation ID, connection data, and key has been completely removed.
  • The deprecated RelayServerData.ComputeNewNonce method has also been removed. One can provide a custom nonce using the "low level" constructor of RelayServerData. Other constructors will select a new one automatically.

Fixes

  • Fixed an issue where a duplicated reliable packet wouldn't be processed correctly, which could possibly lead to the entire reliable pipeline stage stalling (not being able to send new packets).
  • Fixed an issue where a warning about having too many pipeline updates would be spammed after a connection was closed.
  • Fixed an issue where pipeline updates would be run too many times, which would waste CPU and could lead to the warning about having too many pipeline updates being erroneously logged.
  • Fixed issues with ReliableSequencePipelineStage that would, in rare circumstances, lead to failure to deliver a reliable packet.
  • Fixed an issue where sending maximally-sized packets to the Relay when using DTLS would fail with an error about failing to encrypt the packet.
  • Fixed an issue when using secure WebSockets where the stream would become corrupted, resulting in failure to decrypt packets (and eventually potentially a crash of the server).

[2.0.0-exp.6] - 2022-09-02

Fixes

  • Fixed changelog.

[2.0.0-exp.5] - 2022-09-01

New features

  • Preliminary WebSocket support. To have a NetworkDriver use WebSockets, create it with the appropriate network interface (e.g. NetworkDriver.Create(new WebSocketNetworkInterface())). To enable TLS support, create the driver with NetworkSettings configured with WithSecureClientParameters/WithSecureServerParameters (on the client, only the hostname needs to be provided).
  • NetworkSettings.WithSecureClientParameters and NetworkSettings.WithSecureServerParameters now have versions where the certificates and hostnames are provided as normal strings, instead of fixed strings.

Changes

  • Protocol field was removed from the SecureNetworkProtocolParameter structure. The protocol is now determined automatically from the network interface being used.
  • Updated to Collections 2.1.0-exp.1
  • FragmentationPipelineStage.FragContext was made internal as it is an internal implementation detail that serves no purpose being exposed publicly.
  • Multiple APIs were removed or made internal in ReliableUtility (more than is practical to list here). These were all internal implementation details that served no purpose being exposed publicly. The only remaining public APIs in ReliableUtility are those used to gather statistics from a reliable pipeline (as demonstrated in the Soaker sample).
  • All APIs except Parameters and Context in SimulatorUtility were made internal as they are implementation details that serve no purpose being exposed publicly.
  • It is no longer possible to configure the read timeout in the secure parameters as values other than the default (0) were never properly supported.
  • It is no longer possible to configure the handshake minimum/maximum timeouts in the secure parameters. These values are now derived from the connectTimeoutMS and maxConnectAttempts values configured with NetworkSettings.WithNetworkConfigParameters.
  • Hostnames in secure parameters are now FixedString512Bytes instead of FixedString32Bytes, allowing any possibly hostname to be used instead of only short ones.
  • NetworkSendQueueHandle was removed. It was not used for anything anymore (previously it was used for custom implementations of INetworkInterface).
  • NetworkInterfaceSendHandle and SendHandleFlags were made internal. With the removal of NetworkSendInterface, these served no purpose anymore.
  • INetworkInterface.Initialize now receives a ref packetPadding parameter that can be increased to reserve space for headers.
  • BaselibNetworkInterface was renamed to UDPNetworkInterface.

Fixes

  • Fixed an issue where when sending data on a connection and closing that connection in the same update, the data message would not be sent properly.
  • Fixed a stack overflow exception when send/receive queue capacity was set very high (>10,000).
  • Fixed an issue where SimulatorPipelineStage would always use the same seed for its random number generator.

Upgrade guide

[2.0.0-exp.4] - 2022-08-03

New features

  • A new global network simulator has been added, configurable through NetworkSettings.WithNetworkSimulatorParameters (settings can be modified at runtime with NetworkDriver.ModifyNetworkSimulatorParameters). Unlike SimulatorPipelineStage, it applies its parameters to all traffic (including control messages). Note that it is currently much less featureful than SimulatorPipelineStage (only supports dropping packets for now), so we still recommend using the latter for all network simulation.
  • Added a new NetworkDriver.ModifySimulatorStageParameters API to modify the parameters of the SimulatorPipelineStage at runtime.
  • NetworkDriver now exposes the NetworkSettings currently in use through the CurrentSettings property. These settings are read-only.
  • To implement the above functionality, NetworkSettings now provides a AsReadOnly method that returns a read-only copy of the settings.

[2.0.0-exp.3] - 2022-07-11

New features

Changes

  • Updated to Burst 1.7.3.
  • Changed: A call to NetworkDriver.Disconnect now requires a subsequent call to NetworkDriver.Update for the disconnect packet to be effectively sent (Previously NetworkDriver.FlushSend was enough).
  • Changed: The protocol used to establish connections now supports protocol versioning. This should help maintain compatibility for future releases, but unfortunately it's now incompatible with the protocol used in version 1.X.

Fixes

Upgrade guide

  • For NetworkDriver.FlushSend calls that follows a call to NetworkDriver.Disconnect, change it to NetworkDriver.Update.
  • The communication protocol used to establish connections has had a breaking change and is now incompatible with Unity Transport 1.X. Clients and servers will need to be updated at the same time to maintain compatibility.

[2.0.0-exp.2] - 2022-06-07

New features

  • Added a new version of NetworkDriver.CreatePipeline that takes a NativeArray of NetworkPipelineStageId as an argument. The old version taking an array of Type objects is still fully supported.

Changes

  • Removed: NetworkSettings.WithDataStreamParameters has been deleted. The data stream size (the only parameter this API controlled) is now always dynamically-sized to avoid out-of-memory errors.
  • Removed: NetworkSettings.WithPipelineParameters has been deleted. Initial sizing of the pipeline buffers is now handled internally.
  • Removed: NetworkPipelineStageCollection has been deleted. See upgrade guide below for details of how to replace its usages.
  • Updated to Collections 2.0.0-pre.32.
  • Updated to Burst 1.7.2.
  • Removed: NetworkDriver.LastUpdateTime has been deleted. This value was an internal detail not meant to be consumed by users, and its time reference couldn't be reliably related to typical C# timestamps.

Fixes

  • Removed an error log when receiving messages on a closed DTLS connection (this scenario is common if there were in-flight messages at the moment of disconnection).
  • BeginSend would not return an error if called on a closed connection before the next ScheduleUpdate call.
  • Fix broken link in package documentation.
  • On iOS, recreate the socket used for communications when coming back from app suspension. This solves an issue where communications would fail after the app was in the background for a few seconds and iOS decided to reclaim its resources.

Upgrade guide

  • Registering custom pipeline stages is now done on a per-NetworkDriver basis rather than globally through NetworkPipelineStageCollection. Concretely, that means replacing calls to NetworkPipelineStageCollection.RegisterPipelineStage with calls to NetworkDriver.RegisterPipelineStage for each instance of NetworkDriver that will make use of the custom pipeline stage.
  • NetworkPipelineStageId is now obtained through the static NetworkPipelineStageId.Get method, rather than with NetworkPipelineStageCollection.GetStageId. Updating only requires replacing calls like NetworkPipelineStageCollection.GetStageId(typeof(Foo)) with NetworkPipelineStageId.Get<Foo>().
  • NetworkDriver.LocalEndPoint and NetworkDriver.RemoteEndPoint were renamed to NetworkDriver.GetLocalEndpoint and NetworkDriver.RemoteEndpoint, respectively. This should be updated automatically.
  • INetworkInterface.LocalEndPoint has been renamed to INetworkInterface.LocalEndpoint for consistency with other usages of the term in the API. Since this is an interface property, it must be manually updated (see upgrade guide below).
  • Custom implementations of INetworkInterface must now implement the LocalEndpoint property instead of LocalEndPoint. This is purely a change in naming, the behavior should remain the same as before.

[2.0.0-exp.1] - 2022-04-29

New features

  • Added automatic device reconnection (enabled by default). This feature will attempt to re-establish the connection after some inactivity. This feature is intended to handle IP address changes on mobile devices. The inactivity timeout can be controlled by the new parameter reconnectionTimeoutMS in NetworkConfigParameter. Setting it to 0 disabled the feature.
  • When using the Relay protocol, error messages sent by the Relay server are now properly captured and logged.
  • PacketsQueue and PacketProcessor APIs were added for sending and operating over packets in the INetworkInterface.
  • A GetRelayConnectionStatus method has been added to NetworkDriver to query the status of the connection to the Relay server.

Changes

  • Updated to Collections 2.0.0-pre.15
  • Updated to Burst 1.7.1.
  • Updated to Mathematics 1.2.6.
  • Minimal Unity Editor version supported is now 2022.2.0a11.
  • Added NetworkSettings struct and API for defining network parameters.
  • Added reconnectionTimeoutMS in NetworkConfigParameter to support device reconnection (see above).
  • Creating a pipeline with FragmentationPipelineStage after ReliableSequencedPipelineStage is now forbidden (will throw an exception if collections checks are enabled). That order never worked properly to begin with. The reverse order is fully supported and is the recommended way to configure a reliable pipeline with support for large packets.
  • If collections checks are enabled, trying to create an IPv6 NetworkEndPoint will now throw an exception on consoles that don't support IPv6 (PS4, PS5, Switch).
  • Documentation has been moved to the offical multiplayer documentation site.
  • The INetworkInterface.ScheduleSend() method signature was modified to receive a SendJobArguments struct instead of a NativeQueue. A PacketsQueue parameter is passed in this new struct.
  • sendQueueCapacity and receiveQueueCapacity parameters moved from BaselibNetworkParameter to NetworkConfigParameter.
  • Removed: BaselibNetworkParameter.maximumPayloadSize is not needed anymore as it is handled internally.
  • Removed: INetworkInterface.CreateSendInterface is not needed anymore, the send queue is managed internally by the NetworkDriver. Operations from the INetworkInterface must be done through the ScheduleSend and ScheduleReceive methods. This removes the need of function pointers which where casing GC allocations on BeginSend, EndSend and AbortSend when burst is not enabled.
  • Added: SendJobArguments and ReceiveJobArguments structs to pass arguments to the send and receive jobs of the INetworkInterface.
  • Obsolete: NetworkDriver constructor is now obsolete, instead use NetworkDriver.Create methods. This improves burst compatibility as generic methods allows to know the INeworkInterface type at compilation time.
  • Obsolete: NetworkPacketReceiver is now deprecated. Use the ReceiveJobArguments.ReceiveQueue and PacketProcessor instead.
  • NetworkDriver.LastUpdateTime is now consistent across different copies of a driver. It is now also set by the job scheduled with ScheduleUpdate, so any job scheduled before it will not see the updated value. This also means the value will not be updated right after ScheduleUpdate returns (only once its jobs completes).
  • An error is now logged if failing to decrypt a DTLS message when using Relay.
  • Decreased default Relay keep-alive period to 3 seconds (was 9 seconds). The value can still be configured through the relayConnectionTimeMS parameter of NetworkSettings.WithRelayParameters.
  • NetworkDriver now requires that the INetworkInterface provided is an unmanaged type. Managed INetworkInterfaces are still supported but are required to be wrapped into an unmanaged type: myInterface.WrapToUnmanaged().
  • Instantiating a NetworkDriver is now only supported through the NetworkDriver.Create methods.
  • Don't warn when overwriting settings in NetworkSettings (e.g. when calling the same WithFooParameters method twice).
  • Added new methods to set security parameters: NetworkSettings.WithSecureClientParameters and NetworkSettings.WithSecureServerParameters. These replace the existing WithSecureParameters.
  • NetworkInterfaceEndPoint usage replaced with NetworkEndPoint.
  • Removed: INetworkInterface.CreateInterfaceEndPoint and INetworkInterface.GetGenericEndPoint removed as interfaces use now NetworkEndPoint.
  • Renamed NetworkEndPoint to NetworkEndpoint. This should be automatically updated.

Fixes

  • Fixed: Error message when scheduling an update on an unbound NetworkDriver (case 1370584)
  • Fixed: Removed boxing in NetworkDriver initialization by passing NetworkSettings parameter instead of INetworkParameter[]
  • Fixed: BeginSend wouldn't return an error if the required payload size was larger than the supported payload size when close to the MTU
  • Fixed: Issue where an overflow of the ReliableSequencedPipelineStage sequence numbers would not be handled properly.
  • Updated Relay sample to the most recent Relay SDK APIs (would fail to compile with latest packages).
  • Fixed client certificate not being passed to UnityTLS on secure connections. This prevented client authentication from properly working.
  • Fixed: Reliable pipeline drop statistics inaccurate.

Upgrade guide

  • INetworkPipelineStage and INetworkInterface initialization methods now receive a NetworkSettings parameter instead of INetworkParameter[].
  • SimulatorPipelineStageInSend is no longer required and can be safely removed from your pipeline construction. To replace it, SimulatorPipelineStage now supports handling both sending and receiving via ApplyMode.AllPackets.
  • On fragmented and reliable pipelines, sending a large packet when the reliable window was almost full could result in the packet being lost.
  • Revert decrease of MTU to 1384 on Xbox platforms (now back at 1400). It would cause issues for cross-platform communications.
  • For custom implementation of the INetworkInterface: Remove the CreateSendInterface and update the ScheduleSend and ScheduleReceive signature; to iterate over the send/receive queue use the PacketsQueue[] operator.
  • Move the definition of the sendQueueCapacity and receiveQueueCapacity parameters from the WithBaselibNetworkParameters() to the WithNetworkConfigParameters().
  • Update all new NetworkDriver() usages to NetworkDriver.Create().
  • For custom implementations of INetworkInterface that are managed types, use the INetworkInterface.WrapToUnmanaged() configuring the NetworkDriver.
  • For custom implementations of INetworkInterface: Remove CreateInterfaceEndPoint and GetGenericEndPoint implementations and update NetworkInterfaceEndPoint usages to NetworkEndPoint.

[1.3.0] - 2022-09-27

New features

  • It is now possible to obtain RelayAllocationId, RelayConnectionData, and RelayHMACKey structures from byte arrays using their static FromByteArray method.
  • A new constructor for RelayServerData is now provided with argument types that better match those available in the models returned by the Relay SDK. The "RelayPing" sample has been updated to use this constructor.
  • New constructors for RelayServerData are now provided with argument types that better match those available in the models returned by the Relay SDK. The "RelayPing" sample has been updated to use them constructor.
  • NetworkSettings now has a IsCreated property which can be used to check if it's been disposed of or not.
  • New versions of NetworkSettings.WithSecureClientParameters and NetworkSettins.WithSecureServerParameters are provided that take strings as parameters instead of references to fixed strings. The older versions are still available and fully supported.
  • A new version of NetworkSettings.WithSecureClientParameters is provided that only takes the server name as a parameter. This can be used when the server is using certificates from a recognized CA.

Changes

  • A warning is now emitted if binding to a port where another application is listening. The binding operation still succeeds in that scenario, but this will fail in Unity Transport 2.0 (which disables address reuse on the sockets used by the default interface).
  • The constructor for RelayServerData that was taking strings for the allocation ID, connection data, and key is now deprecated. Use the new constructor (see above) or the existing lower-level constructor instead.
  • The RelayServerData.ComputeNewNonce method is now deprecated. One can provide a custom nonce using the "low level" constructor of RelayServerData. The new constructor will select a new one automatically.
  • If using Relay, it is now possible to call Connect without an endpoint (the endpoint would be ignored anyway). This extension to NetworkDriver is provided in the Unity.Networking.Transport.Relay namespace.

Fixes

  • Fixed a possible stack overflow if the receive or send queue parameters were configured with very large values (>15,000).
  • Prevented an issue where a warning about having too many pipeline updates would be spammed after a connection was closed.
  • Fixed an issue where a duplicated reliable packet wouldn't be processed correctly, which could possibly lead to the entire reliable pipeline stage stalling (not being able to send new packets).
  • Fixed an issue where pipeline updates would be run too many times, which would waste CPU and could lead to the warning about having too many pipeline updates being erroneously logged.
  • Fixed issues with ReliableSequencePipelineStage that would, in rare circumstances, lead to failure to deliver a reliable packet.

[1.2.0] - 2022-08-10

New features

  • If using the default network interface, the transport will attempt to transparently recreate the underlying network socket if it fails. This should increase robustness, especially on mobile where the OS might close sockets when an application is sent to the background.

Changes

  • A new NetworkSocketError value has been added to Error.StatusCode. This will be returned through NetworkDriver.ReceiveErrorCode when the automatic socket recreation mentioned above has failed (indicating an unrecoverable network failure).

Fixes

  • On iOS, communications will restart correctly if the application was in the background. Note that if using Relay, it's still possible for the allocation to have timed out while in the background. Recreation of a new allocation with a new NetworkDriver is still required in that scenario.
  • Fixed a possible stack overflow if the receive queue parameter was configured with a very large value (>10,000).

[1.1.0] - 2022-06-14

New features

  • A DataStreamReader can now be passed to another job without triggering the job safety system.
  • A GetRelayConnectionStatus method has been added to NetworkDriver to query the status of the connection to the Relay server.

Changes

  • NetworkSettings.WithDataStreamParameters is now obsolete. The functionality still works and will remain supported for version 1.X of the package, but will be removed in version 2.0. The reason for the removal is that in 2.0 the data stream size is always dynamically-sized to avoid out-of-memory errors.
  • NetworkSettings.WithPipelineParameters is now obsolete. The functionality still works and will remain supported for version 1.X of the package, but will be removed in version 2.0, where pipeline buffer sizing is handled internally.
  • Updated Burst dependency to 1.6.6.
  • Updated Collections dependency to 1.2.4.
  • Updated Mathematics dependency to 1.2.6.

Fixes

  • BeginSend would not return an error if called on a closed connection before the next ScheduleUpdate call.
  • Fixed a warning if using the default maximum payload size with DTLS.
  • Removed an error log when receiving messages on a closed DTLS connection (this scenario is common if there were in-flight messages at the moment of disconnection).
  • Fix broken link in package documentation.

[1.0.0] - 2022-03-28

Changes

  • Changed version to 1.0.0.

[1.0.0-pre.16] - 2022-03-24

Changes

  • Don't warn when overwriting settings in NetworkSettings (e.g. when calling the same WithFooParameters method twice).
  • Added new methods to set security parameters: NetworkSettings.WithSecureClientParameters and NetworkSettings.WithSecureServerParameters. These replace the existing WithSecureParameters, which is now obsolete.
  • Updated Collections dependency to 1.2.3.

Fixes

  • Fixed client certificate not being passed to UnityTLS on secure connections. This prevented client authentication from properly working.
  • Fixed: Reliable pipeline drop statistics inaccurate.

[1.0.0-pre.15] - 2022-03-11

Changes

  • An error is now logged if failing to decrypt a DTLS message when using Relay.
  • Decreased default Relay keep-alive period to 3 seconds (was 9 seconds). The value can still be configured through the relayConnectionTimeMS parameter of NetworkSettings.WithRelayParameters.

Fixes

  • Updated Relay sample to the most recent Relay SDK APIs (would fail to compile with latest packages).

[1.0.0-pre.14] - 2022-03-01

Changes

  • IValidatableNetworkParameter.Validate() method is now part of INetworkParameter.
  • Added: NetworkDriver.Create<>() generic methods.

Fixes

  • Fixed compilation on WebGL. Note that the platform is still unsupported, but at least including the package in a WebGL project will not create compilation errors anymore. Creating a NetworkDriver in WebGL projects will now produce a warning.

[1.0.0-pre.13] - 2022-02-14

New features

  • When using the Relay protocol, error messages sent by the Relay server are now properly captured and logged.

Fixes

  • Fixed: Issue where an overflow of the ReliableSequencedPipelineStage sequence numbers would not be handled properly.

[1.0.0-pre.12] - 2022-01-24

Fixes

  • Clean up changelog for package promotion.

[1.0.0-pre.11] - 2022-01-24

Changes

Fixes

  • Fixed a division by zero in SimulatorPipelineStage when PacketDropInterval is set.
  • Don't warn when receiving repeated connection accept messages (case 1370591).
  • Fixed an exception when receiving a data message from an unknown connection.

[1.0.0-pre.10] - 2021-12-02

Fixes

  • On fragmented and reliable pipelines, sending a large packet when the reliable window was almost full could result in the packet being lost.
  • Fixed "pending sends" warning being emitted very often when sending to remote hosts.
  • Revert decrease of MTU to 1384 on Xbox platforms (now back at 1400). It would cause issues for cross-platform communications.

[1.0.0-pre.9] - 2021-11-26

Changes

  • Disabled Roslyn Analyzers provisionally

Fixes

  • Fixed: Compiler error due to Roslyn Analyzers causing a wrong compiler argument

[1.0.0-pre.8] - 2021-11-18

Changes

  • Creating a pipeline with FragmentationPipelineStage after ReliableSequencedPipelineStage is now forbidden (will throw an exception if collections checks are enabled). That order never worked properly to begin with. The reverse order is fully supported and is the recommended way to configure a reliable pipeline with support for large packets.
  • Added NetworkSettings struct and API for defining network parameters. See NetworkSettings documentation for more information.
  • Added Roslyn Analyzers for ensuring proper extension of NetworkParameters and NetworkSettings API.
  • Update Collections package to 1.1.0

Fixes

  • Fixed: Error message when scheduling an update on an unbound NetworkDriver (case 1370584)
  • Fixed: BeginSend wouldn't return an error if the required payload size was larger than the supported payload size when close to the MTU
  • Fixed: Removed boxing in NetworkDriver initialization by passing NetworkSettings parameter instead of INetworkParameter[]
  • Fixed a crash on XboxOne(X/S) when using the fragmentation pipeline (case 1370473)

Upgrade guide

  • INetworkPipelineStage and INetworkInterface initialization methods now receive a NetworkSettings parameter instead of INetworkParameter[].

[1.0.0-pre.7] - 2021-10-21

Changes

  • Some public APIs that should have always been internal are now internal (Base64, SHA256, HMACSHA256, NetworkEventQueue, UdpCHeader, UdpCProtocol, SessionIdToken, NativeMultiQueue).

Fixes

  • Fixed: Couldn't send a payload of the configured payload size on fragmented pipelines

[1.0.0-pre.6] - 2021-10-14

New features

  • Added heartbeats functionality to all protocols (enabled by default). If there's no traffic on a connection for some time, a heartbeat is automatically sent to keep the connection alive. The inactivity timeout is controlled by the new parameter heartbeatTimeoutMS in NetworkConfigParameter. Setting it to 0 disables the feature.

Changes

  • Added heartbeatTimeoutMS in NetworkConfigParameter to support heartbeats (see above).
  • NetworkDriver.Bind is now synchronous when using Relay (matches behavior of other protocols).
  • NetworkDriver.Bind is not required to be called anymore for Relay clients (only for host).
  • EndSend will now return an error if called with a writer that has failed writes.
  • MTU decreased to 1384 (from 1400) on Xbox platforms.
  • Connect will automatically bind the driver if not already bound. This was already done implicitly before, but now it's explicit (the NetworkDriver.Bound property will be true after a successful call to Connect).
  • Added DataStream.ReadLong

Fixes

  • Fixed: Receiving a Disconnect message on DTLS would crash the receive job
  • Fixed: TLS server name might be set to nothing in Relay+DTLS, causing the handshake to fail
  • Fixed: Couldn't send large messages on fragmented pipeline if requiredPayloadSize was not provided to BeginSend
  • Fixed: DTLS handshake messages were never resent if lost
  • Fixed: Clients wouldn't honor the endpoint their were bound to

Known issues

  • Function pointers (for instance in BeginSend and EndSend) generate GC allocations in non-Burst use cases. The issue will be fixed in the next releases
  • XboxOne(S/X) crash when using fragmentation pipeline when the size of the packet is within 100 bytes of the MTU. This will be fixed in the next release

[1.0.0-pre.5] - 2021-09-16

Fixes

  • Fixed: Socket never created on unbound DTLS clients (causes handshake to fail)
  • Fixed: When using DTLS it would not properly read data packets
  • Fixed: When using DTLS it could possibly fail to send a packet that was at the MTU size.

[1.0.0-pre.4] - 2021-09-07

New features

Changes

Fixes

  • Fixed: Updated collection types in SecureNetworkProtocol.cs
  • Fixed: Fixed race condition between UTP and Relay disconnects
  • Fixed: Relay not being able to use the fragmentation pipelinestage

Upgrade guide

[1.0.0-pre.3] - 2021-09-01

New features

  • Removed references of TransportSamples from readme as they are not currently included in the package
  • Stripping out un-needed files from the package

Changes

Fixes

Upgrade guide

[1.0.0-pre.2] - 2021-08-23

New features

  • Upgraded collections to 1.0.0-pre.5
  • Added support for Secure Protocol while using Unity Relay

Changes

Fixes

Upgrade guide

[1.0.0-pre.1] - 2021-07-29

New features

  • Moving into pre-release
  • Added Secure Protocol support (TLS/DTLS) to allow for encrypted and secure connections.
  • Unity Transport package now supports connecting to the Unity Relay Service. See Unity Relay for more information.
  • Upgraded burst to 1.5.5

Changes

Fixes

Upgrade guide

[0.9.0] - 2021-05-10

New features

  • Added support for long serialization and delta compression.
  • Upgraded collections to 1.0.0-pre.1
  • Added a new network interface for WebSockets, can be used in both native and web builds.

Changes

  • Minimum required Unity version has changed to 2020.3.0f1.
  • The transport package can be compiled with the tiny c# profile and for WebGL, but WebGL builds only support IPC - not sockets.

Fixes

Upgrade guide

[0.8.0] - 2021-03-23

New features

  • Added overloads of PopEvent and PopEventForConnection which return the pipeline used as an out parameter.

Changes

Fixes

  • Fixed some compatility issues with tiny.
  • Fixed a crash when sending messages slightly less than one MTU using the fragmentation pipeline.
  • Fixed a bug causing NetworkDriver.RemoteEndPoint to return an invalid value when using the default network interface.

Upgrade guide

[0.7.0] - 2021-02-05

New features

  • Added DataStreamWriter.WriteRawbits and DataStreamWriter.ReadRawBits for reading and writing raw bits from a data stream.

Changes

  • Optimized the NetworkCompressionModel to find buckets in constant time.
  • Changed the error behavior of DataStreamReader to be consistent between the editor and players.

Fixes

  • Fixed a crash when receiving a packet with an invalid pipeline identifier.

Upgrade guide

[0.6.0] - 2020-11-26

New features

  • An error handling pass has been made and Error.StatusCode have been added to indicate more specific errors.
  • Error.DisconnectReason has been added, so when NetworkDriver.PopEvent returns a NetworkEvent.Type.Disconnect the reader returned contains 1 byte of data indicating the reason.

Changes

  • The function signature for NetworkDriver.BeginSend has changed. It now returns an int value indicating if the function succeeded or not and the DataStreamWriter now instead is returned as a out parameter.
  • The function signature for INetworkInterface.Initialize has changed. It now requires you to return an int value indicating if the function succeeded or not.
  • The function signature for INetworkInterface.CreateInterfaceEndPoint has changed. It now requires you to return an int value indicating if the function succeeded or not, and NetworkInterfaceEndPoint is now returned as a out parameter.

Fixes

  • Fixed a potential crash when receiving a malformated packet.
  • Fixed an issue where the DataStream could sometimes fail writing packet uints before the buffer was full.

Upgrade guide

  • NetworkDriver.BeginSend now returns an int indicating a Error.StatusCode, and the DataStreamWriter is passed as an out parameter.

[0.5.0] - 2020-10-01

New features

Changes

Fixes

  • Fixed display of ipv6 addresses as strings

Upgrade guide

[0.4.1] - 2020-09-10

New features

  • Added NetworkDriver.GetEventQueueSizeForConnection which allows you to check how many pending events a connection has.

Changes

Fixes

  • Fixed a compatibility isue with DOTS Runtime.

Upgrade guide

[0.4.0-preview.3] - 2020-08-21

New features

  • Added a new fragmentation pipeline which allows you to send messages larger than one MTU. If the FragmentationPipelineStage is part of the pipeline you are trying to send with the NetworkDriver will allow a requiredPayloadSize larger than one MTU to be specified and split the message into multiple packages.

Changes

  • The methods to read and write strings in the DataStreamReader/DataStreamWriter have been changed to use FixedString<N> instead of NativeString<N>. The name of the methods have also changed from ReadString to ReadFixedString64 - and similar changes for write and the packed version of the calls. The calls support FixedString32, FixedString64, FixedString128, FixedString512 and FixedString4096.
  • Minimum required Unity version has changed to 2020.1.2.

Fixes

Upgrade guide

The data stream methods for reading and writing strings have changed, they now take FixedString64 instead of NativeString64 and the names have changed as follows:

  • DataStreamReader.ReadString -> DataStreamReader.ReadFixedString64
  • DataStreamReader.ReadPackedStringDelta -> DataStreamReader.ReadPackedFixedString64Delta
  • DataStreamWriter.WriteString -> DataStreamWriter.WriteFixedString64
  • DataStreamWriter.WritePackedStringDelta -> DataStreamWriter.WritePackedFixedString64Delta

The transport now requires Unity 2020.1.2.

[0.3.1-preview.4] - 2020-06-05

New features

Changes

  • Added a new requiredPayloadSize parameter to BeginSend. The required size cannot be larger than NetworkParameterConstants.MTU.
  • Added errorcode parameter to a network_set_nonblocking, network_set_send_buffer_size and network_set_receive_buffer_size in NativeBindings.
  • Additional APIs added to NativeBindings: network_set_blocking, network_get_send_buffer_size, network_get_receive_buffer_size, network_set_receive_timeout, network_set_send_timeout.
  • Implemented NetworkEndPoint.AddressAsString.

Fixes

  • Fixed an issue in the reliable pipeline which would cause it to not recover if one end did not receive packages for a while.
  • Fixed NetworkInterfaceEndPoint and NetworkEndPoint GetHashCode implementation.
  • Fixed invalid use of strings when specifying the size of socket buffers in the native bindings.

Upgrade guide

[0.3.0-preview.6] - 2020-02-24

New features

Changes

  • Pipelines are now registered by calling NetworkPipelineStageCollection.RegisterPipelineStage before creating a NetworkDriver. The built-in pipelines do not require explicit registration. The interface for implementing pipelines has been changed to support this.
  • NetworkDriver is no longer a generic type. You pass it an interface when creating the NetworkDriver, which means you can switch between backends without modifying all usage of the driver. There is a new NetworkDriver.Create which creates a driver with the default NetworkInterface. It is also possible to create a new NetworkDriver by passing a NetworkInterface instance as the first argument.
  • NetworkDriver.Send is replaced by BeginSend and EndSend. This allows us to do less data copying when sending messages. The interface for implementing new network interfaces has been changed to support this.
  • DataStreamReader and DataStreamWriter no longer owns any memory. They are just reading/writing the data of a NativeArray<byte>.
  • DataStreamWriter has explicit types for all Write methods.
  • DataStreamReader.Context has been removed.
  • Error handling for DataStreamWriter has been improved, on failure it returns false and sets DataStreamWriter.HasFailedWrites to true. DataStreamReader returns a default value and sets DataStreamReader.HasFailedReads to true. DataStreamReader will throw an exception instead of returning a default value in the editor.
  • IPCManager is no longer public, it is still possible to create a NetworkDriver with a IPCNetworkInterface.
  • Added NetworkDriver.ScheduleFlushSend which must be called to guarantee that messages are send before next call to NetworkDriver.ScheduleUpdate.
  • Added NetworkDriver.LastUpdateTime to get the update time the NetworkDriver used for the most recent update.
  • Removed the IPC address family, use a IPv4 localhost address instead.

Fixes

  • Fixed a memory overflow in the reliability pipeline.
  • Made the soaker report locale independent.

Upgrade guide

Creation and type of NetworkDriver has changed, use NetworkDriver.Create or pass an instance of a NetworkInterface to the NetworkDriver constructor.

NetworkDriver.Send has been replaced by a pair of NetworkDriver.BeginSend and NetworkDriver.EndSend. Calling BeginSend will return a DataStreamWriter to which you write the data. The DataStreamWriter is then passed to EndSend.

All write calls in DataStreamWriter need an explicit type, for example Write(0) should be replaced by WriteInt(0).

DataStreamWriter no longer shares current position between copies, if you call a method which writes you must pass it by ref for the modifications to apply.

DataStreamWriter no longer returns a DeferedWriter, you need to take a copy of the writer at the point you want to make modifications and use the copy to overwrite data later.

DataStreamWriter is no longer disposable. If you use the allocating constructor you need to use Allocator.Temp, if you pass a NativeArray<byte> to the constructor the NativeArray owns the memory.

DataStreamReader.Context no longer exists, you need to pass the DataStreamReader itself by ref if you read in a different function.

The interface for network pipelines has been changed.

The interface for network interfaces has been changed.

[0.2.3-preview.0] - 2019-12-12

New features

Changes

  • Added reading and write methods for NativeString64 to DataStream.

Fixes

Upgrade guide

[0.2.2-preview.2] - 2019-12-05

New features

Changes

  • Added a stress test for parallel sending of data.
  • Upgraded collections to 0.3.0.

Fixes

  • Fixed a race condition in IPCNetworkInterface.
  • Changed NetworkEventQueue to use UnsafeList to get some type safety.
  • Fixed an out-of-bounds access in the reliable sequenced pipeline.
  • Fixed spelling and broken links in the documentation.

Upgrade guide

[0.2.1-preview.1] - 2019-11-28

New features

Changes

Fixes

  • Added missing bindings for Linux and Android.

Upgrade guide

[0.2.0-preview.4] - 2019-11-26

New features

Changes

  • Added support for unquantized floats to DataStream class.
  • Added NetworkConfigParameter.maxFrameTimeMS so you to allow longer frame times when debugging to prevent disconnections due to timeout.
  • Allow "1.1.1.1:1234" strings when parsing the IP string in the NetworkEndPoint class, it will use the port part when it's present.
  • Reliable pipeline now doesn't require parameters passed in (uses default window size of 32)
  • Added Read/Write of ulong to DataStream.
  • Made it possible to get connection state from the parallel NetworkDriver.
  • Added LengthInBits to the DataStreamWriter.

Fixes

  • Do not push data events to disconnected connections. Fixes an error about resetting the queue with pending messages.
  • Made the endian checks in DataStream compatible with latest version of burst.

Upgrade guide

[0.1.2-preview.1] - 2019-07-17

New features

  • Added a new Ping-Multiplay sample based on the Ping sample.
    • Created to be the main sample for demonstrating Multiplay compatibility and best practices (SQP usage, IP binding, etc.).
    • Contains both client and server code. Additional details in readme in /Assets/Samples/Ping-Multiplay/.
  • DedicatedServerConfig: Added arguments for -fps and -timeout.
  • NetworkEndPoint: Added a TryParse() method which returns false if parsing fails
    • Note: The Parse() method returns a default IP / Endpoint if parsing fails, but a method that could report failure was needed for the Multiplay sample.
  • CommandLine:
    • Added a HasArgument() method which returns true if an argument is present.
    • Added a PrintArgsToLog() method which is a simple way to print launch args to logs.
    • Added a TryUpdateVariableWithArgValue() method which updates a ref var only if an arg was found and successfully parsed.

Changes

  • Deleted existing SQP code and added reference to SQP Package (now in staging).
  • Removed SQP server usage from basic Ping sample.
    • Note: The SQP server was only needed for Multiplay compatibility, so the addition of Ping-Multiplay allowed us to remove SQP from Ping.

Fixes

  • DedicatedServerConfig: Vsync is now disabled programmatically if requesting an FPS different from the current screen refresh rate.

Upgrade guide

[0.1.1-preview.1] - 2019-06-05

New features

  • Moved MatchMaking to a package and supporting code to a separate folder.

Fixes

  • Fixed an issue with the reliable pipeline not resending when completely idle.

Upgrade guide

[0.1.0-preview.1] - 2019-04-16

New features

  • Added network pipelines to enable processing of outgoing and incomming packets. The available pipeline stages are ReliableSequencedPipelineStage for reliable UDP messages and SimulatorPipelineStage for emulating network conditions such as high latency and packet loss. See the pipeline documentation for more information.
  • Added reading and writing of packed signed and unsigned integers to DataStream. These new methods use huffman encoding to reduce the size of transfered data for small numbers.

Changes

  • Enable Burst compilation for most jobs.
  • Made it possible to get the remote endpoint for a connection.
  • Replacing EndPoint parsing with custom code to avoid having a dependency on System.Net.
  • Change the ping sample command-line parameters for server to -port and -query_port.
  • For matchmaking, use an Assignment object containing the ConnectionString, the Roster, and an AssignmentError string instead of just the ConnectionString.

Fixes

  • Fixed an issue with building iOS on Windows.
  • Fixed inconsistent error handling between platforms when the network buffer is full.

Upgrade guide

Unity 2019.1 is now required.

BasicNetworkDriver has been renamed to GenericNetworkDriver and a new UdpNetworkDriver helper class is also available.

System.Net EndPoints can no longer be used as addresses, use the new NetworkEndpoint struct instead.