summaryrefslogtreecommitdiffstats
path: root/docs/rfc.md
diff options
context:
space:
mode:
authorbt <bt@rctt.net>2026-05-16 18:34:07 +0200
committerbt <bt@rctt.net>2026-05-16 22:46:48 +0200
commitc04c73a4df223c8c2b2b42ed482fc0181948e6ea (patch)
tree5f42522ddfb880a677b92a4492c42fdb786e23b2 /docs/rfc.md
parentb5d08e7908efaa2d9eae9a3d52249bbb51be0761 (diff)
downloadsolec-c04c73a4df223c8c2b2b42ed482fc0181948e6ea.tar.gz
solec-c04c73a4df223c8c2b2b42ed482fc0181948e6ea.zip
Update docs
Diffstat (limited to 'docs/rfc.md')
-rw-r--r--docs/rfc.md14
1 files changed, 13 insertions, 1 deletions
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