From 5abf00ab87a55662eefc7716de52ead9749293c6 Mon Sep 17 00:00:00 2001 From: jwijenbergh Date: Fri, 13 May 2022 12:12:22 +0200 Subject: Refactor: Adapt the API to the documentation --- docs/src/gettingstarted/debugging/fsm.md | 8 ++++---- docs/src/gettingstarted/debugging/fsm_example.svg | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) (limited to 'docs/src/gettingstarted/debugging') diff --git a/docs/src/gettingstarted/debugging/fsm.md b/docs/src/gettingstarted/debugging/fsm.md index 11d51de..8479a92 100644 --- a/docs/src/gettingstarted/debugging/fsm.md +++ b/docs/src/gettingstarted/debugging/fsm.md @@ -1,6 +1,6 @@ -# Finite State Machine +# Finite state machine -The eduvpn-common library uses a Finite State Machine internally to keep track of which state the client is in and to communicate data callbacks (e.g. to communicate the Authorization URL in the OAuth process to the client). +The eduvpn-common library uses a finite state machine internally to keep track of which state the client is in and to communicate data callbacks (e.g. to communicate the Authorization URL in the OAuth process to the client). ## Viewing the FSM To view the FSM in an image, set the debug variable to `True`. This outputs the graph with a `.graph` extension in the client-specified config directory (See [API](../../api/index.html)). The format of this graph is from [Mermaid](https://mermaid-js.github.io/mermaid/#/). @@ -9,7 +9,7 @@ If you have the [Mermaid command line client](https://github.com/mermaid-js/merm If you do not want to install additional tools to view the graph, you can submit the contents of the `.graph` file to the [Mermaid Live Editor](https://mermaid.live/) to see the image. -## FSM Example +## FSM example The following is an example of the FSM when the client has obtained a Wireguard/OpenVPN configuration from an eduVPN server ![](./fsm_example.svg) @@ -21,7 +21,7 @@ The states mean the following: - `Deregistered`: The client has not registered with the library yet, the state variables are not initialized - `No_Server`: The client is registered, but has not chosen a server yet -- `Chosen_ServeR`: The client has chosen a server to connect to +- `Chosen_Server`: The client has chosen a server to connect to - `OAuth_Started`: The OAuth process has been started. This means that the client needs to redirect to the browser so that the user can login and approve the application - `Authorized`: The OAuth process has finished. The client now has tokens and is thus authorized - `Request_Config`: The client is in the process of requesting an OpenVPN/Wireguard configuration from the server diff --git a/docs/src/gettingstarted/debugging/fsm_example.svg b/docs/src/gettingstarted/debugging/fsm_example.svg index 9b19280..134b0fb 100644 --- a/docs/src/gettingstarted/debugging/fsm_example.svg +++ b/docs/src/gettingstarted/debugging/fsm_example.svg @@ -1 +1 @@ -
Client registers
User chooses a server
Found tokens in config
No tokens found in config
User authorizes with browser
Cancel OAuth
Re-authorize with OAuth
Client requests a config
Multiple profiles found
Success, only one profile
OS reports connected
User chooses profile and success
OS reports disconnected
Deregistered
No_Server
Chosen_Server
Authorized
OAuth_Started
Request_Config
Ask_Profile
Has_Config
Connected
 \ No newline at end of file +
Client registers
User chooses a server
Found tokens in config
No tokens found in config
User authorizes with browser
Cancel or Error
Re-authorize with OAuth
Client requests a config
Multiple profiles found and no profile chosen
Only one profile or profile already chosen
Cancel or Error
Re-authorize
OS reports connected
User chooses a new profile
User wants to choose a new server
User chooses profile
Done but no profile selected
OS reports disconnected
Deregistered
No_Server
Chosen_Server
Authorized
OAuth_Started
Request_Config
Ask_Profile
Has_Config
Connected
 \ No newline at end of file -- cgit v1.2.3