mirror of https://github.com/logos-messaging/nim-ffi.git synced 2026-08-06 06:53:21 +00:00

History

feat(ffi): RET_STALE_WARN progress callback replacing handler timeout

nim-ffi never times a handler out: a hard-cancel mid-call into the
underlying library (Waku/libp2p) can leave it half-applied. Instead, while
a request is still in flight its result callback receives a non-terminal
RET_STALE_WARN every StaleWarnInterval (5s default, Android's ANR interval;
-d:ffiStaleWarnIntervalMs to override), carrying the elapsed milliseconds as
a decimal string. The request always ends with exactly one terminal
RET_OK/RET_ERR — the dev decides what to do with a slow one, nim-ffi does
not decide for them.

This replaces the never-released per-proc {.ffi: "timeout = <ms>".} override
and the defaultRequestTimeout context field (issue #93), whose hard abort
unblocked the caller early. The stale-warn interval is an internal context
seam (staleWarnInterval), not a per-proc pragma.

Codegen: emit RET_STALE_WARN in the C/C++ headers, and guard every generated
trampoline (C, C++, Rust, and the Nim abi=c reply trampolines) to early-return
on the non-terminal code so the repeated callback can't double-free the
one-shot reply box. Typed wrappers ignore the progress signal for now; it is
delivered at the raw result-callback boundary.

Closes #126.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

2026-07-11 00:59:26 +02:00

CMakeLists.txt

feat(codegen): C binding generator (-d:targetLang=c) (#102 )

2026-07-01 12:00:47 -03:00

main.cpp

Remove wildcard event listener; keep per-event dispatch (#70 )

2026-06-02 22:22:35 +02:00

my_timer.hpp

feat(ffi): RET_STALE_WARN progress callback replacing handler timeout

2026-07-11 00:59:26 +02:00

README.md

Add basic cpp e2e tests (#27 )

2026-05-19 12:43:34 +02:00

README.md

C++ Bindings for nim-timer

Purpose

This folder contains auto-generated C++ bindings for the my_timer Nim library. It is generated from ../timer.nim and provides:

my_timer.hpp: High-level C++ class (MyTimerCtx) wrapping the FFI interface
main.cpp: Example executable demonstrating how to use the bindings
CMakeLists.txt: Build configuration that compiles the Nim library and links the C++ example

How It's Generated

Generate or regenerate these bindings by running from the parent directory:

cd examples/timer
nimble genbindings_cpp

This command:

Invokes the Nim compiler with -d:targetLang:cpp flag
Triggers genBindings("examples/timer/cpp_bindings", "../timer.nim") in timer.nim
Creates/updates the generated binding files

Building the Example

cd examples/timer/cpp_bindings
cmake -S . -B build
cmake --build build
./build/example

Do Not Edit

The generated files in this folder are overwritten each time nimble genbindings_cpp runs. Any manual changes will be lost.