Cysharp/MagicOnion
MagicOnion
MagicOnion is a .NET RPC framework used to build type-safe remote procedure call services using shared interfaces for communication between servers and clients. It functions as a binary serialization framework and a distributed service orchestrator, providing a network layer for low-latency streaming and real-time data exchange.
The project distinguishes itself through an AOT-compatible network client that uses source generators to support ahead-of-time compilation in restricted runtime environments. It enables bidirectional communication and real-time data streaming, allowing servers and multiple clients to push messages asynchronously without polling.
The framework covers a broad capability surface, including session-based stateful connection management, interceptor-based request pipelines for validation, and role-based access control. It also includes observability tools such as heartbeat-based connection monitoring and server performance metrics, alongside support for Unity network communication.
Features
- Remote Procedure Calls - Builds type-safe remote procedure call services using shared interfaces to define API schemas between server and client.
- RPC Frameworks - A type-safe .NET RPC framework for building distributed services using shared interfaces and binary serialization.
- Binary Serialization - Converts complex .NET objects into a compact binary format for high-performance network transmission.
- Binary Serialization Formats - Provides a binary serialization framework to encode structured data into compact formats for efficient network transmission.
- Custom Serializer Implementations - Allows replacing the default serialization format with custom implementations to support specific data types or encryption.
- API Client Generators - Produces pre-generated client code during compilation to support platforms requiring static references for network calls.
- AOT-Compatible Networking Clients - Provides a networking client designed to function without dynamic reflection in AOT environments.
- Bi-directional Streaming RPC - Implements full-duplex communication channels for transmitting ordered sequences of messages between client and server.
- Server-Side Session State - Maintains dedicated server-side instances per connection to preserve user state across a session.
- Cross-Platform Clients - Supports establishing communication from various platforms and runtime versions using a unified network protocol.
- Real-Time Message Streaming - Establishes bidirectional network connections to push real-time updates and messages between servers and clients.
- Real-Time Messaging Servers - Implements a real-time messaging server that maintains persistent connections for instant bidirectional communication.
- Bidirectional RPC Streaming - Establishes persistent bidirectional channels for asynchronous real-time message exchange between client and server.
- Connection State Management - Preserves service instance state across multiple method calls for a single connected client session.
- Client Proxy Generators - Generates client-side code via source generators to ensure compatibility with ahead-of-time compilation.
- Asynchronous RPC Execution - Enables non-blocking execution of remote procedures to handle concurrent requests without thread exhaustion.
- Distributed Orchestration Frameworks - Functions as a distributed service orchestrator managing stateful connections, request filtering, and service coordination across a network.
- Proxy-Based Remote Invocation - Invokes server-side methods transparently over a network channel using a client proxy based on a shared interface.
- Shared API Contract Libraries - Uses shared interfaces to define service signatures that ensure type-safe communication between the server and client.
- AOT Proxy Generators - Uses source generators to produce static client proxies, ensuring compatibility with AOT-compiled environments.
- Unary RPC Execution - Implements standard request-response remote procedure call patterns for single asynchronous calls.
- Interface-Based Definitions - Uses shared C# interfaces to define type-safe service contracts between the server and client.
- Service Orchestration - Manages the lifecycle of distributed services, including request filtering and session handling.
- Unity Networking Integrations - Provides specialized networking bridges for Unity game clients with AOT support and native type handling.
- Connection Metadata Tracking - Allows access to unique identifiers and service metadata for each incoming request or active connection.
- Group Messaging Systems - Provides infrastructure to bundle clients into logical groups and broadcast messages to all members simultaneously.
- Heartbeat Disconnection Detection - Ships a heartbeat mechanism to monitor connection health and automatically detect dropped client sessions.
- Per-Request Context Providers - Provides a per-request dictionary to store and retrieve data shared between filters and service methods.
- Real-Time State Broadcasting - Enables real-time state broadcasting to push application updates from the server to multiple connected clients.
- API Version Compatibility Layers - Enables clients and servers of different versions to communicate by sharing the same functional capabilities.
- Request Filter Integrations - Implements a request pipeline using custom filters to inspect headers and perform security checks before processing calls.
- Role-Based Access Control - Enforces access restrictions on specific services using authorization attributes to block unauthenticated requests.
- Transport Layer Encryption - Utilizes transport layer security to encrypt communication channels between clients and servers for data privacy.
- Token-Based Identity Verifications - Validates cryptographically signed JWT tokens in request headers to verify user identity.
- Cross-Platform Data Integration - Defines shared service contracts to ensure consistent data exchange across different platforms and runtimes.
- Request Interceptors - Provides an interceptor-based pipeline to handle cross-cutting concerns like authentication and validation for RPC calls.
- RPC Invocation Interceptors - Executes custom logic before and after a method call to handle request validation or global exception processing.
- RPC Connection Heartbeats - Uses periodic heartbeat signals to monitor RPC connection health and automatically prune dead client sessions.
- Server Metrics - Exposes internal server performance metrics, including connection counts and method execution durations, for observability.
- Status Monitors - Provides a real-time monitoring window to track data rates and connection health for active network channels.
- Remote Exception Mapping - Captures server-side errors or network failures on the client as standard exceptions for consistent error processing.
- Engine-Specific Type Serialization - Enables the serialization and transmission of specific engine data types using specialized extension packages.
- Game Server Frameworks - gRPC-based real-time communication framework for .NET.
- Game Networking Libraries - Unified real-time API framework for .NET and Unity.
- Networking Libraries - Unified real-time and API framework for .NET and Unity.
