Chapter 2. API Reference
• [in] client: The client
• [in] timeout: Timeout in RTOS ticks for waiting
esp_err_t esp_websocket_client_close_with_code(esp_websocket_client_handle_t client, int
code, const char *data, int len, Tick-
Type_t timeout)
Close the WebSocket connection in a clean way with custom code/data Closing sequence is the same as for
esp_websocket_client_close()
Notes:
• Cannot be called from the websocket event handler
Return esp_err_t
Parameters
• [in] client: The client
• [in] code: Close status code as defined in RFC6455 section-7.4
• [in] data: Additional data to closing message
• [in] len: The length of the additional data
• [in] timeout: Timeout in RTOS ticks for waiting
bool esp_websocket_client_is_connected(esp_websocket_client_handle_t client)
Check the WebSocket client connection state.
Return
• true
• false
Parameters
• [in] client: The client handle
esp_err_t esp_websocket_register_events(esp_websocket_client_handle_t client,
esp_websocket_event_id_t event, esp_event_handler_t
event_handler, void *event_handler_arg)
Register the Websocket Events.
Return esp_err_t
Parameters
• client: The client handle
• event: The event id
• event_handler: The callback function
• event_handler_arg: User context
Structures
struct esp_websocket_event_data_t
Websocket event data.
Public Members
const char *data_ptr
Data pointer
int data_len
Data length
uint8_t op_code
Received opcode
esp_websocket_client_handle_t client
esp_websocket_client_handle_t context
void *user_context
user_data context, from esp_websocket_client_config_t user_data
Espressif Systems 646
Submit Document Feedback
Release v4.4
To Next Page
Loading...