httpd_queue_work() function

Queue execution of a function in HTTPD's context This API queues a work function for asynchronous execution

Syntax

Show:

Summary

Declaration

Definition

from esp_http_server.h:1662

esp_err_t httpd_queue_work(httpd_handle_t handle, httpd_work_fn_t work, void *arg);

Implemented in httpd_main.c:145

Arguments

Argument

Description

handle

Handle to server returned by httpd_start

work

Pointer to the function to be executed in the HTTPD's context

arg

Pointer to the arguments that should be passed to this function

Return value

- ESP_OK : On successfully queueing the work - ESP_FAIL : Failure in ctrl socket - ESP_ERR_INVALID_ARG : Null arguments

Notes

Some protocols require that the web server generate some asynchronous data and send it to the persistently opened connection. This facility is for use by such protocols.

Examples

httpd_queue_work() is referenced by 3 libraries and example projects:

References

from examples

httpd_queue_work() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle