Akka.Serialization.Compressed.Json 1.5.8

Prefix Reserved
.NET Standard 2.1 This package targets .NET Standard 2.1. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Akka.Serialization.Compressed.Json --version 1.5.8
                    


                    

                
NuGet\Install-Package Akka.Serialization.Compressed.Json -Version 1.5.8
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Akka.Serialization.Compressed.Json" Version="1.5.8" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Akka.Serialization.Compressed.Json" Version="1.5.8" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Akka.Serialization.Compressed.Json" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Akka.Serialization.Compressed.Json --version 1.5.8
                    


                    

                
#r "nuget: Akka.Serialization.Compressed.Json, 1.5.8"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Akka.Serialization.Compressed.Json@1.5.8
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Akka.Serialization.Compressed.Json&version=1.5.8
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Akka.Serialization.Compressed.Json&version=1.5.8
                    


                            Install as a Cake Tool

Akka.Serialization.Compressed.Json

This CompressedJsonSerializer Akka.NET serializer is a compressed version of the built-in Akka.Serialization.NewtonSoftJsonSerializer.

Configuration

Using Akka.Hosting

You can add this serializer by using the Akka.Hosting extension method:

using var host = new HostBuilder()
    .ConfigureServices((context, services) =>
    {
        services.AddAkka("compressed", (builder, provider) =>
        {
            builder.WithCompressedJsonSerializer();
        });
    }).Build();

await host.RunAsync();

Using HOCON Configuration

To use this serializer, add these settings to your HOCON configuration:

akka.actor {
  serializers {
    json-gzip = "Akka.Serialization.Compressed.Json.CompressedJsonSerializer, Akka.Serialization.Compressed.Json"
  }
  
  serialization-bindings {
    "Akka.Serialization.Compressed.Json.IShouldCompress, Akka.Serialization.Compressed.Json" = json-gzip
  }
}

Compressing Data Model

Using The Built-in Marker Interface

The Akka.Hosting extension and HOCON configuration above binds the marker IShouldCompress interface to the serializer. To start compressing your data model, make your classes inherit from this interface.

public sealed class MyDataModel: IShouldCompress
{
    // ...
}

Binding Your Data Model Directly Using Akka.Hosting

To bind your your data model to the serializer using Akka.Hosting, you can use the extension method below:

public static class DataClassOne
{ }

public static class DataClassTwo
{ }

using var host = new HostBuilder()
    .ConfigureServices((context, services) =>
    {
        services.AddAkka("compressed", (builder, provider) =>
        {
            builder.WithCompressedJsonSerializer(
                typeof(DataClassOne), 
                typeof(DataClassTwo);
        });
    }).Build();

await host.RunAsync();

Binding Your Data Model Directly Using HOCON Configuration

You can bind your classes to this serializer by registering them in the HOCON configuration:

akka.actor.serialization-bindings {
  "MyAssembly.DataClassOne, MyAssembly" = json-gzip
  "MyAssembly.DataClassTwo, MyAssembly" = json-gzip
}
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.5.25 7,040 6/24/2024
1.5.8 3,529 6/27/2023
1.5.4 191 5/3/2023
0.1.0 1,131 1/12/2023

• [Update Akka.NET to 1.5.8](https://github.com/akkadotnet/akka.net/releases/tag/1.5.8)
• [Update Akka.Hosting to 1.5.8](https://github.com/akkadotnet/Akka.Hosting/releases/tag/1.5.8)

Full changelog at https://github.com/akkadotnet/Akka.Serialization.Compressed/blob/refs/tags/1.5.8/RELEASE_NOTES.md