What's New

📖New documentation site launched!

Until now, the only MagicOnion documentation available was the README file, but we have now launched a new documentation site.

https://cysharp.github.io/MagicOnion/

The new site has been updated and reorganized from the previous README file, making it easier to read.
This site has only just been launched, so we plan to continue updating and improving it.

In addition, the Japanese version of the documentation is also available.

General

void return value support for StreamingHub methods

StreamingHub method now supports void return value. This can be used for Fire-and-Forget pattern that does not require a return value from the server.

Client results

Added a mechanism to wait for the receiver's method call in StreamingHub and receive the processing result on the server. For more information, see Client Results.

Built-in heartbeat for StreamingHub

Added a built-in heartbeat feature to StreamingHub. For more information, see Heartbeat.

Upgrade to MessagePack v3

MessagePack has been upgraded to v3. This eliminates the need for using MessagePack Generator (mpc) in Unity and AOT environments. For more information, see the MessagePack-CSharp release.

Server

Refresh of the backend implementation of StreamingHub groups

Backends of StreamingHub groups have been refreshed to be based on Multicaster, allowing for more flexible group operations. This has resulted in changes to the group-related APIs.

• InMemoryStorage API has been removed
• Changes to the IGroup interface API
  • Changes to the API for getting group receivers
    • Added All, Single, Only, Except methods
    • Removed Broadcast methods in StreamingHubBase and CreateBroadcaster methods in Group

For more information, see Groups and Application-managed groups. For migration from v6, see the migration guide.

Introduction of MagicOnion.Server.JsonTranscoding and removal of MagicOnion.Server.HttpGateway

MagicOnion.Server.HttpGateway, which was used for Swagger support, has been removed. Instead, MagicOnion.Server.JsonTranscoding has been introduced, which encodes/decodes requests/responses in JSON. and its Swagger support has been added. For more information, see JSON Transcoding.

Other improvements

• Suport for .NET 9
• Call AddLogging and AddGrpc implicitly

Client

Introduce WaitForDisconnectAsync API

The WaitForDisconnectAsync method has been added to the StreamingHub client. This method waits for disconnection as before with WaitForDisconnect, but now returns the reason for disconnection. This allows you to get disconnection reasons such as timeouts due to heartbeats. For more information, see Disconnection.

Other improvements

• Enable trimming warnings in the client library
• Reduce allocations in StreamingHubClient

Breaking changes

Server

Removed support for .NET 7

We no longer support .NET 7 as its runtime support has ended. Please use .NET 8 or later.

StreamingHubContext is now reused

StreamingHubContext is now reused, so caching StreamingHubContext outside of Hub method calls may result in unexpected behavior. The context is only valid during the call.

Reworked the binding logic for gRPC methods

We have reworked the mechanism for registering MagicOnion methods as gRPC methods on the server. This changes the timing of registering MagicOnion Unary/StreamingHub services from application build to request pipeline/route construction.

AddMagicOnion was used to register Unary/StreamingHub services, but now you need to change it to register with MapMagicOnionService.

Client

Removed support for C-Core gRPC library

We have removed support for the C-core gRPC library in Unity. Please use grpc-dotnet and YetAnotherHttpHandler instead. For more information, see Using with Unity.

StreamingHub client now throws RpcException instead of ObjectDisposedException after disconnection

In previous versions, when a client called a method after being disconnected from StreamingHub, an ObjectDisposedException was thrown. Now, an RpcException is thrown. ObjectDisposedException is only thrown when it is disposed like a general class.

Migration guide from v6

Please refer to the documentation for migration instructions from v6.
https://cysharp.github.io/MagicOnion/release-notes/7.0#migration-guide

Full changes

New Contributors

• @AldeRoberge made their first contribution in #868

Full Changelog: 6.1.3...7.0.0