monitor

Documentation

Overview

Package monitor provides facilities for monitoring network interface and route changes. It primarily exists to know when portable devices move between different networks.

Index

• type ChangeFunc
• type Mon
  • func New(logf logger.Logf) (*Mon, error)
  • func (m *Mon) Close() error
  • func (m *Mon) GatewayAndSelfIP() (gw, myIP netaddr.IP, ok bool)
  • func (m *Mon) InjectEvent()
  • func (m *Mon) InterfaceState() *interfaces.State
  • func (m *Mon) RegisterChangeCallback(callback ChangeFunc) (unregister func())
  • func (m *Mon) Start()

Types

type ChangeFunc

type ChangeFunc func(changed bool, state *interfaces.State)

ChangeFunc is a callback function that's called when the network changed. The changed parameter is whether the network changed enough for interfaces.State to have changed since the last callback.

type Mon

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

Mon represents a monitoring instance.

func New

func New(logf logger.Logf) (*Mon, error)

New instantiates and starts a monitoring instance. The returned monitor is inactive until it's started by the Start method. Use RegisterChangeCallback to get notified of network changes.

func (*Mon) Close

func (m *Mon) Close() error

Close closes the monitor.

func (*Mon) GatewayAndSelfIP

func (m *Mon) GatewayAndSelfIP() (gw, myIP netaddr.IP, ok bool)

GatewayAndSelfIP returns the current network's default gateway, and the machine's default IP for that gateway.

It's the same as interfaces.LikelyHomeRouterIP, but it caches the result until the monitor detects a network change.

func (*Mon) InjectEvent

func (m *Mon) InjectEvent()

InjectEvent forces the monitor to pretend there was a network change and re-check the state of the network. Any registered ChangeFunc callbacks will be called within the event coalescing period (under a fraction of a second).

func (*Mon) InterfaceState

func (m *Mon) InterfaceState() *interfaces.State

InterfaceState returns the state of the machine's network interfaces, without any Tailscale ones.

func (*Mon) RegisterChangeCallback

func (m *Mon) RegisterChangeCallback(callback ChangeFunc) (unregister func())

RegisterChangeCallback adds callback to the set of parties to be notified (in their own goroutine) when the network state changes. To remove this callback, call unregister (or close the monitor).

func (*Mon) Start

func (m *Mon) Start()

Start starts the monitor. A monitor can only be started & closed once.