flavien/Projet_JAVA_P2P_STRI2A
3
2
Fork 0
Code Issues 11 Pull Requests Releases 13 Activity

Update protocol.md
All checks were successful
flavien's git/Projet_JAVA_P2P_STRI2A/pipeline/pr-etape5 This commit looks good
Details

Browse Source 
Fix #42
This commit is contained in:
Louis Royer 2020-03-25 14:05:48 +01:00
parent c3b4d0660d
commit 230092ab2a
1 changed files with 59 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
doc/protocol.md
View File

@ -2,7 +2,7 @@
All strings in the datagram are utf-8 encoded. All strings in the datagram are utf-8 encoded.
```Datagram format ```text
1 byte: [(byte 0 ): VERSION(0x11, first quartet is major version, second is minor)] 1 byte: [(byte 0 ): VERSION(0x11, first quartet is major version, second is minor)]
1 byte: [(byte 1 ): REQUEST/RESPONSE CODE] 1 byte: [(byte 1 ): REQUEST/RESPONSE CODE]
@ -20,12 +20,15 @@ x bytes: [(bytes 8-?): PAYLOAD]
- `DISCOVER` (0x03) - `DISCOVER` (0x03)
- `REGISTER` (0x04) - `REGISTER` (0x04)
- `UNREGISTER` (0x05) - `UNREGISTER` (0x05)
- `RATIO` (0x06)
- `UPDATE RATIO` (0x07)
- RESPONSES (msb is 1): - RESPONSES (msb is 1):
- `LIST` (0x80) - `LIST` (0x80)
- `LOAD` (0x81) - `LOAD` (0x81)
- `HASH` (0x82) - `HASH` (0x82)
- `DISCOVER` (0x83) - `DISCOVER` (0x83)
- `RATIO` (0x86)
- `VERSION ERROR` (0xC0) - `VERSION ERROR` (0xC0)
- `PROTOCOL ERROR` (0xC1) - `PROTOCOL ERROR` (0xC1)
- `INTERNAL ERROR` (0xC2) - `INTERNAL ERROR` (0xC2)
@ -33,6 +36,8 @@ x bytes: [(bytes 8-?): PAYLOAD]
- `NOT FOUND` (0xC4) - `NOT FOUND` (0xC4)
- `EMPTY FILE` (0xC5) - `EMPTY FILE` (0xC5)
- `NOT A TRACKER` (0xC6) - `NOT A TRACKER` (0xC6)
- `UNKNOWN HOST` (0xC7)
- `DENIED` (0xC8)
### List ### List
Payload size for list request is always zero. Payload size for list request is always zero.
@ -52,7 +57,7 @@ Payload size for Not found is zero.
#### Load response #### Load response
Payload contains Payload contains
``` ```text
8 bytes: [(bytes 8-15): OFFSET OF FILE CONTENT IN BYTES] 8 bytes: [(bytes 8-15): OFFSET OF FILE CONTENT IN BYTES]
8 bytes: [(bytes 16-23): TOTAL FILESIZE] 8 bytes: [(bytes 16-23): TOTAL FILESIZE]
4 bytes: [(bytes 24-27): FILENAME SIZE] (cannot be > to PAYLOAD_SIZE - 20 or be zero) 4 bytes: [(bytes 24-27): FILENAME SIZE] (cannot be > to PAYLOAD_SIZE - 20 or be zero)
@ -63,18 +68,21 @@ z bytes: [PARTIAL CONTENT]
#### Load request #### Load request
Payload contains Payload contains
``` ```text
8 bytes: [(bytes 8-15): OFFSET OF FILE CONTENT IN BYTES] 8 bytes: [(bytes 8-15): OFFSET OF FILE CONTENT IN BYTES]
8 bytes: [(bytes 16-23): MAX SIZE OF PARTIAL CONTENT (partial content in response should not excess this size, but this can be less (by example if endoffile is reached or server doesn't have the full block requested) 8 bytes: [(bytes 16-23): MAX SIZE OF PARTIAL CONTENT (partial content in response should not excess this size, but this can be less (by example if endoffile is reached or server doesn't have the full block requested)
4 bytes: [(bytes 24-27): FILENAME SIZE] (cannot be > to PAYLOAD_SIZE - 20 or be zero) 4 bytes: [(bytes 24-27): FILENAME SIZE] (cannot be > to PAYLOAD_SIZE - 20 or be zero)
y bytes: [<FILENAME>] y bytes: [<FILENAME>]
2 bytes: port used to register on tracker
? bytes: hostname used to register on tracker followed by \n
``` ```
Possible responses: Load Response, or Denied
### Hash ### Hash
#### Hash request #### Hash request
Get hash of a file. Payload contains Get hash of a file. Payload contains
``` ```text
4 bytes: [(bytes 8-11): FILENAME SIZE] 4 bytes: [(bytes 8-11): FILENAME SIZE]
y bytes: [<FILENAME>] y bytes: [<FILENAME>]
z bytes: [ALGO_NAMES requested separated by \n] (ex.: SHA-256, MD5) z bytes: [ALGO_NAMES requested separated by \n] (ex.: SHA-256, MD5)
@ -86,7 +94,7 @@ If file does not exists, a NotFound can be responded.
Payload contains: Payload contains:
``` ```text
4 bytes: [(bytes 8-11): FILENAME SIZE] 4 bytes: [(bytes 8-11): FILENAME SIZE]
y bytes: [<FILENAME>] y bytes: [<FILENAME>]
[[ multiple algo hashes bloc]] [[ multiple algo hashes bloc]]
@ -94,7 +102,7 @@ y bytes: [<FILENAME>]
A algo hash bloc contains: A algo hash bloc contains:
``` ```text
4 bytes [ALGO_NAME size] 4 bytes [ALGO_NAME size]
? [ALGO_NAME] ? [ALGO_NAME]
4 bytes: [HASH SIZE (bytes)] / or 0 if this hash algorithm is unsupported. 4 bytes: [HASH SIZE (bytes)] / or 0 if this hash algorithm is unsupported.
@ -108,7 +116,7 @@ Used by a server to register itself on a tracker.
Server may want to do a free `DISCOVER` to check if they have been registered. Server may want to do a free `DISCOVER` to check if they have been registered.
Payload contains: Payload contains:
``` ```text
2 bytes: [<PORT NUMBER>] 2 bytes: [<PORT NUMBER>]
``` ```
@ -118,7 +126,7 @@ No error is raised if the server was not registered.
Server may want to do a free `DISCOVER` to check if they have been unregistered. Server may want to do a free `DISCOVER` to check if they have been unregistered.
Payload contains: Payload contains:
``` ```text
2 bytes: [<PORT NUMBER>] 2 bytes: [<PORT NUMBER>]
? bytes: [<HOSTNAME>] ? bytes: [<HOSTNAME>]
``` ```
@ -127,14 +135,14 @@ Payload contains:
If payload size is null, lists all servers registered. If payload size is null, lists all servers registered.
If payload contains a filename, list all servers having this file in their list. If payload contains a filename, list all servers having this file in their list.
``` ```text
? bytes: [<FILENAME>] ? bytes: [<FILENAME>]
? bytes: [<HOSTNAME>] ? bytes: [<HOSTNAME>]
``` ```
#### Discover response #### Discover response
Contains: Contains:
``` ```text
4 bytes: [(bytes 8-11): FILENAME SIZE] 4 bytes: [(bytes 8-11): FILENAME SIZE]
y bytes: [<FILENAME>] y bytes: [<FILENAME>]
? bytes [multiple server blocks] ? bytes [multiple server blocks]
@ -142,7 +150,7 @@ y bytes: [<FILENAME>]
Server block is composed with: Server block is composed with:
``` ```text
2 bytes: [port] 2 bytes: [port]
? bytes: hostname ? bytes: hostname
\n \n
@ -152,6 +160,45 @@ Server block is composed with:
This error is raised when receiving a DISCOVER, a REGISTER, or an UNREGISTER request, This error is raised when receiving a DISCOVER, a REGISTER, or an UNREGISTER request,
but this application is not a tracker. but this application is not a tracker.
#### Ratio Request
Contains:
```text
2 bytes: port
? bytes: hostname
```
Possible responses: Ratio Response, or Unknown Host
#### Ratio Response
Contains:
```text
2 bytes: port
? bytes: hostname followed by \n
8 bytes: total sent bytes
8 bytes: total received bytes
```
#### Update Ratio
Contains:
```text
2 bytes: server port
2 bytes: client* port
? bytes: server hostname followed by \n
? bytes: client* hostname
* note: used by client to register on tracker
```
Possible responses: No response, or Unknown Host (if client is not registered or server is not registered)
Note: client must have verified hash before sending Update Ratio to tracker for each server which participated.
#### Unknown Host
Payload size is zero.
#### Denied
Contains
```text
?bytes: filename
```
### Other response code (errors) ### Other response code (errors)
#### Version error #### Version error
Response when datagram received use wrong version code. Response when datagram received use wrong version code.