Symbols

loading (1/5)...

Files

loading (4/5)...

Summary Syntax Arguments Examples References Call Tree Data Use

SourceVuESP-IDF Framework and ExamplesESP-IDFhttpd_ws_get_fd_info()

httpd_ws_get_fd_info() function

Checks the supplied socket descriptor if it belongs to any active client of this server instance and if the websoket protocol is active

Syntax

Show:

Summary

Declaration

Definition

from esp_http_server.h:1777

httpd_ws_client_info_t httpd_ws_get_fd_info(httpd_handle_t hd, int fd);

Implemented in httpd_ws.c:519

Arguments

Argument

Description

Server instance data

Socket descriptor

Return value

- HTTPD_WS_CLIENT_INVALID : This fd is not a client of this httpd - HTTPD_WS_CLIENT_HTTP : This fd is an active client, protocol is not WS - HTTPD_WS_CLIENT_WEBSOCKET : This fd is an active client, protocol is WS

Examples

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

wss_server sample

References

from 0/1 examples

Code

Location

httpd_ws_client_info_t httpd_ws_get_fd_info(httpd_handle_t hd, int fd)

httpd_ws.c:519

httpd_ws_client_info_t httpd_ws_get_fd_info(httpd_handle_t hd, int fd);

esp_http_server.h:1777

Call Tree

from 0/1 examples

httpd_ws_get_fd_info() calls 1 function:

httpd_ws_get_fd_info()

httpd_sess_get()

Data Use

from 0/1 examples

httpd_ws_get_fd_info() reads 5 variables:

httpd_ws_client_info_t::HTTPD_WS_CLIENT_INVALID

httpd_ws_client_info_t::HTTPD_WS_CLIENT_HTTP

httpd_ws_client_info_t::HTTPD_WS_CLIENT_WEBSOCKET

sock_db::ws_handshake_done

sock_db::ws_close

httpd_ws_get_fd_info()

Class Tree

from 0/1 examples

All items filtered out

Override Tree

from 0/1 examples

All items filtered out

Implementations

from 0/1 examples

All items filtered out

Instances

from 0/1 examples

Lifecycle

from 0/1 examples

All items filtered out