From 164428421ef950ee9572287fd9ade8876ed4bfe5 Mon Sep 17 00:00:00 2001 From: bt Date: Sat, 16 May 2026 22:45:42 +0200 Subject: Update docs --- docs/rfc.html | 17 +++++++++++------ docs/rfc.md | 22 +++++++++++----------- docs/rfc.txt | 52 +++++++++++++++++++++++++++------------------------- 3 files changed, 49 insertions(+), 42 deletions(-) (limited to 'docs') diff --git a/docs/rfc.html b/docs/rfc.html index b760565..03c7a96 100644 --- a/docs/rfc.html +++ b/docs/rfc.html @@ -1362,7 +1362,7 @@ SOLEC system.

2.4.7.  Usermode

  • -

    2.4.8.  GetHistory

    +

    2.4.8.  History

  • 2.4.9.  Test

    @@ -1621,6 +1621,11 @@ Text is encoded using UTF-8.

    UserMode C + + 0x08 + History. + C + 0xFF Test @@ -1852,7 +1857,7 @@ example: joining, leaving or setting privilages. string - channel_name + channel_address uint8 @@ -1888,10 +1893,10 @@ example: joining, leaving or setting privilages. -
    +
    -

    -2.4.8. GetHistory +

    +2.4.8. History

    Read messages previously send to a specific channel. User has to member of the channel to perform this action. since field specifies start of time range for which history should be retrieved. count specifes how many messages should be returned in a single response. GetHistory is a locking sequence and it cannot be cancelled while in progress so count should be set relatively low. To get more messages use multiple requests with incremented offset.

    Response is just a sequence of Message. Client should use Timestamp field of a Message to show them in corrent order.

    @@ -1906,7 +1911,7 @@ example: joining, leaving or setting privilages. string - channel_name + channel_address timestamp diff --git a/docs/rfc.md b/docs/rfc.md index e60527f..e99b53b 100644 --- a/docs/rfc.md +++ b/docs/rfc.md @@ -231,11 +231,11 @@ different auth method will be used. Usermode payload is used for changing user settings related to channels. For example: joining, leaving or setting privilages. -| Type | Name | -|--------|--------------| -| string | user_address | -| string | channel_name | -| uint8 | mode | +| Type | Name | +|--------|-----------------| +| string | user_address | +| string | channel_address | +| uint8 | mode | #### Modes @@ -250,12 +250,12 @@ Read messages previously send to a specific channel. User has to member of the c Response is just a sequence of *Message*. Client should use *Timestamp* field of a *Message* to show them in corrent order. -| Type | Name | -|-----------|--------------| -| string | channel_name | -| timestamp | since | -| int64 | count | -| int64 | offset | +| Type | Name | +|-----------|-----------------| +| string | channel_address | +| timestamp | since | +| int64 | count | +| int64 | offset | ### Test diff --git a/docs/rfc.txt b/docs/rfc.txt index 4805ab7..c235666 100644 --- a/docs/rfc.txt +++ b/docs/rfc.txt @@ -33,7 +33,7 @@ Table of Contents 2.4.5. ServerAuth 2.4.6. Message 2.4.7. Usermode - 2.4.8. GetHistory + 2.4.8. History 2.4.9. Test 2.5. Sequential operations 2.6. Client-Server connection initialisation @@ -179,6 +179,8 @@ Table of Contents +------+------------+------------+ | 0x07 | UserMode | C | +------+------------+------------+ + | 0x08 | History. | C | + +------+------------+------------+ | 0xFF | Test | R | +------+------------+------------+ @@ -287,17 +289,17 @@ Table of Contents Usermode payload is used for changing user settings related to channels. For example: joining, leaving or setting privilages. - +========+==============+ - | Type | Name | - +========+==============+ - | string | user_address | - +--------+--------------+ - | string | channel_name | - +--------+--------------+ - | uint8 | mode | - +--------+--------------+ + +========+=================+ + | Type | Name | + +========+=================+ + | string | user_address | + +--------+-----------------+ + | string | channel_address | + +--------+-----------------+ + | uint8 | mode | + +--------+-----------------+ - Table 9 + Table 9 2.4.7.1. Modes @@ -311,7 +313,7 @@ Table of Contents Table 10 -2.4.8. GetHistory +2.4.8. History Read messages previously send to a specific channel. User has to member of the channel to perform this action. _since_ field specifies @@ -324,19 +326,19 @@ Table of Contents Response is just a sequence of _Message_. Client should use _Timestamp_ field of a _Message_ to show them in corrent order. - +===========+==============+ - | Type | Name | - +===========+==============+ - | string | channel_name | - +-----------+--------------+ - | timestamp | since | - +-----------+--------------+ - | int64 | count | - +-----------+--------------+ - | int64 | offset | - +-----------+--------------+ - - Table 11 + +===========+=================+ + | Type | Name | + +===========+=================+ + | string | channel_address | + +-----------+-----------------+ + | timestamp | since | + +-----------+-----------------+ + | int64 | count | + +-----------+-----------------+ + | int64 | offset | + +-----------+-----------------+ + + Table 11 2.4.9. Test -- cgit v1.2.3