Migrating from v1

object → binary encode → memcpy into ring → memcpy out of ring → decode → new object

// v1, Bun
const ring = new Ring("my-ring");
ring.push(Buffer.from("hello"));
const msg = ring.poll(); // polling at setInterval rate

// v2, Bun
const region = SharedRegion.create("my-data", 4096);
const buf = region.buffer();
new TextEncoder().encodeInto("hello", buf);
region.notify(); // real kernel-assisted wake on Linux

// Reader
const r = SharedRegion.open("my-data");
r.wait(5000);       // blocks until notified
const text = new TextDecoder().decode(r.buffer().slice(0, 5));

- import { Ring } from "./ring";
+ import { SharedRegion } from "zinc-bun";

- const ring = new Ring("my-channel");
- ring.push(data);
- const out = ring.poll();
+ const region = SharedRegion.create("my-channel", 4096);
+ region.buffer().set(data);
+ region.notify();
+ // Reader side:
+ const r = SharedRegion.open("my-channel");
+ r.wait(5000);
+ const out = r.buffer().slice(0, data.length);

- const ringBinding = require('./zig/ring.node');
+ import { ZincRegion } from '@ossl/zinc';

- const handle = ringBinding.create("my-channel");
- ringBinding.write(handle, buffer);
+ const region = ZincRegion.create("my-channel", 4096);
+ region.asBuffer().set(buffer);
+ region.notify();

- import ctypes
- lib = ctypes.CDLL("./libring.so")
- lib.ring_create.restype = ctypes.c_void_p
- handle = lib.ring_create(b"my-channel")
+ from zinc import SharedRegion
+ region = SharedRegion.create("my-channel", 4096)
+ arr = region.as_numpy(dtype=np.float32)
+ arr[0] = 42.0  # zero-copy write