espressif/esp-protocols
1
0
Fork 1
mirror of https://github.com/espressif/esp-protocols.git synced 2025-07-16 12:02:11 +02:00
Code Issues Packages Projects Releases Wiki Activity

ws_client: fix for not sending ping responses, updated to pass events also for PING and PONG messages, added interfaces to send both binary and text data

Browse Source 
closes https://github.com/espressif/esp-idf/issues/3982


* Original commit: espressif/esp-idf@abf9345b85
This commit is contained in:
David Cermak
2019-09-16 15:22:29 +02:00
committed by gabsuren
parent fe26b734b5
commit f55d8391c9
3 changed files with 61 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
components/esp_websocket_client/esp_websocket_client.c
View File

@ -90,6 +90,7 @@ struct esp_websocket_client {
char *rx_buffer; char *rx_buffer;
char *tx_buffer; char *tx_buffer;
int buffer_size; int buffer_size;
ws_transport_opcodes_t last_opcode;
}; };
static uint64_t _tick_get_ms(void) static uint64_t _tick_get_ms(void)
@ -106,6 +107,7 @@ static esp_err_t esp_websocket_client_dispatch_event(esp_websocket_client_handle
esp_websocket_event_data_t event_data; esp_websocket_event_data_t event_data;
event_data.data_ptr = data; event_data.data_ptr = data;
event_data.data_len = data_len; event_data.data_len = data_len;
event_data.op_code = client->last_opcode;
if ((err = esp_event_post_to(client->event_handle, if ((err = esp_event_post_to(client->event_handle,
WEBSOCKET_EVENTS, event, WEBSOCKET_EVENTS, event,
@ -474,7 +476,7 @@ static void esp_websocket_client_task(void *pv)
if (_tick_get_ms() - client->ping_tick_ms > WEBSOCKET_PING_TIMEOUT_MS) { if (_tick_get_ms() - client->ping_tick_ms > WEBSOCKET_PING_TIMEOUT_MS) {
client->ping_tick_ms = _tick_get_ms(); client->ping_tick_ms = _tick_get_ms();
// Send PING // Send PING
esp_transport_write(client->transport, NULL, 0, client->config->network_timeout_ms); esp_transport_ws_send_raw(client->transport, WS_TRANSPORT_OPCODES_PING, NULL, 0, client->config->network_timeout_ms);
} }
if (read_select == 0) { if (read_select == 0) {
ESP_LOGD(TAG, "Timeout..."); ESP_LOGD(TAG, "Timeout...");
@ -488,8 +490,15 @@ static void esp_websocket_client_task(void *pv)
esp_websocket_client_abort_connection(client); esp_websocket_client_abort_connection(client);
break; break;
} }
if (rlen > 0) { if (rlen >= 0) {
client->last_opcode = esp_transport_ws_get_read_opcode(client->transport);
esp_websocket_client_dispatch_event(client, WEBSOCKET_EVENT_DATA, client->rx_buffer, rlen); esp_websocket_client_dispatch_event(client, WEBSOCKET_EVENT_DATA, client->rx_buffer, rlen);
// if a PING message received -> send out the PONG
if (client->last_opcode == WS_TRANSPORT_OPCODES_PING) {
const char *data = (rlen == 0) ? NULL : client->rx_buffer;
esp_transport_ws_send_raw(client->transport, WS_TRANSPORT_OPCODES_PONG, data, rlen,
client->config->network_timeout_ms);
}
} }
break; break;
case WEBSOCKET_STATE_WAIT_TIMEOUT: case WEBSOCKET_STATE_WAIT_TIMEOUT:
@ -546,7 +555,24 @@ esp_err_t esp_websocket_client_stop(esp_websocket_client_handle_t client)
return ESP_OK; return ESP_OK;
} }
static int esp_websocket_client_send_with_opcode(esp_websocket_client_handle_t client, ws_transport_opcodes_t opcode, const char *data, int len, TickType_t timeout);
int esp_websocket_client_send_text(esp_websocket_client_handle_t client, const char *data, int len, TickType_t timeout)
{
return esp_websocket_client_send_with_opcode(client, WS_TRANSPORT_OPCODES_TEXT, data, len, timeout);
}
int esp_websocket_client_send(esp_websocket_client_handle_t client, const char *data, int len, TickType_t timeout) int esp_websocket_client_send(esp_websocket_client_handle_t client, const char *data, int len, TickType_t timeout)
{
return esp_websocket_client_send_with_opcode(client, WS_TRANSPORT_OPCODES_BINARY, data, len, timeout);
}
int esp_websocket_client_send_bin(esp_websocket_client_handle_t client, const char *data, int len, TickType_t timeout)
{
return esp_websocket_client_send_with_opcode(client, WS_TRANSPORT_OPCODES_BINARY, data, len, timeout);
}
static int esp_websocket_client_send_with_opcode(esp_websocket_client_handle_t client, ws_transport_opcodes_t opcode, const char *data, int len, TickType_t timeout)
{ {
int need_write = len; int need_write = len;
int wlen = 0, widx = 0; int wlen = 0, widx = 0;
@ -575,10 +601,8 @@ int esp_websocket_client_send(esp_websocket_client_handle_t client, const char *
need_write = client->buffer_size; need_write = client->buffer_size;
} }
memcpy(client->tx_buffer, data + widx, need_write); memcpy(client->tx_buffer, data + widx, need_write);
wlen = esp_transport_write(client->transport, // send with ws specific way and specific opcode
(char *)client->tx_buffer, wlen = esp_transport_ws_send_raw(client->transport, opcode, (char *)client->tx_buffer, need_write, timeout);
need_write,
client->config->network_timeout_ms);
if (wlen <= 0) { if (wlen <= 0) {
xSemaphoreGive(client->lock); xSemaphoreGive(client->lock);
return wlen; return wlen;

32
components/esp_websocket_client/include/esp_websocket_client.h
View File

@ -49,6 +49,7 @@ typedef enum {
typedef struct { typedef struct {
const char *data_ptr; /*!< Data pointer */ const char *data_ptr; /*!< Data pointer */
int data_len; /*!< Data length */ int data_len; /*!< Data length */
uint8_t op_code; /*!< Received opcode */
} esp_websocket_event_data_t; } esp_websocket_event_data_t;
/** /**
@ -72,7 +73,6 @@ typedef struct {
} esp_websocket_event_t; } esp_websocket_event_t;
typedef esp_websocket_event_t* esp_websocket_event_handle_t; typedef esp_websocket_event_t* esp_websocket_event_handle_t;
typedef esp_err_t (* websocket_event_callback_t)(esp_websocket_event_handle_t event);
/** /**
* @brief Websocket client setup configuration * @brief Websocket client setup configuration
@ -150,7 +150,7 @@ esp_err_t esp_websocket_client_stop(esp_websocket_client_handle_t client);
esp_err_t esp_websocket_client_destroy(esp_websocket_client_handle_t client); esp_err_t esp_websocket_client_destroy(esp_websocket_client_handle_t client);
/** /**
* @brief Write data to the WebSocket connection * @brief Generic write data to the WebSocket connection; defaults to binary send
* *
* @param[in] client The client * @param[in] client The client
* @param[in] data The data * @param[in] data The data
@ -163,6 +163,34 @@ esp_err_t esp_websocket_client_destroy(esp_websocket_client_handle_t client);
*/ */
int esp_websocket_client_send(esp_websocket_client_handle_t client, const char *data, int len, TickType_t timeout); int esp_websocket_client_send(esp_websocket_client_handle_t client, const char *data, int len, TickType_t timeout);
/**
* @brief Write binary data to the WebSocket connection (data send with WS OPCODE=02, i.e. binary)
*
* @param[in] client The client
* @param[in] data The data
* @param[in] len The length
* @param[in] timeout Write data timeout
*
* @return
* - Number of data was sent
* - (-1) if any errors
*/
int esp_websocket_client_send_bin(esp_websocket_client_handle_t client, const char *data, int len, TickType_t timeout);
/**
* @brief Write textual data to the WebSocket connection (data send with WS OPCODE=01, i.e. text)
*
* @param[in] client The client
* @param[in] data The data
* @param[in] len The length
* @param[in] timeout Write data timeout
*
* @return
* - Number of data was sent
* - (-1) if any errors
*/
int esp_websocket_client_send_text(esp_websocket_client_handle_t client, const char *data, int len, TickType_t timeout);
/** /**
* @brief Check the WebSocket connection status * @brief Check the WebSocket connection status
* *

1
examples/protocols/websocket/main/websocket_example.c
View File

@ -44,6 +44,7 @@ static void websocket_event_handler(void *handler_args, esp_event_base_t base, i
case WEBSOCKET_EVENT_DATA: case WEBSOCKET_EVENT_DATA:
ESP_LOGI(TAG, "WEBSOCKET_EVENT_DATA"); ESP_LOGI(TAG, "WEBSOCKET_EVENT_DATA");
ESP_LOGI(TAG, "Received opcode=%d", data->op_code);
ESP_LOGW(TAG, "Received=%.*s\r\n", data->data_len, (char*)data->data_ptr); ESP_LOGW(TAG, "Received=%.*s\r\n", data->data_len, (char*)data->data_ptr);
break; break;
case WEBSOCKET_EVENT_ERROR: case WEBSOCKET_EVENT_ERROR: