From d464f63284fef47b71442d4c2bb93c699a6e4e44 Mon Sep 17 00:00:00 2001 From: bt Date: Sun, 29 Mar 2026 21:18:03 +0200 Subject: [docs] Use tables for payload types description --- docs/rfc.html | 188 +++++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 126 insertions(+), 62 deletions(-) (limited to 'docs/rfc.html') diff --git a/docs/rfc.html b/docs/rfc.html index 796825f..62a6738 100644 --- a/docs/rfc.html +++ b/docs/rfc.html @@ -1494,6 +1494,7 @@ spec. Following types are in use:
  • uint64
  • +

    Number in numeric type name is number of bits used to encode this type.

    @@ -1609,21 +1610,28 @@ Text is encoded using UTF-8.

    2.4.2. Error -
    -
      0
    -  0 1 2 3 4 5 6 7
    - +-+-+-+-+-+-+-+-+
    - |  Error Type   |
    - +-+-+-+-+-+-+-+-+
    -
    -
    + + + + + + + + + + + + + + +
    Table 2
    TypeName
    uint8error_type
    2.4.2.1. Error types
    - - +
    Table 2
    + @@ -1646,14 +1654,25 @@ Text is encoded using UTF-8.

    2.4.3. Handshake -
    -
      0                   1
    -  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
    - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
    - |   ver_major   |   ver_minor   |
    - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
    -
    -
    +
    Table 3
    Type
    + + + + + + + + + + + + + + + + + +
    Table 4
    TypeName
    uint8ver_major
    uint8ver_minor
    @@ -1661,16 +1680,25 @@ Text is encoded using UTF-8.

    2.4.4. Auth -
    -
      0                   1
    -  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
    - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
    - |   username (string)         ...
    - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
    - |   password (string)         ...
    - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
    -
    -
    + + + + + + + + + + + + + + + + + + +
    Table 5
    TypeName
    stringusername
    stringpassword
    @@ -1678,21 +1706,33 @@ Text is encoded using UTF-8.

    2.4.5. Message -
    -
      0                   1                   2                   3
    -  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
    - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
    - |                        source_address (string)              ...
    - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
    - |                        target_address (string)              ...
    - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
    - |                          timestamp                            |
    - |                                                               |
    - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
    - |                        message_content (string)             ...
    - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
    -
    -
    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 6
    TypeName
    stringsource_address
    stringtarget_address
    timestampsend_time
    stringmessage_content
    @@ -1702,25 +1742,49 @@ Text is encoded using UTF-8.

    Test payload is used for encoder and decoders testing. Clients and servers should ignore this kind of payload.

    -
    -
      0                   1                   2                   3
    -  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
    - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
    - | num1 (uint8)  | time1 (timestamp)                             |
    - |               +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-|
    - |               | str1 (string)                               ...
    - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
    - |         num2 (uint16)         | str2 (string)                 |
    - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
    - |                        num3 (uint32)                          |
    - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
    - |                        str3 (string)                          |
    - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
    - |                        num4 (uint64)                          |
    - |                                                               |
    - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
    -
    -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 7
    TypeName
    uint8num1
    timestamptime1
    stringstr1
    uint16num2
    stringstr2
    uint32num3
    stringstr3
    uint64num4
    -- cgit v1.2.3