net_websocket_type.h
概述
定义websocket客户端模块的C接口需要的数据结构。
库： libnet_websocket.so
系统能力： SystemCapability.Communication.NetStack
起始版本： 11
相关模块：Netstack
汇总
结构体
| 名称 | 描述 |
|---|---|
| WebSocket_CloseResult | websocket客户端来自服务端关闭的参数。 |
| WebSocket_CloseOption | websocket客户端主动关闭的参数。 |
| WebSocket_ErrorResult | websocket客户端来自服务端连接错误的参数。 |
| WebSocket_OpenResult | websocket客户端来自服务端连接成功的参数。 |
| WebSocket_Header | websocket客户端增加header头的链表节点。 |
| WebSocket_RequestOptions | websocket客户端和服务端建立连接的参数。 |
| WebSocket | websocket客户端结构体。 |
类型定义
| 名称 | 描述 |
|---|---|
| (* WebSocket_OnOpenCallback) (struct WebSocket *client, WebSocket_OpenResult openResult) | websocket客户端接收open消息的回调函数定义。 |
| (* WebSocket_OnMessageCallback) (struct WebSocket *client, char *data, uint32_t length) | websocket客户端接收数据的回调函数定义。 |
| (* WebSocket_OnErrorCallback) (struct WebSocket *client, WebSocket_ErrorResult errorResult) | websocket客户端接收error错误消息的回调函数定义。 |
| (* WebSocket_OnCloseCallback) (struct WebSocket *client, WebSocket_CloseResult closeResult) | websocket客户端接收close消息的回调函数定义。 |
枚举
| 名称 | 描述 |
|---|---|
| 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错误码。 |