mirror
/
M17_spec
kopia lustrzana https://github.com/M17-Project/M17_spec
1
0
Forkuj 0
Kod Zgłoszenia Projekty Wydania Wiki Aktywność

Merge pull request #58 from wgaylord/wgaylord-ip-encapsulation 

Update ip_encapslation to follow existing M17 implementations.
pull/61/head
Wojciech Kaczmarski 2021-06-09 19:05:58 +02:00 zatwierdzone przez GitHub
rodzic 88a7a82663 f6ac50dbb3
commit 04adb9e9dd
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: 4AEE18F83AFDEB23
1 zmienionych plików z 19 dodań i 4 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

23
docs/ip_encapsulation.rst
Wyświetl plik

@ -67,7 +67,8 @@ Reflectors use a few different types of control frames, identified by their magi
* *CONN* - Connect to a reflector
* *ACKN* - acknowledge connection
* *NACK* - deny connection
* *PING/PONG* - keepalives for the connection
* *PING* - keepalive for the connection from the reflector to the client
* *PONG* - keepalive response from the client to the reflector
* *DISC* - Disconnect (client->reflector or reflector->client)
CONN
@ -99,8 +100,8 @@ ACKN
+=======+================================================================================================================+
| 0-3 | Magic - ASCII "ACKN" |
+-------+----------------------------------------------------------------------------------------------------------------+
| 4-9 | 6-byte callsign including module in last character (e.g. "A1BCD D") encoded as per `Address Encoding` |
+-------+----------------------------------------------------------------------------------------------------------------+
.. todo:: Originally this was defined as having the callsign including module encodes as per 'Address Encoding' simular to the CONN frame, while current implementations of the client do not accept packets with that, it may be go to eventually re-work this to once again include that field.
NACK
~~~~~~~~~~~~~~~~~
@ -113,6 +114,21 @@ NACK
| 0-3 | Magic - ASCII "NACK" |
+-------+--------------------------------------------------------------------------------------------------------------------------+
PING
~~~~~~~~~~~~~~~~~
.. table :: Bytes of PING packet
+-------+----------------------------------------------------------------------------------------------------------------+
| Bytes | Purpose |
+=======+================================================================================================================+
| 0-3 | Magic - ASCII "PING" |
+-------+----------------------------------------------------------------------------------------------------------------+
| 4-9 | 6-byte 'From' callsign including module in last character (e.g. "A1BCD D") encoded as per `Address Encoding` |
+-------+----------------------------------------------------------------------------------------------------------------+
Upon receivng a PING from a reflector, the client replies with a PONG
PONG
~~~~~~~~~~~~~~~~~
@ -126,7 +142,6 @@ PONG
| 4-9 | 6-byte 'From' callsign including module in last character (e.g. "A1BCD D") encoded as per `Address Encoding` |
+-------+----------------------------------------------------------------------------------------------------------------+
Upon receivng a PING, the client replies with a PONG
DISC
~~~~~~~~~~~~~~~~~