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

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

extern "C" {
    /// Constructor of websocket.
    ///
    /// # Arguments
    ///
    /// * `onOpen` - Callback function invoked when a connection setup message is received.
    ///
    /// * `onMessage` - Callback function invoked when a message is received.
    ///
    /// * `onError` - Callback function invoked when a connection error message is received.
    ///
    /// * `onclose` - Callback function invoked when a connection closing message is closed.
    ///
    ///
    /// # Returns
    ///
    /// * Pointer to the websocket client if success; NULL otherwise.
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetStack
    ///
    /// Available since API-level: 11
    ///
    /// Version: 1.0
    #[cfg(feature = "api-11")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-11")))]
    pub fn OH_WebSocketClient_Constructor(
        onOpen: WebSocket_OnOpenCallback,
        onMessage: WebSocket_OnMessageCallback,
        onError: WebSocket_OnErrorCallback,
        onclose: WebSocket_OnCloseCallback,
    ) -> *mut WebSocket;
    /// Adds the header information to the client request.
    ///
    /// # Arguments
    ///
    /// * `client` - Pointer to the websocket client.
    ///
    /// * `header` - Header information
    ///
    /// # Returns
    ///
    /// * 0 if success; non-0 otherwise. For details about error codes, see [`OH_Websocket_ErrCode`].
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetStack
    ///
    /// Available since API-level: 11
    ///
    /// Version: 1.0
    #[cfg(feature = "api-11")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-11")))]
    pub fn OH_WebSocketClient_AddHeader(
        client: *mut WebSocket,
        header: WebSocket_Header,
    ) -> ::core::ffi::c_int;
    /// Connects the client to the server.
    ///
    /// # Arguments
    ///
    /// * `client` - Pointer to the websocket client.
    ///
    /// * `url` - URL for the client to connect to the server.
    ///
    /// * `options` - Optional parameters.
    ///
    /// # Returns
    ///
    /// * 0 if success; non-0 otherwise. For details about error codes, see [`OH_Websocket_ErrCode`].
    /// ohos.permission.INTERNET
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetStack
    ///
    /// Available since API-level: 11
    ///
    /// Version: 1.0
    #[cfg(feature = "api-11")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-11")))]
    pub fn OH_WebSocketClient_Connect(
        client: *mut WebSocket,
        url: *const ::core::ffi::c_char,
        options: WebSocket_RequestOptions,
    ) -> ::core::ffi::c_int;
    /// Sends data from the client to the server.
    ///
    /// # Arguments
    ///
    /// * `client` - Pointer to the websocket client.
    ///
    /// * `data` - Data sent by the client.
    ///
    /// * `length` - Length of the data sent by the client.
    ///
    /// # Returns
    ///
    /// * 0 if success; non-0 otherwise. For details about error codes, see [`OH_Websocket_ErrCode`].
    /// ohos.permission.INTERNET
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetStack
    ///
    /// Available since API-level: 11
    ///
    /// Version: 1.0
    #[cfg(feature = "api-11")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-11")))]
    pub fn OH_WebSocketClient_Send(
        client: *mut WebSocket,
        data: *mut ::core::ffi::c_char,
        length: usize,
    ) -> ::core::ffi::c_int;
    /// Closes a webSocket connection.
    ///
    /// # Arguments
    ///
    /// * `client` - Pointer to the websocket client.
    ///
    /// * `options` - Optional parameters.
    ///
    /// # Returns
    ///
    /// * 0 if success; non-0 otherwise. For details about error codes, see [`OH_Websocket_ErrCode`].
    /// ohos.permission.INTERNET
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetStack
    ///
    /// Available since API-level: 11
    ///
    /// Version: 1.0
    #[cfg(feature = "api-11")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-11")))]
    pub fn OH_WebSocketClient_Close(
        client: *mut WebSocket,
        options: WebSocket_CloseOption,
    ) -> ::core::ffi::c_int;
    /// Releases the context and resources of the websocket connection.
    ///
    /// # Arguments
    ///
    /// * `client` - Pointer to the websocket client.
    ///
    /// # Returns
    ///
    /// * 0 if success; non-0 otherwise. For details about error codes, see [`OH_Websocket_ErrCode`].
    /// ohos.permission.INTERNET
    ///
    /// Required System Capabilities: SystemCapability.Communication.NetStack
    ///
    /// Available since API-level: 11
    ///
    /// Version: 1.0
    #[cfg(feature = "api-11")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-11")))]
    pub fn OH_WebSocketClient_Destroy(client: *mut WebSocket) -> ::core::ffi::c_int;
}