diff options
| -rw-r--r-- | docs/src/api/functiondocs.md | 11 | ||||
| -rw-r--r-- | exports/exports.go | 8 |
2 files changed, 14 insertions, 5 deletions
diff --git a/docs/src/api/functiondocs.md b/docs/src/api/functiondocs.md index 9061515..42013ce 100644 --- a/docs/src/api/functiondocs.md +++ b/docs/src/api/functiondocs.md @@ -114,7 +114,8 @@ Signature: ```go func Cleanup(c C.uintptr_t) *C.char ``` -Cleanup sends a /disconnect to cleanup the connection +Cleanup sends a /disconnect to cleanup the connection. Additionally, +if ProxyGuard is active it cancels the running process This MUST be called when disconnecting, see https://docs.eduvpn.org/server/v3/api.html#application-flow `c` is the @@ -831,8 +832,12 @@ Signature: ```go func StartProxyguard(c C.uintptr_t, listen *C.char, tcpsp C.int, peer *C.char, proxySetup C.ProxySetup, proxyReady C.ProxyReady) *C.char ``` -StartProxyguard starts the 'proxyguard' procedure in -eduvpn-common. This proxies WireGuard UDP connections over HTTP: +StartProxyguard starts the 'proxyguard' procedure in eduvpn-common. Note +that you should cancel/delete the cookie for this function when ProxyGuard +is no longer needed! eduvpn-common currently also cleans up the running +ProxyGuard process in `cleanup`. + +This function proxies WireGuard UDP connections over HTTP: https://codeberg.org/eduvpn/proxyguard. These input variables can be gotten from the configuration that is retrieved using the `proxy` JSON key diff --git a/exports/exports.go b/exports/exports.go index a955899..4b48d12 100644 --- a/exports/exports.go +++ b/exports/exports.go @@ -773,7 +773,8 @@ func DiscoOrganizations(c C.uintptr_t) (*C.char, *C.char) { return C.CString(s), getCError(err) } -// Cleanup sends a /disconnect to cleanup the connection +// Cleanup sends a /disconnect to cleanup the connection. +// Additionally, if ProxyGuard is active it cancels the running process // // This MUST be called when disconnecting, see https://docs.eduvpn.org/server/v3/api.html#application-flow // `c` is the Cookie that needs to be passed. Create a new Cookie using `CookieNew` @@ -882,7 +883,10 @@ func StartFailover(c C.uintptr_t, gateway *C.char, mtu C.int, readRxBytes C.Read } // StartProxyguard starts the 'proxyguard' procedure in eduvpn-common. -// This proxies WireGuard UDP connections over HTTP: https://codeberg.org/eduvpn/proxyguard. +// Note that you should cancel/delete the cookie for this function when ProxyGuard is no longer needed! +// eduvpn-common currently also cleans up the running ProxyGuard process in `cleanup`. +// +// This function proxies WireGuard UDP connections over HTTP: https://codeberg.org/eduvpn/proxyguard. // These input variables can be gotten from the configuration that is retrieved using the `proxy` JSON key // // - `c` is the cookie |