dmitrat/OutWit.Communication.Client.MMFv2.3.0
.NET 6.0-windows7.0.NET 7.0-windows7.0.NET 8.0-windows7.0.NET 9.0-windows7.0
Memory-mapped file transport client for WitRPC, enabling high-speed inter-process communication via a shared memory region (for on-machine RPC calls).
Get Started
$ dotnet add package OutWit.Communication.Client.MMFReadme
OutWit.Communication.Client.MMF
Memory-mapped file transport client for WitRPC, enabling high-speed inter-process communication via a shared memory region (for on-machine RPC calls).
Overview
OutWit.Communication.Client.MMF adds support for using Memory-Mapped Files as the communication transport on the client side of the WitRPC framework. This is ideal for scenarios where the client and server run on the same machine and need extremely fast communication (for example, a host process communicating with a sandboxed worker process). Memory-mapped file (MMF) transport uses a shared memory region to exchange data, which bypasses the network stack entirely and provides ultra-low latency IPC on a single host.
Using this transport, the client and server coordinate via a common memory-mapped file name. The server creates the memory-mapped file and listens, and the client opens the same file to read/write requests and responses. This approach can achieve very high throughput since reading and writing to memory is much faster than socket communication.
Note: This MMF client must be used in tandem with OutWit.Communication.Server.MMF on the server side. Both sides should use the same memory-mapped file name to communicate. Typically, MMF transport is used for one-to-one communication (one client and one server process) rather than many clients.
Installation
Install-Package OutWit.Communication.Client.MMF
This will also install the core OutWit.Communication.Client library if it's not already referenced. Make sure the server application references OutWit.Communication.Server.MMF to complete the setup.
Usage
To use the memory-mapped file transport on a client, specify it when building the WitRPC client. For example:
using OutWit.Communication.Client;
using OutWit.Communication.Client.MMF;
using OutWit.Communication.Serializers;
var client = WitClientBuilder.Build(options =>
{
options.WithMemoryMappedFile("MyApp_MMF"); // use a memory-mapped file named "MyApp_MMF"
options.WithJson(); // use JSON serialization (default)
options.WithoutEncryption(); // encryption can be optional for same-machine comm
});
await client.ConnectAsync(TimeSpan.FromSeconds(5));
// Get the service proxy as usual
IMyService service = client.GetService<IMyService>();