opensource/teleport
3
0
Fork 0
mirror of https://github.com/gravitational/teleport.git synced 2026-10-29 17:58:15 +08:00
Code Issues Packages Projects Releases Wiki Activity

Convert Sequence Diagram img to mermaid (#51723)

Browse Source 
* Convert Sequence Diagram img to mermaid

* Remove PTY communication documentation files
This commit is contained in:
Nicolas
2025-01-31 22:50:03 +00:00
committed by GitHub
parent 79b11308ca
commit 4d4a406f5a
3 changed files with 28 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files
web/packages/teleterm/README.md
+28 -1
View File
@@ -248,7 +248,34 @@ resource availability as possible.
### PTY communication overview (Renderer Process <=> Shared Process)
![PTY communication](docs/ptyCommunication.png)
```mermaid
sequenceDiagram
autonumber
participant DT as Document Terminal
participant PS as PTY Service
participant PHS as PTY Host Service
participant PP as PTY Process
DT->>PS: wants new PTY
Note over PS,PHS: gRPC communication
PS->>PHS: createPtyProcess(options)
PHS->>PP: new PtyProcess()
PHS-->>PS: ptyId of the process is returned
PS->>PHS: establishExchangeEvents(ptyId) channel
Note right of DT: client has been created,<br/> so PTY Service can attach <br/> event handlers to the channel <br/>(onData/onOpen/onExit)
PS-->>DT: pty process object
DT->>PS: start()
PS->>PHS: exchangeEvents.start()
Note left of PP: exchangeEvents attaches event handlers<br/>to the PTY Process (onData/onOpen/onExit)
PHS->>PP: start()
PP-->>PHS: onOpen()
PHS-->>PS: exchangeEvents.onOpen()
PS-->>DT: onOpen()
DT->>PS: dispose()
PS->>PHS: end exchangeEvents channel
PHS->>PP: dispose process and remove it
```
### Overview of a deep link launch process
web/packages/teleterm/docs/ptyCommunication.png
BIN
View File
Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 57 KiB

web/packages/teleterm/docs/ptyCommunication.txt
-30
View File
@@ -1,30 +0,0 @@
#Source of ptyCommunication.png
title PTY Communication
Document Terminal->PTY Service: wants new PTY
note over PTY Service,PTY Host Service: gRPC communication
PTY Service->PTY Host Service: createPtyProcess(options)
PTY Host Service->PTY Process: new PtyProcess()
PTY Host Service->PTY Service: ptyId of the process is returned
PTY Service->PTY Host Service: establish exchangeEvents(ptyId) channel
note left of PTY Service:
client has been created,
so PTY Service can attach event handlers
to the channel (onData/onOpen/onExit)
end note
PTY Service->Document Terminal: pty process object
Document Terminal->PTY Service: start()
PTY Service->PTY Host Service: exchangeEvents.start()
note right of PTY Host Service:
exchangeEvents attaches event handlers
to the PTY Process (onData/onOpen/onExit)
end note
PTY Host Service->PTY Process: start()
PTY Process->PTY Host Service: onOpen()
PTY Host Service->PTY Service: exchangeEvents.onOpen()
PTY Service->Document Terminal: onOpen()
Document Terminal->PTY Service: dispose()
PTY Service->PTY Host Service: end exchangeEvents channel
PTY Host Service->PTY Process: dispose process and remove it