Can we describe the behavior of disconnect/autoreconnect and according action

[ScreamZ]

Hi,

I would be pleased to improve the documentation on various points about connection stability if you could anyone help me with the investigation.

Once the first authentication has been done we set autoReconnectInterval which is by default 500ms.

1 - What happens if we use webSocket.sendTXT if the client is disconnected? Does it crash, enqueue, ignore ?

It seems that it returns false nothing gets queued, but there is no crash. Is that right?

arduinoWebSockets/src/WebSocketsClient.cpp

Lines 303 to 311 in 30d5e13

	bool WebSocketsClient::sendTXT(uint8_t * payload, size_t length, bool headerToPayload) {
	if(length == 0) {
	length = strlen((const char *)payload);
	}
	if(clientIsConnected(&_client)) {
	return sendFrame(&_client, WSop_text, payload, length, true, headerToPayload);
	}
	return false;
	}

2 - is webSocket.onEvent called by webSocket.loop and therefore it's blocking the loop while loading

[Links2004]

Hi,
more documentation is very welcome.

1. you are correct, no queued, and the return value indecates if somthing is send.
2. yes webSocket.loop is calling webSocket.onEvent (unless tcp async is used)

the call stack look like this:

arduinoWebSockets/src/WebSocketsClient.h

Lines 162 to 166 in 30d5e13

	virtual void runCbEvent(WStype_t type, uint8_t * payload, size_t length) {
	if(_cbEvent) {
	_cbEvent(type, payload, length);
	}
	}

arduinoWebSockets/src/WebSocketsClient.cpp

Lines 467 to 469 in 30d5e13

	runCbEvent(type, payload, length);
	}

arduinoWebSockets/src/WebSockets.cpp

Line 468 in 30d5e13

void WebSockets::handleWebsocketPayloadCb(WSclient_t * client, bool ok, uint8_t * payload) {

arduinoWebSockets/src/WebSockets.cpp

Lines 462 to 465 in 30d5e13

	readCb(client, payload, header->payloadLen, std::bind(&WebSockets::handleWebsocketPayloadCb, this, std::placeholders::_1, std::placeholders::_2, payload));
	} else {
	handleWebsocketPayloadCb(client, true, NULL);
	}

arduinoWebSockets/src/WebSockets.cpp

Line 341 in 30d5e13

void WebSockets::handleWebsocket(WSclient_t * client) {

arduinoWebSockets/src/WebSocketsClient.cpp

Line 558 in 30d5e13

void WebSocketsClient::handleClientData(void) {

arduinoWebSockets/src/WebSocketsClient.cpp

Line 202 in 30d5e13

void WebSocketsClient::loop(void) {

[ScreamZ]

Alright, I'll work on some documentation. I'll also link issues here as long as I find some.

• Disconnection detection issue #864 (comment)

I'll write in doc for now that this is safe to just call websocket.loop() in the loop. As the send method is only doing a skip and false.

Also, the user can implement queuing on its own if desired.

Here is my current implementation of sending, which just skip with a message printed.

void serializeAndSend(WebSocketsClient &webSocket, const JsonDocument &document)
{
  // Serialize the JSON document to a String
  String jsonString;
  serializeJson(document, jsonString);

  // Send the JSON message to the WebSocket server
#ifdef DEBUG
  const bool isSent = webSocket.sendTXT(jsonString);

  Serial.print("📥 OUT - ");
  if (isSent)
    Serial.println(jsonString);
  else
    Serial.println("Not connected… Skipped!");
#else
  webSocket.sendTXT(jsonString);
#endif
}