Skip to content

Commit 03fce22

Browse files
authored
[doc] Add Connection stability section
1 parent 637f796 commit 03fce22

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

cmd/ssl-team-client/README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,17 @@ The .proto files can be found [here](../../pkg/refproto).
99

1010
The default port is `10008` for plain connections and 10108 for TLS encrypted connections. The IP to connect to can be determined using the multicast referee messages.
1111

12-
## Connection Sequence
12+
## Connection sequence
1313
The connection is described in the following sequence diagram:
1414

1515
![sequence diagram](https://www.websequencediagrams.com/cgi-bin/cdraw?lz=IyBodHRwczovL3d3dy53ZWJzZXF1ZW5jZWRpYWdyYW1zLmNvbS8KClRlYW0tPkNvbnRyb2xsZXI6IGVzdGFibGlzaCBUQ1AgY29ubmVjdGlvbgoAGwoAIw5nZW5lcmF0ZSBuZXcgdG9rZQAdDlRlYW06IABYClJlcGx5ICgAJAYgKQBvE1RlYW1SZWdpc3RyYXRpb24gKCB0ZWFtTmFtZSwgWwBdBiwgc2lnbmF0dXJlIF0gKQCBEQwAgUEOdmVyaWZ5AIEGEgARFQBLCQCBHSVvayB8IHJlamVjdCApCgpsb29wCmFsdACBKAUgcmVxdWVzdHMgYSBjaGFuZ2UAgVIXVG8Agg8MAC8FAEozZWxzZSBjAIM9CQByDGRlY2lzAIMwEACDBRBUbwCCbwYAegYATV1uZAplbmQKCg&s=napkin)
1616

1717
Source to generate the diagram: [communication_team.txt](./communication_team.txt)
1818

19-
## Secure Connection
19+
## Connection stability
20+
Clients should deal with connection losts (reconnect). The game-controller may be restarted due to various reasons like crashes or other technical issues. Teams are not allowed to touch their system to reconnect to the game-controller, except during timeouts.
21+
22+
## Secure connection
2023
The connection can optionally be secured by signing each request using a RSA key.
2124

2225
The private key is used on the client side to sign the complete message, excluding the signature itself.
@@ -47,4 +50,4 @@ go run cmd/ssl-team-client/main.go
4750
```
4851
Pass it the `-h` parameter to get the available options.
4952

50-
By default, it tries to connect as "Test Team", which is also available in the UI. Make sure to select this team for yellow or blue.
53+
By default, it tries to connect as "Test Team", which is also available in the UI. Make sure to select this team for yellow or blue.

0 commit comments

Comments
 (0)