openharmony/interface_sdk_c
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk_c synced 2024-11-27 00:41:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

add websocket code

Browse Source 
Signed-off-by: liuxiyao223 <liuxiyao223@huawei.com>
This commit is contained in:
liuxiyao223 2023-12-13 09:49:37 +08:00
parent f40f74dfa6
commit 96c3ff38fc
3 changed files with 75 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
network/netstack/net_websocket/libwebsocket.ndk.json
View File

@ -1,9 +1,9 @@
[
{"name": "OH_NetStack_WebsocketClient_Construct"},
{"name": "OH_NetStack_WebSocketClient_AddHeader"},
{"name": "OH_NetStack_WebSocketClient_Connect"},
{"name": "OH_NetStack_WebSocketClient_Send"},
{"name": "OH_NetStack_WebSocketClient_Close"},
{"name": "OH_NetStack_WebsocketClient_AddHeader"},
{"name": "OH_NetStack_WebsocketClient_Connect"},
{"name": "OH_NetStack_WebsocketClient_Send"},
{"name": "OH_NetStack_WebsocketClient_Close"},
{"name": "OH_NetStack_WebsocketClient_Destroy"},
{"name": "OH_NetStack_WebSocketClient_FreeAll"}
{"name": "OH_NetStack_WebsocketClient_FreeAll"}
]

43
network/netstack/net_websocket/net_websocket.h
View File

@ -24,7 +24,7 @@
* @addtogroup netstack
* @{
*
* @brief Provides C APIs for the WebSocket client module.
* @brief Provides C APIs for the websocket client module.
* @since 11
* @version 1.0
@ -33,7 +33,7 @@
/**
* @file net_websocket.h
*
* @brief Defines the APIs for the WebSocket client module.
* @brief Defines the APIs for the websocket client module.
*
* @library libnet_websocket.so
* @syscap SystemCapability.Communication.NetStack
@ -48,38 +48,38 @@ extern "C" {
#endif
/**
* @brief Constructor of OH_NetStack_WebsocketClient.
* @brief Constructor of websocket.
*
* @param onMessage Callback function invoked when a message is received.
* @param onClose Callback function invoked when a connection closing message is closed.
* @param onError Callback function invoked when a connection error message is received.
* @param onOpen Callback function invoked when a connection setup message is received.
* @return Pointer to the WebSocket client if success; NULL otherwise.
* @return Pointer to the websocket client if success; NULL otherwise.
* @syscap SystemCapability.Communication.NetStack
* @since 11
* @version 1.0
*/
struct OH_NetStack_WebsocketClient *OH_NetStack_WebsocketClient_Construct(
OH_NetStack_WebsocketClient_OnOpenCallback onOpen, OH_NetStack_WebsocketClient_OnMessageCallback onMessage,
OH_NetStack_WebsocketClient_OnErrorCallback onError, OH_NetStack_WebsocketClient_OnCloseCallback onclose);
struct Websocket *OH_NetStack_WebsocketClient_Construct(Websocket_OnOpenCallback onOpen,
Websocket_OnMessageCallback onMessage,
Websocket_OnErrorCallback onError,
Websocket_OnCloseCallback onclose);
/**
* @brief Adds the header information to the client request.
*
* @param client Pointer to the WebSocket client.
* @param client Pointer to the websocket client.
* @param header Header information
* @return 0 if success; non-0 otherwise. For details about error codes, see {@link OH_Websocket_ErrCode}.
* @syscap SystemCapability.Communication.NetStack
* @since 11
* @version 1.0
*/
int OH_NetStack_WebSocketClient_AddHeader(struct OH_NetStack_WebsocketClient *client,
struct OH_NetStack_WebsocketClient_Slist header);
int OH_NetStack_WebsocketClient_AddHeader(struct Websocket *client, struct Websocket_HeaderNode header);
/**
* @brief Connects the client to the server.
*
* @param client Pointer to the WebSocket client.
* @param client Pointer to the websocket client.
* @param url URL for the client to connect to the server.
* @param options Optional parameters.
* @return 0 if success; non-0 otherwise. For details about error codes, see {@link OH_Websocket_ErrCode}.
@ -88,13 +88,13 @@ int OH_NetStack_WebSocketClient_AddHeader(struct OH_NetStack_WebsocketClient *cl
* @since 11
* @version 1.0
*/
int OH_NetStack_WebSocketClient_Connect(struct OH_NetStack_WebsocketClient *client, const char *url,
struct OH_NetStack_WebsocketClient_RequestOptions options);
int OH_NetStack_WebsocketClient_Connect(struct Websocket *client, const char *url,
struct Websocket_RequestOptions options);
/**
* @brief Sends data from the client to the server.
*
* @param client Pointer to the WebSocket client.
* @param client Pointer to the websocket client.
* @param data Data sent by the client.
* @param length Length of the data sent by the client.
* @return 0 if success; non-0 otherwise. For details about error codes, see {@link OH_Websocket_ErrCode}.
@ -103,12 +103,12 @@ int OH_NetStack_WebSocketClient_Connect(struct OH_NetStack_WebsocketClient *clie
* @since 11
* @version 1.0
*/
int OH_NetStack_WebSocketClient_Send(struct OH_NetStack_WebsocketClient *client, char *data, size_t length);
int OH_NetStack_WebsocketClient_Send(struct Websocket *client, char *data, size_t length);
/**
* @brief Closes a WebSocket connection.
* @brief Closes a webSocket connection.
*
* @param client Pointer to the WebSocket client.
* @param client Pointer to the websocket client.
* @param url URL for the client to connect to the server.
* @param options Optional parameters.
* @return 0 if success; non-0 otherwise. For details about error codes, see {@link OH_Websocket_ErrCode}.
@ -117,20 +117,19 @@ int OH_NetStack_WebSocketClient_Send(struct OH_NetStack_WebsocketClient *client,
* @since 11
* @version 1.0
*/
int OH_NetStack_WebSocketClient_Close(struct OH_NetStack_WebsocketClient *client,
struct OH_NetStack_WebsocketClient_CloseOption options);
int OH_NetStack_WebsocketClient_Close(struct Websocket *client, struct Websocket_CloseOption options);
/**
* @brief Releases the context and resources of the WebSocket connection.
* @brief Releases the context and resources of the websocket connection.
*
* @param client Pointer to the WebSocket client.
* @param client Pointer to the websocket client.
* @return 0 if success; non-0 otherwise. For details about error codes, see {@link OH_Websocket_ErrCode}.
* @permission ohos.permission.INTERNET
* @syscap SystemCapability.Communication.NetStack
* @since 11
* @version 1.0
*/
int OH_NetStack_WebsocketClient_Destroy(struct OH_NetStack_WebsocketClient *client);
int OH_NetStack_WebsocketClient_Destroy(struct Websocket *client);
#ifdef __cplusplus
}

