mirror of https://github.com/logos-messaging/nim-ffi.git synced 2026-08-07 07:23:17 +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

examples

refactor(ffi): event thread scaffolding + FFIContext lifecycle split (#71 )

2026-06-08 11:46:16 -03:00

src

feat(ffi): RET_STALE_WARN progress callback replacing handler timeout

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

build.rs

Add basic cpp e2e tests (#27 )

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

Cargo.lock

Rust event examples (#53 )

2026-06-01 13:34:56 -03:00

Cargo.toml

Rust event examples (#53 )

2026-06-01 13:34:56 -03:00

README.md

Add basic cpp e2e tests (#27 )

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

README.md

Rust Bindings for nim-timer

Purpose

This folder contains auto-generated Rust bindings (the my_timer crate) for the my_timer Nim library. It is generated from ../timer.nim and provides:

src/lib.rs: Main library exposing high-level Rust types and the MyTimerCtx API
src/api.rs: High-level async/sync wrapper around the FFI
src/ffi.rs: Raw extern "C" declarations for the Nim library
src/types.rs: Serializable Rust types matching the Nim FFI types
build.rs: Build script that compiles the Nim library to libmy_timer.dylib (or .so/.dll)
Cargo.toml: Package manifest with serde and serde_json dependencies

How It's Generated

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

cd examples/timer
nimble genbindings_rust

This command:

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

Using as a Dependency

The rust_client example consumes this crate:

[dependencies]
my_timer = { path = "../rust_bindings" }

Do Not Edit

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