wginternal

Documentation

Overview

Package wginternal contains shared internal types for wgctrl.

This package is internal-only and not meant for end users to consume. Please use package wgctrl (an abstraction over this package) instead.

Index

• Variables
• type Client

Variables

var ErrReadOnly = errors.New("driver is read-only")

ErrReadOnly indicates that the driver backing a device is read-only. It is a sentinel value used in integration tests. TODO(mdlayher): consider exposing in API.

Types

type Client

type Client interface {
	io.Closer
	Devices() ([]*wgtypes.Device, error)
	Device(name string) (*wgtypes.Device, error)
	ConfigureDevice(name string, cfg wgtypes.Config) error
}

A Client is a type which can control a WireGuard device.