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, callback ChangeFunc) (*Mon, error)
  • func (m *Mon) Close() error
  • func (m *Mon) Start()

Types

type ChangeFunc

type ChangeFunc func()

ChangeFunc is a callback function that's called when an interface status changes.

type Mon

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

Mon represents a monitoring instance.

func New

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

New instantiates and starts a monitoring instance. Change notifications are propagated to the callback function. The returned monitor is inactive until it's started by the Start method.

func (*Mon) Close

func (m *Mon) Close() error

Close closes the monitor. It may only be called once.

func (*Mon) Start

func (m *Mon) Start()

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