From c04c73a4df223c8c2b2b42ed482fc0181948e6ea Mon Sep 17 00:00:00 2001 From: bt Date: Sat, 16 May 2026 18:34:07 +0200 Subject: Update docs --- docs/rfc.html | 59 +++++++++++++++++++++++++++++++++++++++++++++++++---------- docs/rfc.md | 14 +++++++++++++- docs/rfc.txt | 38 +++++++++++++++++++++++++++++++++----- 3 files changed, 95 insertions(+), 16 deletions(-) diff --git a/docs/rfc.html b/docs/rfc.html index 3452389..b760565 100644 --- a/docs/rfc.html +++ b/docs/rfc.html @@ -1220,7 +1220,7 @@ li > p:last-of-type:only-child { bt -Expires 4 November 2026 +Expires 17 November 2026 [Page] @@ -1233,12 +1233,12 @@ li > p:last-of-type:only-child {
SOLEC
Published:
- +
Intended Status:
Experimental
Expires:
-
+
Author:
@@ -1274,7 +1274,7 @@ SOLEC system.

time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."

- This Internet-Draft will expire on 4 November 2026.

+ This Internet-Draft will expire on 17 November 2026.

-
+
-

-2.4.8. Test +

+2.4.8. GetHistory

-

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

+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + +
Table 11
TypeName
stringchannel_name
timestampsince
int64count
int64offset
+
+
+
+
+

+2.4.9. Test +

+

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

+ + diff --git a/docs/rfc.md b/docs/rfc.md index 3336cd4..b5fa585 100644 --- a/docs/rfc.md +++ b/docs/rfc.md @@ -243,6 +243,19 @@ example: joining, leaving or setting privilages. | 0x00 | none | | 0x01 | in_channel | +### GetHistory + +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. + +| Type | Name | +|-----------|--------------| +| string | channel_name | +| timestamp | since | +| int64 | count | +| int64 | offset | + ### Test Test payload is used for encoder and decoders testing. Clients and servers @@ -300,7 +313,6 @@ Exchanging messages between SOLEC servers is a core concept behind the project. Sending message to user residing on a different server require estabilishing a connection between both servers. - ### Authentication Server authentication is crucial to prevent message spoofing and other forms of diff --git a/docs/rfc.txt b/docs/rfc.txt index a9a4e0c..4805ab7 100644 --- a/docs/rfc.txt +++ b/docs/rfc.txt @@ -1,7 +1,7 @@ SOLEC Working Group bt, Ed. Internet-Draft RCTT.net -Intended status: Experimental 3 May 2026 -Expires: 4 November 2026 +Intended status: Experimental 16 May 2026 +Expires: 17 November 2026 System of Lightweight Electronic Communication @@ -33,7 +33,8 @@ Table of Contents 2.4.5. ServerAuth 2.4.6. Message 2.4.7. Usermode - 2.4.8. Test + 2.4.8. GetHistory + 2.4.9. Test 2.5. Sequential operations 2.6. Client-Server connection initialisation 2.7. Exchanging messages between servers @@ -310,7 +311,34 @@ Table of Contents Table 10 -2.4.8. Test +2.4.8. GetHistory + + 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. + + +===========+==============+ + | Type | Name | + +===========+==============+ + | string | channel_name | + +-----------+--------------+ + | timestamp | since | + +-----------+--------------+ + | int64 | count | + +-----------+--------------+ + | int64 | offset | + +-----------+--------------+ + + Table 11 + +2.4.9. Test Test payload is used for encoder and decoders testing. Clients and servers should ignore this kind of payload. @@ -335,7 +363,7 @@ Table of Contents | uint64 | num4 | +-----------+-------+ - Table 11 + Table 12 2.5. Sequential operations -- cgit v1.2.3
Table 12
Type