Merge pull request #443 from arduino-libraries/new-cloud-interfaces

New cloud interfaces

Author: pennam

src/interfaces/CloudProcess.h

@@ -0,0 +1,56 @@
+/*
+  This file is part of the ArduinoIoTCloud library.
+
+  Copyright (c) 2024 Arduino SA
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+*/
+
+#ifndef ARDUINO_IOT_CLOUD_PROCESS
+#define ARDUINO_IOT_CLOUD_PROCESS
+
+/******************************************************************************
+ * INCLUDES
+ ******************************************************************************/
+
+#include <message/Commands.h>
+#include <interfaces/MessageStream.h>
+#include <assert.h>
+#include <functional>
+
+/******************************************************************************
+ * CLASS DECLARATION
+ ******************************************************************************/
+
+class CloudProcess {
+public:
+  CloudProcess(MessageStream* stream): stream(stream) {}
+
+  /**
+   * Abstract method that is called whenever a message comes from Message stream
+   * @param m: the incoming message
+   */
+  virtual void handleMessage(Message* m) = 0;
+
+  /**
+   * Abstract method that is called to update the FSM of the CloudProcess
+   */
+  virtual void update() = 0;
+
+protected:
+  /**
+   * Used by a derived class to send a message to the underlying messageStream
+   * @param msg: the message to send
+   */
+  void deliver(Message* msg) {
+    assert(stream != nullptr);
+    stream->sendUpstream(msg);
+  }
+
+private:
+  MessageStream* stream;
+};
+
+#endif /* ARDUINO_IOT_CLOUD_PROCESS */

src/interfaces/MessageStream.h

@@ -0,0 +1,40 @@
+/*
+  This file is part of the ArduinoIoTCloud library.
+
+  Copyright (c) 2024 Arduino SA
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+*/
+
+#pragma once
+
+/******************************************************************************
+ * INCLUDE
+ ******************************************************************************/
+
+#include <message/Commands.h>
+#include <functional>
+
+using upstreamFunction = std::function<void(Message*)>;
+
+/******************************************************************************
+ * CLASS DECLARATION
+ ******************************************************************************/
+
+class MessageStream {
+public:
+  MessageStream(upstreamFunction upstream): upstream(upstream) {}
+
+  /**
+   * Send message upstream
+   * @param m: message to send
+   */
+  virtual inline void sendUpstream(Message* m) {
+    upstream(m);
+  }
+
+private:
+  upstreamFunction upstream;
+};

src/message/Commands.h

@@ -0,0 +1,50 @@
+/*
+  This file is part of the ArduinoIoTCloud library.
+
+  Copyright (c) 2024 Arduino SA
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+*/
+
+#pragma once
+
+/******************************************************************************
+ * INCLUDE
+ ******************************************************************************/
+
+#include <stdint.h>
+#include <stddef.h>
+
+/******************************************************************************
+ * TYPEDEF
+ ******************************************************************************/
+
+enum CommandId : uint16_t {
+
+  /* Device commands */
+  DeviceBeginCmdId,
+  ThingBeginCmdId,
+  ThingUpdateCmdId,
+  DeviceRegisteredCmdId,
+  DeviceAttachedCmdId,
+  DeviceDetachedCmdId,
+
+  /* Thing commands */
+  LastValuesBeginCmdId,
+  LastValuesUpdateCmdId,
+  PropertiesUpdateCmdId,
+
+  /* Generic commands */
+  ResetCmdId,
+
+  /* Unknown command id */
+  UnknownCmdId
+};
+
+struct Command {
+  CommandId id;
+};
+
+typedef Command Message;