tunnel

Documentation

Overview

Package tunnel contains the public tunnel API.

Index

• type SimpleDialer
• type TUN
  • func Start(ctx context.Context, underlyingDialer SimpleDialer, cfg *config.Config) (*TUN, error)

Types

type SimpleDialer

type SimpleDialer interface {
	DialContext(ctx context.Context, network, endpoint string) (net.Conn, error)
}

SimpleDialer establishes network connections.

type TUN

type TUN = tun.TUN

We're creating a type alias to expose the internal TUN implementation on the public API.

func Start

func Start(ctx context.Context, underlyingDialer SimpleDialer, cfg *config.Config) (*TUN, error)

Start starts a VPN tunnel initialized with the passed dialer and config, and returns a TUN device that can later be stopped. In case there was any error during the initialization of the tunnel, they will also be returned by this function.