diff options
| author | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2022-05-05 17:47:36 +0200 |
|---|---|---|
| committer | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2022-05-05 17:47:36 +0200 |
| commit | 7bb7885f6eb19547b906513d2664e3730ef5b593 (patch) | |
| tree | ce387ad24da5e3ba3b4d1604d07a5b11d9e68a2e /docs/src/api/overview/connecting.md | |
| parent | 657776055cd07c1f9279e982fbfef88dca1ca71b (diff) | |
Docs: Add API and building improvements
Diffstat (limited to 'docs/src/api/overview/connecting.md')
| -rw-r--r-- | docs/src/api/overview/connecting.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/src/api/overview/connecting.md b/docs/src/api/overview/connecting.md new file mode 100644 index 0000000..c2a82a0 --- /dev/null +++ b/docs/src/api/overview/connecting.md @@ -0,0 +1,14 @@ +# Connecting/Disconnecting +## Summary +Name: `Set Connected` and `Set Disconnected` + +Arguments: None + +Returns: `Error` + +Used to signal to the FSM that we're connected/disconnected to the VPN + +## Detailed information +This function is used to set the internal FSM state to connected. As the library does not actually connect to a VPN server, as this is platform specific, this must be called by the client to signal to the library that the user is connected to the VPN. If the FSM does not have a transition to the Connected state it will signal this with a returned error. + +The same function is used to signal the FSM that the VPN is disconnected. |