Support optional version and tag

Fixes: #11

README.md

@@ -28,8 +28,14 @@ A State Machine;
 - Writes logs to either stdout or the filesystem for Debuggability.
 - Has a Hierarchy of States to minimize Code Duplication.
 - Is Uniquely Identified by its Binary Name and Network Address;
-  - local `:<port>` or `localhost:<port>` or `127.0.0.1:<port>`
-  - remote `<ip>:<port>`
+  - binary name consists of;
+    - package and executable: `family/Parent` or `family/Child`
+    - optional [semantic versioning](https://semver.org/): `family/Parent_v0.0.1`
+    - optional tag: `family/Child:Alice` or `family/Child:Bob`
+    - compound example: `family/Child_v1.2.3:Alice`
+  - address can either be local, or remote;
+    - local: `:<port>` or `localhost:<port>` or `127.0.0.1:<port>`
+    - remote: `<ip>:<port>`
 
 ### States
 
@@ -58,15 +64,16 @@ The optional empty receiver is triggered if no other receivers match.
 
 int main(int argc, char **argv) {
   if (argc < 3) {
-    error() << "Incorrect parameters, expected <spawner> <address>\n"
+    error() << "Incorrect parameters, expected <address> <spawner>\n"
             << std::flush;
     return -1;
   }
 
-  Address spawner(argv[1]);
-  Address address(argv[2]);
+  std::string name(argv[0]);
   UDPSocket socket;
-  Machine m(spawner, address, "switch/Switch", socket);
+  Address address(argv[1]);
+  Address spawner(argv[2]);
+  Machine m(name, socket, address, spawner);
 
   m.AddState(std::make_unique<State>(
       // State Name
@@ -137,15 +144,16 @@ When a parent is notified that a child has errored, it can chose to do nothing,
 
 int main(int argc, char **argv) {
   if (argc < 3) {
-    error() << "Incorrect parameters, expected <spawner> <address>\n"
+    error() << "Incorrect parameters, expected <address> <spawner>\n"
             << std::flush;
     return -1;
   }
 
-  Address spawner(argv[1]);
-  Address address(argv[2]);
+  std::string name(argv[0]);
   UDPSocket socket;
-  Machine m(spawner, address, "family/Parent", socket);
+  Address address(argv[1]);
+  Address spawner(argv[2]);
+  Machine m(name, socket, address, spawner);
 
   m.AddState(std::make_unique<State>(
       // State Name
@@ -212,15 +220,16 @@ int main(int argc, char **argv) {
 
 int main(int argc, char **argv) {
   if (argc < 3) {
-    error() << "Incorrect parameters, expected <spawner> <address>\n"
+    error() << "Incorrect parameters, expected <address> <spawner>\n"
             << std::flush;
     return -1;
   }
 
-  Address spawner(argv[1]);
-  Address address(argv[2]);
+  std::string name(argv[0]);
   UDPSocket socket;
-  Machine m(spawner, address, "family/Child", socket);
+  Address address(argv[1]);
+  Address spawner(argv[2]);
+  Machine m(name, socket, address, spawner);
 
   m.AddState(std::make_unique<State>(
       // State Name

include/Wink/machine.h

@@ -16,15 +16,15 @@
 
 class Machine {
 public:
-  Machine(Address &spawner, Address &address, std::string name, Socket &socket)
-      : spawner(spawner), address(address), name(name), socket(socket) {}
+  Machine(std::string name, Socket &socket, Address &address, Address &spawner)
+      : name(name), socket(socket), address(address), spawner(spawner) {}
   Machine(const Machine &m) = delete;
   Machine(Machine &&m) = delete;
   ~Machine() {}
   /**
    * Returns this Machine's Unique Identifier.
    */
-  std::string Uid() const { return uid; }
+  std::string UID() const { return uid; }
   /**
    * Start begins execution of the state machine and sends a
    * 'started' message to the machine which spawned this machine.
@@ -101,12 +101,12 @@ class Machine {
   void registerMachine(const std::string &machine, const int pid);
   void unregisterMachine();
 
-  Address &spawner;
-  Address &address;
   std::string name;
+  Socket &socket;
+  Address &address;
+  Address &spawner;
   std::string uid;
   bool running = true;
-  Socket &socket;
   Address sender;
   char buffer[MAX_PAYLOAD];
   std::map<const std::string, const std::unique_ptr<State>> states;

include/Wink/semver.h

@@ -0,0 +1,40 @@
+#ifndef SEMVER_H
+#define SEMVER_H
+
+#include <sstream>
+#include <string>
+
+class SemVer {
+public:
+  SemVer() {}
+  SemVer(std::string version) : _version(version) { stov(version); }
+  SemVer(int major, int minor, int patch, std::string prerelease,
+         std::string build)
+      : _major(major), _minor(minor), _patch(patch), _prerelease(prerelease),
+        _build(build) {
+    _version = vtos();
+  }
+  ~SemVer() {}
+  std::string version();
+  int major();
+  int minor();
+  int patch();
+  std::string prerelease();
+  std::string build();
+  void stov(const std::string &version);
+  std::string vtos() const;
+  bool operator<(const SemVer &rhs) const;
+
+private:
+  std::string _version = "";
+  int _major = 0;
+  int _minor = 0;
+  int _patch = 0;
+  std::string _prerelease = "";
+  std::string _build = "";
+};
+
+std::istream &operator>>(std::istream &is, SemVer &v);
+std::ostream &operator<<(std::ostream &os, const SemVer &v);
+
+#endif

include/Wink/server/server.h

@@ -17,6 +17,7 @@
 #include <Wink/constants.h>
 #include <Wink/log.h>
 #include <Wink/machine.h>
+#include <Wink/semver.h>
 #include <Wink/socket.h>
 
 class Server {
@@ -27,7 +28,7 @@ class Server {
   Server(Server &&m) = delete;
   ~Server() {}
   int Serve(const std::string &directory);
-  int Start(const std::string &machine,
+  int Start(const std::string &binary, const std::string &machine,
             const std::vector<std::string> &parameters);
   int Stop(int port);
 
@@ -41,4 +42,7 @@ class Server {
   std::map<ushort, int> pids;
 };
 
+std::string resolveVersion(const std::string &directory,
+                           const std::string &machine);
+
 #endif

samples/CMakeLists.txt

@@ -17,3 +17,5 @@ add_subdirectory("switch")
 add_subdirectory("time")
 
 add_subdirectory("useless")
+
+add_subdirectory("version")

samples/README.md

@@ -41,3 +41,7 @@ Demonstrates various time-related use cases.
 ## [Useless](useless/README.md)
 
 A Useless State Machine that exits as soon as it is started.
+
+## [Version](version/README.md)
+
+Demonstrates how multiple versions of the same State Machine can coexist.

samples/echo/echo.cpp

@@ -8,15 +8,16 @@
 
 int main(int argc, char **argv) {
   if (argc < 3) {
-    error() << "Incorrect parameters, expected <spawner> <address>\n"
+    error() << "Incorrect parameters, expected <address> <spawner>\n"
             << std::flush;
     return -1;
   }
 
-  Address spawner(argv[1]);
-  Address address(argv[2]);
+  std::string name(argv[0]);
   UDPSocket socket;
-  Machine m(spawner, address, "echo/Echo", socket);
+  Address address(argv[1]);
+  Address spawner(argv[2]);
+  Machine m(name, socket, address, spawner);
 
   m.AddState(std::make_unique<State>(
       // State Name

samples/family/child.cpp

@@ -9,15 +9,16 @@
 
 int main(int argc, char **argv) {
   if (argc < 3) {
-    error() << "Incorrect parameters, expected <spawner> <address>\n"
+    error() << "Incorrect parameters, expected <address> <spawner>\n"
             << std::flush;
     return -1;
   }
 
-  Address spawner(argv[1]);
-  Address address(argv[2]);
+  std::string name(argv[0]);
   UDPSocket socket;
-  Machine m(spawner, address, "family/Child", socket);
+  Address address(argv[1]);
+  Address spawner(argv[2]);
+  Machine m(name, socket, address, spawner);
 
   m.AddState(std::make_unique<State>(
       // State Name

samples/family/parent.cpp

@@ -8,15 +8,16 @@
 
 int main(int argc, char **argv) {
   if (argc < 3) {
-    error() << "Incorrect parameters, expected <spawner> <address>\n"
+    error() << "Incorrect parameters, expected <address> <spawner>\n"
             << std::flush;
     return -1;
   }
 
-  Address spawner(argv[1]);
-  Address address(argv[2]);
+  std::string name(argv[0]);
   UDPSocket socket;
-  Machine m(spawner, address, "family/Parent", socket);
+  Address address(argv[1]);
+  Address spawner(argv[2]);
+  Machine m(name, socket, address, spawner);
 
   m.AddState(std::make_unique<State>(
       // State Name
@@ -26,7 +27,8 @@ int main(int argc, char **argv) {
       // On Entry Action
       [&]() {
         info() << "Parent: OnEntry\n" << std::flush;
-        m.Spawn("family/Child");
+        m.Spawn("family/Child:Alice");
+        m.Spawn("family/Child:Bob");
       },
       // On Exit Action
       []() { info() << "Parent: OnExit\n"
@@ -63,7 +65,7 @@ int main(int argc, char **argv) {
              args >> child;
              info() << "Parent: " << sender << ' ' << child << " has exited\n"
                     << std::flush;
-             m.GotoState("main"); // Retry
+             m.Spawn(child); // Retry
            }},
       }));
 

samples/fizzbuzz/README.md

@@ -9,4 +9,5 @@ start fizzbuzz/FizzBuzz
 send <fizzbuzz> 1
 send <fizzbuzz> 2
 send <fizzbuzz> 3
+...
 ```

samples/fizzbuzz/fizzbuzz.cpp

@@ -8,15 +8,16 @@
 
 int main(int argc, char **argv) {
   if (argc < 3) {
-    error() << "Incorrect parameters, expected <spawner> <address>\n"
+    error() << "Incorrect parameters, expected <address> <spawner>\n"
             << std::flush;
     return -1;
   }
 
-  Address spawner(argv[1]);
-  Address address(argv[2]);
+  std::string name(argv[0]);
   UDPSocket socket;
-  Machine m(spawner, address, "fizzbuzz/FizzBuzz", socket);
+  Address address(argv[1]);
+  Address spawner(argv[2]);
+  Machine m(name, socket, address, spawner);
 
   m.AddState(std::make_unique<State>(
       // State Name

samples/forward/forward.cpp

@@ -9,16 +9,16 @@
 int main(int argc, char **argv) {
   if (argc < 4) {
     error()
-        << "Incorrect parameters, expected <spawner> <address> <destination>\n"
+        << "Incorrect parameters, expected <address> <spawner> <destination>\n"
         << std::flush;
     return -1;
   }
 
-  Address spawner(argv[1]);
-  Address address(argv[2]);
-  std::string name("forward/Forward");
+  std::string name(argv[0]);
   UDPSocket socket;
-  Machine m(spawner, address, name, socket);
+  Address address(argv[1]);
+  Address spawner(argv[2]);
+  Machine m(name, socket, address, spawner);
 
   Address destination(argv[3]);
 

samples/hierarchy/bigger.cpp

@@ -7,15 +7,16 @@
 
 int main(int argc, char **argv) {
   if (argc < 3) {
-    error() << "Incorrect parameters, expected <spawner> <address>\n"
+    error() << "Incorrect parameters, expected <address> <spawner>\n"
             << std::flush;
     return -1;
   }
 
-  Address spawner(argv[1]);
-  Address address(argv[2]);
+  std::string name(argv[0]);
   UDPSocket socket;
-  Machine m(spawner, address, "hierarchy/Bigger", socket);
+  Address address(argv[1]);
+  Address spawner(argv[2]);
+  Machine m(name, socket, address, spawner);
 
   m.AddState(std::make_unique<State>(
       // State Name

samples/hierarchy/empty.cpp

@@ -7,15 +7,16 @@
 
 int main(int argc, char **argv) {
   if (argc < 3) {
-    error() << "Incorrect parameters, expected <spawner> <address>\n"
+    error() << "Incorrect parameters, expected <address> <spawner>\n"
             << std::flush;
     return -1;
   }
 
-  Address spawner(argv[1]);
-  Address address(argv[2]);
+  std::string name(argv[0]);
   UDPSocket socket;
-  Machine m(spawner, address, "hierarchy/Empty", socket);
+  Address address(argv[1]);
+  Address spawner(argv[2]);
+  Machine m(name, socket, address, spawner);
 
   m.Start();
 }

samples/hierarchy/forrest.cpp

@@ -7,15 +7,16 @@
 
 int main(int argc, char **argv) {
   if (argc < 3) {
-    error() << "Incorrect parameters, expected <spawner> <address>\n"
+    error() << "Incorrect parameters, expected <address> <spawner>\n"
             << std::flush;
     return -1;
   }
 
-  Address spawner(argv[1]);
-  Address address(argv[2]);
+  std::string name(argv[0]);
   UDPSocket socket;
-  Machine m(spawner, address, "hierarchy/Forrest", socket);
+  Address address(argv[1]);
+  Address spawner(argv[2]);
+  Machine m(name, socket, address, spawner);
 
   m.AddState(std::make_unique<State>(
       "Leaf1", "", []() {}, []() {},