alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-08 04:02:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

esp_http_server: Add Websocket API to return list of active clients

Browse Source 
Closes https://github.com/espressif/esp-idf/issues/5406
This commit is contained in:
David Cermak
2020-08-28 17:12:11 +02:00
parent d3801be6d9
commit fbf2680427
4 changed files with 60 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
components/esp_http_server/include/esp_http_server.h
View File

@@ -409,6 +409,14 @@ typedef struct httpd_uri {
#endif
} httpd_uri_t;
/**
* @brief Structure for holding list of clients
*/
typedef struct httpd_client_list {
size_t active_clients; /*!< number of active clients in this struct */
int client_fds[]; /*!< array of file descriptors of all active clients */
} httpd_client_list_t;
/**
* @brief Registers a URI handler
*
@@ -1466,6 +1474,19 @@ esp_err_t httpd_sess_trigger_close(httpd_handle_t handle, int sockfd);
*/
esp_err_t httpd_sess_update_lru_counter(httpd_handle_t handle, int sockfd);
/**
* @brief Returns list of current socket descriptors of active sessions
*
* @param[in] handle Handle to server returned by httpd_start
* @param[in] max_fds Maximum number of socket fds the supplied list could hold
* @param[out] fd_list Structure holding socket descriptors
*
* @return
* - ESP_OK : Successfully retrieved session list
* - ESP_ERR_INVALID_ARG : Wrong arguments or list is longer than maximum
*/
esp_err_t httpd_get_client_list(httpd_handle_t handle, size_t max_fds, httpd_client_list_t *fd_list);
/** End of Session
* @}
*/
@@ -1526,6 +1547,15 @@ typedef enum {
HTTPD_WS_TYPE_PONG = 0xA
} httpd_ws_type_t;
/**
* @brief Enum for client info description
*/
typedef enum {
HTTPD_WS_CLIENT_INVALID = 0x0,
HTTPD_WS_CLIENT_HTTP = 0x1,
HTTPD_WS_CLIENT_WEBSOCKET = 0x2,
} httpd_ws_client_info_t;
/**
* @brief WebSocket frame format
*/
@@ -1593,11 +1623,11 @@ esp_err_t httpd_ws_send_frame_async(httpd_handle_t hd, int fd, httpd_ws_frame_t
* @param[in] hd Server instance data
* @param[in] fd Socket descriptor
* @return
* - -1 : This fd is not a client of this httpd
* - 0 : This fd is an active client, protocol is not WS
* - 1 : This fd is an active client, protocol is WS
* - 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
*/
int httpd_ws_get_fd_info(httpd_handle_t hd, int fd)
httpd_ws_client_info_t httpd_ws_get_fd_info(httpd_handle_t hd, int fd);
#endif /* CONFIG_HTTPD_WS_SUPPORT */
/** End of WebSocket related stuff