backend

Documentation

Index

• func Register(name string, ctor BackendCtor)
• type Backend
• type BackendCtor
• type ExternalInterface
• type Manager
  • func NewManager(ctx context.Context, sm subnet.Manager, extIface *ExternalInterface) Manager
• type Network
• type SimpleNetwork
  • func (n *SimpleNetwork) Lease() *subnet.Lease
  • func (n *SimpleNetwork) MTU() int
  • func (_ *SimpleNetwork) Run(ctx context.Context)

Functions

func Register

func Register(name string, ctor BackendCtor)

Types

type Backend

type Backend interface {
	// Called when the backend should create or begin managing a new network
	RegisterNetwork(ctx context.Context, config *subnet.Config) (Network, error)
}

Besides the entry points in the Backend interface, the backend's New() function receives static network interface information (like internal and external IP addresses, MTU, etc) which it should cache for later use if needed.

type BackendCtor

type BackendCtor func(sm subnet.Manager, ei *ExternalInterface) (Backend, error)

type ExternalInterface

type ExternalInterface struct {
	Iface     *net.Interface
	IfaceAddr net.IP
	ExtAddr   net.IP
}

type Manager

type Manager interface {
	GetBackend(backendType string) (Backend, error)
}

func NewManager

func NewManager(ctx context.Context, sm subnet.Manager, extIface *ExternalInterface) Manager

type Network

type Network interface {
	Lease() *subnet.Lease
	MTU() int
	Run(ctx context.Context)
}

type SimpleNetwork

type SimpleNetwork struct {
	SubnetLease *subnet.Lease
	ExtIface    *ExternalInterface
}

func (*SimpleNetwork) Lease

func (n *SimpleNetwork) Lease() *subnet.Lease

func (*SimpleNetwork) MTU

func (n *SimpleNetwork) MTU() int

func (*SimpleNetwork) Run

func (_ *SimpleNetwork) Run(ctx context.Context)