Merge pull request #1058 from SteamRE/yaakov/2.4.0-beta.1

Release notes for 2.4.0-Beta.1 release

SteamKit2/SteamKit2/SteamKit2.csproj

@@ -5,7 +5,7 @@
     <AssemblyOriginatorKeyFile>..\..\SteamKit.snk</AssemblyOriginatorKeyFile>
     <SignAssembly>true</SignAssembly>
     <Description>.NET library that aims to interoperate with the Steam network.</Description>
-    <PackageReleaseNotes>Release notes are available at https://github.com/SteamRE/SteamKit/releases/tag/2.4.0-Alpha.3</PackageReleaseNotes>
+    <PackageReleaseNotes>Release notes are available at https://github.com/SteamRE/SteamKit/releases/tag/2.4.0-Beta.1</PackageReleaseNotes>
     <PackageIcon>steamkit_logo_128.png</PackageIcon>
     <PackageProjectUrl>https://github.com/SteamRE/SteamKit</PackageProjectUrl>
     <PackageLicenseExpression>LGPL-2.1-only</PackageLicenseExpression>

SteamKit2/SteamKit2/changes.txt

@@ -1,3 +1,40 @@
+------------------------------------------------------------------------------
+v 2.4.0			November 17 2021 (Beta 1)
+------------------------------------------------------------------------------
+* Added `CallProtobufAsync<T>` method to WebAPI to deserialize response as Protobuf instead of KeyValues.
+* Added `SteamChinaOnly` flag to CDN server objects.
+* Added new APIs to allow consumers to provide their own machine info.
+* Added `SteamUser.VanityUrlChangedCallback`.
+* Added `SteamApps.PurchaseResponseCallback`.
+* Added `SteamApps.RedeemGuestPassResponseCallback`.
+* Added new `SteamContent` handler.
+* Added the ability to set `ClientMsgProtoBuf<T>.Body`.
+* SteamKit2 now ships a net6.0 assembly as well as a netstandard2.0 assembly.
+* Changed thread names to not get truncated on Linux.
+* Changed message handler exception handling to log the full `Exception` object rather than just the message.
+* Changed the implementation of `SteamUnifiedMessages` to use the newer message protocol under the hood.
+* Fixed `IDebugNetworkListener` not being given encryption handshake messages.
+* Fixed a possible unhandled exception when opening a TCP connection.
+* Fixed the `UnobservedTaskException` event being triggered on .NET 6 if a TCP connection times out.
+* Fixed WebSocket connections constructing an incorrect IPv6 URI.
+* Fixed `DisconnectedCallback.UserInitiated` being true when a connection was terminated due to an internal error.
+* Removed some DebugLog spam from WebSocket connections.
+* Updated Protobufs.
+
+BREAKING CHANGES
+* Changed `SteamApps.GetPICSProductInfo` signature to now use `PICSRequest` objects.
+* Removed some old non-Protobuf messages.
+* Updated nullability to match latest BCL annotations and to fix .NET 6 SDK analysis warnings.
+* `SteamClient.AddHandler` will now throw an `ArgumentNullException` if the handler is null, rather than crashing on a `NullReferenceException`.
+* WebAPI will now throw an `ArgumentException` if the `method` parameter is `null`, rather than crashing on a `NullReferenceException`.
+* CDN timeouts options are now properties instead of fields.
+* `CDNClient` has been heavily refactored and is now `SteamKit2.CDN.Client`.
+* `ClientMsgProtobuf` can now only be constructed from a `PacketClientMsgProtobuf`.
+* Removed `IClientMsg.Deserialize(...)` and implementations.
+* Removed `ServiceMethodResponse.ResponseRaw`.
+* `CDN.Server.AllowedAppIds` is now not-nullable. Check for empty instead.
+
+
 ------------------------------------------------------------------------------
 v 2.4.0			July 29 2021 (Alpha 3)
 ------------------------------------------------------------------------------
@@ -20,17 +57,17 @@ BREAKING CHANGES
 ------------------------------------------------------------------------------
 v 2.4.0			March 9, 2021 (Alpha 2)
 ------------------------------------------------------------------------------
-- CDN: Updated interface to capture `preferred_server`, `use_as_proxy`, `proxy_request_path` and `allowed_app_ids`.
-- CDN: CDNClient methods now accept an optional `proxyServer` parameter.
-- CDN: Separated the request timeout into configurable request/response timeouts.
-- Added a MemoryServerListProvider implementation.
-- Enabled strong name signing on the SteamKit2 assembly.
-- Protocol/definition updates.
+* CDN: Updated interface to capture `preferred_server`, `use_as_proxy`, `proxy_request_path` and `allowed_app_ids`.
+* CDN: CDNClient methods now accept an optional `proxyServer` parameter.
+* CDN: Separated the request timeout into configurable request/response timeouts.
+* Added a MemoryServerListProvider implementation.
+* Enabled strong name signing on the SteamKit2 assembly.
+* Protocol/definition updates.
 
 Bug Fixes
-- Fixed a race in CMClient.Send.
-- Fixed a race in AsyncJob registration.
-- Fixed an issue opening files in IsolatedStorageServerListProvider.
+* Fixed a race in CMClient.Send.
+* Fixed a race in AsyncJob registration.
+* Fixed an issue opening files in IsolatedStorageServerListProvider.
 
 
 ------------------------------------------------------------------------------