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.

Sign up for GitHub

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

misc docs pass #40

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

misc docs pass #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
37 changes: 37 additions & 0 deletions source/calliope/PROTOCOL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
```mermaid
sequenceDiagram
participant Client
participant Server as Server Interface
participant Service
Client->>Server: CONNECT (client ID, identity, Hello)
break service identity does not exist
Server->>Client: REJECT (client ID, NotFound)
end
break server's conn table is full
Server->>Client: REJECT (client ID, ConnTableFull)
end
Server-->>Service: client Hello
activate Service
break Service rejects client Hello
Service-->>Server: ConnectError
Server->>Client: REJECT (client ID, ServiceRejected, ConnectError)
end
Server->>Client: ACK (server ID, client ID)
loop until one peer disconnects
alt client has data to send
Client->>Server: DATA (client ID, server ID, body)
Server-->>Service: body message
else server has data to send
Service-->>Server: body message
Server->>Client: DATA (server ID, client ID, body)
end
end
alt client disconnects
Client->>Server: RESET (server ID, BecauseISaidSo)
Server-->>Service: close connection
else service disconnects
Service-->>Server: close connection
Server->>Client: RESET (client ID, BecauseISaidSo)
end
deactivate Service
```
Loading