Skip to content

Latest commit

 

History

History
47 lines (27 loc) · 2.61 KB

README.md

File metadata and controls

47 lines (27 loc) · 2.61 KB
Raw

Remote UDP Tunnel

Provides "Forward a Port" for UDP ports when using VS Code Remote Development

Features

Remote UDP Tunnel: Forward a Port command exposes a UDP port on the local machine which proxies traffic to the selected port in the remote workspace.

Diagram of Mechanism

The UDP traffic is tunneled via vscode's builtin TCP port forwarding.

When you're done using the port, close it with the Remote UDP Tunnel: Stop Forwarding Port via the command palette or via the "UDP" explorer view added by the extension.

Extension in action

Why yes, that is Factorio connected to a server over the UDP tunnel.

Alternatives

If you know the UDP port number you will need access to in advance, and you can configure the remote environment (eg. the devcontainer) to make that port available, then it is likely simpler and more robust for you to use a method such as this.

If, as I did, you find yourself working with UDP servers on ephemeral / dynamic ports or have other reasons to rely on access over VS Code's builtin TCP tunnel, then this extension may help you.

Limitations

  • Because the UDP traffic is tunneled over TCP, this will introduce Head-of-line blocking and generally alter some UDP traffic characteristics.
  • The encoding and decoding of UDP over TCP adds 2 bytes of overhead per datagram and so this may reduce the effective MTU by 2 bytes.
  • The proxy decoder has a small chance of fragmenting some UDP packets. I have not observed this in practice so far.
  • The "Time to First Byte" for a new client sending packets can be over a second as the VS Code TCP tunnel itself has a very slow handshake to complete on each new connection.
  • The extension does not currently auto-detect open UDP ports and forward them, as the TCP version built in to vscode does. I may add this feature.
  • This extension won't work with vscode running in browser-sandboxed scenarios (such as "Visual Studio Code for the Web") where the extension cannot open a UDP port for you to access.

Extension Settings

This extension exposes no settings.

Release Notes

0.0.1

Alpha release. Good Luck, Have Fun!

0.0.5

Feature: Open multiple ports with a single command. Multiple ports can be specified as a list (eg. "2001,2002,2003"), a range (eg. "2001-2003"), or a count eg. ("2001x3"). Thanks to @Danielv123.