Ivan FB 98e8e8829f
docs(examples): C example reads typed struct returns
Update the native C example to cast each struct return's callback msg to its
`const <Type>*` and read it in-callback (EchoResponse, ComplexResponse), instead
of scanning opaque bytes. Regenerate the headers with the new return-shape note.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-05-31 18:37:19 +02:00
..

C bindings — native (same-process) example

Generated C headers for the timer library plus a small driver that links the library directly and calls the native (zero-serialization) ABI.

Files

File Description
my_timer.h Native ABI: each {.ffi.} type is a plain C struct, passed by value to int <name>(ctx, cb, ud, <args…>). Results arrive on the callback. Best for same-process callers — no serialization.
my_timer_cbor.h CBOR ABI (<name>_cbor): request/response as CBOR bytes. Use this when the call crosses a process or machine boundary. See ../ipc.
example.c Native same-process driver: create → version → echo → complex → destroy.
Makefile Builds the Nim dylib (from the repo root) and the driver.

The headers are regenerated by nimble genbindings_c (run from the repo root) and overwritten each time — don't edit them by hand.

Build & run

cd examples/timer/c_bindings
make run

This compiles libmy_timer.{dylib,so} and runs ./example, which prints the library version and the round-tripped echo/complex responses. Every call is dispatched on the library's FFI thread, so the driver blocks on a condvar-backed callback for each result.

Native vs CBOR

The native path passes {.ffi.} structs as flat C-POD values (const char* for strings, { T* ptr; size_t len } for sequences, { int present; T } for options). Arguments are deep-copied across the FFI-thread boundary, so the C caller's buffers can be freed immediately after the call returns. String returns arrive as raw bytes; struct returns arrive as a typed const <Type>* in the callback (cast and read it there — it is valid only for the callback's lifetime, and the library deep-frees it afterwards, so copy out anything you need).

For the cross-process / cross-machine path, the same library is reached over a socket using the CBOR ABI — see ../ipc.