Symbols

loading (3/5)...

Files

loading (4/5)...

Summary Syntax Arguments References Call Tree Data Use

SourceVuESP-IDF Framework and ExamplesESP-IDFhttpd_sess_trigger_close_()

httpd_sess_trigger_close_() function

Trigger an httpd session close externally

Syntax

Show:

Summary

Declaration

Definition

from esp_httpd_priv.h:550

esp_err_t httpd_sess_trigger_close_(httpd_handle_t handle, struct sock_db *session);

Implemented in httpd_sess.c:475

Arguments

Argument

Description

handle

Handle to server returned by httpd_start

session

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.

References

Code

Location

Referrer

esp_err_t httpd_sess_trigger_close_(httpd_handle_t handle, struct sock_db *session)

httpd_sess.c:475

esp_err_t httpd_sess_trigger_close_(httpd_handle_t handle, struct sock_db *session);

esp_httpd_priv.h:550

return httpd_sess_trigger_close_(hd, context.session);

httpd_sess.c:472

httpd_sess_close_lru()

return httpd_sess_trigger_close_(handle, session);

httpd_sess.c:489

httpd_sess_trigger_close()

Call Tree

httpd_sess_trigger_close_() is called by 2 functions and calls 1 function:

httpd_sess_close_lru()

httpd_sess_trigger_close()

httpd_sess_trigger_close_()

httpd_queue_work()

Data Use

httpd_sess_trigger_close_() reads 1 variable:

httpd_sess_close()

httpd_sess_trigger_close_()

Class Tree

All items filtered out

Override Tree

All items filtered out

Implementations

All items filtered out

Instances

Lifecycle

All items filtered out