ohos-netstack-sys 0.1.0

Raw bindings to the OpenHarmony NetworkKit (netstack) 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

// 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_http_type::*;

extern "C" {
    /// Creates headers for a request or response.
    ///
    ///
    /// # Returns
    ///
    /// * Http_Headers* Pointer to [`Http_Headers`].
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetStack
    ///
    /// Available since API-level: 20
    #[cfg(feature = "api-20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-20")))]
    pub fn OH_Http_CreateHeaders() -> *mut Http_Headers;
    /// Destroys the headers of a request or response.
    ///
    /// # Arguments
    ///
    /// * `headers` - Pointer to the [`Http_Headers`] to be destroyed, headers ends with null.
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetStack
    ///
    /// Available since API-level: 20
    #[cfg(feature = "api-20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-20")))]
    pub fn OH_Http_DestroyHeaders(headers: *mut *mut Http_Headers);
    /// Sets the key-value pair of the request or response header.
    ///
    /// # Arguments
    ///
    /// * `headers` - Pointer to the [`Http_Headers`] to be set.
    ///
    /// * `name` - Key.
    ///
    /// * `value` - Value.
    ///
    /// # Returns
    ///
    /// * uint32_t 0 - success. 401 - Parameter error. 2300027 - Out of memory.
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetStack
    ///
    /// Available since API-level: 20
    #[cfg(feature = "api-20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-20")))]
    pub fn OH_Http_SetHeaderValue(
        headers: *mut Http_Headers,
        name: *const ::core::ffi::c_char,
        value: *const ::core::ffi::c_char,
    ) -> u32;
    /// Obtains the value of a request or response header by key.
    ///
    /// # Arguments
    ///
    /// * `headers` - Pointer to [`Http_Headers`].
    ///
    /// * `name` - Key.
    ///
    /// # Returns
    ///
    /// * Http_HeaderValue* Pointer to the obtained [`Http_HeaderValue`].
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetStack
    ///
    /// Available since API-level: 20
    #[cfg(feature = "api-20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-20")))]
    pub fn OH_Http_GetHeaderValue(
        headers: *mut Http_Headers,
        name: *const ::core::ffi::c_char,
    ) -> *mut Http_HeaderValue;
    /// Obtains all the key-value pairs of a request or response header.
    ///
    /// # Arguments
    ///
    /// * `headers` - Pointer to [`Http_Headersaders`].
    ///
    /// # Returns
    ///
    /// * Http_HeaderEntry* Pointers to all obtained key-value pairs [`Http_HeaderEntry`].
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetStack
    ///
    /// Available since API-level: 20
    #[cfg(feature = "api-20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-20")))]
    pub fn OH_Http_GetHeaderEntries(headers: *mut Http_Headers) -> *mut Http_HeaderEntry;
    /// Destroys all key-value pairs obtained in [`OH_Http_GetHeaderEntries`].
    ///
    /// # Arguments
    ///
    /// * `headerEntry` - Pointer to the [`Http_HeaderEntry`] to be destroyed, headerEntry ends with null.
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetStack
    ///
    /// Available since API-level: 20
    #[cfg(feature = "api-20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-20")))]
    pub fn OH_Http_DestroyHeaderEntries(headerEntry: *mut *mut Http_HeaderEntry);
    /// Create a http request.
    ///
    /// # Arguments
    ///
    /// * `url` - Http request url.
    ///
    /// # Returns
    ///
    /// * Pointer of HttpRequest if success; Null otherwise.
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetStack
    ///
    /// Available since API-level: 20
    #[cfg(feature = "api-20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-20")))]
    pub fn OH_Http_CreateRequest(url: *const ::core::ffi::c_char) -> *mut Http_Request;
    /// Initiates an HTTP request.
    ///
    /// # Arguments
    ///
    /// * `request` - Pointer to [`Http_Request`].
    ///
    /// * `callback` - Http response info, pointer to [`Http_ResponseCallback`]
    ///
    /// * `handler` - Callbacks to watch different events, pointer to [`Http_EventsHandler`].
    ///
    /// # Returns
    ///
    /// * 0 if success; non-0 otherwise. For details about error codes, see [`Http_ErrCode`].
    /// ohos.permission.INTERNET
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetStack
    ///
    /// Available since API-level: 20
    #[cfg(feature = "api-20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-20")))]
    pub fn OH_Http_Request(
        request: *mut Http_Request,
        callback: Http_ResponseCallback,
        handler: Http_EventsHandler,
    ) -> ::core::ffi::c_int;
    /// Destroy the HTTP request.
    ///
    /// # Arguments
    ///
    /// * `request` - Pointer to the http request [`Http_Request`].
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetStack
    ///
    /// Available since API-level: 20
    #[cfg(feature = "api-20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-20")))]
    pub fn OH_Http_Destroy(request: *mut *mut Http_Request);
}