fix: RpcCall error not private and thread safe

Author: eigen-value

README.md

@@ -57,9 +57,9 @@ void loop() {
     if (!async_rpc.result(sum)) {
         Monitor.println("Error calling method: add");
         Monitor.print("Error code: ");
-        Monitor.println(async_rpc.error.code);
+        Monitor.println(async_rpc.getErrorCode);
         Monitor.print("Error message: ");
-        Monitor.println(async_rpc.error.traceback);
+        Monitor.println(async_rpc.getErrorMessage);
     }
 
     // Implicit boolean cast. Use with caution as in this case the call is indeed

examples/simple_bridge/simple_bridge.ino

@@ -59,8 +59,8 @@ void loop() {
         Serial.print("Result of the operation is: ");
         Serial.println(res);
     } else {
-        Serial.println(outcome.error.code);
-        Serial.println(outcome.error.traceback);
+        Serial.println(outcome.getErrorCode());
+        Serial.println(outcome.getErrorMessage());
     }
 
     Bridge.notify("signal", 200);

examples/test/test.ino

@@ -64,34 +64,34 @@ void loop() {
     if (async_res.result(pow)) {
       Monitor.println("Result of assignment and then result: "+String(pow)); // returns true, so the right result
     } else {
-      Monitor.println("Error code: "+String(async_res.error.code));
-      Monitor.println("Error message: "+async_res.error.traceback);
+      Monitor.println("Error code: "+String(async_res.getErrorCode()));
+      Monitor.println("Error message: "+async_res.getErrorMessage());
     }
 
     float div = 0;
     RpcCall async_res1 = Bridge.call("2_args_float_result", 2.0);  // passing 1 arg when 2 are expected
     if (async_res1.result(div)) {
       Monitor.println("Result of assignment and then result: "+String(div)); // returns true, so the right result
     } else {
-      Monitor.println("Error code: "+String(async_res1.error.code));
-      Monitor.println("Error message: "+async_res1.error.traceback);
+      Monitor.println("Error code: "+String(async_res1.getErrorCode()));
+      Monitor.println("Error message: "+async_res1.getErrorMessage());
     }
 
     div = 0;
     RpcCall async_res2 = Bridge.call("2_args_float_result", 2.0, "invalid");  // passing a wrong type arg
     if (async_res2.result(div)) {
       Monitor.println("Result of assignment and then result: "+String(div)); // returns true, so the right result
     } else {
-      Monitor.println("Error code: "+String(async_res2.error.code));
-      Monitor.println("Error message: "+async_res2.error.traceback);
+      Monitor.println("Error code: "+String(async_res2.getErrorCode()));
+      Monitor.println("Error message: "+async_res2.getErrorMessage());
     }
 
     x = false;
     RpcCall async_res3 = Bridge.call("0_args_bool_result");
     if (async_res3.result(x)) {
         Monitor.println("Result of assignment and then result: "+String(x)); // returns true, so the right result
     } else {
-        Monitor.println("Error expecting bool result: "+String(async_res3.error.code));
+        Monitor.println("Error expecting bool result: "+String(async_res3.getErrorCode()));
     }
 
     // Avoid the following:

src/bridge.h

@@ -27,22 +27,56 @@
 #include <zephyr/sys/atomic.h>
 #include <Arduino_RPClite.h>
 
+#include <utility>
+
 
 void updateEntryPoint(void *, void *, void *);
 
 template<typename... Args>
 class RpcCall {
+
+    RpcError error;
+
+    void setError(int code, MsgPack::str_t text) {
+        k_mutex_lock(&call_mutex, K_FOREVER);
+        error.code = code;
+        error.traceback = std::move(text);
+        k_mutex_unlock(&call_mutex);
+    }
+
 public:
-    RpcError error{GENERIC_ERR, "This call is not executed yet"};
 
-    RpcCall(const MsgPack::str_t& m, RPCClient* c, struct k_mutex* rm, struct k_mutex* wm, Args&&... args): method(m), client(c), read_mutex(rm), write_mutex(wm), callback_params(std::forward_as_tuple(std::forward<Args>(args)...)) {}
+    RpcCall(const MsgPack::str_t& m, RPCClient* c, struct k_mutex* rm, struct k_mutex* wm, Args&&... args): method(m), client(c), read_mutex(rm), write_mutex(wm), callback_params(std::forward_as_tuple(std::forward<Args>(args)...)) {
+        k_mutex_init(&call_mutex);
+        setError(GENERIC_ERR, "This call is not yet executed");
+    }
+
+    bool isError() {
+        k_mutex_lock(&call_mutex, K_FOREVER);
+        const bool out = error.code > NO_ERR;
+        k_mutex_unlock(&call_mutex);
+        return out;
+    }
+
+    int getErrorCode() {
+        k_mutex_lock(&call_mutex, K_FOREVER);
+        const int out = error.code;
+        k_mutex_unlock(&call_mutex);
+        return out;
+    }
+
+    MsgPack::str_t getErrorMessage() {
+        k_mutex_lock(&call_mutex, K_FOREVER);
+        MsgPack::str_t out = error.traceback;
+        k_mutex_unlock(&call_mutex);
+        return out;
+    }
 
     template<typename RType> bool result(RType& result) {
 
         if (!atomic_cas(&_executed, 0, 1)){
             // this thread lost the race
-            error.code = GENERIC_ERR;
-            error.traceback = "This call result is no longer available";
+            setError(GENERIC_ERR, "This call is no longer available");
             return false;
         }
 
@@ -60,13 +94,15 @@ class RpcCall {
 
         while(true) {
             if (k_mutex_lock(read_mutex, K_MSEC(10)) == 0 ) {
-                if (client->get_response(msg_id_wait, result, error)) {
+                RpcError temp_err;
+                if (client->get_response(msg_id_wait, result, temp_err)) {
                     k_mutex_unlock(read_mutex);
                     // if (error.code == PARSING_ERR) {
                     //     k_mutex_lock(write_mutex, K_FOREVER);
                     //     client->notify(BRIDGE_ERROR, error.traceback);
                     //     k_mutex_unlock(write_mutex);
                     // }
+                    setError(temp_err.code, temp_err.traceback);
                     break;
                 }
                 k_mutex_unlock(read_mutex);
@@ -76,7 +112,7 @@ class RpcCall {
             }
         }
 
-        return error.code == NO_ERR;
+        return !isError();
     }
 
     bool result() {
@@ -100,6 +136,7 @@ class RpcCall {
     RPCClient* client;
     struct k_mutex* read_mutex;
     struct k_mutex* write_mutex;
+    struct k_mutex call_mutex{};
     std::tuple<Args...> callback_params;
 };
 

src/monitor.h

@@ -151,7 +151,7 @@ class BridgeMonitor: public Stream {
             }
         }
 
-        // if (async_rpc.error.code > NO_ERR) {
+        // if (async_rpc.getErrorCode() > NO_ERR) {
         //     _connected = false;
         // }
 

src/tcp_client.h

@@ -202,7 +202,7 @@ class BridgeTCPClient : public Client {
             }
         }
 
-        if (async_rpc.error.code > NO_ERR) {
+        if (async_rpc.getErrorCode() > NO_ERR) {
             _connected = false;
         }