Skip to content

Commit 1d26505

Browse files
authored
Merge pull request #409 from nervosnetwork/add-spec-readme
docs: added tentacle event sequence description
2 parents 497499c + 6e5de11 commit 1d26505

File tree

2 files changed

+10
-104
lines changed

2 files changed

+10
-104
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,15 @@ all wasm code generate from [book](https://rustwasm.github.io/docs/book/game-of-
9191

9292
4. Now you can see the connection on the server workbench or on browser's console
9393

94+
## Event Order Guarantees
95+
96+
Tentacle provides the following guarantees regarding event ordering:
97+
98+
1. All protocol events **always occur after** the initial `SessionOpen` event
99+
2. The `SessionClose` event is guaranteed to be the final event in a session's lifecycle
100+
3. When multiple protocols are opened simultaneously, no specific ordering is guaranteed between their events
101+
4. Critical errors such as `SessionTimeOut` or `MuxerError` will immediately trigger a `SessionClose` event, causing the connection to terminate automatically
102+
94103
## Other Languages
95104

96105
Implementations in other languages

tentacle/README.md

Lines changed: 0 additions & 104 deletions
This file was deleted.

tentacle/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../README.md

0 commit comments

Comments
 (0)