Merge pull request #690 from SignalK/rename_wsclient

Breaking change: rename WSClient to SKWSClient
SignalK · Apr 16, 2024 · 8672fa2 · 8672fa2
2 parents aa8a343 + faea9b3
commit 8672fa2
Show file tree

Hide file tree

Showing 11 changed files with 109 additions and 109 deletions.
diff --git a/examples/freertos_tasks.cpp b/examples/freertos_tasks.cpp
@@ -7,7 +7,7 @@
 #include "sensesp/net/discovery.h"
 #include "sensesp/net/http_server.h"
 #include "sensesp/net/networking.h"
-#include "sensesp/net/ws_client.h"
+#include "sensesp/signalk/signalk_ws_client.h"
 #include "sensesp/sensors/digital_input.h"
 #include "sensesp/signalk/signalk_delta_queue.h"
 #include "sensesp/signalk/signalk_output.h"
@@ -50,10 +50,10 @@ void setup() {
   auto sk_delta_queue_ = new SKDeltaQueue();
 
   // create the websocket client
-  auto ws_client_ = new WSClient("/system/sk", sk_delta_queue_, "", 0);
+  auto ws_client_ = new SKWSClient("/system/sk", sk_delta_queue_, "", 0);
 
-  ws_client_->connect_to(new LambdaConsumer<WSConnectionState>(
-      [](WSConnectionState input) { debugD("WSConnectionState: %d", input); }));
+  ws_client_->connect_to(new LambdaConsumer<SKWSConnectionState>(
+      [](SKWSConnectionState input) { debugD("SKWSConnectionState: %d", input); }));
 
   // create the MDNS discovery object
   auto mdns_discovery_ = new MDNSDiscovery();

diff --git a/src/sensesp/controllers/system_status_controller.cpp b/src/sensesp/controllers/system_status_controller.cpp
@@ -15,33 +15,33 @@ void SystemStatusController::set(WiFiState new_value,
       break;
     case WiFiState::kWifiConnectedToAP:
     case WiFiState::kWifiAPModeActivated:
-      this->update_state(SystemStatus::kWSDisconnected);
+      this->update_state(SystemStatus::kSKWSDisconnected);
       break;
     case WiFiState::kWifiManagerActivated:
       this->update_state(SystemStatus::kWifiManagerActivated);
       break;
   }
 }
 
-void SystemStatusController::set(WSConnectionState new_value,
+void SystemStatusController::set(SKWSConnectionState new_value,
                                        uint8_t input_channel) {
   switch (new_value) {
-    case WSConnectionState::kWSDisconnected:
+    case SKWSConnectionState::kSKWSDisconnected:
       if (current_state_ != SystemStatus::kWifiDisconnected &&
           current_state_ != SystemStatus::kWifiNoAP &&
           current_state_ != SystemStatus::kWifiManagerActivated) {
         // Wifi disconnection states override the higher level protocol state
-        this->update_state(SystemStatus::kWSDisconnected);
+        this->update_state(SystemStatus::kSKWSDisconnected);
       }
       break;
-    case WSConnectionState::kWSConnecting:
-      this->update_state(SystemStatus::kWSConnecting);
+    case SKWSConnectionState::kSKWSConnecting:
+      this->update_state(SystemStatus::kSKWSConnecting);
       break;
-    case WSConnectionState::kWSAuthorizing:
-      this->update_state(SystemStatus::kWSAuthorizing);
+    case SKWSConnectionState::kSKWSAuthorizing:
+      this->update_state(SystemStatus::kSKWSAuthorizing);
       break;
-    case WSConnectionState::kWSConnected:
-      this->update_state(SystemStatus::kWSConnected);
+    case SKWSConnectionState::kSKWSConnected:
+      this->update_state(SystemStatus::kSKWSConnected);
       break;
   }
 }

diff --git a/src/sensesp/controllers/system_status_controller.h b/src/sensesp/controllers/system_status_controller.h
@@ -2,7 +2,7 @@
 #define _SYSTEM_STATUS_CONTROLLER_H_
 
 #include "sensesp/net/networking.h"
-#include "sensesp/net/ws_client.h"
+#include "sensesp/signalk/signalk_ws_client.h"
 #include "sensesp/system/valueproducer.h"
 
 namespace sensesp {
@@ -11,10 +11,10 @@ enum class SystemStatus {
   kWifiNoAP = 100,
   kWifiDisconnected,
   kWifiManagerActivated,
-  kWSDisconnected,
-  kWSAuthorizing,
-  kWSConnecting,
-  kWSConnected
+  kSKWSDisconnected,
+  kSKWSAuthorizing,
+  kSKWSConnecting,
+  kSKWSConnected
 };
 
 /**
@@ -25,7 +25,7 @@ enum class SystemStatus {
  * an event occurs.
  */
 class SystemStatusController : public ValueConsumer<WiFiState>,
-                               public ValueConsumer<WSConnectionState>,
+                               public ValueConsumer<SKWSConnectionState>,
                                public ValueProducer<SystemStatus> {
  public:
   SystemStatusController() {}
@@ -34,9 +34,9 @@ class SystemStatusController : public ValueConsumer<WiFiState>,
   /// state updates)
   virtual void set(WiFiState new_value,
                          uint8_t input_channel = 0) override;
-  /// ValueConsumer interface for ValueConsumer<WSConnectionState>
-  /// (WSClient object state updates)
-  virtual void set(WSConnectionState new_value,
+  /// ValueConsumer interface for ValueConsumer<SKWSConnectionState>
+  /// (SKWSClient object state updates)
+  virtual void set(SKWSConnectionState new_value,
                          uint8_t input_channel = 0) override;
 
  protected:

diff --git a/src/sensesp/signalk/signalk_delta_queue.h b/src/sensesp/signalk/signalk_delta_queue.h
@@ -11,7 +11,7 @@ namespace sensesp {
  * @brief Signal K delta queue
  *
  * This class implements a Signal K delta queue. There should be a unique queue
- * for each possible output channel (WSClient, NMEA 2000 messages,
+ * for each possible output channel (SKWSClient, NMEA 2000 messages,
  * carrier pigeons).
  */
 class SKDeltaQueue {