httpd_ws_send_frame_async() function

Low level send of a WebSocket frame out of the scope of current request using internally configured httpd send function This API should rarely be called directly, with an exception of asynchronous send using httpd_queue_work.

Syntax

Show:

Summary

Declaration

Definition

from esp_http_server.h:1764

esp_err_t httpd_ws_send_frame_async(httpd_handle_t hd, int fd, httpd_ws_frame_t *frame);

Implemented in httpd_ws.c:375

Arguments

Argument

Description

Server instance data

Socket descriptor for sending data

frame

WebSocket frame

Return value

- ESP_OK : On successful - ESP_FAIL : When socket errors occurs - ESP_ERR_INVALID_STATE : Handshake was already done beforehand - ESP_ERR_INVALID_ARG : Argument is invalid (null or non-WebSocket)

Examples

httpd_ws_send_frame_async() is referenced by 2 libraries and example projects:

References

from examples

httpd_ws_send_frame_async() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle