Skip to content
This repository was archived by the owner on Sep 19, 2021. It is now read-only.

Commit 265cce3

Browse files
authored
Merge branch 'master' into fix_hex_conversion
2 parents 0d48971 + 182a1c9 commit 265cce3

1 file changed

Lines changed: 28 additions & 8 deletions

File tree

README.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,34 @@ JAVA 7 when working with this project.
3737
the following two commands in separate shells:
3838

3939
```
40-
$ sh run_server.sh
41-
$ sh run_client.sh
40+
$ sh run_server.sh <team_id> <team_secret> <port>
41+
$ sh run_client.sh <host> <port>
4242
```
4343

44-
The `run_server` and `run_client` scripts have hard-coded addresses for
45-
your local machine. If you are running the server on a different machine
46-
than the client, you will need to change the host portion of the address
47-
in `run_client.sh` to the name of the host where your server is running.
48-
Make sure the client and server are using the same port number.
44+
You must specify the following startup arguments for `run_server.sh:
45+
+ `<team_id>` and `<team_secret>`: a numeric id for your team, and a secret
46+
code, which are used to authenticate your server with the Relay server.
47+
You can specify any integer value for `<team_id>`, and a value expressed
48+
in hexadecimal format (using numbers `0-9` and letters in the range
49+
`A-F`) for `<team_secret>` when you launch the server in your local setup
50+
since it will not connect to the Relay server.
51+
+ `<port>`: the TCP port that your Server will listen on for connections
52+
from the Client. You can use any value between 1024 and 65535, as long as
53+
there is no other service currently listening on that port in your
54+
system. The server will return an error:
55+
56+
```
57+
java.net.BindException: Address already in use (Bind failed)
58+
```
59+
60+
if the port is already in use.
61+
62+
The startup arguments for `run_client.sh` are the following:
63+
+ `<host>`: the hostname or IP address of the computer on which the server
64+
is listening. If you are running server and client on the same computer,
65+
you can use `localhost` here.
66+
+ `<port>`: the port on which your server is listening. Must be the same
67+
port number you have specified when you launched `run_server.sh`.
4968
5069
All running images write informational and exceptional events to log files.
5170
The default setting for log messages is "INFO". You may change this to get
@@ -66,12 +85,13 @@ All the source files (except test-related source files) are in
6685
use the supplied scripts to build the project, the `.class` files will be placed
6786
in `./bin`. There is a `./third_party` directory that holds the jar files for
6887
JUnit (a Java testing framework). Your environment may or may not already have
69-
this installed. The supplied scripts use the version in ./third_party.
88+
this installed. The supplied scripts use the version in `./third_party`.
7089
7190
Finally, there are some high-level design documents in the project Wiki. Please
7291
review them as they can help you find your way around the sources.
7392
7493
94+
7595
## Source Directories
7696
7797
The major project components have been separated into their own packages. The

0 commit comments

Comments
 (0)