Skip to content

Commit

Permalink
chore: add diagrams
Browse files Browse the repository at this point in the history
  • Loading branch information
Zork33 committed Sep 9, 2024
1 parent 69ca7b6 commit c34aad6
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions src/topic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,37 @@ Notice: This API is EXPERIMENTAL and may be changed or removed in a later releas
- Transactions
- Add context
- Graceful shutdown

# State machine

## Stream

```mermaid
stateDiagram
direction LR
[*] --> Init
Init --> Active
Active --> Closing
Closing --> Closed
Active --> Closed
Closed --> [*]
```

## Retryer

```mermaid
stateDiagram
direction TB
[*] --> init
init --> initStream
initStream --> active
active --> retriableError
active --> notRetriableError
active --> closing
closing --> closed
retriableError --> reinitStream
reinitStream --> forceblyCloseExistingStream
forceblyCloseExistingStream --> initStream
notRetriableError --> [*]
note right of notRetriableError : <font color="#333333">one of the possible causes of the error is the context timeout</font><br>
```

0 comments on commit c34aad6

Please sign in to comment.