Rename _lock to _queue_lock for clarity and fixed the wrong usage of _queue_lock

_queue_lock is a lock guarding the queues and should not be used to guard the internal client pointer

Author: mathieucarbou

src/AsyncWebSocket.cpp

@@ -297,7 +297,7 @@ AsyncWebSocketClient::AsyncWebSocketClient(AsyncClient *client, AsyncWebSocket *
 
 AsyncWebSocketClient::~AsyncWebSocketClient() {
   {
-    asyncsrv::lock_guard_type lock(_lock);
+    asyncsrv::lock_guard_type lock(_queue_lock);
     _messageQueue.clear();
     _controlQueue.clear();
   }
@@ -313,7 +313,7 @@ void AsyncWebSocketClient::_clearQueue() {
 void AsyncWebSocketClient::_onAck(size_t len, uint32_t time) {
   _lastMessageTime = millis();
 
-  asyncsrv::unique_lock_type lock(_lock);
+  asyncsrv::unique_lock_type lock(_queue_lock);
 
   async_ws_log_v("[%s][%" PRIu32 "] START ACK(%u, %" PRIu32 ") Q:%u", _server->url(), _clientId, len, time, _messageQueue.size());
 
@@ -357,7 +357,7 @@ void AsyncWebSocketClient::_onAck(size_t len, uint32_t time) {
 }
 
 void AsyncWebSocketClient::_onPoll() {
-  asyncsrv::unique_lock_type lock(_lock);
+  asyncsrv::unique_lock_type lock(_queue_lock);
 
   if (!_client) {
     return;
@@ -430,22 +430,22 @@ void AsyncWebSocketClient::_runQueue() {
 }
 
 bool AsyncWebSocketClient::queueIsFull() const {
-  asyncsrv::lock_guard_type lock(_lock);
+  asyncsrv::lock_guard_type lock(_queue_lock);
   return (_messageQueue.size() >= WS_MAX_QUEUED_MESSAGES) || (_status != WS_CONNECTED);
 }
 
 size_t AsyncWebSocketClient::queueLen() const {
-  asyncsrv::lock_guard_type lock(_lock);
+  asyncsrv::lock_guard_type lock(_queue_lock);
   return _messageQueue.size();
 }
 
 bool AsyncWebSocketClient::canSend() const {
-  asyncsrv::lock_guard_type lock(_lock);
+  asyncsrv::lock_guard_type lock(_queue_lock);
   return _messageQueue.size() < WS_MAX_QUEUED_MESSAGES;
 }
 
 bool AsyncWebSocketClient::_queueControl(uint8_t opcode, const uint8_t *data, size_t len, bool mask) {
-  asyncsrv::lock_guard_type lock(_lock);
+  asyncsrv::lock_guard_type lock(_queue_lock);
 
   if (!_client) {
     return false;
@@ -462,7 +462,7 @@ bool AsyncWebSocketClient::_queueControl(uint8_t opcode, const uint8_t *data, si
 }
 
 bool AsyncWebSocketClient::_queueMessage(AsyncWebSocketSharedBuffer buffer, uint8_t opcode, bool mask) {
-  asyncsrv::unique_lock_type lock(_lock);
+  asyncsrv::unique_lock_type lock(_queue_lock);
 
   if (!_client || !buffer || buffer->empty() || _status != WS_CONNECTED) {
     return false;
@@ -546,7 +546,6 @@ void AsyncWebSocketClient::_onError(int8_t err) {
 }
 
 void AsyncWebSocketClient::_onTimeout(uint32_t time) {
-  asyncsrv::lock_guard_type lock(_lock);
   if (!_client) {
     return;
   }
@@ -555,7 +554,6 @@ void AsyncWebSocketClient::_onTimeout(uint32_t time) {
 }
 
 void AsyncWebSocketClient::_onDisconnect() {
-  asyncsrv::lock_guard_type lock(_lock);
   async_ws_log_v("[%s][%" PRIu32 "] DISCONNECT", _server->url(), _clientId);
   _status = WS_DISCONNECTED;
   _client = nullptr;
@@ -951,22 +949,16 @@ bool AsyncWebSocketClient::binary(const __FlashStringHelper *data, size_t len) {
 #endif
 
 IPAddress AsyncWebSocketClient::remoteIP() const {
-  asyncsrv::lock_guard_type lock(_lock);
-
   if (!_client) {
     return IPAddress((uint32_t)0U);
   }
-
   return _client->remoteIP();
 }
 
 uint16_t AsyncWebSocketClient::remotePort() const {
-  asyncsrv::lock_guard_type lock(_lock);
-
   if (!_client) {
     return 0;
   }
-
   return _client->remotePort();
 }
 

src/AsyncWebSocket.h

@@ -222,7 +222,7 @@ class AsyncWebSocketClient {
   uint8_t _pstate;
   uint32_t _lastMessageTime;
   uint32_t _keepAlivePeriod;
-  mutable asyncsrv::mutex_type _lock;
+  mutable asyncsrv::mutex_type _queue_lock;
   std::deque<AsyncWebSocketControl> _controlQueue;
   std::deque<AsyncWebSocketMessage> _messageQueue;
   bool closeWhenFull = true;
@@ -303,7 +303,6 @@ class AsyncWebSocketClient {
   uint16_t remotePort() const;
 
   bool shouldBeDeleted() const {
-    asyncsrv::lock_guard_type lock(_lock);
     return !_client;
   }
 
@@ -371,7 +370,7 @@ class AsyncWebSocket : public AsyncWebHandler {
   AwsEventHandler _eventHandler;
   AwsHandshakeHandler _handshakeHandler;
   bool _enabled;
-  mutable asyncsrv::mutex_type _lock;
+  mutable asyncsrv::mutex_type _ws_clients_lock;
 
 public:
   typedef enum {