ohos-netmanager-sys 0.1.0

Raw bindings to the OpenHarmony NetworkKit (netmanager) native APIs
Documentation
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
// automatically generated by rust-bindgen 0.71.1

#![allow(non_upper_case_globals)]
#![allow(non_camel_case_types)]
#![allow(non_snake_case)]
use crate::net_connection_type::*;
use libc::addrinfo;

extern "C" {
    /// Checks whether a default activated data network is available.
    ///
    /// # Arguments
    ///
    /// * `hasDefaultNet` - Pointer to the result that specifies whether a default activated data network is available.
    ///
    /// # Returns
    ///
    /// * 0 - Success. 201 - Missing permissions.
    /// 401 - Parameter error. 2100002 - Unable to connect to service.
    /// 2100003 - Internal error.
    /// ohos.permission.GET_NETWORK_INFO
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetManager.Core
    ///
    /// Available since API-level: 11
    ///
    /// Version: 1.0
    #[cfg(feature = "api-11")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-11")))]
    pub fn OH_NetConn_HasDefaultNet(hasDefaultNet: *mut i32) -> i32;
    /// Obtains the default activated data network.
    ///
    /// # Arguments
    ///
    /// * `netHandle` - Pointer to the network handle that contains the network ID.
    ///
    /// # Returns
    ///
    /// * 0 - Success. 201 - Missing permissions.
    /// 401 - Parameter error. 2100002 - Unable to connect to service.
    /// 2100003 - Internal error.
    /// ohos.permission.GET_NETWORK_INFO
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetManager.Core
    ///
    /// Available since API-level: 11
    ///
    /// Version: 1.0
    #[cfg(feature = "api-11")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-11")))]
    pub fn OH_NetConn_GetDefaultNet(netHandle: *mut NetConn_NetHandle) -> i32;
    /// Checks whether metering is enabled for the default data network.
    ///
    /// # Arguments
    ///
    /// * `isMetered` - Pointer to the result that specifies whether metering is enabled.
    ///
    /// # Returns
    ///
    /// * 0 - Success. 201 - Missing permissions.
    /// 401 - Parameter error. 2100002 - Unable to connect to service.
    /// 2100003 - Internal error.
    /// ohos.permission.GET_NETWORK_INFO
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetManager.Core
    ///
    /// Available since API-level: 11
    ///
    /// Version: 1.0
    #[cfg(feature = "api-11")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-11")))]
    pub fn OH_NetConn_IsDefaultNetMetered(isMetered: *mut i32) -> i32;
    /// Obtains the connection properties of a data network.
    ///
    /// # Arguments
    ///
    /// * `netHandle` - Pointer to the network handle that contains the network ID.
    ///
    /// * `prop` - Pointer to the connection properties.
    ///
    /// # Returns
    ///
    /// * 0 - Success. 201 - Missing permissions.
    /// 401 - Parameter error. 2100002 - Unable to connect to service.
    /// 2100003 - Internal error.
    /// ohos.permission.GET_NETWORK_INFO
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetManager.Core
    ///
    /// Available since API-level: 11
    ///
    /// Version: 1.0
    #[cfg(feature = "api-11")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-11")))]
    pub fn OH_NetConn_GetConnectionProperties(
        netHandle: *mut NetConn_NetHandle,
        prop: *mut NetConn_ConnectionProperties,
    ) -> i32;
    /// Obtains the capabilities of a data network.
    ///
    /// # Arguments
    ///
    /// * `netHandle` - Pointer to the network handle that contains the network ID.
    ///
    /// * `netCapacities` - Pointer to the network capabilities.
    ///
    /// # Returns
    ///
    /// * 0 - Success. 201 - Missing permissions.
    /// 401 - Parameter error. 2100002 - Unable to connect to service.
    /// 2100003 - Internal error.
    /// ohos.permission.GET_NETWORK_INFO
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetManager.Core
    ///
    /// Available since API-level: 11
    ///
    /// Version: 1.0
    #[cfg(feature = "api-11")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-11")))]
    pub fn OH_NetConn_GetNetCapabilities(
        netHandle: *mut NetConn_NetHandle,
        netCapabilities: *mut NetConn_NetCapabilities,
    ) -> i32;
    /// Obtains the default http proxy.
    ///
    /// # Arguments
    ///
    /// * `httpProxy` - Pointer to the HTTP proxy.
    ///
    /// # Returns
    ///
    /// * 0 - Success. 201 - Missing permissions.
    /// 401 - Parameter error. 2100002 - Unable to connect to service.
    /// 2100003 - Internal error.
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetManager.Core
    ///
    /// Available since API-level: 11
    ///
    /// Version: 1.0
    #[cfg(feature = "api-11")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-11")))]
    pub fn OH_NetConn_GetDefaultHttpProxy(httpProxy: *mut NetConn_HttpProxy) -> i32;
    /// Get DNS result with netId.
    ///
    /// # Arguments
    ///
    /// * `host` - The host name to query.
    ///
    /// * `serv` - Service name.
    ///
    /// * `hint` - Pointer to the addrinfo structure.
    ///
    /// * `res` - Store DNS query results and return them in a linked list format.
    ///
    /// * `netId` - DNS query netId, 0 is used for default netid query.
    ///
    /// # Returns
    ///
    /// * 0 - Success. 201 - Missing permissions.
    /// 401 - Parameter error. 2100002 - Unable to connect to service.
    /// 2100003 - Internal error.
    /// ohos.permission.INTERNET
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetManager.Core
    ///
    /// Available since API-level: 11
    ///
    /// Version: 1.0
    #[cfg(feature = "api-11")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-11")))]
    pub fn OH_NetConn_GetAddrInfo(
        host: *mut ::core::ffi::c_char,
        serv: *mut ::core::ffi::c_char,
        hint: *mut addrinfo,
        res: *mut *mut addrinfo,
        netId: i32,
    ) -> i32;
    /// Free DNS result.
    ///
    /// # Arguments
    ///
    /// * `res` - DNS query result chain header.
    ///
    /// # Returns
    ///
    /// * 0 - Success. 201 - Missing permissions.
    /// 401 - Parameter error. 2100002 - Unable to connect to service.
    /// 2100003 - Internal error.
    /// ohos.permission.INTERNET
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetManager.Core
    ///
    /// Available since API-level: 11
    ///
    /// Version: 1.0
    #[cfg(feature = "api-11")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-11")))]
    pub fn OH_NetConn_FreeDnsResult(res: *mut addrinfo) -> i32;
    /// Queries all activated data networks.
    ///
    /// # Arguments
    ///
    /// * `netHandleList` - Network handle that stores the network ID list.
    ///
    /// # Returns
    ///
    /// * 0 - Success. 201 - Missing permissions.
    /// 401 - Parameter error. 2100002 - Unable to connect to service.
    /// 2100003 - Internal error.
    /// ohos.permission.GET_NETWORK_INFO
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetManager.Core
    ///
    /// Available since API-level: 11
    ///
    /// Version: 1.0
    #[cfg(feature = "api-11")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-11")))]
    pub fn OH_NetConn_GetAllNets(netHandleList: *mut NetConn_NetHandleList) -> i32;
    /// Registers a custom DNS resolver.
    ///
    /// # Arguments
    ///
    /// * `resolver` - Pointer to the custom DNS resolver.
    ///
    /// # Returns
    ///
    /// * 0 - Success. 201 - Missing permissions.
    /// 401 - Parameter error. 2100002 - Unable to connect to service.
    /// 2100003 - Internal error.
    /// ohos.permission.INTERNET
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetManager.Core
    ///
    /// **Deprecated** since 13
    /// OH_NetConn_RegisterDnsResolver
    ///
    /// Available since API-level: 11
    ///
    /// Version: 1.0
    #[cfg(feature = "api-11")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-11")))]
    #[deprecated(since = "13")]
    pub fn OHOS_NetConn_RegisterDnsResolver(resolver: OH_NetConn_CustomDnsResolver) -> i32;
    /// Unregisters a custom DNS resolver.
    ///
    ///
    /// # Returns
    ///
    /// * 0 - Success. 201 - Missing permissions.
    /// 401 - Parameter error. 2100002 - Unable to connect to service.
    /// 2100003 - Internal error.
    /// ohos.permission.INTERNET
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetManager.Core
    ///
    /// **Deprecated** since 13
    /// OH_NetConn_UnregisterDnsResolver
    ///
    /// Available since API-level: 11
    ///
    /// Version: 1.0
    #[cfg(feature = "api-11")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-11")))]
    #[deprecated(since = "13")]
    pub fn OHOS_NetConn_UnregisterDnsResolver() -> i32;
    /// Registers a custom DNS resolver.
    ///
    /// # Arguments
    ///
    /// * `resolver` - Pointer to the custom DNS resolver.
    ///
    /// # Returns
    ///
    /// * Returns the result code.
    /// [`NETMANAGER_EXT_SUCCESS`] if the operation is successful.
    /// [`NETMANAGER_ERR_PERMISSION_DENIED`] Missing permissions, add permission.
    /// [`NETMANAGER_ERR_PARAMETER_ERROR`] Parameter error. Please enter a correct parameter.
    /// ohos.permission.INTERNET
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetManager.Core
    ///
    /// Available since API-level: 13
    ///
    /// Version: 1.0
    #[cfg(feature = "api-13")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
    pub fn OH_NetConn_RegisterDnsResolver(resolver: OH_NetConn_CustomDnsResolver) -> i32;
    /// Unregisters a custom DNS resolver.
    ///
    ///
    /// # Returns
    ///
    /// * 0 - Success. 201 - Missing permissions.
    /// 401 - Parameter error. 2100002 - Unable to connect to service.
    /// 2100003 - Internal error.
    /// ohos.permission.INTERNET
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetManager.Core
    ///
    /// Available since API-level: 13
    ///
    /// Version: 1.0
    #[cfg(feature = "api-13")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
    pub fn OH_NetConn_UnregisterDnsResolver() -> i32;
    /// Binds a socket to the specific network.
    ///
    /// # Arguments
    ///
    /// * `socketFd` - Socket constructed by user.
    ///
    /// * `netHandle` - Pointer to the network handle that contains the network ID.
    ///
    /// # Returns
    ///
    /// * 0 - Success.
    /// 401 - Parameter error.
    /// 2100002 - Unable to connect to service.
    /// 2100003 - Internal error.
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetManager.Core
    ///
    /// Available since API-level: 12
    ///
    /// Version: 1.0
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_NetConn_BindSocket(socketFd: i32, netHandle: *mut NetConn_NetHandle) -> i32;
    /// Sets http proxy information to current application.
    ///
    /// # Arguments
    ///
    /// * `httpProxy` - Information about the proxy that needs to be set.
    ///
    /// # Returns
    ///
    /// * 0 - Success.
    /// 401 - Parameter error.
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetManager.Core
    ///
    /// Available since API-level: 12
    ///
    /// Version: 1.0
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_NetConn_SetAppHttpProxy(httpProxy: *mut NetConn_HttpProxy) -> i32;
    /// Registers callback to listen for changes to the application-level http proxy.
    ///
    /// # Arguments
    ///
    /// * `appHttpProxyChange` - Callback that need to be registered to listen for changes to the http proxy.
    ///
    /// * `callbackId` - Callback id returned after registration, associated with a registered callback.
    ///
    /// # Returns
    ///
    /// * 0 - Success.
    /// 401 - Parameter error.
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetManager.Core
    ///
    /// Available since API-level: 12
    ///
    /// Version: 1.0
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_NetConn_RegisterAppHttpProxyCallback(
        appHttpProxyChange: OH_NetConn_AppHttpProxyChange,
        callbackId: *mut u32,
    ) -> i32;
    /// Unregisters a callback function that listens for application-level proxy changes.
    ///
    /// # Arguments
    ///
    /// * `callbackId` - Id of the callback function that needs to be deregistered.
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetManager.Core
    ///
    /// Available since API-level: 12
    ///
    /// Version: 1.0
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_NetConn_UnregisterAppHttpProxyCallback(callbackId: u32);
    /// Registers callback, used to monitor specific network status.
    ///
    /// # Arguments
    ///
    /// * `netSpecifier` - specifier information.
    ///
    /// * `callback` - The callback needed to be registered.
    ///
    /// * `timeout` - The timeout period in milliseconds.
    ///
    /// * `callbackId` - out param, corresponding to a registered callback.
    ///
    /// # Returns
    ///
    /// * 0 - Success.
    /// 201 - Permission denied.
    /// 401 - Parameter error.
    /// 2100002 - Failed to connect to the service.
    /// 2100003 - System internal error.
    /// 2101008 - The callback already exists.
    /// 2101022 - The number of requests exceeded the maximum allowed.
    /// ohos.permission.GET_NETWORK_INFO
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetManager.Core
    ///
    /// Available since API-level: 12
    ///
    /// Version: 1.0
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_NetConn_RegisterNetConnCallback(
        specifier: *mut NetConn_NetSpecifier,
        netConnCallback: *mut NetConn_NetConnCallback,
        timeout: u32,
        callbackId: *mut u32,
    ) -> i32;
    /// Registers a callback to listen default network's status changed.
    ///
    /// # Arguments
    ///
    /// * `callback` - The callback needed to be registered.
    ///
    /// * `callbackId` - out param, corresponding to a registered callback.
    ///
    /// # Returns
    ///
    /// * 0 - Success.
    /// 201 - Permission denied.
    /// 401 - Parameter error.
    /// 2100002 - Failed to connect to the service.
    /// 2100003 - System internal error.
    /// 2101008 - The callback already exists.
    /// 2101022 - The number of requests exceeded the maximum allowed.
    /// ohos.permission.GET_NETWORK_INFO
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetManager.Core
    ///
    /// Available since API-level: 12
    ///
    /// Version: 1.0
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_NetConn_RegisterDefaultNetConnCallback(
        netConnCallback: *mut NetConn_NetConnCallback,
        callbackId: *mut u32,
    ) -> i32;
    /// Unregisters network status callback.
    ///
    /// # Arguments
    ///
    /// * `callBackId` - the id corresponding to a registered callback.
    ///
    /// # Returns
    ///
    /// * 0 - Success.
    /// 201 - Permission denied.
    /// 401 - Parameter error.
    /// 2100002 - Failed to connect to the service.
    /// 2100003 - System internal error.
    /// 2101007 - The callback does not exists.
    /// ohos.permission.GET_NETWORK_INFO
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetManager.Core
    ///
    /// Available since API-level: 12
    ///
    /// Version: 1.0
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_NetConn_UnregisterNetConnCallback(callBackId: u32) -> i32;
    /// Sets the URL of the current PAC script.
    ///
    /// # Arguments
    ///
    /// * `pacUrl` - the URL of the current PAC script.
    ///
    /// # Returns
    ///
    /// * the result defines in [`NetConn_ErrorCode`].
    /// [`NETCONN_SUCCESS`] Success.
    /// [`NETCONN_PERMISSION_DENIED`] Permission denied.
    /// [`NETCONN_PARAMETER_ERROR`] Parameter check failed.
    /// [`NETCONN_OPERATION_FAILED`] Failed to connect to the service.
    /// [`NETCONN_INTERNAL_ERROR`] System internal error.
    /// ohos.permission.SET_PAC_URL
    ///
    /// Available since API-level: 15
    #[cfg(feature = "api-15")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
    pub fn OH_NetConn_SetPacUrl(pacUrl: *const ::core::ffi::c_char) -> NetConn_ErrorCode;
    /// Obtains the URL of the current PAC script.
    ///
    /// # Arguments
    ///
    /// * `pacUrl` - the URL of the current PAC script.
    ///
    /// # Returns
    ///
    /// * the result defines in [`NetConn_ErrorCode`].
    /// [`NETCONN_SUCCESS`] Success.
    /// [`NETCONN_PARAMETER_ERROR`] Parameter check failed.
    /// [`NETCONN_OPERATION_FAILED`] Failed to connect to the service.
    /// [`NETCONN_INTERNAL_ERROR`] System internal error.
    ///
    /// Available since API-level: 15
    #[cfg(feature = "api-15")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
    pub fn OH_NetConn_GetPacUrl(pacUrl: *mut ::core::ffi::c_char) -> NetConn_ErrorCode;
    /// Query a network probe result.
    ///
    /// # Arguments
    ///
    /// * `destination` - Pointer to the destination.
    ///
    /// * `duration` - probe duration. Unit: second.
    ///
    /// * `probeResultInfo` - Pointer to probe loss rate and rtt.
    ///
    /// # Returns
    ///
    /// * 0 - Success.
    /// 201 - Missing permissions.
    /// 401 - Parameter error.
    /// 2100003 - Internal error.
    /// ohos.permission.INTERNET
    ///
    /// Available since API-level: 20
    #[cfg(feature = "api-20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-20")))]
    pub fn OH_NetConn_QueryProbeResult(
        destination: *mut ::core::ffi::c_char,
        duration: i32,
        probeResultInfo: *mut NetConn_ProbeResultInfo,
    ) -> i32;
    /// Query a network trace route.
    ///
    /// # Arguments
    ///
    /// * `destination` - Pointer to the destination.
    ///
    /// * `option` - Pointer to the trace route option
    ///
    /// * `traceRouteInfo` - Pointer to trace route result.
    ///
    /// # Returns
    ///
    /// * 0 - Success.
    /// 201 - Missing permissions.
    /// ohos.permission.INTERNET and ohos.permission.LOCATION and ohos.permission.ACCESS_NET_TRACE_INFO
    ///
    /// Available since API-level: 20
    #[cfg(feature = "api-20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-20")))]
    pub fn OH_NetConn_QueryTraceRoute(
        destination: *mut ::core::ffi::c_char,
        option: *mut NetConn_TraceRouteOption,
        traceRouteInfo: *mut NetConn_TraceRouteInfo,
    ) -> i32;
}