tunnel

package

v0.0.0-...-851e5e8 Latest Latest Go to latest Published: Mar 28, 2024 License: GPL-3.0 Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package tunnel provides an extension over standard library's net.Interface type.

This section is empty.

View Source

var (
	// ErrNotFound is returned when no tunnel matches the search parameters.
	ErrNotFound = errors.New("tunnel not found")
)

This section is empty.

type Statistics struct {
	Tx uint64
	Rx uint64
}

Statistics defines what information can be collected about the tunnel

type T interface {
	Interface() net.Interface
	IPs() []netip.Addr
	TransferRates() (Statistics, error)
}

T describes tunnel behavior probably needs a better name, though

type Tunnel struct {
	// contains filtered or unexported fields
}

Tunnel encrypts and decrypts network traffic.

func Find(ipAddrs ...netip.Addr) (Tunnel, error)

Find a tunnel with given IPs.

func New(iface net.Interface, ips []netip.Addr) *Tunnel

func (t *Tunnel) AddAddrs() error

AddAddrs to a tunnel interface.

func (t *Tunnel) DelAddrs() error

DelAddrs from a tunnel interface.

func (t *Tunnel) IPs() []netip.Addr

IPs attached to the tunnel.

func (t *Tunnel) Interface() net.Interface

Interface returns the underlying network interface.

func (t Tunnel) TransferRates() (Statistics, error)

TransferRates collects data transfer statistics.

func (t *Tunnel) Up() error

Up sets tunnel state to up.