• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# WebSocket
2
3## Overview
4
5Defines the WebSocket client structure.
6
7**Since**: 11
8
9**Related module**: [netstack](capi-netstack.md)
10
11**Header file**: [net_websocket_type.h](capi-net-websocket-type-h.md)
12
13## Summary
14
15### Member Variables
16
17| Name                                                                                               | Description|
18|---------------------------------------------------------------------------------------------------| -- |
19| [WebSocket_OnOpenCallback](capi-net-websocket-type-h.md#websocket_onopencallback) onOpen          | Pointer to the callback invoked when the WebSocket client receives a connection message.|
20| [WebSocket_OnMessageCallback](capi-net-websocket-type-h.md#websocket_onmessagecallback) onMessage | Pointer to the callback invoked when the WebSocket client receives a message.|
21| [WebSocket_OnErrorCallback](capi-net-websocket-type-h.md#websocket_onerrorcallback) onError       | Pointer to the callback invoked when the WebSocket client receives an error message.|
22| [WebSocket_OnCloseCallback](capi-net-websocket-type-h.md#websocket_onclosecallback) onClose       | Pointer to the callback invoked when the WebSocket client receives a **close** message.|
23| [WebSocket_RequestOptions](capi-netstack-websocket-requestoptions.md) requestOptions              | Options of the connection request.|
24