From 6017b58600910e83e6177044e4e69b9ff556a70c Mon Sep 17 00:00:00 2001 From: jwijenbergh Date: Tue, 21 Mar 2023 13:54:43 +0100 Subject: Docs: Remove outdated documents --- docs/src/api/overview/connecting.md | 14 -------------- 1 file changed, 14 deletions(-) delete mode 100644 docs/src/api/overview/connecting.md (limited to 'docs/src/api/overview/connecting.md') diff --git a/docs/src/api/overview/connecting.md b/docs/src/api/overview/connecting.md deleted file mode 100644 index c2a82a0..0000000 --- a/docs/src/api/overview/connecting.md +++ /dev/null @@ -1,14 +0,0 @@ -# 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. -- cgit v1.2.3