cha0s/flecks
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: dox++

Browse Source
This commit is contained in:
cha0s 2024-01-06 21:25:45 -06:00
parent f5769b8df8
commit 4c72b71f4a
1 changed files with 3 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
website/docs/sockets.mdx
View File

@ -295,37 +295,30 @@ only the others.
::: :::
### Diagram
```mermaid ```mermaid
sequenceDiagram sequenceDiagram
actor Client actor Client
participant Node-1 participant Node-1
participant Node-2 participant Node-2
participant Node-3
participant Node-N participant Node-N
Note right of Client: Client makes a request for position(P)
Client->>Node-1: REQUEST: position(P) Client->>Node-1: REQUEST: position(P)
alt has position(P) alt has position(P)
Note left of Node-1: Has position: no intercom necessary.
Node-1->>Client: RESPONSE: {x, y, z} Node-1->>Client: RESPONSE: {x, y, z}
else doesn't have position(P) else doesn't have position(P)
Note right of Node-1: Doesn't have position: intercom necessary.
Node-1->>Intercom: INTERCOM: @simulation/position.request(P) Node-1->>Intercom: INTERCOM: @simulation/position.request(P)
par par
Intercom-->>Node-1: INTERCOM: @simulation/position.request(P) Intercom-->>Node-1: INTERCOM: @simulation/position.request(P)
Node-1-xIntercom: RESPONSE: undefined Node-1-xIntercom: RESPONSE: undefined
Note right of Node-1: Doesn't have position: undefined.
and and
Intercom-->>Node-2: INTERCOM: @simulation/position.request(P) Intercom-->>Node-2: INTERCOM: @simulation/position.request(P)
Node-2-xIntercom: RESPONSE: {x, y, z} Node-2->>Intercom: RESPONSE: {x, y, z}
Note right of Node-2: Has position: {x, y, z}.
and and
Intercom-->>Node-N: INTERCOM: @simulation/position.request(P) Intercom-->>Node-N: INTERCOM: @simulation/position.request(P)
Node-N-xIntercom: RESPONSE: undefined Node-N-xIntercom: RESPONSE: undefined
Note right of Node-N: Doesn't have position: undefined.
end end
Note left of Intercom: Return all results as an array.
Intercom->>Node-1: RESPONSE: [undefined, {x, y, z}, undefined] Intercom->>Node-1: RESPONSE: [undefined, {x, y, z}, undefined]
Note left of Node-1: Filter out and return the position from the results.
Node-1->>Client: RESPONSE: {x, y, z} Node-1->>Client: RESPONSE: {x, y, z}
end end
``` ```