Skip to content

Commit 9d8d5c0

Browse files
docs: update FFI API documentation
1 parent cb1a32a commit 9d8d5c0

File tree

1 file changed

+37
-3
lines changed

1 file changed

+37
-3
lines changed

dash-spv-ffi/FFI_API.md

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This document provides a comprehensive reference for all FFI (Foreign Function I
44

55
**Auto-generated**: This documentation is automatically generated from the source code. Do not edit manually.
66

7-
**Total Functions**: 68
7+
**Total Functions**: 70
88

99
## Table of Contents
1010

@@ -34,7 +34,7 @@ Functions: 4
3434

3535
### Configuration
3636

37-
Functions: 26
37+
Functions: 27
3838

3939
| Function | Description | Module |
4040
|----------|-------------|--------|
@@ -63,6 +63,7 @@ Functions: 26
6363
| `dash_spv_ffi_config_set_user_agent` | Sets the user agent string to advertise in the P2P handshake # Safety - `con... | config |
6464
| `dash_spv_ffi_config_set_validation_mode` | Sets the validation mode for the SPV client # Safety - `config` must be a va... | config |
6565
| `dash_spv_ffi_config_set_wallet_creation_time` | Sets the wallet creation timestamp for synchronization optimization # Safety... | config |
66+
| `dash_spv_ffi_config_set_worker_threads` | Sets the number of Tokio worker threads for the FFI runtime (0 = auto) # Saf... | config |
6667
| `dash_spv_ffi_config_testnet` | No description | config |
6768

6869
### Synchronization
@@ -119,10 +120,11 @@ Functions: 4
119120

120121
### Event Callbacks
121122

122-
Functions: 1
123+
Functions: 2
123124

124125
| Function | Description | Module |
125126
|----------|-------------|--------|
127+
| `dash_spv_ffi_client_drain_events` | Drain pending events and invoke configured callbacks (non-blocking) | client |
126128
| `dash_spv_ffi_client_set_event_callbacks` | Set event callbacks for the client | client |
127129

128130
### Error Handling
@@ -617,6 +619,22 @@ Sets the wallet creation timestamp for synchronization optimization # Safety -
617619
618620
---
619621
622+
#### `dash_spv_ffi_config_set_worker_threads`
623+
624+
```c
625+
dash_spv_ffi_config_set_worker_threads(config: *mut FFIClientConfig, threads: u32,) -> i32
626+
```
627+
628+
**Description:**
629+
Sets the number of Tokio worker threads for the FFI runtime (0 = auto) # Safety - `config` must be a valid pointer to an FFIClientConfig
630+
631+
**Safety:**
632+
- `config` must be a valid pointer to an FFIClientConfig
633+
634+
**Module:** `config`
635+
636+
---
637+
620638
#### `dash_spv_ffi_config_testnet`
621639

622640
```c
@@ -905,6 +923,22 @@ This function is unsafe because: - The caller must ensure the handle pointer is
905923
906924
### Event Callbacks - Detailed
907925
926+
#### `dash_spv_ffi_client_drain_events`
927+
928+
```c
929+
dash_spv_ffi_client_drain_events(client: *mut FFIDashSpvClient) -> i32
930+
```
931+
932+
**Description:**
933+
Drain pending events and invoke configured callbacks (non-blocking). # Safety - `client` must be a valid, non-null pointer.
934+
935+
**Safety:**
936+
- `client` must be a valid, non-null pointer.
937+
938+
**Module:** `client`
939+
940+
---
941+
908942
#### `dash_spv_ffi_client_set_event_callbacks`
909943

910944
```c

0 commit comments

Comments
 (0)