C# Adapter

Use Zinc from C# with P/Invoke

The C# adapter uses P/Invoke (Platform Invocation Services) to call the Zinc C ABI. It exposes a Span<byte> over the shared mapping. Keep the region open while using that span. The source targets .NET 8.

Installation

Build the core from a source checkout, then set up the adapter:

dotnet add YourApp.csproj reference adapters/csharp/Zinc.csproj

SharedRegion

using Zinc;

Create

var region = SharedRegion.Create("my-data", (nuint)16384);

Creates a new region. Throws InvalidOperationException on failure.

Open

var region = SharedRegion.Open("my-data");

Opens an existing region.

Bytes

Returns a Span<byte> backed by the shared memory mapping. No copying occurs.

Span<byte> bytes = region.Bytes();
BitConverter.GetBytes(3.14f).CopyTo(bytes);
float val = BitConverter.ToSingle(bytes);

Notify

region.Notify();

Wait

bool ok = region.Wait(timeoutMs: 1000);

Returns true on notification, false on timeout.

Dispose

region.Dispose();

using (var region = SharedRegion.Open("my-data")) {
    Span<byte> bytes = region.Bytes();
    // region is disposed when the block exits
}

Complete example

using System;
using Zinc;

using var writer = SharedRegion.Create("csharp-channel", (nuint)16384);
using var reader = SharedRegion.Open("csharp-channel");
BitConverter.TryWriteBytes(writer.Bytes(), 42.0);
writer.Notify();
if (reader.Wait(3000)) {
    Console.WriteLine(BitConverter.ToDouble(reader.Bytes()));
}

This uses two handles in one process. For separate processes, keep the creator running until the reader finishes.

TryWait() consumes a pending notification without blocking.

P/Invoke details

The native function declarations:

[DllImport("zinc_core")]
static extern int zinc_create(string name, nuint capacity, out nint handle);

[DllImport("zinc_core")]
static extern int zinc_open(string name, out nint handle);

[DllImport("zinc_core")]
static extern nint zinc_ptr(nint handle);

[DllImport("zinc_core")]
static extern nuint zinc_capacity(nint handle);

[DllImport("zinc_core")]
static extern void zinc_close(nint handle);

[DllImport("zinc_core")]
static extern void zinc_notify(nint handle);

[DllImport("zinc_core")]
static extern int zinc_wait(nint handle, uint timeoutMs);

The Bytes() method creates a Span<byte> from the native pointer and capacity using new Span<byte>((void*)ptr, (int)capacity). This is an unsafe context but the adapter encapsulates it. The span is valid only while the SharedRegion handle is not disposed.

The zinc_core library must be on the system’s library search path, or placed in the same directory as the application executable.