summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorbt <bt@rctt.net>2026-03-29 22:11:02 +0200
committerbt <bt@rctt.net>2026-03-29 22:11:02 +0200
commit37190b05b522890388d22f55d11d456635e89559 (patch)
tree9b33fc543816884a0e89cc1af0bb92b563a7b543 /docs
parentd464f63284fef47b71442d4c2bb93c699a6e4e44 (diff)
downloadsolec-37190b05b522890388d22f55d11d456635e89559.tar.gz
solec-37190b05b522890388d22f55d11d456635e89559.zip
[docs] Use sequence diagram for sequential operations description
Diffstat (limited to 'docs')
-rw-r--r--docs/rfc.html41
-rw-r--r--docs/rfc.md31
-rw-r--r--docs/rfc.txt31
3 files changed, 71 insertions, 32 deletions
diff --git a/docs/rfc.html b/docs/rfc.html
index 62a6738..86eaadf 100644
--- a/docs/rfc.html
+++ b/docs/rfc.html
@@ -1802,22 +1802,31 @@ specific operation (for example incoming message) cannot interrupt this process.
<h4 id="name-connection-initialisation">
<a href="#section-2.5.1" class="section-number selfRef">2.5.1. </a><a href="#name-connection-initialisation" class="section-name selfRef">Connection initialisation</a>
</h4>
-<ul class="compact">
-<li class="compact" id="section-2.5.1-1.1">Client: Initialise TCP connection.<a href="#section-2.5.1-1.1" class="pilcrow">¶</a>
-</li>
- <li class="compact" id="section-2.5.1-1.2">Client: Send <em>handshake</em>.<a href="#section-2.5.1-1.2" class="pilcrow">¶</a>
-</li>
- <li class="compact" id="section-2.5.1-1.3">Server: If <em>major</em> version of protocol differs close the connection.<a href="#section-2.5.1-1.3" class="pilcrow">¶</a>
-</li>
- <li class="compact" id="section-2.5.1-1.4">Server: Otherwise send <em>handshake</em>.<a href="#section-2.5.1-1.4" class="pilcrow">¶</a>
-</li>
- <li class="compact" id="section-2.5.1-1.5">Client: Send <em>auth</em>.<a href="#section-2.5.1-1.5" class="pilcrow">¶</a>
-</li>
- <li class="compact" id="section-2.5.1-1.6">Server: If user credentials does not match send <em>error</em> with <em>auth_failed</em>.<a href="#section-2.5.1-1.6" class="pilcrow">¶</a>
-</li>
- <li class="compact" id="section-2.5.1-1.7">Server: Otherwise send <em>success</em>.<a href="#section-2.5.1-1.7" class="pilcrow">¶</a>
-</li>
- </ul>
+<div class="lang-ascii-art sourcecode" id="section-2.5.1-1">
+<pre>+--------+ +--------+
+| Client | | Server |
++----+---+ +----+---+
+ | |
+ | Initialise TCP connection |
+ +---------------------------&gt;|
+ | |
+ | Send [Handshake] |
+ +---------------------------&gt;|
+ | |
+ | +- If [ver_major] does not match server
+ | | protocol version close the connection
+ | |
+ | Send [Auth] |
+ +---------------------------&gt;|
+ | |
+ | Send [Error 0x01] |
+ |&lt;---------------------------+- If [username] or [password] does not match
+ | | and close the connection
+ | |
+ | Send [Sucesss] |
+ |&lt;---------------------------+
+</pre><a href="#section-2.5.1-1" class="pilcrow">¶</a>
+</div>
</section>
</div>
</section>
diff --git a/docs/rfc.md b/docs/rfc.md
index 3bed7fc..6f902b0 100644
--- a/docs/rfc.md
+++ b/docs/rfc.md
@@ -226,10 +226,27 @@ specific operation (for example incoming message) cannot interrupt this process.
### Connection initialisation
-- Client: Initialise TCP connection.
-- Client: Send *handshake*.
-- Server: If *major* version of protocol differs close the connection.
-- Server: Otherwise send *handshake*.
-- Client: Send *auth*.
-- Server: If user credentials does not match send *error* with *auth_failed*.
-- Server: Otherwise send *success*.
+~~~ ascii-art
++--------+ +--------+
+| Client | | Server |
++----+---+ +----+---+
+ | |
+ | Initialise TCP connection |
+ +--------------------------->|
+ | |
+ | Send [Handshake] |
+ +--------------------------->|
+ | |
+ | +- If [ver_major] does not match server
+ | | protocol version close the connection
+ | |
+ | Send [Auth] |
+ +--------------------------->|
+ | |
+ | Send [Error 0x01] |
+ |<---------------------------+- If [username] or [password] does not match
+ | | and close the connection
+ | |
+ | Send [Sucesss] |
+ |<---------------------------+
+~~~ \ No newline at end of file
diff --git a/docs/rfc.txt b/docs/rfc.txt
index 02ad60a..1b2371a 100644
--- a/docs/rfc.txt
+++ b/docs/rfc.txt
@@ -273,12 +273,25 @@ Table of Contents
2.5.1. Connection initialisation
- * Client: Initialise TCP connection.
- * Client: Send _handshake_.
- * Server: If _major_ version of protocol differs close the
- connection.
- * Server: Otherwise send _handshake_.
- * Client: Send _auth_.
- * Server: If user credentials does not match send _error_ with
- _auth_failed_.
- * Server: Otherwise send _success_.
+ +--------+ +--------+
+ | Client | | Server |
+ +----+---+ +----+---+
+ | |
+ | Initialise TCP connection |
+ +--------------------------->|
+ | |
+ | Send [Handshake] |
+ +--------------------------->|
+ | |
+ | +- If [ver_major] does not match server
+ | | protocol version close the connection
+ | |
+ | Send [Auth] |
+ +--------------------------->|
+ | |
+ | Send [Error 0x01] |
+ |<---------------------------+- If [username] or [password] does not match
+ | | and close the connection
+ | |
+ | Send [Sucesss] |
+ |<---------------------------+