From 6628f924ba4aefa8f8361ebc252fb225718359c2 Mon Sep 17 00:00:00 2001 From: bt Date: Thu, 4 Jun 2026 17:13:39 +0200 Subject: [common] Add channels list query --- docs/rfc.html | 68 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++- docs/rfc.md | 26 ++++++++++++++++++++--- docs/rfc.txt | 37 +++++++++++++++++++++++++++++++- 3 files changed, 126 insertions(+), 5 deletions(-) (limited to 'docs') diff --git a/docs/rfc.html b/docs/rfc.html index 373526e..297f593 100644 --- a/docs/rfc.html +++ b/docs/rfc.html @@ -1366,6 +1366,12 @@ SOLEC system.

  • 2.4.9.  Test

    +
    • +
  • +

    2.4.10. List

    +
    • +
  • +

    2.4.11. ListItem

    • @@ -1623,9 +1629,19 @@ Text is encoded using UTF-8.

    0x08 - History. + History C + + 0x09 + List + CE + + + 0x10 + ListItem + S + 0xFF Test @@ -1981,6 +1997,56 @@ should ignore this kind of payload.¶ +
    +
    +

    +2.4.10. List +

    +

    Request list of channels and users that client can send messages to. Number of retrieved items can be limited using count and offset fields.

    + + + + + + + + + + + + + + + + + + +
    Table 13
    TypeName
    int64count
    int64offset
    +
    +
    +
    +
    +

    +2.4.11. ListItem +

    +

    ListItem is send as a reply to List request. Multiple list items are sent in separate payloads.

    + + + + + + + + + + + + + + +
    Table 14
    TypeName
    stringaddress
    +
    +
    diff --git a/docs/rfc.md b/docs/rfc.md index d6c8085..ecfbdc0 100644 --- a/docs/rfc.md +++ b/docs/rfc.md @@ -161,9 +161,11 @@ Payload type attributes describes following characteristics: | 0x03 | Handshake | SC | | 0x04 | UserAuth | C | | 0x05 | Message | SC | -| 0x06 | ServerAuth | S | -| 0x07 | UserMode | C | -| 0x08 | History. | C | +| 0x06 | ServerAuth | S | +| 0x07 | UserMode | C | +| 0x08 | History | C | +| 0x09 | List | CE | +| 0x10 | ListItem | S | | 0xFF | Test | R | ### Success @@ -273,6 +275,24 @@ should ignore this kind of payload. | string | str3 | | uint64 | num4 | +### List + +Request list of channels and users that client can send messages to. Number of retrieved items can be limited using *count* and *offset* fields. + +| Type | Name | +|-----------|-----------------| +| int64 | count | +| int64 | offset | + +### ListItem + +*ListItem* is send as a reply to *List* request. Multiple list items are sent in separate payloads. + +| Type | Name | +|--------|---------| +| string | address | + + ## Sequential operations Some operations require multiple rounds of communication. diff --git a/docs/rfc.txt b/docs/rfc.txt index 335ea3d..173c1bd 100644 --- a/docs/rfc.txt +++ b/docs/rfc.txt @@ -35,6 +35,8 @@ Table of Contents 2.4.7. Usermode 2.4.8. History 2.4.9. Test + 2.4.10. List + 2.4.11. ListItem 2.5. Sequential operations 2.6. Client-Server connection initialisation 2.7. Exchanging messages between servers @@ -180,7 +182,11 @@ Table of Contents +------+------------+------------+ | 0x07 | UserMode | C | +------+------------+------------+ - | 0x08 | History. | C | + | 0x08 | History | C | + +------+------------+------------+ + | 0x09 | List | CE | + +------+------------+------------+ + | 0x10 | ListItem | S | +------+------------+------------+ | 0xFF | Test | R | +------+------------+------------+ @@ -368,6 +374,35 @@ Table of Contents Table 12 +2.4.10. List + + Request list of channels and users that client can send messages to. + Number of retrieved items can be limited using _count_ and _offset_ + fields. + + +=======+========+ + | Type | Name | + +=======+========+ + | int64 | count | + +-------+--------+ + | int64 | offset | + +-------+--------+ + + Table 13 + +2.4.11. ListItem + + _ListItem_ is send as a reply to _List_ request. Multiple list items + are sent in separate payloads. + + +========+=========+ + | Type | Name | + +========+=========+ + | string | address | + +--------+---------+ + + Table 14 + 2.5. Sequential operations Some operations require multiple rounds of communication. In this -- cgit v1.2.3