diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/rfc.html | 68 | ||||
| -rw-r--r-- | docs/rfc.md | 26 | ||||
| -rw-r--r-- | docs/rfc.txt | 37 |
3 files changed, 126 insertions, 5 deletions
diff --git a/docs/rfc.html b/docs/rfc.html index 373526e..297f593 100644 --- a/docs/rfc.html +++ b/docs/rfc.html @@ -1367,6 +1367,12 @@ SOLEC system.<a href="#section-abstract-1" class="pilcrow">¶</a></p> <li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.4.2.9"> <p id="section-toc.1-1.2.2.4.2.9.1"><a href="#section-2.4.9" class="auto internal xref">2.4.9</a>. <a href="#name-test" class="internal xref">Test</a></p> </li> + <li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.4.2.10"> + <p id="section-toc.1-1.2.2.4.2.10.1"><a href="#section-2.4.10" class="auto internal xref">2.4.10</a>. <a href="#name-list" class="internal xref">List</a></p> +</li> + <li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.4.2.11"> + <p id="section-toc.1-1.2.2.4.2.11.1"><a href="#section-2.4.11" class="auto internal xref">2.4.11</a>. <a href="#name-listitem" class="internal xref">ListItem</a></p> +</li> </ul> </li> <li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.5"> @@ -1623,10 +1629,20 @@ Text is encoded using UTF-8.<a href="#section-2.3.3-1" class="pilcrow">¶</a></p </tr> <tr> <td class="text-left" rowspan="1" colspan="1">0x08</td> - <td class="text-left" rowspan="1" colspan="1">History.</td> + <td class="text-left" rowspan="1" colspan="1">History</td> <td class="text-left" rowspan="1" colspan="1">C</td> </tr> <tr> + <td class="text-left" rowspan="1" colspan="1">0x09</td> + <td class="text-left" rowspan="1" colspan="1">List</td> + <td class="text-left" rowspan="1" colspan="1">CE</td> + </tr> + <tr> + <td class="text-left" rowspan="1" colspan="1">0x10</td> + <td class="text-left" rowspan="1" colspan="1">ListItem</td> + <td class="text-left" rowspan="1" colspan="1">S</td> + </tr> + <tr> <td class="text-left" rowspan="1" colspan="1">0xFF</td> <td class="text-left" rowspan="1" colspan="1">Test</td> <td class="text-left" rowspan="1" colspan="1">R</td> @@ -1981,6 +1997,56 @@ should ignore this kind of payload.<a href="#section-2.4.9-1" class="pilcrow">¶ </table> </section> </div> +<div id="list"> +<section id="section-2.4.10"> + <h4 id="name-list"> +<a href="#section-2.4.10" class="section-number selfRef">2.4.10. </a><a href="#name-list" class="section-name selfRef">List</a> + </h4> +<p id="section-2.4.10-1">Request list of channels and users that client can send messages to. Number of retrieved items can be limited using <em>count</em> and <em>offset</em> fields.<a href="#section-2.4.10-1" class="pilcrow">¶</a></p> +<table class="center" id="table-13"> + <caption><a href="#table-13" class="selfRef">Table 13</a></caption> +<thead> + <tr> + <th class="text-left" rowspan="1" colspan="1">Type</th> + <th class="text-left" rowspan="1" colspan="1">Name</th> + </tr> + </thead> + <tbody> + <tr> + <td class="text-left" rowspan="1" colspan="1">int64</td> + <td class="text-left" rowspan="1" colspan="1">count</td> + </tr> + <tr> + <td class="text-left" rowspan="1" colspan="1">int64</td> + <td class="text-left" rowspan="1" colspan="1">offset</td> + </tr> + </tbody> + </table> +</section> +</div> +<div id="listitem"> +<section id="section-2.4.11"> + <h4 id="name-listitem"> +<a href="#section-2.4.11" class="section-number selfRef">2.4.11. </a><a href="#name-listitem" class="section-name selfRef">ListItem</a> + </h4> +<p id="section-2.4.11-1"><em>ListItem</em> is send as a reply to <em>List</em> request. Multiple list items are sent in separate payloads.<a href="#section-2.4.11-1" class="pilcrow">¶</a></p> +<table class="center" id="table-14"> + <caption><a href="#table-14" class="selfRef">Table 14</a></caption> +<thead> + <tr> + <th class="text-left" rowspan="1" colspan="1">Type</th> + <th class="text-left" rowspan="1" colspan="1">Name</th> + </tr> + </thead> + <tbody> + <tr> + <td class="text-left" rowspan="1" colspan="1">string</td> + <td class="text-left" rowspan="1" colspan="1">address</td> + </tr> + </tbody> + </table> +</section> +</div> </section> </div> <div id="sequential-operations"> 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 |