webteleport

README

WebTeleport

Documentation

Overview

Package webteleport is a client library for creating webteleport connections that is easy to use:

• Call Listen the same way you use net.Listen to get a [Listener]
• Call [Listener.Accept] to create new net.Conn

The URL you pass to Listen should be a [WebTeleport Server](github.com/webteleport/server)

With webteleport, you can easily serve on a public address, even if you are behind a firewall.

For possible use cases, check https://github.com/webteleport/ufo

Index

• func Listen(ctx context.Context, relayAddr string) (net.Listener, error)

Functions

func Listen

func Listen(ctx context.Context, relayAddr string) (net.Listener, error)

Listen calls [Dial] to create a [Listener], which is essentially a wrapper struct around a webtransport session, which in turn is able to spawn arbitrary number of streams that implements net.Conn

It is modelled after net.Listen, however it doesn't require the caller to be able to bind to a local port.

The returned Listener can be imagined to be bound to a remote net.Addr, which can be obtained using the [Listener.Addr] method