diff options
Diffstat (limited to 'docs/src/api')
| -rw-r--r-- | docs/src/api/functiondocs.md | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/src/api/functiondocs.md b/docs/src/api/functiondocs.md index 3bf1899..3f1b214 100644 --- a/docs/src/api/functiondocs.md +++ b/docs/src/api/functiondocs.md @@ -844,7 +844,7 @@ Example Output: ```1, null``` ## StartProxyguard Signature: ```go -func StartProxyguard(c C.uintptr_t, listen *C.char, tcpsp C.int, peer *C.char, proxyFD C.ProxyFD) *C.char +func StartProxyguard(c C.uintptr_t, listen *C.char, tcpsp C.int, peer *C.char, proxyFD C.ProxyFD, proxyReady C.ProxyReady) *C.char ``` StartProxyguard starts the 'proxyguard' procedure in eduvpn-common. This proxies WireGuard UDP connections over HTTP: @@ -859,6 +859,9 @@ from the configuration that is retrieved using the `proxy` JSON key - `proxyFD` is a callback with the file descriptor as only argument. It can be used to set certain socket option, e.g. to exclude the proxy connection from going over the VPN + - `proxyReady` is a callback when the proxy is ready to be used. This is + only called when the client is not connected yet. Use this to determine + when the actual wireguard connection can be started If the proxy cannot be started it returns an error |