package
0.5.0
Repository: https://github.com/moby/vpnkit.git
Documentation: pkg.go.dev

# Functions

ExposePort exposes a port using 9p.
Forward a connection to a given destination.
HandleTCPConnection forwards the TCP traffic to a specified backend address.
HandleUnixConnection forwards the Unix traffic to a specified backend address.
NewBestEffortIPProxy Best-effort attempt to listen on the address in the VM.
NewClose creates a close frame.
NewData creates a data header frame.
NewIPProxy creates a Proxy according to the specified frontendAddr and backendAddr.
NewMultiplexer constructs a multiplexer from a channel.
NewOpen creates an open message.
NewShutdown creates a shutdown frame.
NewStubProxy creates a new StubProxy.
NewTCPProxy creates a new TCPProxy.
NewUDPProxy creates a new UDPProxy.
NewUnixProxy creates a new UnixProxy.
NewWindow creates a Window message.
ProxyStream data between client and backend, until both are at EOF or quit is closed.
SetLogger sets a new default logger.

# Constants

Close requests and then acknowledges the close of a sub-connection.
Data is a payload of a connection/sub-connection.
Dedicated means this connection will not use multiplexing.
Multiplexed means this connection will contain labelled sub-connections mixed together.
Open requests to open a connection to a backend service.
Shutdown indicates that no more data will be written in this direction.
TCP flow.
UDP flow.
UDPBufSize is the buffer size for the UDP proxy.
UDPConnTrackTimeout is the timeout used for UDP connection tracking.
Unix domain socket flow.
Window is permission to send and consume buffer space.

# Structs

CloseFrame requests to disconnect from a proxy backend.
DataFrame is the header of a frame containing user data.
Destination refers to a listening TCP or UDP service.
Frame is the low-level message sent to the multiplexer.
OpenFrame requests to connect to a proxy backend.
ShutdownFrame requests to close the write channel to a proxy backend.
StubProxy is a proxy that is a stub (does nothing).
TCPProxy is a proxy for TCP connections.
UDPProxy is proxy for which handles UDP datagrams.
UnixProxy is a proxy for Unix connections.
WindowFrame is a window advertisement message.

# Interfaces

Conn defines a network connection.
Multiplexer muxes and demuxes sub-connections over a single connection.
Proxy defines the behavior of a proxy.
UDPDialer creates UDP (pseudo-)connections to an address.
UDPListener defines a listener interface to read, write and close a UDP connection.

# Type aliases

Command is the action requested by a message.
Connection indicates whether the connection will use multiplexing or not.
Proto is the protocol of the flow.