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
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
#![allow(non_camel_case_types, non_snake_case)]
use bitflags::bitflags;
use std::{ffi::CStr, fmt::Debug};
#[repr(C)]
#[derive(Debug, Copy, Clone, Hash)]
pub struct WPI_String {
pub str: *const std::ffi::c_char,
pub len: usize,
}
impl From<&CStr> for WPI_String {
fn from(s: &CStr) -> Self {
Self {
str: s.as_ptr() as *const std::ffi::c_char,
len: s.count_bytes(),
}
}
}
pub type WPI_DataLog = std::ffi::c_void;
pub type NT_Bool = i32;
pub type NT_Handle = u32;
pub type NT_ConnectionDataLogger = NT_Handle;
pub type NT_DataLogger = NT_Handle;
pub type NT_Entry = NT_Handle;
pub type NT_Inst = NT_Handle;
pub type NT_Listener = NT_Handle;
pub type NT_ListenerPoller = NT_Handle;
pub type NT_MultiSubscriber = NT_Handle;
pub type NT_Topic = NT_Handle;
pub type NT_Subscriber = NT_Handle;
pub type NT_Publisher = NT_Handle;
/// Event listener callback function.
///
/// # Parameters
///
/// - `data`: data pointer provided to callback creation function
/// - `event`: event info
pub type NT_ListenerCallback = unsafe extern "C" fn(*mut std::ffi::c_void, *const NT_Event);
macro_rules! c_enum {
{$(
$(#[$meta:meta])*
$vis:vis enum $name:ident: $type:ty {
$($(#[$memmeta:meta])* $var:ident = $val:expr),+ $(,)?
})+} => {
$(
#[repr(transparent)]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
$(#[$meta])*
$vis struct $name($type);
impl $name {
pub fn bits(&self) -> $type {
self.0
}
$(
$(#[$memmeta])*
pub const $var: $name = $name($val);
)+
}
)+
};
}
c_enum! {
/// NetworkTables data types.
pub enum NT_Type: u32 {
NT_UNASSIGNED = 0,
NT_BOOLEAN = 0x01,
NT_DOUBLE = 0x02,
NT_STRING = 0x04,
NT_RAW = 0x08,
NT_BOOLEAN_ARRAY = 0x10,
NT_DOUBLE_ARRAY = 0x20,
NT_STRING_ARRAY = 0x40,
NT_RPC = 0x80,
NT_INTEGER = 0x100,
NT_FLOAT = 0x200,
NT_INTEGER_ARRAY = 0x400,
NT_FLOAT_ARRAY = 0x800
}
/// NetworkTables logging levels.
pub enum NT_LogLevel: u32 {
NT_LOG_CRITICAL = 50,
NT_LOG_ERROR = 40,
NT_LOG_WARNING = 30,
NT_LOG_INFO = 20,
NT_LOG_DEBUG = 10,
NT_LOG_DEBUG1 = 9,
NT_LOG_DEBUG2 = 8,
NT_LOG_DEBUG3 = 7,
NT_LOG_DEBUG4 = 6
}
/// Client/server modes
pub enum NT_NetworkMode: u32 {
/// Not running
NT_NET_MODE_NONE = 0x00,
/// Running in server mode
NT_NET_MODE_SERVER = 0x01,
/// Running in NT3 client mode
NT_NET_MODE_CLIENT3 = 0x02,
/// Running in NT4 client mode
NT_NET_MODE_CLIENT4 = 0x04,
/// Starting (either client or server)
NT_NET_MODE_STARTING = 0x08,
/// Running in local-only mode
NT_NET_MODE_LOCAL = 0x10,
}
}
bitflags! {
/// Event notification flags.
#[repr(transparent)]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub struct NT_EventFlags: u32 {
const NT_EVENT_NONE = 0;
/// Initial listener addition.
const NT_EVENT_IMMEDIATE = 0x01;
/// Client connected (on server, any client connected).
const NT_EVENT_CONNECTED = 0x02;
/// Client disconnected (on server, any client disconnected).
const NT_EVENT_DISCONNECTED = 0x04;
/// Any connection event (connect or disconnect).
const NT_EVENT_CONNECTION = 0x02| 0x04;
/// New topic published.
const NT_EVENT_PUBLISH = 0x08;
/// Topic unpublished.
const NT_EVENT_UNPUBLISH = 0x10;
/// Topic properties changed.
const NT_EVENT_PROPERTIES = 0x20;
/// Any topic event (publish, unpublish, or properties changed).
const NT_EVENT_TOPIC = 0x08| 0x10 | 0x20;
/// Topic value updated (via network).
const NT_EVENT_VALUE_REMOTE = 0x40;
/// Topic value updated (local).
const NT_EVENT_VALUE_LOCAL = 0x80;
/// Topic value updated (network or local).
const NT_EVENT_VALUE_ALL = 0x40 | 0x80;
/// Log message.
const NT_EVENT_LOGMESSAGE = 0x100;
/// Time synchronized with server.
const NT_EVENT_TIMESYNC = 0x200;
}
/// NetworkTables entry flags.
#[repr(transparent)]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub struct NT_EntryFlags: u32 {
const NT_PERSISTENT = 0x01;
const NT_RETAINED = 0x02;
const NT_UNCACHED = 0x04;
}
}
/// Not included in the original ntcore header file, but required because of rust union limitations.
#[repr(C)]
#[derive(Copy, Clone, Debug)]
pub struct NT_ValueDataArray<T> {
pub arr: *const T,
pub size: usize,
}
#[repr(C)]
#[derive(Copy, Clone)]
pub union NT_ValueData {
pub v_boolean: NT_Bool,
pub v_int: i64,
pub v_float: f32,
pub v_double: f64,
pub v_string: WPI_String,
pub v_raw: NT_ValueDataArray<u8>,
pub arr_boolean: NT_ValueDataArray<NT_Bool>,
pub arr_double: NT_ValueDataArray<f64>,
pub arr_float: NT_ValueDataArray<f32>,
pub arr_int: NT_ValueDataArray<i64>,
pub arr_string: NT_ValueDataArray<WPI_String>,
}
/// NetworkTables Entry Value. Note this is a typed union.
#[repr(C)]
#[derive(Copy, Clone)]
pub struct NT_Value {
pub r#type: NT_Type,
pub last_change: i64,
pub server_time: i64,
pub data: NT_ValueData,
}
/// NetworkTables Topic Information
#[repr(C)]
#[derive(Copy, Clone, Debug, Hash)]
pub struct NT_TopicInfo {
/// Topic handle
pub topic: NT_Topic,
/// Topic name
pub name: WPI_String,
/// Topic type
pub r#type: NT_Type,
/// Topic type string
pub type_str: WPI_String,
/// Topic properties JSON string
pub properties: WPI_String,
}
/// NetworkTables Connection Information
#[repr(C)]
#[derive(Copy, Clone, Debug, Hash)]
pub struct NT_ConnectionInfo {
/// The remote identifier (as set on the remote node by NT_StartClient4().
pub remote_id: WPI_String,
/// The IP address of the remote node.
pub remote_ip: WPI_String,
/// The port number of the remote node.
pub remote_port: u32,
/// The last time any update was received from the remote node (same scale as
/// returned by nt::Now()).
pub last_update: u64,
/// The protocol version being used for this connection. This in protocol
/// layer format, so 0x0200 = 2.0, 0x0300 = 3.0).
pub protocol_version: u32,
}
/// NetworkTables value event data.
#[repr(C)]
#[derive(Copy, Clone)]
pub struct NT_ValueEventData {
/// Topic handle.
pub topic: NT_Topic,
/// Subscriber/entry handle.
pub subentry: NT_Handle,
/// The new value.
pub value: NT_Value,
}
/// NetworkTables log message.
#[repr(C)]
#[derive(Copy, Clone, Debug, Hash)]
pub struct NT_LogMessage {
/// Log level of the message. See NT_LogLevel.
pub level: u32,
/// The filename of the source file that generated the message.
pub filename: WPI_String,
/// The line number in the source file that generated the message.
pub line: u32,
/// The message.
pub message: WPI_String,
}
/// NetworkTables time sync event data.
#[repr(C)]
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
pub struct NT_TimeSyncEventData {
/// Offset between local time and server time, in microseconds. Add this value
/// to local time to get the estimated equivalent server time.
pub serverTimeOffset: i64,
/// Measured round trip time divided by 2, in microseconds.
pub rtt2: i64,
/// If serverTimeOffset and RTT are valid. An event with this set to false is
/// sent when the client disconnects.
pub valid: NT_Bool,
}
#[repr(C)]
#[derive(Copy, Clone)]
pub union NT_EventData {
pub connInfo: NT_ConnectionInfo,
pub topicInfo: NT_TopicInfo,
pub valueData: NT_ValueEventData,
pub logMessage: NT_LogMessage,
pub timeSyncData: NT_TimeSyncEventData,
}
/// NetworkTables event
#[repr(C)]
#[derive(Copy, Clone)]
pub struct NT_Event {
/// Listener that triggered this event.
pub listener: NT_Handle,
/// Event flags (NT_EventFlags). Also indicates the data included with the
/// event:
/// - NT_EVENT_CONNECTED or NT_EVENT_DISCONNECTED: connInfo
/// - NT_EVENT_PUBLISH, NT_EVENT_UNPUBLISH, or NT_EVENT_PROPERTIES: topicInfo
/// - NT_EVENT_VALUE_REMOTE, NT_NOTIFY_VALUE_LOCAL: valueData
/// - NT_EVENT_LOGMESSAGE: logMessage
/// - NT_EVENT_TIMESYNC: timeSyncData
pub flags: u32,
/// Event data; content depends on flags.
pub data: NT_EventData,
}
/// NetworkTables publish/subscribe options.
#[repr(C)]
#[derive(Debug, Copy, Clone, PartialEq)]
pub struct NT_PubSubOptions {
/// Structure size. Must be set to sizeof(NT_PubSubOptions).
pub structSize: u32,
/// Polling storage size for a subscription. Specifies the maximum number of
/// updates NetworkTables should store between calls to the subscriber's
/// ReadQueue() function. If zero, defaults to 1 if sendAll is false, 20 if
/// sendAll is true.
pub pollStorage: u32,
/// How frequently changes will be sent over the network, in seconds.
/// NetworkTables may send more frequently than this (e.g. use a combined
/// minimum period for all values) or apply a restricted range to this value.
/// The default is 100 ms.
pub periodic: f64,
/// For subscriptions, if non-zero, value updates for ReadQueue() are not
/// queued for this publisher.
pub excludePublisher: NT_Publisher,
/// Send all value changes over the network.
pub sendAll: NT_Bool,
/// For subscriptions, don't ask for value changes (only topic announcements).
pub topicsOnly: NT_Bool,
/// Perform prefix match on subscriber topic names. Is ignored/overridden by
/// Subscribe() functions; only present in struct for the purposes of getting
/// information about subscriptions.
pub prefixMatch: NT_Bool,
/// Preserve duplicate value changes (rather than ignoring them).
pub keepDuplicates: NT_Bool,
/// For subscriptions, if remote value updates should not be queued for
/// ReadQueue(). See also disableLocal.
pub disableRemote: NT_Bool,
/// For subscriptions, if local value updates should not be queued for
/// ReadQueue(). See also disableRemote.
pub disableLocal: NT_Bool,
/// For entries, don't queue (for ReadQueue) value updates for the entry's
/// internal publisher.
pub excludeSelf: NT_Bool,
/// For subscriptions, don't share the existence of the subscription with the
/// network. Note this means updates will not be received from the network
/// unless another subscription overlaps with this one, and the subscription
/// will not appear in metatopics.
pub hidden: NT_Bool,
}
/// Timestamped Boolean.
#[repr(C)]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub struct NT_TimestampedBoolean {
/// Time in local time base
time: i64,
/// Time in server time base. May be 0 or 1 for locally set values.
serverTime: i64,
/// Value.
value: NT_Bool,
}
/// Timestamped Integer.
#[repr(C)]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub struct NT_TimestampedInteger {
/// Time in local time base
time: i64,
/// Time in server time base. May be 0 or 1 for locally set values.
serverTime: i64,
/// Value.
value: i64,
}
/// Timestamped Float.
#[repr(C)]
#[derive(Debug, Copy, Clone, PartialEq)]
pub struct NT_TimestampedFloat {
/// Time in local time base
time: i64,
/// Time in server time base. May be 0 or 1 for locally set values.
serverTime: i64,
/// Value.
value: f32,
}
/// Timestamped Double.
#[repr(C)]
#[derive(Debug, Copy, Clone, PartialEq)]
pub struct NT_TimestampedDouble {
/// Time in local time base
time: i64,
/// Time in server time base. May be 0 or 1 for locally set values.
serverTime: i64,
/// Value.
value: f32,
}
/// Timestamped String.
#[repr(C)]
#[derive(Debug, Copy, Clone, Hash)]
pub struct NT_TimestampedString {
/// Time in local time base
time: i64,
/// Time in server time base. May be 0 or 1 for locally set values.
serverTime: i64,
/// Value.
value: WPI_String,
}
/// Timestamped Raw.
#[repr(C)]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub struct NT_TimestampedRaw {
/// Time in local time base
time: i64,
/// Time in server time base. May be 0 or 1 for locally set values.
serverTime: i64,
/// Value.
value: *mut u8,
/// Value length.
len: usize,
}
/// Timestamped Boolean Array.
#[repr(C)]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub struct NT_TimestampedBooleanArray {
/// Time in local time base
time: i64,
/// Time in server time base. May be 0 or 1 for locally set values.
serverTime: i64,
/// Value.
value: *mut NT_Bool,
/// Value length.
len: usize,
}
/// Timestamped Integer Array.
#[repr(C)]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub struct NT_TimestampedIntegerArray {
/// Time in local time base
time: i64,
/// Time in server time base. May be 0 or 1 for locally set values.
serverTime: i64,
/// Value.
value: *mut i64,
/// Value length.
len: usize,
}
/// Timestamped Float Array.
#[repr(C)]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub struct NT_TimestampedFloatArray {
/// Time in local time base
time: i64,
/// Time in server time base. May be 0 or 1 for locally set values.
serverTime: i64,
/// Value.
value: *mut f32,
/// Value length.
len: usize,
}
/// Timestamped Double Array.
#[repr(C)]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub struct NT_TimestampedDoubleArray {
/// Time in local time base
time: i64,
/// Time in server time base. May be 0 or 1 for locally set values.
serverTime: i64,
/// Value.
value: *mut f64,
/// Value length.
len: usize,
}
/// Timestamped String Array.
#[repr(C)]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub struct NT_TimestampedStringArray {
/// Time in local time base
time: i64,
/// Time in server time base. May be 0 or 1 for locally set values.
serverTime: i64,
/// Value.
value: *mut WPI_String,
/// Value length.
len: usize,
}
extern "C" {
/// Get default instance.
/// This is the instance used by non-handle-taking functions.
///
/// # Returns
///
/// Instance handle
pub fn NT_GetDefaultInstance() -> NT_Inst;
/// Create an instance.
///
/// # Returns
///
/// Instance handle
pub fn NT_CreateInstance() -> NT_Inst;
/// Destroy an instance.
/// The default instance cannot be destroyed.
///
/// # Parameters
///
/// - inst: Instance handle
pub fn NT_DestroyInstance(inst: NT_Inst);
/// Get instance handle from another handle.
pub fn NT_GetInstanceFromHandle(handle: NT_Handle) -> NT_Inst;
/// Get Entry Handle.
///
/// # Parameters
///
/// - `inst`: Instance handle.
/// - `name`: Entry name (UTF-8 string).
///
/// # Returns
///
/// Entry handle.
pub fn NT_GetEntry(inst: NT_Inst, name: *const WPI_String) -> NT_Entry;
/// Gets the name of the specified entry.
/// Returns an empty string if the handle is invalid.
///
/// # Parameters
///
/// - `entry`: Entry handle.
/// - `name`: Entry name (output parameter).
pub fn NT_GetEntryName(entry: NT_Entry, name: *mut WPI_String);
/// Gets the type for the specified key, or unassigned if non-existent.
///
/// # Parameters
///
/// - `entry`: Entry handle.
///
/// # Returns
///
/// Entry type.
pub fn NT_GetEntryType(entry: NT_Entry) -> NT_Type;
/// Gets the last time the entry was changed.
/// Returns 0 if the handle is invalid.
///
/// # Parameters
///
/// - entry: entry handle
///
/// # Returns
///
/// Entry last change time
pub fn NT_GetEntryLastChange(entry: NT_Entry) -> u64;
/// Get Entry Value.
///
/// Returns copy of current entry value.
/// Note that one of the type options is "unassigned".
///
/// # Parameters
///
/// - entry: entry handle
/// - value: storage for returned entry value
///
/// # Note
///
/// It is the caller's responsibility to free value once it's no longer
/// needed (the utility function NT_DisposeValue() is useful for this
/// purpose).
pub fn NT_GetEntryValue(entry: NT_Entry, value: *mut NT_Value);
/// Get Entry Value.
///
/// Returns copy of current entry value.
/// Note that one of the type options is "unassigned".
///
/// # Parameters
///
/// - entry: entry handle
/// - types: bitmask of NT_Type values; 0 is treated specially
/// as a "don't care"
/// - value: storage for returned entry value
///
/// # Note
///
/// It is the caller's responsibility to free value once it's no longer
/// needed (the utility function NT_DisposeValue() is useful for this
/// purpose).
pub fn NT_GetEntryValueType(entry: NT_Entry, types: NT_Type, value: *mut NT_Value);
/// Set Default Entry Value.
///
/// Returns copy of current entry value if it exists.
/// Otherwise, sets passed in value, and returns set value.
/// Note that one of the type options is "unassigned".
///
/// # Parameters
///
/// - entry: entry handle
/// - default_value: value to be set if name does not exist
///
/// # Returns
///
/// 0 on error (value not set), 1 on success
pub fn NT_SetDefaultEntryValue(entry: NT_Entry, default_value: *const NT_Value) -> NT_Bool;
/// Set Entry Value.
///
/// Sets new entry value. If type of new value differs from the type of the
/// currently stored entry, returns error and does not update value.
///
/// # Parameters
///
/// - entry: entry handle
/// - value: new entry value
///
/// # Returns
///
/// 0 on error (type mismatch), 1 on success
pub fn NT_SetEntryValue(entry: NT_Entry, value: *const NT_Value) -> NT_Bool;
/// Set Entry Flags.
///
/// # Parameters
///
/// - entry: entry handle
/// - flags: flags value (bitmask of NT_EntryFlags)
pub fn NT_SetEntryFlags(entry: NT_Entry, flags: NT_EntryFlags);
/// Get Entry Flags.
///
/// # Parameters
///
/// - entry: entry handle
///
/// # Returns
///
/// Flags value (bitmask of NT_EntryFlags)
pub fn NT_GetEntryFlags(entry: NT_Entry) -> NT_EntryFlags;
/// Read Entry Queue.
///
/// Returns new entry values since last call. The returned array must be freed
/// using NT_DisposeValueArray().
///
/// # Parameters
///
/// - subentry: subscriber or entry handle
/// - count: count of items in returned array (output)
///
/// # Returns
///
/// entry value array; returns NULL and count=0 if no new values
pub fn NT_ReadQueueValue(subentry: NT_Handle, count: *mut usize) -> *mut NT_Value;
/// Read Entry Queue.
///
/// Returns new entry values since last call. The returned array must be freed
/// using NT_DisposeValueArray().
///
/// # Parameters
///
/// - subentry: subscriber or entry handle
/// - types: bitmask of NT_Type values; 0 is treated specially
/// as a "don't care"
/// - count: count of items in returned array (output)
///
/// # Returns
///
/// entry value array; returns NULL and count=0 if no new values
pub fn NT_ReadQueueValueType(
subentry: NT_Handle,
types: u32,
count: *mut usize,
) -> *mut NT_Value;
/// Get Published Topic Handles.
///
/// Returns an array of topic handles. The results are optionally
/// filtered by string prefix and type to only return a subset of all
/// topics.
///
/// # Parameters
///
/// - inst: instance handle
/// - prefix: name required prefix; only topics whose name
/// starts with this string are returned
/// - types: bitmask of NT_Type values; 0 is treated specially
/// as a "don't care"
/// - count: output parameter; set to length of returned array
///
/// # Returns
///
/// Array of topic handles.
pub fn NT_GetTopics(
inst: NT_Inst,
prefix: *const WPI_String,
types: u32,
count: *mut usize,
) -> *mut NT_Topic;
/// Get Published Topic Handles.
///
/// Returns an array of topic handles. The results are optionally
/// filtered by string prefix and type to only return a subset of all
/// topics.
///
/// # Parameters
///
/// - inst: instance handle
/// - prefix: name required prefix; only topics whose name
/// starts with this string are returned
/// - types: array of type strings
/// - types_len: number of elements in types array
/// - count: output parameter; set to length of returned array
///
/// # Returns
///
/// Array of topic handles.
pub fn NT_GetTopicsStr(
inst: NT_Inst,
prefix: *const WPI_String,
types: *const WPI_String,
types_len: usize,
count: *mut usize,
) -> *mut NT_Topic;
/// Get Topics.
///
/// Returns an array of topic information (handle, name, type). The results are
/// optionally filtered by string prefix and type to only return a subset
/// of all topics.
///
/// # Parameters
///
/// - inst: instance handle
/// - prefix: name required prefix; only topics whose name
/// starts with this string are returned
/// - types: bitmask of NT_Type values; 0 is treated specially
/// as a "don't care"
/// - count: output parameter; set to length of returned array
///
/// # Returns
///
/// Array of topic information.
pub fn NT_GetTopicInfos(
inst: NT_Inst,
prefix: *const WPI_String,
types: u32,
count: *mut usize,
) -> *mut NT_TopicInfo;
/// Get Topics.
///
/// Returns an array of topic information (handle, name, type). The results are
/// optionally filtered by string prefix and type to only return a subset
/// of all topics.
///
/// # Parameters
///
/// - inst: instance handle
/// - prefix: name required prefix; only topics whose name
/// starts with this string are returned
/// - types: array of type strings
/// - types_len: number of elements in types array
/// - count: output parameter; set to length of returned array
///
/// # Returns
///
/// Array of topic information.
pub fn NT_GetTopicInfosStr(
inst: NT_Inst,
prefix: *const WPI_String,
types: *const WPI_String,
types_len: usize,
count: *mut usize,
) -> *mut NT_TopicInfo;
/// Gets Topic Information.
///
/// Returns information about a topic (name and type).
///
/// - topic: handle
/// - info: information (output)
///
/// # Returns
///
/// True if successful, false on error.
pub fn NT_GetTopicInfo(topic: NT_Topic, info: *mut NT_TopicInfo) -> NT_Bool;
/// Gets Topic Handle.
///
/// Returns topic handle.
///
/// # Parameters
///
/// - inst: instance handle
/// - name: topic name
///
/// # Returns
///
/// Topic handle.
pub fn NT_GetTopic(inst: NT_Inst, name: *const WPI_String) -> NT_Topic;
/// Gets the name of the specified topic.
///
/// # Parameters
///
/// - topic: topic handle
/// - name: topic name (output); return length of 0 and nullptr if
/// handle is invalid.
pub fn NT_GetTopicName(topic: NT_Topic, name: *mut WPI_String);
/// Gets the type for the specified topic, or unassigned if non existent.
///
/// # Parameters
///
/// - topic: topic handle
///
/// # Returns
///
/// Topic type
pub fn NT_GetTopicType(topic: NT_Topic) -> NT_Type;
/// Gets the type string for the specified topic. This may have more information
/// than the numeric type (especially for raw values).
///
/// # Parameters
///
/// - topic: topic handle
/// - type: topic type string (output)
pub fn NT_GetTopicTypeString(topic: NT_Topic, r#type: *mut WPI_String);
/// Sets the persistent property of a topic. If true, the stored value is
/// persistent through server restarts.
///
/// # Parameters
///
/// - topic: topic handle
/// - value: True for persistent, false for not persistent.
pub fn NT_SetTopicPersistent(topic: NT_Topic, value: NT_Bool);
/// Gets the persistent property of a topic.
///
/// # Parameters
///
/// - topic: topic handle
///
/// # Returns
///
/// persistent property value
pub fn NT_GetTopicPersistent(topic: NT_Topic) -> NT_Bool;
/// Sets the retained property of a topic. If true, the server retains the
/// topic even when there are no publishers.
///
/// # Parameters
///
/// - topic: topic handle
/// - value: new retained property value
pub fn NT_SetTopicRetained(topic: NT_Topic, value: NT_Bool);
/// Gets the retained property of a topic.
///
/// # Parameters
///
/// - topic: topic handle
///
/// # Returns
///
/// retained property value
pub fn NT_GetTopicRetained(topic: NT_Topic) -> NT_Bool;
/// Sets the cached property of a topic. If true, the server and clients will
/// store the latest value, allowing the value to be read (and not just accessed
/// through event queues and listeners).
///
/// # Parameters
///
/// - topic: topic handle
/// - value: True for cached, false for not cached
pub fn NT_SetTopicCached(topic: NT_Topic, value: NT_Bool);
/// Gets the cached property of a topic.
///
/// # Parameters
///
/// - topic: topic handle
///
/// # Return
///
/// cached property value
pub fn NT_GetTopicCached(topic: NT_Topic) -> NT_Bool;
/// Determine if topic exists (e.g. has at least one publisher).
///
/// # Parameters
///
/// - handle: Topic, entry, or subscriber handle.
///
/// # Returns
///
/// True if topic exists.
pub fn NT_GetTopicExists(handle: NT_Handle) -> NT_Bool;
/// Gets the current value of a property (as a JSON string).
///
/// # Parameters
///
/// - topic: topic handle
/// - name: property name
/// - property: JSON string (output)
pub fn NT_GetTopicProperty(topic: NT_Topic, name: *const WPI_String, property: *mut WPI_String);
/// Sets a property value.
///
/// # Parameters
///
/// - topic: topic handle
/// - name: property name
/// - value: property value (JSON string)
pub fn NT_SetTopicProperty(
topic: NT_Topic,
name: *const WPI_String,
value: *const WPI_String,
) -> NT_Bool;
/// Deletes a property. Has no effect if the property does not exist.
///
/// # Parameters
///
/// - topic: topic handle
/// - name: property name
pub fn NT_DeleteTopicProperty(topic: NT_Topic, name: *const WPI_String);
/// Gets all topic properties as a JSON string. Each key in the object
/// is the property name, and the corresponding value is the property value.
///
/// # Parameters
///
/// - topic: topic handle
/// - properties: JSON string (output)
pub fn NT_GetTopicProperties(topic: NT_Topic, properties: *mut WPI_String);
/// Updates multiple topic properties. Each key in the passed-in JSON object is
/// the name of the property to add/update, and the corresponding value is the
/// property value to set for that property. Null values result in deletion
/// of the corresponding property.
///
/// # Parameters
///
/// - topic: topic handle
/// - properties: JSON object string with keys to add/update/delete
///
/// # Returns
///
/// False if properties are not a valid JSON object
pub fn NT_SetTopicProperties(topic: NT_Topic, properties: *const WPI_String) -> NT_Bool;
/// Creates a new subscriber to value changes on a topic.
///
/// # Parameters
///
/// - topic: topic handle
/// - type: expected type
/// - typeStr: expected type string
/// - options: subscription options
///
/// # Returns
///
/// Subscriber handle
pub fn NT_Subscribe(
topic: NT_Topic,
r#type: NT_Type,
typeStr: *const WPI_String,
options: *const NT_PubSubOptions,
) -> NT_Subscriber;
/// Stops subscriber.
///
/// # Returns
///
/// sub subscriber handle
pub fn NT_Unsubscribe(sub: NT_Subscriber);
/// Creates a new publisher to a topic.
///
/// # Parameters
///
/// - topic: topic handle
/// - type: type
/// - typeStr: type string
/// - options: publish options
///
/// # Returns
///
/// Publisher handle
pub fn NT_Publish(
topic: NT_Topic,
r#type: NT_Type,
typeStr: *const WPI_String,
options: *const NT_PubSubOptions,
) -> NT_Publisher;
/// Creates a new publisher to a topic.
///
/// # Parameters
///
/// - topic: topic handle
/// - type: type
/// - typeStr: type string
/// - properties: initial properties (JSON object)
/// - options: publish options
///
/// # Returns
///
/// Publisher handle
pub fn NT_PublishEx(
topic: NT_Topic,
r#type: NT_Type,
typeStr: *const WPI_String,
properties: *const WPI_String,
options: *const NT_PubSubOptions,
) -> NT_Publisher;
/// Stops publisher.
///
/// # Parameters
///
/// pubentry publisher/entry handle
pub fn NT_Unpublish(pubentry: NT_Handle);
/// Creates a new entry (subscriber and weak publisher) to a topic.
///
/// # Parameters
///
/// - topic: topic handle
/// - type: type
/// - typeStr: type string
/// - options: publish options
///
/// # Returns
///
/// Entry handle
pub fn NT_GetEntryEx(
topic: NT_Topic,
r#type: NT_Type,
typeStr: *const WPI_String,
options: *const NT_PubSubOptions,
) -> NT_Entry;
/// Stops entry subscriber/publisher.
///
/// # Parameters
///
/// - entry: entry handle
pub fn NT_ReleaseEntry(entry: NT_Entry);
/// Stops entry/subscriber/publisher.
///
/// # Parameters
///
/// - pubsubentry: entry/subscriber/publisher handle
pub fn NT_Release(pubsubentry: NT_Handle);
/// Gets the topic handle from an entry/subscriber/publisher handle.
///
/// # Parameters
///
/// - pubsubentry: entry/subscriber/publisher handle
///
/// # Returns
///
/// Topic handle
pub fn NT_GetTopicFromHandle(pubsubentry: NT_Handle) -> NT_Topic;
/// Subscribes to multiple topics based on one or more topic name prefixes. Can
/// be used in combination with a Value Listener or ReadQueueValue() to get value
/// changes across all matching topics.
///
/// # Parameters
///
/// - inst: instance handle
/// - prefixes: topic name prefixes
/// - prefixes_len: number of elements in prefixes array
/// - options: subscriber options
///
/// # Returns
///
/// subscriber handle
pub fn NT_SubscribeMultiple(
inst: NT_Inst,
prefixes: *const WPI_String,
prefixes_len: usize,
options: *const NT_PubSubOptions,
) -> NT_MultiSubscriber;
/// Unsubscribes a multi-subscriber.
///
/// # Parameters
///
/// sub multi-subscriber handle
pub fn NT_UnsubscribeMultiple(sub: NT_MultiSubscriber);
/// Creates a listener poller.
///
/// A poller provides a single queue of poll events. Events linked to this
/// poller (using NT_AddPolledXListener()) will be stored in the queue and
/// must be collected by calling NT_ReadListenerQueue().
/// The returned handle must be destroyed with NT_DestroyListenerPoller().
///
/// # Parameters
///
/// - inst: instance handle
///
/// # Returns
///
/// poller handle
pub fn NT_CreateListenerPoller(inst: NT_Inst) -> NT_ListenerPoller;
/// Destroys a listener poller. This will abort any blocked polling
/// call and prevent additional events from being generated for this poller.
///
/// # Parameters
///
/// - poller: poller handle
pub fn NT_DestroyListenerPoller(poller: NT_ListenerPoller);
/// Read notifications.
///
/// # Parameters
///
/// - poller: poller handle
/// - len: length of returned array (output)
///
/// # Returns
///
/// Array of events. Returns NULL and len=0 if no events since last call.
pub fn NT_ReadListenerQueue(poller: NT_ListenerPoller, len: *mut usize) -> *mut NT_Event;
/// Removes a listener.
///
/// # Parameters
///
/// - listener: Listener handle to remove
pub fn NT_RemoveListener(listener: NT_Listener);
/// Wait for the listener queue to be empty. This is primarily useful
/// for deterministic testing. This blocks until either the listener
/// queue is empty (e.g. there are no more events that need to be passed along to
/// callbacks or poll queues) or the timeout expires.
///
/// # Parameters
///
/// - handle: handle
/// - timeout: timeout, in seconds. Set to 0 for non-blocking behavior, or a
/// negative value to block indefinitely
///
/// # Returns
///
/// False if timed out, otherwise true.
pub fn NT_WaitForListenerQueue(handle: NT_Handle, timeout: f64) -> NT_Bool;
/// Create a listener for changes to topics with names that start with
/// the given prefix. This creates a corresponding internal subscriber with the
/// lifetime of the listener.
///
/// # Parameters
///
/// - inst: Instance handle
/// - prefix: Topic name string prefix
/// - mask: Bitmask of NT_EventFlags values (only topic and value events will
/// be generated)
/// - data: Data passed to callback function
/// - callback: Listener function
///
/// # Returns
///
/// Listener handle
pub fn NT_AddListenerSingle(
inst: NT_Inst,
prefix: *const WPI_String,
mask: u32,
data: *mut std::ffi::c_void,
callback: NT_ListenerCallback,
) -> NT_Listener;
/// Create a listener for changes to topics with names that start with any of
/// the given prefixes. This creates a corresponding internal subscriber with the
/// lifetime of the listener.
///
/// # Parameters
///
/// - inst: Instance handle
/// - prefixes: Topic name string prefixes
/// - prefixes_len: Number of elements in prefixes array
/// - mask: Bitmask of NT_EventFlags values (only topic and value events will
/// be generated)
/// - data: Data passed to callback function
/// - callback: Listener function
///
/// # Returns
///
/// Listener handle
pub fn NT_AddListenerMultiple(
inst: NT_Inst,
prefixes: *const WPI_String,
prefixes_len: usize,
mask: u32,
data: *mut std::ffi::c_void,
callback: NT_ListenerCallback,
) -> NT_Listener;
/// Create a listener.
///
/// Some combinations of handle and mask have no effect:
/// - connection and log message events are only generated on instances
/// - topic and value events are only generated on non-instances
///
/// Adding value and topic events on a topic will create a corresponding internal
/// subscriber with the lifetime of the listener.
///
/// Adding a log message listener through this function will only result in
/// events at NT_LOG_INFO or higher; for more customized settings, use
/// NT_AddLogger().
///
/// # Parameters
///
/// - handle: Handle
/// - mask: Bitmask of NT_EventFlags values
/// - data: Data passed to callback function
/// - callback: Listener function
///
/// # Returns
///
/// Listener handle
pub fn NT_AddListener(
handle: NT_Handle,
mask: u32,
data: *mut std::ffi::c_void,
callback: NT_ListenerCallback,
) -> NT_Listener;
/// Creates a polled topic listener. This creates a corresponding internal
/// subscriber with the lifetime of the listener.
/// The caller is responsible for calling NT_ReadListenerQueue() to poll.
///
/// # Parameters
///
/// - poller: poller handle
/// - prefix: UTF-8 string prefix
/// - mask: NT_EventFlags bitmask (only topic and value events
/// will be generated)
///
/// # Returns
///
/// Listener handle
pub fn NT_AddPolledListenerSingle(
poller: NT_ListenerPoller,
prefix: *const WPI_String,
mask: u32,
) -> NT_Listener;
/// Creates a polled topic listener. This creates a corresponding internal
/// subscriber with the lifetime of the listener.
/// The caller is responsible for calling NT_ReadListenerQueue() to poll.
///
/// # Parameters
///
/// - `poller`: Poller handle.
/// - `prefixes`: Array of UTF-8 string prefixes.
/// - `prefixes_len`: Length of prefixes array.
/// - `mask`: NT_EventFlags bitmask (only topic and value events will be generated).
///
/// # Returns
///
/// Listener handle.
pub fn NT_AddPolledListenerMultiple(
poller: NT_ListenerPoller,
prefixes: *const WPI_String,
prefixes_len: usize,
mask: u32,
) -> NT_Listener;
/// Creates a polled listener.
/// The caller is responsible for calling NT_ReadListenerQueue() to poll.
///
/// Some combinations of handle and mask have no effect:
///
/// - connection and log message events are only generated on instances
/// - topic and value events are only generated on non-instances
///
/// Adding value and topic events on a topic will create a corresponding internal
/// subscriber with the lifetime of the listener.
///
/// Adding a log message listener through this function will only result in
/// events at NT_LOG_INFO or higher; for more customized settings, use
/// NT_AddPolledLogger.
///
/// # Parameters
///
/// - `poller`: Poller handle.
/// - `handle`: Handle.
/// - `mask`: NT_NotifyKind bitmask.
///
/// # Returns
///
/// Listener handle.
pub fn NT_AddPolledListener(
poller: NT_ListenerPoller,
handle: NT_Handle,
mask: u32,
) -> NT_Listener;
/// Starts local-only operation. Prevents calls to NT_StartServer or
/// NT_StartClient from taking effect. Has no effect if NT_StartServer or
/// NT_StartClient has already been called.
///
/// # Parameters
///
/// - `inst`: Instance handle.
pub fn NT_StartLocal(inst: NT_Inst);
/// Stops local-only operation. NT_StartServer or NT_StartClient can be called
/// after this call to start a server or client.
///
/// # Parameters
///
/// - `inst`: Instance handle.
pub fn NT_StopLocal(inst: NT_Inst);
/// Starts a server using the specified filename, listening address, and port.
///
/// # Parameters
///
/// - `inst`: Instance handle.
/// - `persist_filename`: The name of the persist file to use (UTF-8 string, null-terminated).
/// - `listen_address`: The address to listen on, or null to listen on any address (UTF-8 string, null-terminated).
/// - `port3`: Port to communicate over (NT3).
/// - `port4`: Port to communicate over (NT4).
pub fn NT_StartServer(
inst: NT_Inst,
persist_filename: *const WPI_String,
listen_address: *const WPI_String,
port3: u32,
port4: u32,
);
/// Stops the server if it is running.
///
/// # Parameters
///
/// inst: instance handle
pub fn NT_StopServer(inst: NT_Inst);
/// Starts a NT3 client. Use NT_SetServer or NT_SetServerTeam to set the server
/// name and port.
///
/// # Parameters
///
/// - `inst`: Instance handle.
/// - `identity`: Network identity to advertise (cannot be empty string).
pub fn NT_StartClient3(inst: NT_Inst, identity: *const WPI_String);
/// Starts a NT4 client. Use NT_SetServer or NT_SetServerTeam to set the server
/// name and port.
///
/// # Parameters
///
/// - `inst`: Instance handle.
/// - `identity`: Network identity to advertise (cannot be empty string).
pub fn NT_StartClient4(inst: NT_Inst, identity: *const WPI_String);
/// Stops the client if it is running.
///
/// # Parameters
///
/// - inst: instance handle
pub fn NT_StopClient(inst: NT_Inst);
/// Sets server address and port for client (without restarting client).
///
/// # Parameters
///
/// - `inst`: Instance handle.
/// - `server_name`: Server name (UTF-8 string, null-terminated).
/// - `port`: Port to communicate over.
pub fn NT_SetServer(inst: NT_Inst, server_name: *const WPI_String, port: u32);
/// Sets server addresses for client (without restarting client).
/// The client will attempt to connect to each server in round-robin fashion.
///
/// # Parameters
///
/// - `inst`: Instance handle.
/// - `count`: Length of the `server_names` and `ports` arrays.
/// - `server_names`: Array of server names (each a UTF-8 string, null-terminated).
/// - `ports`: Array of ports to communicate over (one for each server).
pub fn NT_SetServerMulti(
inst: NT_Inst,
count: usize,
server_names: *const WPI_String,
ports: *const u32,
);
/// Sets server addresses and port for client (without restarting client).
/// Connects using commonly known robot addresses for the specified team.
///
/// # Parameters
///
/// - `inst`: Instance handle.
/// - `team`: Team number.
/// - `port`: Port to communicate over.
pub fn NT_SetServerTeam(inst: NT_Inst, team: u32, port: u32);
/// Disconnects the client if it's running and connected. This will automatically
/// start reconnection attempts to the current server list.
///
/// # Parameters
///
/// - inst: instance handle
pub fn NT_Disconnect(inst: NT_Inst);
/// Starts requesting server address from Driver Station.
/// This connects to the Driver Station running on localhost to obtain the
/// server IP address.
///
/// # Parameters
///
/// - `inst`: Instance handle.
/// - `port`: Server port to use in combination with IP from DS.
pub fn NT_StartDSClient(inst: NT_Inst, port: u32);
/// Stops requesting server address from Driver Station.
///
/// # Parameters
///
/// - inst: instance handle
pub fn NT_StopDSClient(inst: NT_Inst);
/// Flush local updates.
///
/// Forces an immediate flush of all local changes to the client/server.
/// This does not flush to the network.
///
/// Normally this is done on a regularly scheduled interval.
///
/// # Parameters
///
/// - inst: instance handle
pub fn NT_FlushLocal(inst: NT_Inst);
/// Flush to network.
///
/// Forces an immediate flush of all local entry changes to network.
/// Normally this is done on a regularly scheduled interval (set
/// by update rates on individual publishers).
///
/// Note: flushes are rate limited to avoid excessive network traffic. If
/// the time between calls is too short, the flush will occur after the minimum
/// time elapses (rather than immediately).
///
/// # Parameters
///
/// - inst: instance handle
pub fn NT_Flush(inst: NT_Inst);
/// Get information on the currently established network connections.
/// If operating as a client, this will return either zero or one values.
///
/// # Parameters
///
/// - `inst`: Instance handle.
/// - `count`: Returns the number of elements in the array.
///
/// # Returns
///
/// Array of connection information.
///
/// It is the caller's responsibility to free the array. The
/// `NT_DisposeConnectionInfoArray` function is useful for this purpose.
pub fn NT_GetConnections(inst: NT_Inst, count: *mut usize) -> *mut NT_ConnectionInfo;
/// Return whether or not the instance is connected to another node.
///
/// # Parameters
///
/// - `inst`: instance handle
///
/// # Returns
///
/// True if connected.
pub fn NT_IsConnected(inst: NT_Inst) -> NT_Bool;
/// Get the time offset between server time and local time. Add this value to
/// local time to get the estimated equivalent server time. In server mode, this
/// always returns a valid value of 0. In client mode, this returns the time
/// offset only if the client and server are connected and have exchanged
/// synchronization messages. Note the time offset may change over time as it is
/// periodically updated; to receive updates as events, add a listener to the
/// "time sync" event.
///
/// # Parameters
///
/// - `inst`: Instance handle.
/// - `valid`: Set to true if the return value is valid, false otherwise (output).
///
/// # Returns
/// Time offset in microseconds (if valid is set to true).
pub fn NT_GetServerTimeOffset(inst: NT_Inst, valid: *mut NT_Bool) -> i64;
/// Frees value memory.
///
/// # Parameters
///
/// - `value`: Value to free.
pub fn NT_DisposeValue(value: *mut NT_Value);
/// Initializes an NT_Value.
/// Sets type to NT_UNASSIGNED and clears the rest of the struct.
///
/// # Parameters
///
/// - `value`: Value to initialize.
pub fn NT_InitValue(value: *mut NT_Value);
/// Frees an array of NT_Values.
///
/// # Parameters
///
/// - `arr`: Pointer to the value array to free.
/// - `count`: Number of elements in the array.
///
/// Note that the individual NT_Values in the array should NOT be
/// freed before calling this. This function will free all the values
/// individually.
pub fn NT_DisposeValueArray(arr: *mut NT_Value, count: usize);
/// Disposes a connection info array.
///
/// # Parameters
///
/// - `arr`: Pointer to the array to dispose.
/// - `count`: Number of elements in the array.
pub fn NT_DisposeConnectionInfoArray(arr: *mut NT_ConnectionInfo, count: usize);
/// Disposes a topic info array.
///
/// # Parameters
///
/// - `arr`: Pointer to the array to dispose.
/// - `count`: Number of elements in the array.
pub fn NT_DisposeTopicInfoArray(arr: *mut NT_TopicInfo, count: usize);
/// Disposes a single topic info (as returned by NT_GetTopicInfo).
///
/// # Parameters
///
/// - `info`: Pointer to the info to dispose.
pub fn NT_DisposeTopicInfo(info: *mut NT_TopicInfo);
/// Disposes an event array.
///
/// # Parameters
///
/// - `arr`: Pointer to the array to dispose.
/// - `count`: Number of elements in the array.
pub fn NT_DisposeEventArray(arr: *mut NT_Event, count: usize);
/// Disposes a single event.
///
/// # Parameters
///
/// - `event`: Pointer to the event to dispose.
pub fn NT_DisposeEvent(event: *mut NT_Event);
/// Returns monotonic current time in 1 us increments.
/// This is the same time base used for entry and connection timestamps.
/// This function by default simply wraps WPI_Now(), but if NT_SetNow() is
/// called, this function instead returns the value passed to NT_SetNow();
/// this can be used to reduce overhead.
///
/// # Returns
///
/// Timestamp
pub fn NT_Now() -> i64;
/// Sets the current timestamp used for timestamping values that do not
/// provide a timestamp (e.g. a value of 0 is passed). For consistency,
/// it also results in NT_Now() returning the set value. This should generally
/// be used only if the overhead of calling WPI_Now() is a concern.
/// If used, it should be called periodically with the value of WPI_Now().
///
/// # Parameters
///
/// - timestamp: timestamp (1 us increments)
pub fn NT_SetNow(timestamp: i64);
/// Starts logging entry changes to a DataLog.
///
/// # Parameters
///
/// - `inst`: Instance handle.
/// - `log`: Data log object; lifetime must extend until `StopEntryDataLog` is
/// called or the instance is destroyed.
/// - `prefix`: Only store entries with names that start with this prefix;
/// the prefix is not included in the data log entry name.
/// - `logPrefix`: Prefix to add to data log entry names.
///
/// # Returns
///
/// Data logger handle.
pub fn NT_StartEntryDataLog(
inst: NT_Inst,
log: *mut WPI_DataLog,
prefix: *const WPI_String,
logPrefix: *const WPI_String,
) -> NT_DataLogger;
/// Stops logging entry changes to a DataLog.
///
/// # Parameters
///
/// - logger: data logger handle
pub fn NT_StopEntryDataLog(logger: NT_DataLogger);
/// Starts logging connection changes to a DataLog.
///
/// # Parameters
///
/// - `inst`: Instance handle.
/// - `log`: Data log object; lifetime must extend until `StopConnectionDataLog`
/// is called or the instance is destroyed.
/// - `name`: Data log entry name.
///
/// # Returns
///
/// Data logger handle.
pub fn NT_StartConnectionDataLog(
inst: NT_Inst,
log: *mut WPI_DataLog,
name: *const WPI_String,
) -> NT_ConnectionDataLogger;
/// Stops logging connection changes to a DataLog.
///
/// # Parameters
///
/// - logger: data logger handle
pub fn NT_StopConnectionDataLog(logger: NT_ConnectionDataLogger);
/// Add logger callback function. By default, log messages are sent to stderr;
/// this function sends log messages to the provided callback function instead.
/// The callback function will only be called for log messages with level
/// greater than or equal to `min_level` and less than or equal to `max_level`;
/// messages outside this range will be silently ignored.
///
/// # Parameters
///
/// - `inst`: Instance handle.
/// - `min_level`: Minimum log level.
/// - `max_level`: Maximum log level.
/// - `data`: Data pointer to pass to `func`.
/// - `func`: Listener callback function.
///
/// # Returns
///
/// Listener handle.
pub fn NT_AddLogger(
inst: NT_Inst,
min_level: u32,
max_level: u32,
data: *mut std::ffi::c_void,
func: NT_ListenerCallback,
) -> NT_Listener;
/// Set the log level for a listener poller. Events will only be generated for
/// log messages with level greater than or equal to `min_level` and less than or
/// equal to `max_level`; messages outside this range will be silently ignored.
///
/// # Parameters
///
/// - `poller`: Poller handle.
/// - `min_level`: Minimum log level.
/// - `max_level`: Maximum log level.
///
/// # Returns
///
/// Listener handle.
pub fn NT_AddPolledLogger(
poller: NT_ListenerPoller,
min_level: u32,
max_level: u32,
) -> NT_Listener;
/// Returns whether there is a data schema already registered with the given
/// name. This does NOT perform a check as to whether the schema has already
/// been published by another node on the network.
///
/// # Parameters
///
/// - `inst`: Instance handle.
/// - `name`: Name (the string passed as the data type for topics using this schema).
///
/// # Returns
///
/// True if schema already registered.
pub fn NT_HasSchema(inst: NT_Inst, name: *const WPI_String) -> NT_Bool;
/// Registers a data schema. Data schemas provide information for how a
/// certain data type string can be decoded. The type string of a data schema
/// indicates the type of the schema itself (e.g. "protobuf" for protobuf
/// schemas, "struct" for struct schemas, etc). In NetworkTables, schemas are
/// published just like normal topics, with the name being generated from the
/// provided name: "/.schema/<name>". Duplicate calls to this function with
/// the same name are silently ignored.
///
/// # Parameters
///
/// - `inst`: Instance handle.
/// - `name`: Name (the string passed as the data type for topics using this schema).
/// - `type`: Type of schema (e.g. "protobuf", "struct", etc).
/// - `schema`: Schema data.
/// - `schema_size`: Size of schema data.
pub fn NT_AddSchema(
inst: NT_Inst,
name: *const WPI_String,
type_: *const WPI_String,
schema: *const u8,
schema_size: usize,
);
/// Allocates an array of chars.
/// Note that the size is the number of elements, and not the
/// specific number of bytes to allocate. That is calculated internally.
///
/// # Parameters
///
/// - `size`: The number of elements the array will contain.
///
/// # Returns
/// The allocated char array.
///
/// After use, the array should be freed using the `NT_FreeCharArray()` function.
pub fn NT_AllocateCharArray(size: usize) -> *mut std::ffi::c_char;
/// Allocates an array of booleans.
/// Note that the size is the number of elements, and not the
/// specific number of bytes to allocate. That is calculated internally.
///
/// # Parameters
///
/// - `size`: The number of elements the array will contain.
///
/// # Returns
/// The allocated boolean array.
///
/// After use, the array should be freed using the `NT_FreeBooleanArray()` function.
pub fn NT_AllocateBooleanArray(size: usize) -> *mut bool;
/// Allocates an array of integers.
/// Note that the size is the number of elements, and not the
/// specific number of bytes to allocate. That is calculated internally.
///
/// # Parameters
///
/// - `size`: The number of elements the array will contain.
///
/// # Returns
/// The allocated integer array.
///
/// After use, the array should be freed using the `NT_FreeIntegerArray()` function.
pub fn NT_AllocateIntegerArray(size: usize) -> *mut i64;
/// Allocates an array of floats.
/// Note that the size is the number of elements, and not the
/// specific number of bytes to allocate. That is calculated internally.
///
/// # Parameters
///
/// - `size`: The number of elements the array will contain.
///
/// # Returns
/// The allocated float array.
///
/// After use, the array should be freed using the `NT_FreeFloatArray()` function.
pub fn NT_AllocateFloatArray(size: usize) -> *mut f32;
/// Allocates an array of doubles.
/// Note that the size is the number of elements, and not the
/// specific number of bytes to allocate. That is calculated internally.
///
/// # Parameters
///
/// - `size`: The number of elements the array will contain.
///
/// # Returns
///
/// The allocated double array.
///
/// After use, the array should be freed using the `NT_FreeDoubleArray()` function.
pub fn NT_AllocateDoubleArray(size: usize) -> *mut f64;
/// Frees an array of chars.
///
/// # Parameters
///
/// - `v_char`: Pointer to the char array to free.
pub fn NT_FreeCharArray(v_char: *mut std::ffi::c_char);
/// Frees an array of booleans.
///
/// # Parameters
///
/// - `v_boolean`: Pointer to the boolean array to free.
pub fn NT_FreeBooleanArray(v_boolean: *mut bool);
/// Frees an array of integers.
///
/// # Parameters
///
/// - `v_int`: Pointer to the integer array to free.
pub fn NT_FreeIntegerArray(v_int: *mut i64);
/// Frees an array of floats.
///
/// # Parameters
///
/// - `v_float`: Pointer to the float array to free.
pub fn NT_FreeFloatArray(v_float: *mut f32);
/// Frees an array of doubles.
///
/// # Parameters
///
/// - `v_double`: Pointer to the double array to free.
pub fn NT_FreeDoubleArray(v_double: *mut f64);
/// Returns the type of an NT_Value struct.
/// Note that one of the type options is "unassigned".
///
/// # Parameters
///
/// - `value`: The NT_Value struct to get the type from.
///
/// # Returns
///
/// The type of the value, or unassigned if null.
pub fn NT_GetValueType(value: *const NT_Value) -> NT_Type;
/// Returns the boolean from the NT_Value.
/// If the NT_Value is null, or is assigned to a different type, returns 0.
///
/// # Parameters
///
/// - `value`: NT_Value struct to get the boolean from.
/// - `last_change`: Returns time in ms since the last change in the value.
/// - `v_boolean`: Returns the boolean assigned to the name.
///
/// # Returns
///
/// 1 if successful, or 0 if value is null or not a boolean.
pub fn NT_GetValueBoolean(
value: *const NT_Value,
last_change: *mut u64,
v_boolean: *mut bool,
) -> NT_Bool;
/// Returns the int from the NT_Value.
/// If the NT_Value is null, or is assigned to a different type, returns 0.
///
/// # Parameters
///
/// - `value`: NT_Value struct to get the int from.
/// - `last_change`: Returns time in ms since the last change in the value.
/// - `v_int`: Returns the int assigned to the name.
///
/// # Returns
///
/// 1 if successful, or 0 if value is null or not an int.
pub fn NT_GetValueInteger(
value: *const NT_Value,
last_change: *mut u64,
v_int: *mut i64,
) -> NT_Bool;
/// Returns the float from the NT_Value.
/// If the NT_Value is null, or is assigned to a different type, returns 0.
///
/// # Parameters
///
/// - `value`: NT_Value struct to get the float from.
/// - `last_change`: Returns time in ms since the last change in the value.
/// - `v_float`: Returns the float assigned to the name.
///
/// # Returns
///
/// 1 if successful, or 0 if value is null or not a float.
pub fn NT_GetValueFloat(
value: *const NT_Value,
last_change: *mut u64,
v_float: *mut f32,
) -> NT_Bool;
/// Returns the double from the NT_Value.
/// If the NT_Value is null, or is assigned to a different type, returns 0.
///
/// # Parameters
///
/// - `value`: NT_Value struct to get the double from.
/// - `last_change`: Returns time in ms since the last change in the value.
/// - `v_double`: Returns the double assigned to the name.
///
/// # Returns
///
/// 1 if successful, or 0 if value is null or not a double.
pub fn NT_GetValueDouble(
value: *const NT_Value,
last_change: *mut u64,
v_double: *mut f64,
) -> NT_Bool;
/// Returns a copy of the string from the NT_Value.
/// If the NT_Value is null, or is assigned to a different type, returns 0.
///
/// # Parameters
///
/// - `value`: NT_Value struct to get the string from.
/// - `last_change`: Returns time in ms since the last change in the value.
/// - `str_len`: Returns the length of the string.
///
/// # Returns
///
/// Pointer to the string (UTF-8), or null if error.
///
/// It is the caller's responsibility to free the string once it's no longer
/// needed. The `NT_FreeCharArray()` function is useful for this purpose. The
/// returned string is a copy of the string in the value, and must be freed
/// separately.
pub fn NT_GetValueString(
value: *const NT_Value,
last_change: *mut u64,
str_len: *mut usize,
) -> *mut std::ffi::c_char;
/// Returns a copy of the raw value from the NT_Value.
/// If the NT_Value is null, or is assigned to a different type, returns null.
///
/// # Parameters
///
/// - `value`: NT_Value struct to get the string from.
/// - `last_change`: Returns time in ms since the last change in the value.
/// - `raw_len`: Returns the length of the string.
///
/// # Returns
/// Pointer to the raw value (UTF-8), or null if error.
///
/// It is the caller's responsibility to free the raw value once it's no longer
/// needed. The `NT_FreeCharArray()` function is useful for this purpose. The
/// returned string is a copy of the string in the value, and must be freed
/// separately.
pub fn NT_GetValueRaw(
value: *const NT_Value,
last_change: *mut u64,
raw_len: *mut usize,
) -> *mut u8;
/// Returns a copy of the boolean array from the NT_Value.
/// If the NT_Value is null, or is assigned to a different type, returns null.
///
/// # Parameters
///
/// - `value`: NT_Value struct to get the boolean array from.
/// - `last_change`: Returns time in ms since the last change in the value.
/// - `arr_size`: Returns the number of elements in the array.
///
/// # Returns
/// Pointer to the boolean array, or null if error.
///
/// It is the caller's responsibility to free the array once it's no longer
/// needed. The `NT_FreeBooleanArray()` function is useful for this purpose.
/// The returned array is a copy of the array in the value, and must be
/// freed separately.
pub fn NT_GetValueBooleanArray(
value: *const NT_Value,
last_change: *mut u64,
arr_size: *mut usize,
) -> *mut bool;
/// Returns a copy of the int array from the NT_Value.
/// If the NT_Value is null, or is assigned to a different type, returns null.
///
/// # Parameters
///
/// - `value`: NT_Value struct to get the int array from.
/// - `last_change`: Returns time in ms since the last change in the value.
/// - `arr_size`: Returns the number of elements in the array.
///
/// # Returns
/// Pointer to the int array, or null if error.
///
/// It is the caller's responsibility to free the array once it's no longer
/// needed. The `NT_FreeIntegerArray()` function is useful for this purpose.
/// The returned array is a copy of the array in the value, and must be
/// freed separately.
pub fn NT_GetValueIntegerArray(
value: *const NT_Value,
last_change: *mut u64,
arr_size: *mut usize,
) -> *mut i64;
/// Returns a copy of the float array from the NT_Value.
/// If the NT_Value is null, or is assigned to a different type, returns null.
///
/// # Parameters
///
/// - `value`: NT_Value struct to get the float array from.
/// - `last_change`: Returns time in ms since the last change in the value.
/// - `arr_size`: Returns the number of elements in the array.
///
/// # Returns
/// Pointer to the float array, or null if error.
///
/// It is the caller's responsibility to free the array once it's no longer
/// needed. The `NT_FreeFloatArray()` function is useful for this purpose.
/// The returned array is a copy of the array in the value, and must be
/// freed separately.
pub fn NT_GetValueFloatArray(
value: *const NT_Value,
last_change: *mut u64,
arr_size: *mut usize,
) -> *mut f32;
/// Returns a copy of the double array from the NT_Value.
/// If the NT_Value is null, or is assigned to a different type, returns null.
///
/// # Parameters
///
/// - `value`: NT_Value struct to get the double array from.
/// - `last_change`: Returns time in ms since the last change in the value.
/// - `arr_size`: Returns the number of elements in the array.
///
/// # Returns
/// Pointer to the double array, or null if error.
///
/// It is the caller's responsibility to free the array once it's no longer
/// needed. The `NT_FreeDoubleArray()` function is useful for this purpose.
/// The returned array is a copy of the array in the value, and must be
/// freed separately.
pub fn NT_GetValueDoubleArray(
value: *const NT_Value,
last_change: *mut u64,
arr_size: *mut usize,
) -> *mut f64;
/// Returns a copy of the struct WPI_String array from the NT_Value.
/// If the NT_Value is null, or is assigned to a different type, returns null.
///
/// # Parameters
///
/// - `value`: NT_Value struct to get the struct WPI_String array from.
/// - `last_change`: Returns time in ms since the last change in the value.
/// - `arr_size`: Returns the number of elements in the array.
///
/// # Returns
/// Pointer to the struct WPI_String array, or null if error.
///
/// It is the caller's responsibility to free the array once it's no longer
/// needed. The `WPI_FreeStringArray()` function is useful for this purpose.
/// The returned array is a copy of the array in the value, and must be
/// freed separately. Note that the individual struct WPI_Strings should not be
/// freed, but the entire array should be freed at once. The
/// `WPI_FreeStringArray()` function will free all the struct WPI_Strings.
pub fn NT_GetValueStringArray(
value: *const NT_Value,
last_change: *mut u64,
arr_size: *mut usize,
) -> *mut WPI_String;
/// Publish a new value.
///
/// # Parameters
///
/// - `pubentry`: publisher or entry handle
/// - `time`: timestamp; 0 indicates current NT time should be used
/// - `value`: value to publish
pub fn NT_SetBoolean(pubentry: NT_Handle, time: i64, value: NT_Bool) -> NT_Bool;
/// Publish a default value.
/// On reconnect, a default value will never be used in preference to a
/// published value.
///
/// # Parameters
///
/// - `pubentry`: publisher or entry handle
/// - `defaultValue`: default value
pub fn NT_SetDefaultBoolean(pubentry: NT_Handle, defaultValue: NT_Bool) -> NT_Bool;
/// Get the last published value.
/// If no value has been published, returns the passed defaultValue.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `defaultValue`: default value to return if no value has been published
///
/// # Returns
///
/// value
pub fn NT_GetBoolean(subentry: NT_Handle, defaultValue: NT_Bool) -> NT_Bool;
/// Get the last published value along with its timestamp.
/// If no value has been published, returns the passed defaultValue and a
/// timestamp of 0.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `defaultValue`: default value to return if no value has been published
/// - `value`: timestamped value (output)
pub fn NT_GetAtomicBoolean(
subentry: NT_Handle,
defaultValue: NT_Bool,
value: *mut NT_TimestampedBoolean,
);
/// Disposes a timestamped value (as returned by NT_GetAtomicBoolean).
///
/// # Parameters
///
/// - `value`: timestamped value
pub fn NT_DisposeTimestampedBoolean(value: *mut NT_TimestampedBoolean);
/// Get an array of all value changes since the last call to ReadQueue.
/// Also provides a timestamp for each value.
///
/// # Note
///
/// The \"poll storage\" subscribe option can be used to set the queue
/// depth.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `len`: length of returned array (output)
///
/// # Returns
///
/// Array of timestamped values; NULL if no new changes have
/// been published since the previous call.
pub fn NT_ReadQueueBoolean(subentry: NT_Handle, len: *mut usize) -> *mut NT_TimestampedBoolean;
/// Frees a timestamped array of values (as returned by NT_ReadQueueBoolean).
///
/// # Parameters
///
/// - `arr`: array
/// - `len`: length of array
pub fn NT_FreeQueueBoolean(arr: *mut NT_TimestampedBoolean, len: usize);
/// Get an array of all value changes since the last call to ReadQueue.
///
/// # Note
///
/// The \"poll storage\" subscribe option can be used to set the queue
/// depth.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `len`: length of returned array (output)
///
/// # Returns
///
/// Array of values; NULL if no new changes have
/// been published since the previous call.
pub fn NT_ReadQueueValuesBoolean(subentry: NT_Handle, len: *mut usize) -> *mut NT_Bool;
/// Publish a new value.
///
/// # Parameters
///
/// - `pubentry`: publisher or entry handle
/// - `time`: timestamp; 0 indicates current NT time should be used
/// - `value`: value to publish
pub fn NT_SetInteger(pubentry: NT_Handle, time: i64, value: i64) -> NT_Bool;
/// Publish a default value.
/// On reconnect, a default value will never be used in preference to a
/// published value.
///
/// # Parameters
///
/// - `pubentry`: publisher or entry handle
/// - `defaultValue`: default value
pub fn NT_SetDefaultInteger(pubentry: NT_Handle, defaultValue: i64) -> NT_Bool;
/// Get the last published value.
/// If no value has been published, returns the passed defaultValue.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `defaultValue`: default value to return if no value has been published
///
/// # Returns
///
/// value
pub fn NT_GetInteger(subentry: NT_Handle, defaultValue: i64) -> i64;
/// Get the last published value along with its timestamp.
/// If no value has been published, returns the passed defaultValue and a
/// timestamp of 0.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `defaultValue`: default value to return if no value has been published
/// - `value`: timestamped value (output)
pub fn NT_GetAtomicInteger(
subentry: NT_Handle,
defaultValue: i64,
value: *mut NT_TimestampedInteger,
);
/// Disposes a timestamped value (as returned by NT_GetAtomicInteger).
///
/// # Parameters
///
/// - `value`: timestamped value
pub fn NT_DisposeTimestampedInteger(value: *mut NT_TimestampedInteger);
/// Get an array of all value changes since the last call to ReadQueue.
/// Also provides a timestamp for each value.
///
/// # Note
///
/// The \"poll storage\" subscribe option can be used to set the queue
/// depth.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `len`: length of returned array (output)
///
/// # Returns
///
/// Array of timestamped values; NULL if no new changes have
/// been published since the previous call.
pub fn NT_ReadQueueInteger(subentry: NT_Handle, len: *mut usize) -> *mut NT_TimestampedInteger;
/// Frees a timestamped array of values (as returned by NT_ReadQueueInteger).
///
/// # Parameters
///
/// - `arr`: array
/// - `len`: length of array
pub fn NT_FreeQueueInteger(arr: *mut NT_TimestampedInteger, len: usize);
/// Get an array of all value changes since the last call to ReadQueue.
///
/// # Note
///
/// The \"poll storage\" subscribe option can be used to set the queue
/// depth.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `len`: length of returned array (output)
///
/// # Returns
///
/// Array of values; NULL if no new changes have
/// been published since the previous call.
pub fn NT_ReadQueueValuesInteger(subentry: NT_Handle, len: *mut usize) -> *mut i64;
/// Publish a new value.
///
/// # Parameters
///
/// - `pubentry`: publisher or entry handle
/// - `time`: timestamp; 0 indicates current NT time should be used
/// - `value`: value to publish
pub fn NT_SetFloat(pubentry: NT_Handle, time: i64, value: f32) -> NT_Bool;
/// Publish a default value.
/// On reconnect, a default value will never be used in preference to a
/// published value.
///
/// # Parameters
///
/// - `pubentry`: publisher or entry handle
/// - `defaultValue`: default value
pub fn NT_SetDefaultFloat(pubentry: NT_Handle, defaultValue: f32) -> NT_Bool;
/// Get the last published value.
/// If no value has been published, returns the passed defaultValue.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `defaultValue`: default value to return if no value has been published
///
/// # Returns
///
/// value
pub fn NT_GetFloat(subentry: NT_Handle, defaultValue: f32) -> f32;
/// Get the last published value along with its timestamp.
/// If no value has been published, returns the passed defaultValue and a
/// timestamp of 0.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `defaultValue`: default value to return if no value has been published
/// - `value`: timestamped value (output)
pub fn NT_GetAtomicFloat(
subentry: NT_Handle,
defaultValue: f32,
value: *mut NT_TimestampedFloat,
);
/// Disposes a timestamped value (as returned by NT_GetAtomicFloat).
///
/// # Parameters
///
/// - `value`: timestamped value
pub fn NT_DisposeTimestampedFloat(value: *mut NT_TimestampedFloat);
/// Get an array of all value changes since the last call to ReadQueue.
/// Also provides a timestamp for each value.
///
/// # Note
///
/// The \"poll storage\" subscribe option can be used to set the queue
/// depth.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `len`: length of returned array (output)
///
/// # Returns
///
/// Array of timestamped values; NULL if no new changes have
/// been published since the previous call.
pub fn NT_ReadQueueFloat(subentry: NT_Handle, len: *mut usize) -> *mut NT_TimestampedFloat;
/// Frees a timestamped array of values (as returned by NT_ReadQueueFloat).
///
/// # Parameters
///
/// - `arr`: array
/// - `len`: length of array
pub fn NT_FreeQueueFloat(arr: *mut NT_TimestampedFloat, len: usize);
/// Get an array of all value changes since the last call to ReadQueue.
///
/// # Note
///
/// The \"poll storage\" subscribe option can be used to set the queue
/// depth.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `len`: length of returned array (output)
///
/// # Returns
///
/// Array of values; NULL if no new changes have
/// been published since the previous call.
pub fn NT_ReadQueueValuesFloat(subentry: NT_Handle, len: *mut usize) -> *mut f32;
/// Publish a new value.
///
/// # Parameters
///
/// - `pubentry`: publisher or entry handle
/// - `time`: timestamp; 0 indicates current NT time should be used
/// - `value`: value to publish
pub fn NT_SetDouble(pubentry: NT_Handle, time: i64, value: f64) -> NT_Bool;
/// Publish a default value.
/// On reconnect, a default value will never be used in preference to a
/// published value.
///
/// # Parameters
///
/// - `pubentry`: publisher or entry handle
/// - `defaultValue`: default value
pub fn NT_SetDefaultDouble(pubentry: NT_Handle, defaultValue: f64) -> NT_Bool;
/// Get the last published value.
/// If no value has been published, returns the passed defaultValue.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `defaultValue`: default value to return if no value has been published
///
/// # Returns
///
/// value
pub fn NT_GetDouble(subentry: NT_Handle, defaultValue: f64) -> f64;
/// Get the last published value along with its timestamp.
/// If no value has been published, returns the passed defaultValue and a
/// timestamp of 0.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `defaultValue`: default value to return if no value has been published
/// - `value`: timestamped value (output)
pub fn NT_GetAtomicDouble(
subentry: NT_Handle,
defaultValue: f64,
value: *mut NT_TimestampedDouble,
);
/// Disposes a timestamped value (as returned by NT_GetAtomicDouble).
///
/// # Parameters
///
/// - `value`: timestamped value
pub fn NT_DisposeTimestampedDouble(value: *mut NT_TimestampedDouble);
/// Get an array of all value changes since the last call to ReadQueue.
/// Also provides a timestamp for each value.
///
/// # Note
///
/// The \"poll storage\" subscribe option can be used to set the queue
/// depth.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `len`: length of returned array (output)
///
/// # Returns
///
/// Array of timestamped values; NULL if no new changes have
/// been published since the previous call.
pub fn NT_ReadQueueDouble(subentry: NT_Handle, len: *mut usize) -> *mut NT_TimestampedDouble;
/// Frees a timestamped array of values (as returned by NT_ReadQueueDouble).
///
/// # Parameters
///
/// - `arr`: array
/// - `len`: length of array
pub fn NT_FreeQueueDouble(arr: *mut NT_TimestampedDouble, len: usize);
/// Get an array of all value changes since the last call to ReadQueue.
///
/// # Note
///
/// The \"poll storage\" subscribe option can be used to set the queue
/// depth.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `len`: length of returned array (output)
///
/// # Returns
///
/// Array of values; NULL if no new changes have
/// been published since the previous call.
pub fn NT_ReadQueueValuesDouble(subentry: NT_Handle, len: *mut usize) -> *mut f64;
/// Publish a new value.
///
/// # Parameters
///
/// - `pubentry`: publisher or entry handle
/// - `time`: timestamp; 0 indicates current NT time should be used
/// - `value`: value to publish
pub fn NT_SetString(pubentry: NT_Handle, time: i64, value: *const WPI_String) -> NT_Bool;
/// Publish a default value.
/// On reconnect, a default value will never be used in preference to a
/// published value.
///
/// # Parameters
///
/// - `pubentry`: publisher or entry handle
/// - `defaultValue`: default value
pub fn NT_SetDefaultString(pubentry: NT_Handle, defaultValue: *const WPI_String) -> NT_Bool;
/// Get the last published value.
/// If no value has been published, returns the passed defaultValue.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `defaultValue`: default value to return if no value has been published
/// - `value`: returned value (output)
///
pub fn NT_GetString(
subentry: NT_Handle,
defaultValue: *const WPI_String,
value: *mut WPI_String,
);
/// Get the last published value along with its timestamp.
/// If no value has been published, returns the passed defaultValue and a
/// timestamp of 0.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `defaultValue`: default value to return if no value has been published
/// - `value`: timestamped value (output)
pub fn NT_GetAtomicString(
subentry: NT_Handle,
defaultValue: *const WPI_String,
value: *mut NT_TimestampedString,
);
/// Disposes a timestamped value (as returned by NT_GetAtomicString).
///
/// # Parameters
///
/// - `value`: timestamped value
pub fn NT_DisposeTimestampedString(value: *mut NT_TimestampedString);
/// Get an array of all value changes since the last call to ReadQueue.
/// Also provides a timestamp for each value.
///
/// # Note
///
/// The \"poll storage\" subscribe option can be used to set the queue
/// depth.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `len`: length of returned array (output)
///
/// # Returns
///
/// Array of timestamped values; NULL if no new changes have
/// been published since the previous call.
pub fn NT_ReadQueueString(subentry: NT_Handle, len: *mut usize) -> *mut NT_TimestampedString;
/// Frees a timestamped array of values (as returned by NT_ReadQueueString).
///
/// # Parameters
///
/// - `arr`: array
/// - `len`: length of array
pub fn NT_FreeQueueString(arr: *mut NT_TimestampedString, len: usize);
/// Publish a new value.
///
/// # Parameters
///
/// - `pubentry`: publisher or entry handle
/// - `time`: timestamp; 0 indicates current NT time should be used
/// - `value`: value to publish
/// - `len`: length of value
///
pub fn NT_SetRaw(pubentry: NT_Handle, time: i64, value: *const u8, len: usize) -> NT_Bool;
/// Publish a default value.
/// On reconnect, a default value will never be used in preference to a
/// published value.
///
/// # Parameters
///
/// - `pubentry`: publisher or entry handle
/// - `defaultValue`: default value
/// - `defaultValueLen`: length of default value
///
pub fn NT_SetDefaultRaw(
pubentry: NT_Handle,
defaultValue: *const u8,
defaultValueLen: usize,
) -> NT_Bool;
/// Get the last published value.
/// If no value has been published, returns the passed defaultValue.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `defaultValue`: default value to return if no value has been published
/// - `defaultValueLen`: length of default value
/// - `len`: length of returned value (output)
///
///
/// # Returns
///
/// value
pub fn NT_GetRaw(
subentry: NT_Handle,
defaultValue: *const u8,
defaultValueLen: usize,
len: *mut usize,
) -> *mut u8;
/// Get the last published value along with its timestamp.
/// If no value has been published, returns the passed defaultValue and a
/// timestamp of 0.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `defaultValue`: default value to return if no value has been published
/// - `defaultValueLen`: length of default value
///
/// # Parameters
///
/// - `value`: timestamped value (output)
pub fn NT_GetAtomicRaw(
subentry: NT_Handle,
defaultValue: *const u8,
defaultValueLen: usize,
value: *mut NT_TimestampedRaw,
);
/// Disposes a timestamped value (as returned by NT_GetAtomicRaw).
///
/// # Parameters
///
/// - `value`: timestamped value
pub fn NT_DisposeTimestampedRaw(value: *mut NT_TimestampedRaw);
/// Get an array of all value changes since the last call to ReadQueue.
/// Also provides a timestamp for each value.
///
/// # Note
///
/// The \"poll storage\" subscribe option can be used to set the queue
/// depth.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `len`: length of returned array (output)
///
/// # Returns
///
/// Array of timestamped values; NULL if no new changes have
/// been published since the previous call.
pub fn NT_ReadQueueRaw(subentry: NT_Handle, len: *mut usize) -> *mut NT_TimestampedRaw;
/// Frees a timestamped array of values (as returned by NT_ReadQueueRaw).
///
/// # Parameters
///
/// - `arr`: array
/// - `len`: length of array
pub fn NT_FreeQueueRaw(arr: *mut NT_TimestampedRaw, len: usize);
/// Publish a new value.
///
/// # Parameters
///
/// - `pubentry`: publisher or entry handle
/// - `time`: timestamp; 0 indicates current NT time should be used
/// - `value`: value to publish
/// - `len`: length of value
///
pub fn NT_SetBooleanArray(
pubentry: NT_Handle,
time: i64,
value: *const NT_Bool,
len: usize,
) -> NT_Bool;
/// Publish a default value.
/// On reconnect, a default value will never be used in preference to a
/// published value.
///
/// # Parameters
///
/// - `pubentry`: publisher or entry handle
/// - `defaultValue`: default value
/// - `defaultValueLen`: length of default value
///
pub fn NT_SetDefaultBooleanArray(
pubentry: NT_Handle,
defaultValue: *const NT_Bool,
defaultValueLen: usize,
) -> NT_Bool;
/// Get the last published value.
/// If no value has been published, returns the passed defaultValue.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `defaultValue`: default value to return if no value has been published
/// - `defaultValueLen`: length of default value
/// - `len`: length of returned value (output)
///
///
/// # Returns
///
/// value
pub fn NT_GetBooleanArray(
subentry: NT_Handle,
defaultValue: *const NT_Bool,
defaultValueLen: usize,
len: *mut usize,
) -> *mut NT_Bool;
/// Get the last published value along with its timestamp.
/// If no value has been published, returns the passed defaultValue and a
/// timestamp of 0.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `defaultValue`: default value to return if no value has been published
/// - `defaultValueLen`: length of default value
///
/// # Parameters
///
/// - `value`: timestamped value (output)
pub fn NT_GetAtomicBooleanArray(
subentry: NT_Handle,
defaultValue: *const NT_Bool,
defaultValueLen: usize,
value: *mut NT_TimestampedBooleanArray,
);
/// Disposes a timestamped value (as returned by NT_GetAtomicBooleanArray).
///
/// # Parameters
///
/// - `value`: timestamped value
pub fn NT_DisposeTimestampedBooleanArray(value: *mut NT_TimestampedBooleanArray);
/// Get an array of all value changes since the last call to ReadQueue.
/// Also provides a timestamp for each value.
///
/// # Note
///
/// The \"poll storage\" subscribe option can be used to set the queue
/// depth.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `len`: length of returned array (output)
///
/// # Returns
///
/// Array of timestamped values; NULL if no new changes have
/// been published since the previous call.
pub fn NT_ReadQueueBooleanArray(
subentry: NT_Handle,
len: *mut usize,
) -> *mut NT_TimestampedBooleanArray;
/// Frees a timestamped array of values (as returned by NT_ReadQueueBooleanArray).
///
/// # Parameters
///
/// - `arr`: array
/// - `len`: length of array
pub fn NT_FreeQueueBooleanArray(arr: *mut NT_TimestampedBooleanArray, len: usize);
/// Publish a new value.
///
/// # Parameters
///
/// - `pubentry`: publisher or entry handle
/// - `time`: timestamp; 0 indicates current NT time should be used
/// - `value`: value to publish
/// - `len`: length of value
///
pub fn NT_SetIntegerArray(
pubentry: NT_Handle,
time: i64,
value: *const i64,
len: usize,
) -> NT_Bool;
/// Publish a default value.
/// On reconnect, a default value will never be used in preference to a
/// published value.
///
/// # Parameters
///
/// - `pubentry`: publisher or entry handle
/// - `defaultValue`: default value
/// - `defaultValueLen`: length of default value
///
pub fn NT_SetDefaultIntegerArray(
pubentry: NT_Handle,
defaultValue: *const i64,
defaultValueLen: usize,
) -> NT_Bool;
/// Get the last published value.
/// If no value has been published, returns the passed defaultValue.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `defaultValue`: default value to return if no value has been published
/// - `defaultValueLen`: length of default value
/// - `len`: length of returned value (output)
///
///
/// # Returns
///
/// value
pub fn NT_GetIntegerArray(
subentry: NT_Handle,
defaultValue: *const i64,
defaultValueLen: usize,
len: *mut usize,
) -> *mut i64;
/// Get the last published value along with its timestamp.
/// If no value has been published, returns the passed defaultValue and a
/// timestamp of 0.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `defaultValue`: default value to return if no value has been published
/// - `defaultValueLen`: length of default value
///
/// # Parameters
///
/// - `value`: timestamped value (output)
pub fn NT_GetAtomicIntegerArray(
subentry: NT_Handle,
defaultValue: *const i64,
defaultValueLen: usize,
value: *mut NT_TimestampedIntegerArray,
);
/// Disposes a timestamped value (as returned by NT_GetAtomicIntegerArray).
///
/// # Parameters
///
/// - `value`: timestamped value
pub fn NT_DisposeTimestampedIntegerArray(value: *mut NT_TimestampedIntegerArray);
/// Get an array of all value changes since the last call to ReadQueue.
/// Also provides a timestamp for each value.
///
/// # Note
///
/// The \"poll storage\" subscribe option can be used to set the queue
/// depth.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `len`: length of returned array (output)
///
/// # Returns
///
/// Array of timestamped values; NULL if no new changes have
/// been published since the previous call.
pub fn NT_ReadQueueIntegerArray(
subentry: NT_Handle,
len: *mut usize,
) -> *mut NT_TimestampedIntegerArray;
/// Frees a timestamped array of values (as returned by NT_ReadQueueIntegerArray).
///
/// # Parameters
///
/// - `arr`: array
/// - `len`: length of array
pub fn NT_FreeQueueIntegerArray(arr: *mut NT_TimestampedIntegerArray, len: usize);
/// Publish a new value.
///
/// # Parameters
///
/// - `pubentry`: publisher or entry handle
/// - `time`: timestamp; 0 indicates current NT time should be used
/// - `value`: value to publish
/// - `len`: length of value
///
pub fn NT_SetFloatArray(
pubentry: NT_Handle,
time: i64,
value: *const f32,
len: usize,
) -> NT_Bool;
/// Publish a default value.
/// On reconnect, a default value will never be used in preference to a
/// published value.
///
/// # Parameters
///
/// - `pubentry`: publisher or entry handle
/// - `defaultValue`: default value
/// - `defaultValueLen`: length of default value
///
pub fn NT_SetDefaultFloatArray(
pubentry: NT_Handle,
defaultValue: *const f32,
defaultValueLen: usize,
) -> NT_Bool;
/// Get the last published value.
/// If no value has been published, returns the passed defaultValue.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `defaultValue`: default value to return if no value has been published
/// - `defaultValueLen`: length of default value
/// - `len`: length of returned value (output)
///
///
/// # Returns
///
/// value
pub fn NT_GetFloatArray(
subentry: NT_Handle,
defaultValue: *const f32,
defaultValueLen: usize,
len: *mut usize,
) -> *mut f32;
/// Get the last published value along with its timestamp.
/// If no value has been published, returns the passed defaultValue and a
/// timestamp of 0.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `defaultValue`: default value to return if no value has been published
/// - `defaultValueLen`: length of default value
/// - `value`: timestamped value (output)
pub fn NT_GetAtomicFloatArray(
subentry: NT_Handle,
defaultValue: *const f32,
defaultValueLen: usize,
value: *mut NT_TimestampedFloatArray,
);
/// Disposes a timestamped value (as returned by NT_GetAtomicFloatArray).
///
/// # Parameters
///
/// - `value`: timestamped value
pub fn NT_DisposeTimestampedFloatArray(value: *mut NT_TimestampedFloatArray);
/// Get an array of all value changes since the last call to ReadQueue.
/// Also provides a timestamp for each value.
///
/// # Note
///
/// The \"poll storage\" subscribe option can be used to set the queue
/// depth.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `len`: length of returned array (output)
///
/// # Returns
///
/// Array of timestamped values; NULL if no new changes have
/// been published since the previous call.
pub fn NT_ReadQueueFloatArray(
subentry: NT_Handle,
len: *mut usize,
) -> *mut NT_TimestampedFloatArray;
/// Frees a timestamped array of values (as returned by NT_ReadQueueFloatArray).
///
/// # Parameters
///
/// - `arr`: array
/// - `len`: length of array
pub fn NT_FreeQueueFloatArray(arr: *mut NT_TimestampedFloatArray, len: usize);
/// Publish a new value.
///
/// # Parameters
///
/// - `pubentry`: publisher or entry handle
/// - `time`: timestamp; 0 indicates current NT time should be used
/// - `value`: value to publish
/// - `len`: length of value
///
pub fn NT_SetDoubleArray(
pubentry: NT_Handle,
time: i64,
value: *const f64,
len: usize,
) -> NT_Bool;
/// Publish a default value.
/// On reconnect, a default value will never be used in preference to a
/// published value.
///
/// # Parameters
///
/// - `pubentry`: publisher or entry handle
/// - `defaultValue`: default value
/// - `defaultValueLen`: length of default value
///
pub fn NT_SetDefaultDoubleArray(
pubentry: NT_Handle,
defaultValue: *const f64,
defaultValueLen: usize,
) -> NT_Bool;
/// Get the last published value.
/// If no value has been published, returns the passed defaultValue.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `defaultValue`: default value to return if no value has been published
/// - `defaultValueLen`: length of default value
/// - `len`: length of returned value (output)
///
///
/// # Returns
///
/// value
pub fn NT_GetDoubleArray(
subentry: NT_Handle,
defaultValue: *const f64,
defaultValueLen: usize,
len: *mut usize,
) -> *mut f64;
/// Get the last published value along with its timestamp.
/// If no value has been published, returns the passed defaultValue and a
/// timestamp of 0.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `defaultValue`: default value to return if no value has been published
/// - `defaultValueLen`: length of default value
///
/// # Parameters
///
/// - `value`: timestamped value (output)
pub fn NT_GetAtomicDoubleArray(
subentry: NT_Handle,
defaultValue: *const f64,
defaultValueLen: usize,
value: *mut NT_TimestampedDoubleArray,
);
/// Disposes a timestamped value (as returned by NT_GetAtomicDoubleArray).
///
/// # Parameters
///
/// - `value`: timestamped value
pub fn NT_DisposeTimestampedDoubleArray(value: *mut NT_TimestampedDoubleArray);
/// Get an array of all value changes since the last call to ReadQueue.
/// Also provides a timestamp for each value.
///
/// # Note
///
/// The \"poll storage\" subscribe option can be used to set the queue
/// depth.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `len`: length of returned array (output)
///
/// # Returns
///
/// Array of timestamped values; NULL if no new changes have
/// been published since the previous call.
pub fn NT_ReadQueueDoubleArray(
subentry: NT_Handle,
len: *mut usize,
) -> *mut NT_TimestampedDoubleArray;
/// Frees a timestamped array of values (as returned by NT_ReadQueueDoubleArray).
///
/// # Parameters
///
/// - `arr`: array
/// - `len`: length of array
pub fn NT_FreeQueueDoubleArray(arr: *mut NT_TimestampedDoubleArray, len: usize);
/// Publish a new value.
///
/// # Parameters
///
/// - `pubentry`: publisher or entry handle
/// - `time`: timestamp; 0 indicates current NT time should be used
/// - `value`: value to publish
/// - `len`: length of value
///
pub fn NT_SetStringArray(
pubentry: NT_Handle,
time: i64,
value: *const WPI_String,
len: usize,
) -> NT_Bool;
/// Publish a default value.
/// On reconnect, a default value will never be used in preference to a
/// published value.
///
/// # Parameters
///
/// - `pubentry`: publisher or entry handle
/// - `defaultValue`: default value
/// - `defaultValueLen`: length of default value
///
pub fn NT_SetDefaultStringArray(
pubentry: NT_Handle,
defaultValue: *const WPI_String,
defaultValueLen: usize,
) -> NT_Bool;
/// Get the last published value.
/// If no value has been published, returns the passed defaultValue.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `defaultValue`: default value to return if no value has been published
/// - `defaultValueLen`: length of default value
/// - `len`: length of returned value (output)
///
///
/// # Returns
///
/// value
pub fn NT_GetStringArray(
subentry: NT_Handle,
defaultValue: *const WPI_String,
defaultValueLen: usize,
len: *mut usize,
) -> *mut WPI_String;
/// Get the last published value along with its timestamp.
/// If no value has been published, returns the passed defaultValue and a
/// timestamp of 0.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `defaultValue`: default value to return if no value has been published
/// - `defaultValueLen`: length of default value
///
/// # Parameters
///
/// - `value`: timestamped value (output)
pub fn NT_GetAtomicStringArray(
subentry: NT_Handle,
defaultValue: *const WPI_String,
defaultValueLen: usize,
value: *mut NT_TimestampedStringArray,
);
/// Disposes a timestamped value (as returned by NT_GetAtomicStringArray).
///
/// # Parameters
///
/// - `value`: timestamped value
pub fn NT_DisposeTimestampedStringArray(value: *mut NT_TimestampedStringArray);
/// Get an array of all value changes since the last call to ReadQueue.
/// Also provides a timestamp for each value.
///
/// # Note
///
/// The \"poll storage\" subscribe option can be used to set the queue
/// depth.
///
/// # Parameters
///
/// - `subentry`: subscriber or entry handle
/// - `len`: length of returned array (output)
///
/// # Returns
///
/// Array of timestamped values; NULL if no new changes have
/// been published since the previous call.
pub fn NT_ReadQueueStringArray(
subentry: NT_Handle,
len: *mut usize,
) -> *mut NT_TimestampedStringArray;
/// Frees a timestamped array of values (as returned by NT_ReadQueueStringArray).
///
/// # Parameters
///
/// - `arr`: array
/// - `len`: length of array
pub fn NT_FreeQueueStringArray(arr: *mut NT_TimestampedStringArray, len: usize);
}