httpd_get_client_list() function

Returns list of current socket descriptors of active sessions

Syntax

Show:

Summary

Declaration

Definition

from esp_http_server.h:1625

esp_err_t httpd_get_client_list(httpd_handle_t handle, size_t *fds, int *client_fds);

Implemented in httpd_main.c:177

Arguments

Argument

Description

handle

Handle to server returned by httpd_start

fds

In: Size of provided client_fds array Out: Number of valid client fds returned in client_fds,

client_fds

Array of client fds

Return value

- ESP_OK : Successfully retrieved session list - ESP_ERR_INVALID_ARG : Wrong arguments or list is longer than provided array

Notes

Size of provided array has to be equal or greater then maximum number of opened sockets, configured upon initialization with max_open_sockets field in httpd_config_t structure.

Examples

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

References

from examples

httpd_get_client_list() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle