dmitrat/OutWit.Communication.Server.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 server for WitRPC, allowing a server to listen for client connections via a shared memory segment (for high-performance on-machine communication).
Get Started
$ dotnet add package OutWit.Communication.Server.MMFReadme
OutWit.Communication.Server.MMF
Memory-mapped file transport server for WitRPC, allowing a server to listen for client connections via a shared memory segment (for high-performance on-machine communication).
Overview
OutWit.Communication.Server.MMF enables a WitRPC server to communicate with clients through a Memory-Mapped File. This transport is intended for on-machine scenarios where the server and client processes share the same physical machine and memory. The server creates or opens a memory-mapped file with a given name (and size) and waits for a client to connect to that shared memory region. The MMF transport offers extremely fast communication (memory-speed reads/writes) and minimal latency since it bypasses networking entirely.
Typical use cases include launching a background "worker" process for intensive computations and communicating with it via shared memory, or any scenario requiring very high throughput between two processes on one machine. Essentially, it's like creating a private high-speed bus between your processes.
Important: This server transport must be paired with OutWit.Communication.Client.MMF on the client side. Both sides need to use the same memory-mapped file name to establish the connection. Typically, an MMF transport is used for one server and one client (one-to-one communication). If you need to handle multiple separate clients, you might either use multiple distinct MMF channels or consider using the named pipes transport which natively supports multiple clients.
Installation
Install-Package OutWit.Communication.Server.MMF
Usage
To use the memory-mapped file transport on the server, configure it with a file name (and optionally a size in bytes for the memory region):
using OutWit.Communication.Server;
using OutWit.Communication.Server.MMF;
using OutWit.Communication.Serializers;
var server = WitServerBuilder.Build(options =>
{
options.WithService(new MyService());
// Create a memory-mapped file transport named "MySharedMap" with 1,000,000 bytes of memory:
options.WithMemoryMappedFile("MySharedMap", size: 1000000);
options.WithJson();
options.WithEncryption(); // optional: enable encryption even for local memory communication
});
server.StartWaitingForConnection();
Console.WriteLine("Memory-mapped file server ready (MySharedMap).");