net_websocket_type.h
Overview
Defines data structures for the C APIs of the WebSocket client module.
Library: libnet_websocket.so
System capability: SystemCapability.Communication.NetStack
Since: 11
Related module: Netstack
Summary
Structs
| Name | Description |
|---|---|
| WebSocket_CloseResult | Parameters for connection closure by the server. |
| WebSocket_CloseOption | Parameters for proactive connection closure by the client. |
| WebSocket_ErrorResult | Parameters for the connection error reported by the server. |
| WebSocket_OpenResult | Parameters for the connection success reported by the server. |
| WebSocket_Header | Header linked list added to the WebSocket client. |
| WebSocket_RequestOptions | Parameters for the connection between the WebSocket client and server. |
| WebSocket | WebSocket client structure. |
Types
| Name | Description |
|---|---|
| (* WebSocket_OnOpenCallback) (struct WebSocket *client, WebSocket_OpenResult openResult) | Callback invoked when the WebSocket client receives an open message. |
| (* WebSocket_OnMessageCallback) (struct WebSocket *client, char *data, uint32_t length) | Callback invoked when the WebSocket client receives data. |
| (* WebSocket_OnErrorCallback) (struct WebSocket *client, WebSocket_ErrorResult errorResult) | Callback invoked when the WebSocket client receives an error message. |
| (* WebSocket_OnCloseCallback) (struct WebSocket *client, WebSocket_CloseResult closeResult) | Callback invoked when the WebSocket client receives a close message. |
Enums
| Name | Description |
|---|---|
| WebSocket_ErrCode { WEBSOCKET_OK = 0, E_BASE = 1000, WEBSOCKET_CLIENT_NULL = (E_BASE + 1), WEBSOCKET_CLIENT_NOT_CREATED = (E_BASE + 2), WEBSOCKET_CONNECTION_ERROR = (E_BASE + 3), WEBSOCKET_CONNECTION_PARSE_URL_ERROR = (E_BASE + 5), WEBSOCKET_CONNECTION_NO_MEMORY = (E_BASE + 6), WEBSOCKET_CONNECTION_CLOSED_BY_PEER = (E_BASE + 7), WEBSOCKET_DESTROYED = (E_BASE + 8), WEBSOCKET_PROTOCOL_ERROR = (E_BASE + 9), WEBSOCKET_SEND_NO_MEMORY = (E_BASE + 10), WEBSOCKET_SEND_DATA_NULL = (E_BASE + 11), WEBSOCKET_DATA_LENGTH_EXCEEDED = (E_BASE + 12), WEBSOCKET_QUEUE_LENGTH_EXCEEDED = (E_BASE + 13), WEBSOCKET_NO_CLIENT_CONTEXT = (E_BASE + 14), WEBSOCKET_NO_HEADER_CONTEXT = (E_BASE + 15), WEBSOCKET_HEADER_EXCEEDED = (E_BASE + 16), WEBSOCKET_NO_CONNECTION = (E_BASE + 17), WEBSOCKET_NO_CONNECTION_CONTEXT = (E_BASE + 18) } |
WebSocket error codes. |