Update naming and documentation

Author: g3force

cmd/ssl-team-client/main.go

@@ -18,7 +18,7 @@ var autoDetectAddress = flag.Bool("autoDetectHost", true, "Automatically detect
 var refBoxAddr = flag.String("address", "localhost:10008", "Address to connect to")
 var privateKeyLocation = flag.String("privateKey", "", "A private key to be used to sign messages")
 var teamName = flag.String("teamName", "Test Team", "The name of the team as it is sent by the referee")
-var teamColor = flag.String("teamColor", "", "The color of the team as it is sent by the referee")
+var teamColor = flag.String("teamColor", "", "The color of the team as it is sent by the referee (YELLOW or BLUE)")
 
 var privateKey *rsa.PrivateKey
 
@@ -62,9 +62,9 @@ func main() {
 	c.sendDesiredKeeper(3)
 
 	for {
-		c.SendAdvantageChoice(rcon.AdvantageResponse_CONTINUE)
+		c.SendAdvantageChoice(rcon.AdvantageChoice_CONTINUE)
 		time.Sleep(time.Millisecond * 1000)
-		c.SendAdvantageChoice(rcon.AdvantageResponse_STOP)
+		c.SendAdvantageChoice(rcon.AdvantageChoice_STOP)
 		time.Sleep(time.Millisecond * 1000)
 	}
 }
@@ -119,8 +119,8 @@ func (c *Client) sendDesiredKeeper(id int32) (accepted bool) {
 	return c.sendRequest(&request)
 }
 
-func (c *Client) SendAdvantageChoice(choice rcon.AdvantageResponse) {
-	reply := rcon.TeamToController_AdvantageResponse{AdvantageResponse: choice}
+func (c *Client) SendAdvantageChoice(choice rcon.AdvantageChoice) {
+	reply := rcon.TeamToController_AdvantageChoice{AdvantageChoice: choice}
 	response := rcon.TeamToController{Msg: &reply}
 	c.sendRequest(&response)
 }

internal/app/engine/process_botremoved.go

@@ -47,8 +47,8 @@ func (e *Engine) processBotNumberPerTeam(team state.Team) {
 	numBotsAllowed := *teamInfo.MaxAllowedBots + newCards
 	if numBots > numBotsAllowed {
 
-		advantageResponse := e.gcState.TeamState[team.Opposite().String()].LastAdvantageResponse
-		if *advantageResponse.Response == TeamAdvantageResponse_CONTINUE {
+		advantageChoice := e.gcState.TeamState[team.Opposite().String()].AdvantageChoice
+		if *advantageChoice.Choice == TeamAdvantageChoice_CONTINUE {
 			return
 		}
 

internal/app/engine/process_team_advantage.go

@@ -2,15 +2,15 @@ package engine
 
 import "github.com/RoboCup-SSL/ssl-game-controller/internal/app/state"
 
-var defaultResponse = TeamAdvantageResponse_STOP
+var defaultChoice = TeamAdvantageChoice_STOP
 
-func (e *Engine) processTeamAdvantageResponse() {
+func (e *Engine) processTeamAdvantageChoice() {
 
 	for _, team := range state.BothTeams() {
-		advantageResponse := e.gcState.TeamState[team.String()].LastAdvantageResponse
-		if advantageResponse == nil {
-			e.gcState.TeamState[team.String()].LastAdvantageResponse = &TeamAdvantageResponse{
-				Response: &defaultResponse,
+		advantageChoice := e.gcState.TeamState[team.String()].AdvantageChoice
+		if advantageChoice == nil {
+			e.gcState.TeamState[team.String()].AdvantageChoice = &TeamAdvantageChoice{
+				Choice: &defaultChoice,
 			}
 		}
 	}

internal/app/engine/process_tick.go

@@ -60,7 +60,7 @@ func (e *Engine) processTick() {
 	e.noProgressDetector.process()
 	e.ballPlacementCoordinator.process()
 	e.processContinue()
-	e.processTeamAdvantageResponse()
+	e.processTeamAdvantageChoice()
 	e.botNumberProcessor.processBotNumber()
 	e.processPenalty()
 	e.processProposals()

internal/app/engine/ssl_gc_engine.pb.go

@@ -116,7 +116,7 @@ func (s *TeamServer) handleClientConnection(conn net.Conn) {
 				connected := false
 				teamState.Connected = &connected
 				teamState.ConnectionVerified = &connected
-				teamState.LastAdvantageResponse = nil
+				teamState.AdvantageChoice = nil
 			} else {
 				log.Println("Team not connected: " + client.team.String())
 			}
@@ -177,14 +177,14 @@ func (s *TeamServer) processRequest(teamClient TeamClient, request *TeamToContro
 		return nil
 	}
 
-	if x, ok := request.GetMsg().(*TeamToController_AdvantageResponse); ok {
-		responseType := engine.TeamAdvantageResponse_STOP
-		if x.AdvantageResponse == AdvantageResponse_CONTINUE {
-			responseType = engine.TeamAdvantageResponse_CONTINUE
+	if x, ok := request.GetMsg().(*TeamToController_AdvantageChoice); ok {
+		responseType := engine.TeamAdvantageChoice_STOP
+		if x.AdvantageChoice == AdvantageChoice_CONTINUE {
+			responseType = engine.TeamAdvantageChoice_CONTINUE
 		}
 		s.gcEngine.UpdateGcState(func(gcState *engine.GcState) {
-			gcState.TeamState[teamClient.team.String()].LastAdvantageResponse = &engine.TeamAdvantageResponse{
-				Response: &responseType,
+			gcState.TeamState[teamClient.team.String()].AdvantageChoice = &engine.TeamAdvantageChoice{
+				Choice: &responseType,
 			}
 		})
 		// exit early to avoid spamming the log

internal/app/rcon/server_team.go

@@ -37,17 +37,17 @@ message GcStateTeam {
     // true: The remote control for the team connected via TLS with a verified certificate
     optional bool remote_control_connection_verified = 4;
 
-    // the last advantage response of the team
-    optional TeamAdvantageResponse last_advantage_response = 5;
+    // the advantage choice of the team
+    optional TeamAdvantageChoice advantage_choice = 5;
 }
 
-// The response from a team regarding the advantage rule
-message TeamAdvantageResponse {
-    // the response of the team
-    optional AdvantageResponse response = 1;
+// The choice from a team regarding the advantage rule
+message TeamAdvantageChoice {
+    // the choice of the team
+    optional AdvantageChoice choice = 1;
 
-    // possible advantage responses
-    enum AdvantageResponse {
+    // possible advantage choices
+    enum AdvantageChoice {
         // stop the game
         STOP = 0;
         // keep the match running

internal/app/rcon/ssl_gc_rcon_team.pb.go

@@ -24,7 +24,7 @@ message TeamToController {
         // request a new desired keeper id
         int32 desired_keeper = 2;
         // response to an advantage choice request
-        AdvantageResponse advantage_response = 3;
+        AdvantageChoice advantage_choice = 3;
         // request to substitute a robot at the next possibility
         bool substitute_bot = 4;
         // send a ping to the GC to test if the connection is still open.
@@ -33,14 +33,15 @@ message TeamToController {
     }
 }
 
-enum AdvantageResponse {
-    option allow_alias = true;
+// the current advantage choice of the team
+// the choice is valid until another choice is received
+// if the team disconnects, the choice is reset to its default (STOP)
+// teams may either send their current choice continuously or only on change
+enum AdvantageChoice {
     // stop the game
     STOP = 0;
-    // continue the game a bit more
+    // keep the game running
     CONTINUE = 1;
-    // no choice -> will default to STOP
-    UNDECIDED = 0;
 }
 
 // wrapper for all messages from controller to a team's computer