httpd_sess_trigger_close() function

Trigger an httpd session close externally

Syntax

Show:

Summary

Declaration

Definition

from esp_http_server.h:1577

esp_err_t httpd_sess_trigger_close(httpd_handle_t handle, int sockfd);

Implemented in httpd_sess.c:483

Arguments

Argument

Description

handle

Handle to server returned by httpd_start

sockfd

The socket descriptor of the session to be closed

Return value

- ESP_OK : On successfully initiating closure - ESP_FAIL : Failure to queue work - ESP_ERR_NOT_FOUND : Socket fd not found - ESP_ERR_INVALID_ARG : Null arguments

Notes

Calling this API is only required in special circumstances wherein some application requires to close an httpd client session asynchronously.

Examples

httpd_sess_trigger_close() is referenced by 1 libraries and example projects:

References

from examples

httpd_sess_trigger_close() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle