Documentation Index
Fetch the complete documentation index at: https://docs.oxd.sh/llms.txt
Use this file to discover all available pages before exploring further.
Design principles
The SDK exposes a C ABI through an opaque handle pattern. This makes it callable from any language with C FFI support.Opaque handle
All state lives behind anOxAccel* pointer. You create it with ox_accel_create, use it across all operations, and free it with ox_accel_destroy. Never inspect or modify the pointer contents directly.
Thread safety
The handle is internally locked. You can safely callox_accel_send, ox_accel_recv, and ox_accel_stats from multiple threads concurrently. The only restriction: ox_accel_destroy must not be called while another thread is using the handle.
Error model
All fallible functions returnOxAccelError. Zero (Ok) means success. Non-zero values are specific error conditions — see Error Codes.
Memory ownership
| Function | Ownership |
|---|---|
ox_accel_create | Returns a heap-allocated handle. Caller owns it. |
ox_accel_destroy | Frees the handle. Caller must not use it after. |
ox_accel_send | Borrows data for the duration of the call. |
ox_accel_recv | Writes into caller-provided buf. |
ox_accel_stats | Writes into caller-provided AccelStats. |
ox_accel_version | Returns a static string. Caller must not free it. |
Function index
| Function | Category | Description |
|---|---|---|
ox_accel_create | Lifecycle | Create context |
ox_accel_connect | Lifecycle | Connect to relay |
ox_accel_destroy | Lifecycle | Free context |
ox_accel_send | Data | Send payload |
ox_accel_recv | Data | Receive payload |
ox_accel_stats | Stats | Read statistics |
ox_accel_version | Info | SDK version string |