Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: mermaid diagrams #115

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/Session.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Session State Diagram

```mermaid
stateDiagram-v2
[*] --> GrabLocalMedia
GrabLocalMedia --> CreateOffer
GrabLocalMedia --> Failed
CreateOffer --> SetLocalSessionDescription
CreateOffer --> Failed
SetLocalSessionDescription --> CollectSignalingAndIceCollection
SetLocalSessionDescription --> Failed
CollectSignalingAndIceCollection --> InviteAnswer
CollectSignalingAndIceCollection --> Failed
InviteAnswer --> Accept
InviteAnswer --> Failed
Accept --> Talking
Accept --> Failed
Talking --> Disconnected
```
24 changes: 24 additions & 0 deletions docs/Signaling.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Signaling State Diagram

```mermaid
stateDiagram-v2
[*] --> PendingConnection
PendingConnection --> PendingInvite
PendingConnection --> PendingConnection : RETRY
PendingConnection --> Failed
PendingInvite --> PendingAnswer
PendingInvite --> Failed
PendingAnswer --> PendingAccept
PendingAnswer --> Failed
PendingAccept --> PendingAcceptAck
PendingAccept --> Failed
PendingAcceptAck --> Talking
PendingAcceptAck --> Failed
Talking --> PendingRemoteHangup
Talking --> PendingLocalHangup
Talking --> PendingReconnect
PendingReconnect --> Talking
PendingReconnect --> Failed
PendingRemoteHangup --> Disconnected
PendingLocalHangup --> Disconnected
```
19 changes: 0 additions & 19 deletions uml/Session.puml

This file was deleted.

23 changes: 0 additions & 23 deletions uml/Signaling.puml

This file was deleted.