102
network/netstack/net_websocket/net_websocket_type.h
View File

@ -20,7 +20,7 @@
* @addtogroup netstack
* @{
*
* @brief Provides C APIs for the WebSocket client module.
* @brief Provides C APIs for the websocket client module.
*
* @since 11
* @version 1.0
@ -28,7 +28,7 @@
/**
* @file net_websocket_type.h
* @brief Defines the data structure for the C APIs of the WebSocket client module.
* @brief Defines the data structure for the C APIs of the websocket client module.
*
* @library libnet_websocket.so
* @syscap SystemCapability.Communication.NetStack
@ -46,7 +46,7 @@ extern "C" {
* @since 11
* @version 1.0
*/
struct OH_NetStack_WebsocketClient_CloseResult {
struct Websocket_CloseResult {
/** Error code */
uint32_t code;
/** Error cause */
@ -59,7 +59,7 @@ struct OH_NetStack_WebsocketClient_CloseResult {
* @since 11
* @version 1.0
*/
struct OH_NetStack_WebsocketClient_CloseOption {
struct Websocket_CloseOption {
/** Error code */
uint32_t code;
/** Error cause */
@ -72,7 +72,7 @@ struct OH_NetStack_WebsocketClient_CloseOption {
* @since 11
* @version 1.0
*/
struct OH_NetStack_WebsocketClient_ErrorResult {
struct Websocket_ErrorResult {
/** Error code */
uint32_t errorCode;
/** Error message */
@ -85,7 +85,7 @@ struct OH_NetStack_WebsocketClient_ErrorResult {
* @since 11
* @version 1.0
*/
struct OH_NetStack_WebsocketClient_OpenResult {
struct Websocket_OpenResult {
/** Connection success code */
uint32_t code;
/** Connection success reason */
@ -95,91 +95,87 @@ struct OH_NetStack_WebsocketClient_OpenResult {
/**
* @brief Defines the callback function invoked when an <b>open</b> message is received.
*
* @param client WebSocket client.
* @param openResult Content of the <b>open</b> message received by the WebSocket client.
* @param client websocket client.
* @param openResult Content of the <b>open</b> message received by the websocket client.
* @since 11
* @version 1.0
*/
typedef void (*OH_NetStack_WebsocketClient_OnOpenCallback)(struct OH_NetStack_WebsocketClient *client,
OH_NetStack_WebsocketClient_OpenResult openResult);
typedef void (*Websocket_OnOpenCallback)(struct Websocket *client, Websocket_OpenResult openResult);
/**
* @brief Defines the callback function invoked when data is received.
*
* @param client WebSocket client.
* @param data Data received by the WebSocket client.
* @param length Length of the data received by the WebSocket client.
* @param client websocket client.
* @param data Data received by the websocket client.
* @param length Length of the data received by the websocket client.
* @since 11
* @version 1.0
*/
typedef void (*OH_NetStack_WebsocketClient_OnMessageCallback)(struct OH_NetStack_WebsocketClient *client, char *data,
uint32_t length);
typedef void (*Websocket_OnMessageCallback)(struct Websocket *client, char *data, uint32_t length);
/**
* @brief Defines the callback function invoked when an error message is received.
*
* @param client WebSocket client.
* @param errorResult Content of the connection error message received by the WebSocket client.
* @param client websocket client.
* @param errorResult Content of the connection error message received by the websocket client.
* @since 11
* @version 1.0
*/
typedef void (*OH_NetStack_WebsocketClient_OnErrorCallback)(struct OH_NetStack_WebsocketClient *client,
OH_NetStack_WebsocketClient_ErrorResult errorResult);
typedef void (*Websocket_OnErrorCallback)(struct Websocket *client, Websocket_ErrorResult errorResult);
/**
* @brief Defines the callback function invoked when a <b>close</b> message is received.
*
* @param client WebSocket client.
* @param closeResult Content of the <b>close</b> message received by the WebSocket client.
* @param client webSocket client.
* @param closeResult Content of the <b>close</b> message received by the webSocket client.
* @since 11
* @version 1.0
*/
typedef void (*OH_NetStack_WebsocketClient_OnCloseCallback)(struct OH_NetStack_WebsocketClient *client,
OH_NetStack_WebsocketClient_CloseResult closeResult);
typedef void (*Websocket_OnCloseCallback)(struct Websocket *client, Websocket_CloseResult closeResult);
/**
* @brief Adds the header linked list to the WebSocket client.
* @brief Adds the header linked list to the websocket client.
*
* @since 11
* @version 1.0
*/
struct OH_NetStack_WebsocketClient_Slist {
struct Websocket_HeaderNode {
/** Header field name */
const char *fieldName;
/** Header field content */
const char *fieldValue;
/** Next pointer of the header linked list */
struct OH_NetStack_WebsocketClient_Slist *next;
struct Websocket_HeaderNode *next;
};
/**
* @brief Defines the parameters for the connection between the WebSocket client and server.
* @brief Defines the parameters for the connection between the websocket client and server.
*
* @param headers Header information.
* @since 11
* @version 1.0
*/
struct OH_NetStack_WebsocketClient_RequestOptions {
struct OH_NetStack_WebsocketClient_Slist *headers;
struct Websocket_RequestOptions {
struct Websocket_HeaderNode *headers;
};
/**
* @brief Defines the WebSocket client structure.
* @brief Defines the websocket client structu re.
*
* @since 11
* @version 1.0
*/
struct OH_NetStack_WebsocketClient {
struct Websocket {
/** Pointer to the callback invoked when a connection message is received */
OH_NetStack_WebsocketClient_OnOpenCallback onOpen;
Websocket_OnOpenCallback onOpen;
/** Pointer to the callback invoked when a message is received */
OH_NetStack_WebsocketClient_OnMessageCallback onMessage;
Websocket_OnMessageCallback onMessage;
/** Pointer to the callback invoked when an error message is received */
OH_NetStack_WebsocketClient_OnErrorCallback onError;
Websocket_OnErrorCallback onError;
/** Pointer to the callback invoked when a close message is received */
OH_NetStack_WebsocketClient_OnCloseCallback onClose;
Websocket_OnCloseCallback onClose;
/** Content of the request for establishing a connection on the client */
OH_NetStack_WebsocketClient_RequestOptions requestOptions;
Websocket_RequestOptions requestOptions;
};
typedef enum OH_Websocket_ErrCode {
@ -194,87 +190,87 @@ typedef enum OH_Websocket_ErrCode {
E_BASE = 1000,
/**
* @brief The WebSocket client is null.
* @brief The websocket client is null.
*/
WEBSOCKET_CLIENT_IS_NULL = (E_BASE + 1),
/**
* @brief A WebSocket client is not created.
* @brief A webSocket client is not created.
*/
WEBSOCKET_CLIENT_IS_NOT_CREAT = (E_BASE + 2),
/**
* @brief An error occurs while setting up a WebSocket connection.
* @brief An error occurs while setting up a websocket connection.
*/
WEBSOCKET_CONNECTION_ERROR = (E_BASE + 3),
/**
* @brief An error occurs while parsing WebSocket connection parameters.
* @brief An error occurs while parsing websocket connection parameters.
*/
WEBSOCKET_CONNECTION_PARSEURL_ERROR = (E_BASE + 5),
/**
* @brief The memory is insufficient for creating a context during WebSocket connection setup.
* @brief The memory is insufficient for creating a context during websocket connection setup.
*/
WEBSOCKET_CONNECTION_NO_MEMOERY = (E_BASE + 6),
/**
* @brief The WebSocket connection is closed by the peer.
* @brief The websocket connection is closed by the peer.
*/
WEBSOCKET_PEER_INITIATED_CLOSE = (E_BASE + 7),
/**
* @brief The WebSocket connection is destroyed.
* @brief The websocket connection is destroyed.
*/
WEBSOCKET_DESTROY = (E_BASE + 8),
/**
* @brief An incorrect protocol is used for WebSocket connection.
* @brief An incorrect protocol is used for websocket connection.
*/
WEBSOCKET_PROTOCOL_ERROR = (E_BASE + 9),
/**
* @brief The memory for the WebSocket client to send data is insufficient.
* @brief The memory for the websocket client to send data is insufficient.
*/
WEBSOCKET_SEND_NO_MEMOERY_ERROR = (E_BASE + 10),
/**
* @brief The data sent by the WebSocket client is null.
* @brief The data sent by the websocket client is null.
*/
WEBSOCKET_SEND_DATA_NULL = (E_BASE + 11),
/**
* @brief The length of the data sent by the WebSocket client exceeds the limit.
* @brief The length of the data sent by the websocket client exceeds the limit.
*/
WEBSOCKET_DATA_LENGTH_EXCEEDS = (E_BASE + 12),
/**
* @brief The queue length of the data sent by the WebSocket client exceeds the limit.
* @brief The queue length of the data sent by the websocket client exceeds the limit.
*/
WEBSOCKET_QUEUE_LENGTH_EXCEEDS = (E_BASE + 13),
/**
* @brief The context of the WebSocket client is null.
* @brief The context of the websocket client is null.
*/
WEBSOCKET_ERROR_NO_CLIENTCONTEX = (E_BASE + 14),
/**
* @brief The header of the WebSocket client is null.
* @brief The header of the webSocket client is null.
*/
WEBSOCKET_ERROR_NO_HEADR_CONTEXT = (E_BASE + 15),
/**
* @brief The header of the WebSocket client exceeds the limit.
* @brief The header of the websocket client exceeds the limit.
*/
WEBSOCKET_ERROR_NO_HEADR_EXCEEDS = (E_BASE + 16),
/**
* @brief The WebSocket client is not connected.
* @brief The websocket client is not connected.
*/
WEBSOCKET_ERROR_HAVE_NO_CONNECT = (E_BASE + 17),
/**
* @brief The WebSocket client does not have the connection context.
* @brief The websocket client does not have the connection context.
*/
WEBSOCKET_ERROR_HAVE_NO_CONNECT_CONTEXT = (E_BASE + 18),
} OH_Websocket_ErrCode;