1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
//! # rustp2p-c-ffi - C FFI Bindings for rustp2p
//!
//! This crate provides C-compatible Foreign Function Interface (FFI) bindings for the `rustp2p`
//! library, enabling integration with C, C++, and other languages that support C FFI.
//!
//! ## Features
//!
//! - **C-Compatible API**: Simple, pointer-based API for C/C++ integration
//! - **Builder Pattern**: Fluent API for configuration
//! - **Error Handling**: Clear error codes for all operations
//! - **Memory Safety**: Proper ownership and cleanup functions
//! - **Cross-Platform**: Works on Windows, Linux, and macOS
//!
//! ## Building
//!
//! This crate produces both a static library and a dynamic library:
//!
//! ```bash
//! cargo build --release
//! ```
//!
//! Output files:
//! - `librustp2p_c_ffi.a` / `rustp2p_c_ffi.lib` (static)
//! - `librustp2p_c_ffi.so` / `rustp2p_c_ffi.dll` / `librustp2p_c_ffi.dylib` (dynamic)
//!
//! ## C Usage Example
//!
//! ### Basic Setup
//!
//! ```c
//! #include <stdio.h>
//! #include <stdlib.h>
//! #include <string.h>
//!
//! // Create and configure a node
//! Rustp2pBuilder* builder = rustp2p_builder_new();
//! rustp2p_builder_node_id(builder, "10.0.0.1");
//! rustp2p_builder_udp_port(builder, 8080);
//! rustp2p_builder_group_code(builder, "12345");
//!
//! // Build the endpoint
//! Rustp2pEndpoint* endpoint = rustp2p_builder_build(builder);
//! if (!endpoint) {
//! fprintf(stderr, "Failed to build endpoint\n");
//! return -1;
//! }
//! ```
//!
//! ### Sending Data
//!
//! ```c
//! const char* message = "Hello, peer!";
//! int result = rustp2p_endpoint_send_to(
//! endpoint,
//! "10.0.0.2",
//! (const uint8_t*)message,
//! strlen(message)
//! );
//!
//! if (result == RUSTP2P_OK) {
//! printf("Message sent successfully\n");
//! }
//! ```
//!
//! ### Receiving Data
//!
//! ```c
//! // Blocking receive
//! Rustp2pRecvData* recv_data = rustp2p_endpoint_recv_from(endpoint);
//! if (recv_data) {
//! const uint8_t* data;
//! size_t len;
//! rustp2p_recv_data_get_payload(recv_data, &data, &len);
//!
//! char src_id[16];
//! rustp2p_recv_data_get_src_id(recv_data, src_id, sizeof(src_id));
//!
//! printf("Received %zu bytes from %s\n", len, src_id);
//!
//! rustp2p_recv_data_free(recv_data);
//! }
//! ```
//!
//! ### Cleanup
//!
//! ```c
//! rustp2p_endpoint_free(endpoint);
//! ```
//!
//! ## Error Codes
//!
//! The library uses the following error codes:
//!
//! - `RUSTP2P_OK` (0): Success
//! - `RUSTP2P_ERROR` (-1): General error
//! - `RUSTP2P_ERROR_NULL_PTR` (-2): NULL pointer provided
//! - `RUSTP2P_ERROR_INVALID_STR` (-3): Invalid string
//! - `RUSTP2P_ERROR_INVALID_IP` (-4): Invalid IP address
//! - `RUSTP2P_ERROR_BUILD_FAILED` (-5): Failed to build endpoint
//! - `RUSTP2P_ERROR_WOULD_BLOCK` (-6): Operation would block
//! - `RUSTP2P_ERROR_EOF` (-7): End of file / connection closed
//!
//! ## Complete C Example
//!
//! ```c
//! #include <stdio.h>
//! #include <stdlib.h>
//! #include <string.h>
//! #include <pthread.h>
//!
//! void* receive_thread(void* arg) {
//! Rustp2pEndpoint* endpoint = (Rustp2pEndpoint*)arg;
//!
//! while (1) {
//! Rustp2pRecvData* recv_data = rustp2p_endpoint_recv_from(endpoint);
//! if (!recv_data) {
//! break;
//! }
//!
//! const uint8_t* data;
//! size_t len;
//! rustp2p_recv_data_get_payload(recv_data, &data, &len);
//!
//! char src_id[16];
//! rustp2p_recv_data_get_src_id(recv_data, src_id, sizeof(src_id));
//!
//! printf("Received %zu bytes from %s: %.*s\n", len, src_id, (int)len, data);
//!
//! rustp2p_recv_data_free(recv_data);
//! }
//!
//! return NULL;
//! }
//!
//! int main() {
//! // Create builder
//! Rustp2pBuilder* builder = rustp2p_builder_new();
//! if (!builder) {
//! return -1;
//! }
//!
//! // Configure
//! rustp2p_builder_node_id(builder, "10.0.0.1");
//! rustp2p_builder_udp_port(builder, 8080);
//! rustp2p_builder_tcp_port(builder, 8080);
//! rustp2p_builder_group_code(builder, "12345");
//! rustp2p_builder_add_peer(builder, "udp://192.168.1.100:9090");
//!
//! // Build endpoint
//! Rustp2pEndpoint* endpoint = rustp2p_builder_build(builder);
//! if (!endpoint) {
//! fprintf(stderr, "Failed to build endpoint\n");
//! return -1;
//! }
//!
//! // Start receive thread
//! pthread_t thread;
//! pthread_create(&thread, NULL, receive_thread, endpoint);
//!
//! // Send messages
//! const char* message = "Hello from C!";
//! rustp2p_endpoint_send_to(endpoint, "10.0.0.2",
//! (const uint8_t*)message, strlen(message));
//!
//! // Wait for thread
//! pthread_join(thread, NULL);
//!
//! // Cleanup
//! rustp2p_endpoint_free(endpoint);
//!
//! return 0;
//! }
//! ```
//!
//! ## C++ Integration
//!
//! For C++ projects, wrap the C API in RAII classes:
//!
//! ```cpp
//! class Rustp2pEndpointWrapper {
//! Rustp2pEndpoint* endpoint_;
//! public:
//! Rustp2pEndpointWrapper(Rustp2pEndpoint* ep) : endpoint_(ep) {}
//! ~Rustp2pEndpointWrapper() {
//! if (endpoint_) {
//! rustp2p_endpoint_free(endpoint_);
//! }
//! }
//!
//! // Prevent copying
//! Rustp2pEndpointWrapper(const Rustp2pEndpointWrapper&) = delete;
//! Rustp2pEndpointWrapper& operator=(const Rustp2pEndpointWrapper&) = delete;
//!
//! Rustp2pEndpoint* get() { return endpoint_; }
//! };
//! ```
//!
//! ## JavaScript/TypeScript Integration
//!
//! See [JAVASCRIPT.md](https://github.com/rustp2p/rustp2p/blob/master/rustp2p-c-ffi/JAVASCRIPT.md)
//! for details on using these bindings with Node.js via `node-ffi-napi`.
//!
//! ## Thread Safety
//!
//! - All functions are thread-safe
//! - Multiple threads can call send/receive operations simultaneously
//! - The Tokio runtime is managed internally
//!
//! ## Memory Management
//!
//! - Always call the corresponding `_free` function for allocated resources
//! - Do not use pointers after calling `_free`
//! - Received data pointers are valid only until `rustp2p_recv_data_free` is called
//!
//! ## See Also
//!
//! - [`rustp2p`](../rustp2p/index.html) - The main Rust library
//! - [GitHub Repository](https://github.com/rustp2p/rustp2p)
use ;
use Ipv4Addr;
use ;
use ptr;
use FromStr;
use Arc;
use Algorithm;
use GroupCode;
use ;
use Runtime;
// Opaque handle types for C
/// Builder handle for configuring a rustp2p endpoint.
///
/// Use the `rustp2p_builder_*` functions to configure, then call
/// `rustp2p_builder_build` to create an endpoint.
/// Endpoint handle for sending and receiving P2P data.
///
/// Create with `rustp2p_builder_build`, free with `rustp2p_endpoint_free`.
/// Received data handle containing both payload and metadata.
///
/// Use `rustp2p_recv_data_get_*` functions to extract information,
/// then call `rustp2p_recv_data_free` to release.
// Error codes
/// Operation completed successfully.
pub const RUSTP2P_OK: c_int = 0;
/// General error occurred.
pub const RUSTP2P_ERROR: c_int = -1;
/// NULL pointer was provided where a valid pointer was expected.
pub const RUSTP2P_ERROR_NULL_PTR: c_int = -2;
/// Invalid string format or encoding.
pub const RUSTP2P_ERROR_INVALID_STR: c_int = -3;
/// Invalid IP address format.
pub const RUSTP2P_ERROR_INVALID_IP: c_int = -4;
/// Failed to build endpoint (e.g., port in use, invalid config).
pub const RUSTP2P_ERROR_BUILD_FAILED: c_int = -5;
/// Operation would block (for non-blocking operations).
pub const RUSTP2P_ERROR_WOULD_BLOCK: c_int = -6;
/// End of file / connection closed.
pub const RUSTP2P_ERROR_EOF: c_int = -7;
/// Create a new builder
///
/// Returns a new builder handle that must be freed with `rustp2p_builder_free`
/// or consumed by `rustp2p_builder_build`.
///
/// # Returns
///
/// Returns a valid builder pointer on success, or NULL on failure (e.g., out of memory).
///
/// # Example
///
/// ```c
/// Rustp2pBuilder* builder = rustp2p_builder_new();
/// if (!builder) {
/// fprintf(stderr, "Failed to create builder\n");
/// return -1;
/// }
/// ```
pub extern "C"
/// Set UDP port
///
/// Configures the UDP port for this endpoint. Use 0 for a random port.
///
/// # Arguments
///
/// * `builder` - The builder handle
/// * `port` - The UDP port number (0-65535)
///
/// # Returns
///
/// * `RUSTP2P_OK` on success
/// * `RUSTP2P_ERROR_NULL_PTR` if builder is NULL
///
/// # Example
///
/// ```c
/// rustp2p_builder_udp_port(builder, 8080);
/// ```
pub extern "C"
/// Set TCP port
///
/// Configures the TCP port for this endpoint. Use 0 for a random port.
///
/// # Arguments
///
/// * `builder` - The builder handle
/// * `port` - The TCP port number (0-65535)
///
/// # Returns
///
/// * `RUSTP2P_OK` on success
/// * `RUSTP2P_ERROR_NULL_PTR` if builder is NULL
///
/// # Example
///
/// ```c
/// rustp2p_builder_tcp_port(builder, 8080);
/// ```
pub extern "C"
/// Set node ID from IPv4 address string (e.g., "10.0.0.1")
///
/// Each node in the P2P network must have a unique node ID.
///
/// # Arguments
///
/// * `builder` - The builder handle
/// * `node_id_str` - NULL-terminated IPv4 address string
///
/// # Returns
///
/// * `RUSTP2P_OK` on success
/// * `RUSTP2P_ERROR_NULL_PTR` if builder or node_id_str is NULL
/// * `RUSTP2P_ERROR_INVALID_STR` if the string is not valid UTF-8
/// * `RUSTP2P_ERROR_INVALID_IP` if the IP address format is invalid
///
/// # Example
///
/// ```c
/// int result = rustp2p_builder_node_id(builder, "10.0.0.1");
/// if (result != RUSTP2P_OK) {
/// fprintf(stderr, "Failed to set node ID\n");
/// }
/// ```
pub extern "C"
/// Set group code from string (e.g., "mygroup" or "12345")
///
/// The group code creates isolated P2P networks. Nodes with different
/// group codes cannot communicate with each other.
///
/// The string will be converted to a 16-byte array (padded with zeros if shorter).
///
/// # Arguments
///
/// * `builder` - The builder handle
/// * `group_code` - NULL-terminated group code string
///
/// # Returns
///
/// * `RUSTP2P_OK` on success
/// * `RUSTP2P_ERROR_NULL_PTR` if builder or group_code is NULL
/// * `RUSTP2P_ERROR_INVALID_STR` if the string is not valid UTF-8
/// * `RUSTP2P_ERROR` if the group code format is invalid
///
/// # Example
///
/// ```c
/// rustp2p_builder_group_code(builder, "12345");
/// ```
pub extern "C"
/// Add a peer address (e.g., "udp://127.0.0.1:9090" or "tcp://192.168.1.1:8080")
///
/// Adds an initial peer that this node will connect to. You can call this
/// multiple times to add multiple peers.
///
/// # Arguments
///
/// * `builder` - The builder handle
/// * `peer_addr` - NULL-terminated peer address string (format: "protocol://ip:port")
///
/// # Returns
///
/// * `RUSTP2P_OK` on success
/// * `RUSTP2P_ERROR_NULL_PTR` if builder or peer_addr is NULL
/// * `RUSTP2P_ERROR_INVALID_STR` if the string is not valid UTF-8
/// * `RUSTP2P_ERROR` if the address format is invalid
///
/// # Example
///
/// ```c
/// rustp2p_builder_add_peer(builder, "udp://192.168.1.100:9090");
/// rustp2p_builder_add_peer(builder, "tcp://10.0.0.1:8080");
/// ```
pub extern "C"
/// Set encryption algorithm
/// algorithm: 0 = AesGcm, 1 = ChaCha20Poly1305 (if available)
/// password: the encryption password
pub extern "C"
/// Build the endpoint
///
/// Consumes the builder and creates an endpoint. The builder is freed automatically
/// and must not be used after this call, regardless of success or failure.
///
/// # Arguments
///
/// * `builder` - The builder handle (will be freed)
///
/// # Returns
///
/// Returns a valid endpoint pointer on success, or NULL on failure.
/// Common failure reasons include:
/// - Port already in use
/// - Missing required configuration (e.g., node_id)
/// - Network initialization errors
///
/// # Example
///
/// ```c
/// Rustp2pEndpoint* endpoint = rustp2p_builder_build(builder);
/// if (!endpoint) {
/// fprintf(stderr, "Failed to build endpoint\n");
/// return -1;
/// }
/// // Use endpoint...
/// rustp2p_endpoint_free(endpoint);
/// ```
pub extern "C"
/// Free/destroy the builder
///
/// Releases all resources associated with the builder. Only use this if you
/// did NOT call `rustp2p_builder_build` (which frees the builder automatically).
///
/// # Safety
///
/// The builder pointer must not be used after this call.
///
/// # Arguments
///
/// * `builder` - The builder handle to free (can be NULL, in which case this is a no-op)
pub extern "C"
/// Send data to a peer
///
/// Sends data to a specific peer by their node ID. This operation blocks until
/// the data is queued for sending (but not necessarily delivered).
///
/// # Arguments
///
/// * `endpoint` - The endpoint handle
/// * `dest_ip` - NULL-terminated destination node IP address string (e.g., "10.0.0.2")
/// * `data` - Pointer to data buffer
/// * `len` - Length of data in bytes
///
/// # Returns
///
/// * `RUSTP2P_OK` on success
/// * `RUSTP2P_ERROR_NULL_PTR` if any pointer is NULL
/// * `RUSTP2P_ERROR_INVALID_STR` if dest_ip is not valid UTF-8
/// * `RUSTP2P_ERROR_INVALID_IP` if dest_ip format is invalid
/// * `RUSTP2P_ERROR` on other errors (e.g., network failure)
///
/// # Example
///
/// ```c
/// const char* message = "Hello, peer!";
/// int result = rustp2p_endpoint_send_to(
/// endpoint,
/// "10.0.0.2",
/// (const uint8_t*)message,
/// strlen(message)
/// );
///
/// if (result == RUSTP2P_OK) {
/// printf("Message sent\n");
/// }
/// ```
pub extern "C"
/// Try to send data to a peer (non-blocking)
pub extern "C"
/// Receive data from peers (blocking)
///
/// Blocks until data is received from any peer or an error occurs.
/// The returned structure must be freed with `rustp2p_recv_data_free`.
///
/// # Arguments
///
/// * `endpoint` - The endpoint handle
///
/// # Returns
///
/// Returns pointer to received data structure, or NULL on error or connection closed.
/// Caller must free the returned pointer with `rustp2p_recv_data_free`.
///
/// # Example
///
/// ```c
/// Rustp2pRecvData* recv_data = rustp2p_endpoint_recv_from(endpoint);
/// if (recv_data) {
/// const uint8_t* data;
/// size_t len;
/// rustp2p_recv_data_get_payload(recv_data, &data, &len);
/// printf("Received %zu bytes\n", len);
/// rustp2p_recv_data_free(recv_data);
/// }
/// ```
pub extern "C"
/// Try to receive data from peers (non-blocking)
/// Returns pointer to received data structure, or NULL if no data available or on error
/// Caller must free the returned pointer with rustp2p_recv_data_free
pub extern "C"
/// Get payload data from received data
/// out_data: output pointer to data (borrowed, don't free)
/// out_len: output length
pub extern "C"
/// Get source node ID from received data as IPv4 string
/// buffer: output buffer for IP string
/// buffer_len: size of buffer (should be at least 16 bytes for "xxx.xxx.xxx.xxx\0")
pub extern "C"
/// Get destination node ID from received data as IPv4 string
pub extern "C"
/// Check if the received data was relayed
pub extern "C"
/// Free received data
pub extern "C"
/// Free/destroy the endpoint
///
/// Releases all resources associated with the endpoint and closes all connections.
///
/// # Safety
///
/// The endpoint pointer must not be used after this call.
///
/// # Arguments
///
/// * `endpoint` - The endpoint handle to free (can be NULL, in which case this is a no-op)
///
/// # Example
///
/// ```c
/// rustp2p_endpoint_free(endpoint);
/// endpoint = NULL; // Good practice to avoid use-after-free
/// ```
pub extern "C"