Constants#
This section provides a reference to the WebSocket Client API constants.
Enumerations#
WebSocket opcodes for different frame types.
Error codes for WebSocket operations.
WebSocket connection states.
Macros#
Final frame bit.
Websocket max host length.
Websocket max resource length.
Enumeration Documentation#
sl_websocket_opcode_t#
sl_websocket_opcode_t
WebSocket opcodes for different frame types.
This enumeration defines the opcodes used in WebSocket frames to indicate the type of frame being sent or received.
| Enumerator | |
|---|---|
| SL_WEBSOCKET_OPCODE_CONTINUE | Continuation frame. |
| SL_WEBSOCKET_OPCODE_TEXT | Text frame. |
| SL_WEBSOCKET_OPCODE_BINARY | Binary frame. |
| SL_WEBSOCKET_OPCODE_CLOSE | Connection close frame. |
| SL_WEBSOCKET_OPCODE_PING | Ping frame. |
| SL_WEBSOCKET_OPCODE_PONG | Pong frame. |
37 of file components/service/sl_websocket_client/inc/sl_websocket_client_types.hsl_websocket_error_t#
sl_websocket_error_t
Error codes for WebSocket operations.
This enumeration defines the error codes that can be returned by WebSocket operations to indicate the result of the operation.
| Enumerator | |
|---|---|
| SL_WEBSOCKET_SUCCESS | Operation successful. |
| SL_WEBSOCKET_ERR_SOCKET_CREATION | Error creating socket. |
| SL_WEBSOCKET_ERR_SOCKET_BIND | Error binding socket. |
| SL_WEBSOCKET_ERR_SOCKET_CONNECT | Error connecting socket. |
| SL_WEBSOCKET_ERR_SEND_FRAME | Error sending frame. |
| SL_WEBSOCKET_ERR_RECEIVE_FRAME | Error receiving frame. |
| SL_WEBSOCKET_ERR_CLOSE_FRAME | Error closing frame. |
| SL_WEBSOCKET_ERR_SSL_SETSOCKOPT | Error setting socket options for SSL. |
| SL_WEBSOCKET_ERR_INVALID_PARAMETER | Invalid input parameter. |
51 of file components/service/sl_websocket_client/inc/sl_websocket_client_types.hsl_websocket_state_t#
sl_websocket_state_t
WebSocket connection states.
This enumeration defines the possible states of a WebSocket connection.
| Enumerator | |
|---|---|
| SL_WEBSOCKET_STATE_DISCONNECTED | The WebSocket client is not connected to the server. |
| SL_WEBSOCKET_STATE_CONNECTING | The WebSocket client is in the process of establishing a connection to the server. |
| SL_WEBSOCKET_STATE_CONNECTED | The WebSocket client is successfully connected to the server. |
| SL_WEBSOCKET_STATE_CLOSING | The WebSocket client is in the process of closing the connection. |
| SL_WEBSOCKET_STATE_CLOSED | The WebSocket connection has been closed. |
68 of file components/service/sl_websocket_client/inc/sl_websocket_client_types.hMacro Definition Documentation#
SL_WEBSOCKET_FIN_BIT#
#define SL_WEBSOCKET_FIN_BITValue:
0x80
Final frame bit.
Not to be configured by the user.
21 of file components/service/sl_websocket_client/inc/sl_websocket_client_types.hSL_SI91X_WEBSOCKET_MAX_HOST_LENGTH#
#define SL_SI91X_WEBSOCKET_MAX_HOST_LENGTHValue:
51
Websocket max host length.
Not to be configured by the user.
23 of file components/service/sl_websocket_client/inc/sl_websocket_client_types.hSL_SI91X_WEBSOCKET_MAX_RESOURCE_LENGTH#
#define SL_SI91X_WEBSOCKET_MAX_RESOURCE_LENGTHValue:
51
Websocket max resource length.
Not to be configured by the user.
25 of file components/service/sl_websocket_client/inc/sl_websocket_client_types.h