mirror of
https://github.com/espressif/esp-idf.git
synced 2025-11-03 22:08:28 +00:00
76ca826758
Added a new https server example with WS support which runs * keep-alive thread to send PINGs to clients * async message to all active WS clients Moved the existing https-server example to a subfolder Closes https://github.com/espressif/esp-idf/issues/5733 Closes https://github.com/espressif/esp-idf/issues/5686
97 lines
3.1 KiB
C
97 lines
3.1 KiB
C
/* Keep Alive engine for wss server example
|
|
|
|
This example code is in the Public Domain (or CC0 licensed, at your option.)
|
|
|
|
Unless required by applicable law or agreed to in writing, this
|
|
software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
|
|
CONDITIONS OF ANY KIND, either express or implied.
|
|
*/
|
|
#pragma once
|
|
|
|
#define KEEP_ALIVE_CONFIG_DEFAULT() \
|
|
{ \
|
|
.max_clients = 10, \
|
|
.task_stack_size = 2048, \
|
|
.task_prio = tskIDLE_PRIORITY+1, \
|
|
.keep_alive_period_ms = 5000, \
|
|
.not_alive_after_ms = 10000, \
|
|
}
|
|
|
|
struct wss_keep_alive_storage;
|
|
typedef struct wss_keep_alive_storage* wss_keep_alive_t;
|
|
typedef bool (*wss_check_client_alive_cb_t)(wss_keep_alive_t h, int fd);
|
|
typedef bool (*wss_client_not_alive_cb_t)(wss_keep_alive_t h, int fd);
|
|
|
|
/**
|
|
* @brief Confiuration struct
|
|
*/
|
|
typedef struct {
|
|
size_t max_clients; /*!< max number of clients */
|
|
size_t task_stack_size; /*!< stack size of the created task */
|
|
size_t task_prio; /*!< priority of the created task */
|
|
size_t keep_alive_period_ms; /*!< check every client after this time */
|
|
size_t not_alive_after_ms; /*!< consider client not alive after this time */
|
|
wss_check_client_alive_cb_t check_client_alive_cb; /*!< callback function to check if client is alive */
|
|
wss_client_not_alive_cb_t client_not_alive_cb; /*!< callback function to notify that the client is not alive */
|
|
void *user_ctx; /*!< user context available in the keep-alive handle */
|
|
} wss_keep_alive_config_t;
|
|
|
|
/**
|
|
* @brief Adds a new client to internal set of clients to keep an eye on
|
|
*
|
|
* @param h keep-alive handle
|
|
* @param fd socket file descriptor for this client
|
|
* @return ESP_OK on success
|
|
*/
|
|
esp_err_t wss_keep_alive_add_client(wss_keep_alive_t h, int fd);
|
|
|
|
/**
|
|
* @brief Removes this client from the set
|
|
*
|
|
* @param h keep-alive handle
|
|
* @param fd socket file descriptor for this client
|
|
* @return ESP_OK on success
|
|
*/
|
|
esp_err_t wss_keep_alive_remove_client(wss_keep_alive_t h, int fd);
|
|
|
|
/**
|
|
* @brief Notify that this client is alive
|
|
*
|
|
* @param h keep-alive handle
|
|
* @param fd socket file descriptor for this client
|
|
* @return ESP_OK on success
|
|
*/
|
|
|
|
esp_err_t wss_keep_alive_client_is_active(wss_keep_alive_t h, int fd);
|
|
|
|
/**
|
|
* @brief Starts keep-alive engine
|
|
*
|
|
* @param config keep-alive configuration
|
|
* @return keep alive handle
|
|
*/
|
|
wss_keep_alive_t wss_keep_alive_start(wss_keep_alive_config_t *config);
|
|
|
|
/**
|
|
* @brief Stops keep-alive engine
|
|
*
|
|
* @param h keep-alive handle
|
|
*/
|
|
void wss_keep_alive_stop(wss_keep_alive_t h);
|
|
|
|
/**
|
|
* @brief Sets user defined context
|
|
*
|
|
* @param h keep-alive handle
|
|
* @param ctx user context
|
|
*/
|
|
void wss_keep_alive_set_user_ctx(wss_keep_alive_t h, void *ctx);
|
|
|
|
/**
|
|
* @brief Gets user defined context
|
|
*
|
|
* @param h keep-alive handle
|
|
* @return ctx user context
|
|
*/
|
|
void* wss_keep_alive_get_user_ctx(wss_keep_alive_t h);
|