Merge remote-tracking branch 'origin/fix/85-message-engine-slowed' into develop

Author: remikey

CHANGELOG.md

@@ -4,6 +4,68 @@ This file lists modifications introduced by each version.
 
 ## [Unreleased]
 
+### MessageEngine modifications
+
+[[issue 85]][issue: #85] [[issue 83]][issue: #83]
+ 
+Some changes have been applied in an effort to simplify, clarify and speed-up the *message engine* system.
+
+* `MessageEngine` is now an interface
+   * A `reset()` method has been added.
+   * It does not handle delays anymore.
+  
+
+* The former `MessageEngine` has been renamed to `DefaultMessageEngine`.
+
+   `io.jbotsim.core.MessageEngine` -> `io.jbotsim.core.DefaultMessageEngine`
+   
+   * It does not handle delays (see `DelayMessageEngine`)
+   * It speeds-up former check on link existence
+   
+* A specific `DelayMessageEngine` has been re-created in `jbotsim-core`/`io.jbotsim.core`.
+   
+   * It handles instantaneous delays better than the former `MessageEngine` used to.
+   * It also handles general delays better than the former `MessageEngine` used to.
+   * A new `DelayMessageEngine.disableLinksContinuityChecks()` method has been added.
+    
+     This method prevents the system from checking the existence of the link each step while it is delayed. 
+     The check still remains at the end of the sending round and before the delivery round.
+     This speeds message processing up when you send a lot of delayed messages in a static environment.  
+   * `AsyncMessageEngine` and `RandomMessageEngine` implementations have been modified to benefit from the new
+   `DelayMessageEngine` capabilities.
+   
+   * `RandomMessageEngine` has been renamed into `RandomDelayMessageEngine`
+     
+     `jbotsim-extras-common`/`io.jbotsim.contrib.messaging.RandomMessageEngine` -> `io.jbotsim.contrib.messaging.RandomDelayMessageEngine`
+   
+
+* Test classes and examples have been added to showcase all MessageEngines behaviors
+
+If you used to inherit from `MessageEngine`, you have several options:
+* inherit from `DefaultMessageEngine` (no delay feature)
+* inherit from `DelayMessageEngine` (has delay feature)
+* actually implement  the `MessageEngine` interface
+
+
+###  Node class modifications
+
+**New symbols in Node:**
+  * `Node.hasNeighbor(Node)`, `Node.hasInNeighbor(Node)`, `Node.hasOutNeighbor(Node)` have been created [[issue 85]][issue: #85]
+  
+    These methods allow you to directly test the presence of the provided `Node` in the neighborhood of the object 
+    on which they are called. Please see documentation for details. 
+
+**Modifications in Node:**
+  * `Node.getOutNeighbors()` has been improved, avoiding unnecessary copies [[issue 85]][issue: #85]
+  
+###  Message class modifications
+
+**New symbol in Message:**
+
+  * `Message.isRetryModeEnabled()` accessor has been created [[issue 85]][issue: #85]
+  
+[issue: #85]: https://github.com/jbotsim/JBotSim/issues/85
+
 ###  ClockManager class modifications
 
 **Bug fixes in ClockManager:**
@@ -47,14 +109,6 @@ This file lists modifications introduced by each version.
 
 [issue: #83]: https://github.com/jbotsim/JBotSim/issues/83
 
-###  MessageEngine class modification
-
-**Symbol modifications in MessageEngine:**
-
-* The `MessageEngine.reset()` method has been added  [[issue 83]][issue: #83]
-
-  This method properly discards any message handled by the MessageEngine.
-
 ###  TikzTopologySerializer class modifications
 
 [[issue 80]][issue: #80]

apps/examples/src/main/java/examples/fancy/canadairs/Main.java

@@ -1,13 +1,8 @@
 package examples.fancy.canadairs;
 
-import io.jbotsim.core.Link;
-import io.jbotsim.core.Node;
-import io.jbotsim.core.Topology;
-import io.jbotsim.core.LinkResolver;
+import io.jbotsim.core.*;
 import io.jbotsim.ui.JViewer;
 
-import io.jbotsim.core.Color;
-
 /**
  * Created by acasteig on 22/03/15.
  */
@@ -36,7 +31,9 @@ public static void createMap(Topology topology){
     public static void main(String[] args) {
         topology = new Topology(800,600);
         topology.setLinkResolver(new Main());
-        topology.getMessageEngine().setDelay(10);
+        DelayMessageEngine messageEngine = new DelayMessageEngine(topology);
+        messageEngine.setDelay(10);
+        topology.setMessageEngine(messageEngine);
         createMap(topology);
         topology.setTimeUnit(30);
         topology.setDefaultNodeModel(Fire.class);

apps/examples/src/main/java/examples/features/async/AsyncExampleFIFO.java

@@ -0,0 +1,76 @@
+/*
+ * Copyright 2008 - 2020, Arnaud Casteigts and the JBotSim contributors <contact@jbotsim.io>
+ *
+ *
+ * This file is part of JBotSim.
+ *
+ * JBotSim is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * JBotSim is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with JBotSim.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
+package examples.features.messaging;
+
+import io.jbotsim.core.Message;
+import io.jbotsim.core.Node;
+import io.jbotsim.core.Topology;
+import io.jbotsim.ui.JViewer;
+import io.jbotsim.contrib.messaging.AsyncMessageEngine;
+import io.jbotsim.gen.basic.TopologyGenerators;
+
+
+public class AsyncMessageEngineFIFOExampleMain extends Node {
+
+    static int msg = 0;
+
+    @Override
+    public void onSelection() {
+        int nbMsg = 50;
+        for(int i = 0; i < nbMsg; i++)
+            sendMessage();
+    }
+
+    protected void sendMessage() {
+        MessageContent content = new MessageContent();
+        sendAll(new Message(content));
+        System.out.println("["+ getID() + " - " + content.messageNumber + "] emitted at " + content.sendTime);
+        msg++;
+    }
+
+    @Override
+    public void onMessage(Message message) {
+        MessageContent messageContent = (MessageContent)message.getContent();
+        int currentTime = getTime();
+        int deliveryDuration = (currentTime - messageContent.sendTime);
+        int messageNumber = messageContent.messageNumber;
+        System.out.println("["+ messageNumber +"] received at " + currentTime + ", deliveryDuration = " + deliveryDuration + " rounds");
+    }
+
+    public static void main(String[] args) {
+        Topology tp = new Topology();
+        tp.setTimeUnit(20);
+        AsyncMessageEngine messageEngine = new AsyncMessageEngine(tp);
+        messageEngine.setAverageDuration(20);
+//        messageEngine.setDebug(true);
+        tp.setMessageEngine(messageEngine);
+        tp.setDefaultNodeModel(AsyncMessageEngineFIFOExampleMain.class);
+        TopologyGenerators.generateLine(tp, 2);
+        new JViewer(tp);
+        tp.start();
+    }
+
+    private class MessageContent {
+        int messageNumber = msg;
+        int sendTime = getTime();
+    }
+}

apps/examples/src/main/java/examples/features/async/AsyncExampleGrid.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2008 - 2020, Arnaud Casteigts and the JBotSim contributors <contact@jbotsim.io>
+ *
+ *
+ * This file is part of JBotSim.
+ *
+ * JBotSim is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * JBotSim is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with JBotSim.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
+package examples.features.messaging;
+
+import io.jbotsim.contrib.messaging.AsyncMessageEngine;
+import io.jbotsim.core.MessageEngine;
+import io.jbotsim.core.Topology;
+import io.jbotsim.gen.basic.TopologyGenerators;
+import io.jbotsim.ui.JViewer;
+
+public class AsyncMessageEngineNonFIFOExampleMain {
+
+
+    public static void main(String[] args) {
+        final Topology tp = new Topology();
+        tp.setTimeUnit(10);
+        tp.setDefaultNodeModel(GridMessagingNode.class);
+        TopologyGenerators.generateGrid(tp, 10,10);
+        new JViewer(tp);
+
+        MessageEngine messageEngine = new AsyncMessageEngine(tp, 10, AsyncMessageEngine.Type.NONFIFO);
+        tp.setMessageEngine(messageEngine);
+
+        tp.start();
+    }
+
+}

apps/examples/src/main/java/examples/features/async/Readme.md

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2008 - 2019, Arnaud Casteigts and the JBotSim contributors <contact@jbotsim.io>
+ *
+ *
+ * This file is part of JBotSim.
+ *
+ * JBotSim is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * JBotSim is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with JBotSim.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
+package examples.features.messaging;
+
+import io.jbotsim.core.DelayMessageEngine;
+import io.jbotsim.core.Topology;
+import io.jbotsim.gen.basic.TopologyGenerators;
+import io.jbotsim.ui.JViewer;
+
+
+public class DelayMessageEngineExampleMain {
+
+    public static void main(String[] args) {
+        Topology tp = new Topology();
+        tp.setTimeUnit(10);
+        tp.setDefaultNodeModel(GridMessagingNode.class);
+        TopologyGenerators.generateGrid(tp, 10,10);
+        new JViewer(tp);
+
+        DelayMessageEngine messageEngine = new DelayMessageEngine(tp);
+        messageEngine.setDelay(10);
+        messageEngine.setDebug(false);
+        tp.setMessageEngine(messageEngine);
+
+        tp.start();
+    }
+}