summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorbt <bt@rctt.net>2026-05-16 22:45:42 +0200
committerbt <bt@rctt.net>2026-05-16 22:46:48 +0200
commit164428421ef950ee9572287fd9ade8876ed4bfe5 (patch)
tree452081adcd3bdba0b016fb107fd19f382387e3ea
parent594ed058b3cf318a9eed2a950501efdf5114b49e (diff)
downloadsolec-0.4.0.tar.gz
solec-0.4.0.zip
Update docsv0.4.0
-rw-r--r--docs/rfc.html17
-rw-r--r--docs/rfc.md22
-rw-r--r--docs/rfc.txt52
3 files changed, 49 insertions, 42 deletions
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.<a href="#section-abstract-1" class="pilcrow">¶</a></p>
<p id="section-toc.1-1.2.2.4.2.7.1"><a href="#section-2.4.7" class="auto internal xref">2.4.7</a>.  <a href="#name-usermode" class="internal xref">Usermode</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.2.2.4.2.8">
- <p id="section-toc.1-1.2.2.4.2.8.1"><a href="#section-2.4.8" class="auto internal xref">2.4.8</a>.  <a href="#name-gethistory" class="internal xref">GetHistory</a></p>
+ <p id="section-toc.1-1.2.2.4.2.8.1"><a href="#section-2.4.8" class="auto internal xref">2.4.8</a>.  <a href="#name-history" class="internal xref">History</a></p>
</li>
<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>
@@ -1622,6 +1622,11 @@ Text is encoded using UTF-8.<a href="#section-2.3.3-1" class="pilcrow">¶</a></p
<td class="text-left" rowspan="1" colspan="1">C</td>
</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">C</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>
@@ -1852,7 +1857,7 @@ example: joining, leaving or setting privilages.<a href="#section-2.4.7-1" class
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">string</td>
- <td class="text-left" rowspan="1" colspan="1">channel_name</td>
+ <td class="text-left" rowspan="1" colspan="1">channel_address</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">uint8</td>
@@ -1888,10 +1893,10 @@ example: joining, leaving or setting privilages.<a href="#section-2.4.7-1" class
</div>
</section>
</div>
-<div id="gethistory">
+<div id="history">
<section id="section-2.4.8">
- <h4 id="name-gethistory">
-<a href="#section-2.4.8" class="section-number selfRef">2.4.8. </a><a href="#name-gethistory" class="section-name selfRef">GetHistory</a>
+ <h4 id="name-history">
+<a href="#section-2.4.8" class="section-number selfRef">2.4.8. </a><a href="#name-history" class="section-name selfRef">History</a>
</h4>
<p id="section-2.4.8-1">Read messages previously send to a specific channel. User has to member of the channel to perform this action. <em>since</em> field specifies start of time range for which history should be retrieved. <em>count</em> specifes how many messages should be returned in a single response. <em>GetHistory</em> is a locking sequence and it cannot be cancelled while in progress so <em>count</em> should be set relatively low. To get more messages use multiple requests with incremented <em>offset</em>.<a href="#section-2.4.8-1" class="pilcrow">¶</a></p>
<p id="section-2.4.8-2">Response is just a sequence of <em>Message</em>. Client should use <em>Timestamp</em> field of a <em>Message</em> to show them in corrent order.<a href="#section-2.4.8-2" class="pilcrow">¶</a></p>
@@ -1906,7 +1911,7 @@ example: joining, leaving or setting privilages.<a href="#section-2.4.7-1" class
<tbody>
<tr>
<td class="text-left" rowspan="1" colspan="1">string</td>
- <td class="text-left" rowspan="1" colspan="1">channel_name</td>
+ <td class="text-left" rowspan="1" colspan="1">channel_address</td>
</tr>
<tr>
<td class="text-left" rowspan="1" colspan="1">timestamp</td>
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