diff options
| author | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2024-02-07 15:24:29 +0100 |
|---|---|---|
| committer | Jeroen Wijenbergh <46386452+jwijenbergh@users.noreply.github.com> | 2024-02-19 14:15:07 +0100 |
| commit | 584663d0c059a922a740d8d8b793f6031ac00791 (patch) | |
| tree | edb3691f10d7337682dc17e6a34e8650e67160b6 /exports | |
| parent | 272f35f3fb35c30d3fcdb523dc38b87a78064520 (diff) | |
Exports: Add doc for StartProxyguard
Diffstat (limited to 'exports')
| -rw-r--r-- | exports/exports.go | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/exports/exports.go b/exports/exports.go index cecdc4e..ea4d4bd 100644 --- a/exports/exports.go +++ b/exports/exports.go @@ -880,7 +880,16 @@ func StartFailover(c C.uintptr_t, gateway *C.char, mtu C.int, readRxBytes C.Read return droppedC, nil } -// StartProxyguard starts the 'proxyguard' procedure in eduvpn-common +// StartProxyguard starts the 'proxyguard' procedure in eduvpn-common. +// This proxies WireGuard UDP connections over TCP. +// These input variables can be gotten from the configuration that is retrieved using the `proxy` JSON key +// +// - `c` is the cookie +// - `listen` is the ip:port of the local udp connection, this is what is set to the WireGuard endpoint +// - `tcpsp` is the TCP source port +// - `peer` is the ip:port of the remote server +// +// If the proxy cannot be started it returns an error // //export StartProxyguard func StartProxyguard(c C.uintptr_t, listen *C.char, tcpsp C.int, peer *C.char) *C.char { |