From 2093e79b6a0646104c4ff22f2a57bc87da738702 Mon Sep 17 00:00:00 2001 From: Calum Date: Sun, 13 Aug 2017 18:38:24 +1200 Subject: [PATCH] Rather than a high frequency loop sending all packets a low frequency loop is made then destroyed on button press for sending turn packets. This means a fast response time on button press but fewer packets sent. #implement #issue[38] --- .../java/seng302/gameServer/GameState.java | 4 +- .../seng302/gameServer/HeartbeatThread.java | 3 - .../gameServer/ServerPacketParser.java | 6 +- .../gameServer/ServerToClientThread.java | 4 +- .../{BoatActionType.java => BoatAction.java} | 10 +- .../server/messages/BoatActionMessage.java | 4 +- src/main/java/seng302/model/Yacht.java | 2 +- .../visualiser/ClientToServerThread.java | 103 +++++++++++------- .../java/seng302/visualiser/GameClient.java | 14 +-- .../java/seng302/visualiser/GameView.java | 3 - .../RegularPacketsTest.java | 20 ++-- 11 files changed, 95 insertions(+), 78 deletions(-) rename src/main/java/seng302/gameServer/server/messages/{BoatActionType.java => BoatAction.java} (66%) diff --git a/src/main/java/seng302/gameServer/GameState.java b/src/main/java/seng302/gameServer/GameState.java index 5a3897d7..52280317 100644 --- a/src/main/java/seng302/gameServer/GameState.java +++ b/src/main/java/seng302/gameServer/GameState.java @@ -4,7 +4,7 @@ import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map; -import seng302.gameServer.server.messages.BoatActionType; +import seng302.gameServer.server.messages.BoatAction; import seng302.model.Player; import seng302.model.Yacht; @@ -119,7 +119,7 @@ public class GameState implements Runnable { return yachts; } - public static void updateBoat(Integer sourceId, BoatActionType actionType) { + public static void updateBoat(Integer sourceId, BoatAction actionType) { Yacht playerYacht = yachts.get(sourceId); // System.out.println("-----------------------"); switch (actionType) { diff --git a/src/main/java/seng302/gameServer/HeartbeatThread.java b/src/main/java/seng302/gameServer/HeartbeatThread.java index 1534a7e6..b168a197 100644 --- a/src/main/java/seng302/gameServer/HeartbeatThread.java +++ b/src/main/java/seng302/gameServer/HeartbeatThread.java @@ -42,7 +42,6 @@ public class HeartbeatThread extends Thread{ */ private void sendHeartbeatToAllPlayers(){ Message heartbeat = new Heartbeat(seqNum); - System.out.println(GameState.getPlayers()); for (Player player : GameState.getPlayers()){ if (!player.getSocket().isConnected()) { playerLostConnection(player); @@ -54,7 +53,6 @@ public class HeartbeatThread extends Thread{ playerLostConnection(player); } } - updateDelegate(); seqNum++; } @@ -71,7 +69,6 @@ public class HeartbeatThread extends Thread{ public void run(){ Timer t = new Timer(); - t.schedule(new TimerTask() { @Override public void run() { diff --git a/src/main/java/seng302/gameServer/ServerPacketParser.java b/src/main/java/seng302/gameServer/ServerPacketParser.java index 0d631eb1..b6555f28 100644 --- a/src/main/java/seng302/gameServer/ServerPacketParser.java +++ b/src/main/java/seng302/gameServer/ServerPacketParser.java @@ -2,17 +2,17 @@ package seng302.gameServer; import java.util.Arrays; import seng302.model.stream.packets.StreamPacket; -import seng302.gameServer.server.messages.BoatActionType; +import seng302.gameServer.server.messages.BoatAction; public class ServerPacketParser { - public static BoatActionType extractBoatAction(StreamPacket packet) { + public static BoatAction extractBoatAction(StreamPacket packet) { byte[] payload = packet.getPayload(); int messageVersionNo = payload[0]; long actionTypeValue = bytesToLong(Arrays.copyOfRange(payload, 0, 1)); - return BoatActionType.getType((int) actionTypeValue); + return BoatAction.getType((int) actionTypeValue); } /** diff --git a/src/main/java/seng302/gameServer/ServerToClientThread.java b/src/main/java/seng302/gameServer/ServerToClientThread.java index ff2c4f23..35302133 100644 --- a/src/main/java/seng302/gameServer/ServerToClientThread.java +++ b/src/main/java/seng302/gameServer/ServerToClientThread.java @@ -25,7 +25,7 @@ import seng302.model.stream.packets.StreamPacket; import seng302.model.stream.xml.generator.Race; import seng302.model.stream.xml.generator.Regatta; import seng302.utilities.XMLGenerator; -import seng302.gameServer.server.messages.BoatActionType; +import seng302.gameServer.server.messages.BoatAction; import seng302.gameServer.server.messages.BoatLocationMessage; import seng302.gameServer.server.messages.BoatStatus; import seng302.gameServer.server.messages.BoatSubMessage; @@ -168,7 +168,7 @@ public class ServerToClientThread implements Runnable, Observer { //System.out.println("RECEIVED A PACKET"); switch (PacketType.assignPacketType(type, payload)) { case BOAT_ACTION: - BoatActionType actionType = ServerPacketParser + BoatAction actionType = ServerPacketParser .extractBoatAction( new StreamPacket(type, payloadLength, timeStamp, payload)); GameState.updateBoat(sourceId, actionType); diff --git a/src/main/java/seng302/gameServer/server/messages/BoatActionType.java b/src/main/java/seng302/gameServer/server/messages/BoatAction.java similarity index 66% rename from src/main/java/seng302/gameServer/server/messages/BoatActionType.java rename to src/main/java/seng302/gameServer/server/messages/BoatAction.java index 1b9fdd58..cc53668c 100644 --- a/src/main/java/seng302/gameServer/server/messages/BoatActionType.java +++ b/src/main/java/seng302/gameServer/server/messages/BoatAction.java @@ -6,7 +6,7 @@ import java.util.Map; /** * Created by kre39 on 12/07/17. */ -public enum BoatActionType { +public enum BoatAction { VMG(1), SAILS_IN(2), @@ -17,19 +17,19 @@ public enum BoatActionType { MAINTAIN_HEADING(7); private final int type; - private static final Map intToTypeMap = new HashMap<>(); + private static final Map intToTypeMap = new HashMap<>(); static { - for (BoatActionType type : BoatActionType.values()) { + for (BoatAction type : BoatAction.values()) { intToTypeMap.put(type.getValue(), type); } } - BoatActionType(int type){ + BoatAction(int type){ this.type = type; } - public static BoatActionType getType(int value) { + public static BoatAction getType(int value) { return intToTypeMap.get(value); } diff --git a/src/main/java/seng302/gameServer/server/messages/BoatActionMessage.java b/src/main/java/seng302/gameServer/server/messages/BoatActionMessage.java index cfa596f7..2fc084e5 100644 --- a/src/main/java/seng302/gameServer/server/messages/BoatActionMessage.java +++ b/src/main/java/seng302/gameServer/server/messages/BoatActionMessage.java @@ -6,9 +6,9 @@ package seng302.gameServer.server.messages; public class BoatActionMessage extends Message{ private final MessageType MESSAGE_TYPE = MessageType.BOAT_ACTION; private final int MESSAGE_SIZE = 1; - private BoatActionType actionType; + private BoatAction actionType; - public BoatActionMessage(BoatActionType actionType) { + public BoatActionMessage(BoatAction actionType) { this.actionType = actionType; setHeader(new Header(MessageType.BOAT_ACTION, 0, (short) 1)); // the second variable is the source id allocateBuffer(); diff --git a/src/main/java/seng302/model/Yacht.java b/src/main/java/seng302/model/Yacht.java index 84fa15ce..addb6a40 100644 --- a/src/main/java/seng302/model/Yacht.java +++ b/src/main/java/seng302/model/Yacht.java @@ -48,7 +48,7 @@ public class Yacht { private Integer legNumber = 0; //SERVER SIDE - public static final Double TURN_STEP = 1.0; //This should be in some utils class somewhere 2bh. Public for tests sake. + public static final Double TURN_STEP = 5.0; //This should be in some utils class somewhere 2bh. Public for tests sake. private Double lastHeading; private Boolean sailIn; private GeoPoint location; diff --git a/src/main/java/seng302/visualiser/ClientToServerThread.java b/src/main/java/seng302/visualiser/ClientToServerThread.java index 1bfaa10d..e2eb7687 100644 --- a/src/main/java/seng302/visualiser/ClientToServerThread.java +++ b/src/main/java/seng302/visualiser/ClientToServerThread.java @@ -17,10 +17,10 @@ import java.util.zip.Checksum; import javafx.application.Platform; import javafx.scene.control.Alert; import javafx.scene.control.Alert.AlertType; -import seng302.gameServer.server.messages.BoatActionType; -import seng302.model.stream.packets.StreamPacket; import seng302.gameServer.server.messages.BoatActionMessage; +import seng302.gameServer.server.messages.BoatAction; import seng302.gameServer.server.messages.Message; +import seng302.model.stream.packets.StreamPacket; /** * A class describing a single connection to a Server for the purposes of sending and receiving on @@ -53,10 +53,10 @@ public class ClientToServerThread implements Runnable { //Output stream private OutputStream os; - private Timer osTimer = new Timer(); - private Queue eventQueue = new ConcurrentLinkedQueue<>(); - private boolean upwindFlag = false, downwindFlag = false; - static public final int PACKET_SENDING_INTERVAL_MS = 20; + private Timer upWindPacketTimer = new Timer(); + private Timer downWindPacketTimer = new Timer(); + private boolean upwindTimerFlag = false, downwindTimerFlag = false; + static public final int PACKET_SENDING_INTERVAL_MS = 100; private int clientId; private ByteArrayOutputStream crcBuffer; @@ -90,15 +90,6 @@ public class ClientToServerThread implements Runnable { thread = new Thread(this); thread.start(); - - osTimer.scheduleAtFixedRate( - new TimerTask() { - @Override - public void run() { - processBoatActionQueue(); - } - }, 0, PACKET_SENDING_INTERVAL_MS - ); } /** @@ -163,7 +154,6 @@ public class ClientToServerThread implements Runnable { clientLog(e.getMessage(), 1); return; } -// System.out.println("streamPackets = " + streamPackets.size()); } closeSocket(); clientLog("Closed connection to Server", 0); @@ -195,30 +185,66 @@ public class ClientToServerThread implements Runnable { } } + /** + * Sends packets for the given boat action. Special cases are: \n + * - DOWNWIND = Packets are sent every ClientToServerThread.PACKET_SENDING_INTERVAL_MS + * - UPWIND = Packets are sent every ClientToServerThread.PACKET_SENDING_INTERVAL_MS + * - MAINTAIN_HEADING = DOWNWIND and UPWIND packets stop being sent. + * @param actionType The boat action that will dictate packets sent. + */ + public void sendBoatAction(BoatAction actionType) { + switch (actionType) { + case MAINTAIN_HEADING: + if (upwindTimerFlag) { + cancelTimer(upWindPacketTimer); + upwindTimerFlag = false; + upWindPacketTimer = new Timer(); + } + if (downwindTimerFlag) { + cancelTimer(downWindPacketTimer); + downwindTimerFlag = false; + downWindPacketTimer = new Timer(); + } + break; + case DOWNWIND: + if (!downwindTimerFlag) { + downwindTimerFlag = true; + downWindPacketTimer.scheduleAtFixedRate( + new TimerTask() { + @Override + public void run() { + sendBoatAction(new BoatActionMessage(BoatAction.DOWNWIND)); + } + }, 0, PACKET_SENDING_INTERVAL_MS + ); + } + break; + case UPWIND: + if (!upwindTimerFlag) { + upwindTimerFlag = true; + upWindPacketTimer.scheduleAtFixedRate( + new TimerTask() { + @Override + public void run() { + sendBoatAction(new BoatActionMessage(BoatAction.UPWIND)); + } + }, 0, PACKET_SENDING_INTERVAL_MS + ); + } + break; + default: + sendBoatAction(new BoatActionMessage(actionType)); + break; + } + } /** - * Processes next element in the queue of events to send. + * Cancels a packet sending timer. + * @param timer The timer to cancel. */ - private void processBoatActionQueue() { - BoatActionType action = eventQueue.poll(); - if (action != null) { - switch (action) { - case MAINTAIN_HEADING: - downwindFlag = upwindFlag = false; break; - case DOWNWIND: - downwindFlag = true; break; - case UPWIND: - upwindFlag = true; break; - default: - sendBoatAction(new BoatActionMessage(action)); break; - } - } - if (downwindFlag) { - sendBoatAction(new BoatActionMessage(BoatActionType.DOWNWIND)); - } - if (upwindFlag) { - sendBoatAction(new BoatActionMessage(BoatActionType.UPWIND)); - } + private void cancelTimer (Timer timer) { + timer.cancel(); + timer.purge(); } /** @@ -289,7 +315,4 @@ public class ClientToServerThread implements Runnable { return clientId; } - public void sendBoatEvent(BoatActionType actionType) { - eventQueue.add(actionType); - } } diff --git a/src/main/java/seng302/visualiser/GameClient.java b/src/main/java/seng302/visualiser/GameClient.java index 0b52a3a4..04c8a87d 100644 --- a/src/main/java/seng302/visualiser/GameClient.java +++ b/src/main/java/seng302/visualiser/GameClient.java @@ -13,7 +13,7 @@ import javafx.scene.Node; import javafx.scene.input.KeyEvent; import javafx.scene.layout.Pane; import seng302.gameServer.MainServerThread; -import seng302.gameServer.server.messages.BoatActionType; +import seng302.gameServer.server.messages.BoatAction; import seng302.model.RaceState; import seng302.model.Yacht; import seng302.model.stream.packets.StreamPacket; @@ -274,13 +274,13 @@ public class GameClient { private void keyPressed(KeyEvent e) { switch (e.getCode()) { case SPACE: // align with vmg - socketThread.sendBoatEvent(BoatActionType.VMG); break; + socketThread.sendBoatAction(BoatAction.VMG); break; case PAGE_UP: // upwind - socketThread.sendBoatEvent(BoatActionType.UPWIND); break; + socketThread.sendBoatAction(BoatAction.UPWIND); break; case PAGE_DOWN: // downwind - socketThread.sendBoatEvent(BoatActionType.DOWNWIND); break; + socketThread.sendBoatAction(BoatAction.DOWNWIND); break; case ENTER: // tack/gybe - socketThread.sendBoatEvent(BoatActionType.TACK_GYBE); break; + socketThread.sendBoatAction(BoatAction.TACK_GYBE); break; //TODO Allow a zoom in and zoom out methods case Z: // zoom in System.out.println("Zoom in"); @@ -295,10 +295,10 @@ public class GameClient { switch (e.getCode()) { //TODO 12/07/17 Determine the sail state and send the appropriate packet (eg. if sails are in, send a sail out packet) case SHIFT: // sails in/sails out - socketThread.sendBoatEvent(BoatActionType.SAILS_IN); break; + socketThread.sendBoatAction(BoatAction.SAILS_IN); break; case PAGE_UP: case PAGE_DOWN: - socketThread.sendBoatEvent(BoatActionType.MAINTAIN_HEADING); break; + socketThread.sendBoatAction(BoatAction.MAINTAIN_HEADING); break; } } } diff --git a/src/main/java/seng302/visualiser/GameView.java b/src/main/java/seng302/visualiser/GameView.java index a636cc4f..426cf8cc 100644 --- a/src/main/java/seng302/visualiser/GameView.java +++ b/src/main/java/seng302/visualiser/GameView.java @@ -492,7 +492,6 @@ public class GameView extends Pane { distanceFromReference = GeoUtility.getDistance( minLatPoint, new GeoPoint(unscaledLat, unscaledLon) ); -// System.out.println("distanceFromReference = " + distanceFromReference); if (angleFromReference >= 0 && angleFromReference <= Math.PI / 2) { xAxisLocation += Math.round(distanceScaleFactor * Math.sin(angleFromReference) * distanceFromReference); yAxisLocation -= Math.round(distanceScaleFactor * Math.cos(angleFromReference) * distanceFromReference); @@ -512,8 +511,6 @@ public class GameView extends Pane { if(horizontalInversion) { xAxisLocation = canvasWidth - bufferSize - (xAxisLocation - bufferSize); } -// System.out.println("yAxisLocation = " + yAxisLocation + " " + unscaledLat); -// System.out.println("xAxisLocation = " + xAxisLocation + " " + unscaledLon); return new Point2D(xAxisLocation, yAxisLocation); } diff --git a/src/test/java/seng302/visualiser/ClientToServerTests/RegularPacketsTest.java b/src/test/java/seng302/visualiser/ClientToServerTests/RegularPacketsTest.java index 94ba6d39..41583cfe 100644 --- a/src/test/java/seng302/visualiser/ClientToServerTests/RegularPacketsTest.java +++ b/src/test/java/seng302/visualiser/ClientToServerTests/RegularPacketsTest.java @@ -4,20 +4,18 @@ import java.util.ArrayList; import org.junit.After; import org.junit.Assert; import org.junit.Before; -import org.junit.FixMethodOrder; import org.junit.Test; -import org.junit.runners.MethodSorters; import seng302.gameServer.GameStages; import seng302.gameServer.GameState; import seng302.gameServer.MainServerThread; -import seng302.gameServer.server.messages.BoatActionType; +import seng302.gameServer.server.messages.BoatAction; import seng302.model.Yacht; import seng302.visualiser.ClientToServerThread; /** * Test for checking how regularly packets are sent from ClientToServer Thread. */ -@FixMethodOrder(MethodSorters.NAME_ASCENDING) +//@FixMethodOrder(MethodSorters.NAME_ASCENDING) public class RegularPacketsTest { private MainServerThread serverThread; @@ -39,12 +37,12 @@ public class RegularPacketsTest { Yacht yacht = new ArrayList<>(GameState.getYachts().values()).get(0); double startAngle = yacht.getHeading(); long startTime = System.currentTimeMillis(); - clientThread.sendBoatEvent(BoatActionType.UPWIND); + clientThread.sendBoatAction(BoatAction.UPWIND); Thread.sleep(200); while (Math.abs(yacht.getHeading() - startAngle) < TEST_DISTANCE) { - //Wait for yacht to move + Thread.sleep(1); } - clientThread.sendBoatEvent(BoatActionType.MAINTAIN_HEADING); + clientThread.sendBoatAction(BoatAction.MAINTAIN_HEADING); long endTime = System.currentTimeMillis(); SleepThreadMaxDelay(); //Allowed to be two loops of delay due to loop delay and processing delay at client + server ends. @@ -58,7 +56,7 @@ public class RegularPacketsTest { SleepThreadMaxDelay(); Yacht yacht = new ArrayList<>(GameState.getYachts().values()).get(0); boolean startState = yacht.getSailIn(); - clientThread.sendBoatEvent(BoatActionType.SAILS_IN); + clientThread.sendBoatAction(BoatAction.SAILS_IN); SleepThreadMaxDelay(); Assert.assertEquals(startState, !yacht.getSailIn()); } @@ -73,7 +71,7 @@ public class RegularPacketsTest { Yacht testYacht = new Yacht("", 0, "", "", "", ""); testYacht.setHeading(heading); testYacht.tackGybe(windDirection); - clientThread.sendBoatEvent(BoatActionType.TACK_GYBE); + clientThread.sendBoatAction(BoatAction.TACK_GYBE); SleepThreadMaxDelay(); Assert.assertEquals(testYacht.getHeading(), yacht.getHeading(), 1); } @@ -88,9 +86,11 @@ public class RegularPacketsTest { } @After - public void teardown () { + public void teardown () throws Exception { serverThread.terminate(); clientThread.setSocketToClose(); GameState.setCurrentStage(GameStages.LOBBYING); + SleepThreadMaxDelay(); //Make sure socket is closed. + SleepThreadMaxDelay(); } }